@salla.sa/twilight-tailwind-theme

2.13.103 • Public • Published

Logo

Twilight Tailwind-Theme

The Tailwind-Theme Plugin registers the Twilight Web Component styles and injects them using JavaScript instead of CSS. It's a good starting point for Tailwind-based themes.
Explore our blogs »
Report Bug · Request Feature . </Salla Developers> . Official Documentation

Table of Contents
  1. Overview
  2. Usage
  3. Add a New Component
  4. Publish
  5. Support
  6. Contributing
  7. Credits
  8. License

Overview

The Tailwind-Theme Plugin registers the styles needed by the Twilight Web Components and then injects them into the theme stylesheet using JavaScript instead of CSS. It can also be used as a starter theme for any theme based on Tailwind.

Usage

By default, any Tailwind-based theme will look for the tailwind.config.d.ts file at the root of the project to retrieve any pre-settings and customizations. Accordingly, the plugin Tailwind-Theme should be added to the tailwind.config.d.ts file as follows:

plugins: [
  ...
  require('@salla.sa/twilight-tailwind-theme'),
  ....
]

JIT Enabled

Tailwind added a just-in-time compiler, which generates styles as the developer writes the theme rather than generating everything in advance at initial build time. Since JIT mode generates your CSS on-demand by scanning your template files, it’s crucial that the developer configure the content option in the tailwind.config.d.ts file with all of the theme paths, otherwise the CSS classes will be empty.

...
content: [
  // theme views
  "views/**/*.twig",
  // list of classes which required by twilight web components
  "node_modules/@salla.sa/twilight-tailwind-theme/safe-list-css.txt"
],
...

Add a New Component

With Tailwind, developer style elements by applying pre-existing classes directly into the HTML. This is done using utility classes to build custom designs without writing CSS. Based on that, the developer may develop a new component by simple doing the following steps:

  1. Create a new folder with the name of the new compnenet.
  2. Create a utilities.json file with list of new compnenet's classes as json.

Publish

Last, the developer may publish the project using the following command:

npm run publish

(back to top)

Support

The team is always here to help you. Happen to face an issue? Want to report a bug? You can submit one here on Github using the Issue Tracker. If you still have any questions, please contact us via the Telegram Bot or join in the Global Developer Community on Telegram.

(back to top)

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Credits

(back to top)

License

The MIT License (MIT). Please see License File for more information.

(back to top)

Package Sidebar

Install

npm i @salla.sa/twilight-tailwind-theme

Homepage

salla.dev

Weekly Downloads

840

Version

2.13.103

License

GPL-3.0

Unpacked Size

213 kB

Total Files

6

Last publish

Collaborators

  • jalmatari
  • s.alkhwlani