https://github.com/siteation/magento2-theme-tokens

Customize your theme with ease with Design Tokens (CSS props)
https://github.com/siteation/magento2-theme-tokens

css-props css-variables design-tokens hyva hyva-compatibility-module magento2 magento2-module

Last synced: 4 days ago
JSON representation

Customize your theme with ease with Design Tokens (CSS props)

• Host: GitHub
• URL: https://github.com/siteation/magento2-theme-tokens
• Owner: Siteation
• License: mit
• Created: 2023-07-03T05:13:01.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-16T21:42:14.000Z (10 months ago)
• Last Synced: 2024-09-17T16:51:11.064Z (2 months ago)
• Topics: css-props, css-variables, design-tokens, hyva, hyva-compatibility-module, magento2, magento2-module
• Language: PHP
• Homepage: https://siteation.dev
• Size: 867 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Siteation - Magento 2 module Theme Tokens

[![Packagist Version](https://img.shields.io/packagist/v/siteation/magento2-theme-tokens?style=for-the-badge)](https://packagist.org/packages/siteation/magento2-theme-tokens)

![Supported Magento Versions](https://img.shields.io/badge/magento-%202.4-brightgreen.svg?logo=magento&longCache=true&style=for-the-badge)

[![Hyvä Themes Supported](https://img.shields.io/badge/Hyva_Themes-Supported-3df0af.svg?longCache=true&style=for-the-badge)](https://hyva.io/)

![License](https://img.shields.io/github/license/siteation/magento2-theme-tokens?color=%23234&style=for-the-badge)

This Magento 2 module makes it easy to manage Design Tokens from the Magento backend.

Once you have set your tokens,

they will be output as CSS variables to the frontend,

making it easy to style your website with consistent and reusable code.

## Installation

Install the package via;

```bash

composer require siteation/magento2-theme-tokens

bin/magento setup:upgrade

```

> **Note** This Module requires Magento 2.4 or higher!

> For more requirements see the `composer.json`.

## How to use

Once the module is installed, you can manage your Design Tokens from the Magento backend.

First make sure your styles support CSS variables

![Sample config with Hyva Tailwind Config](./assets/preview-config.jpg)

After this you can configure your tokens, Go to Stores > Configuration > Siteation > Design Tokens.

Enter your the tokens in the desired format.

![Sample config with Hyva Tailwind Config](./assets/backend.jpg)

Once you have set your tokens, they will be output as CSS variables to the frontend.

| Before       | After        |

| ------------ | ------------ |

| ![preview-1] | ![preview-2] |

[preview-1]: ./assets/default.jpg

[preview-2]: ./assets/with-tokens.jpg