@archway-kit/tailwind-plugin

@archway-kit/tailwind-plugin

A Tailwind CSS plugin that provides a set of classes and styles for the archway-kit components.

Installation

Install the plugin from npm:

npm install -D @archway-kit/tailwind-plugin

Then add the plugin to your tailwind.config.js file:

// tailwind.config.js
module.exports = {
  // ...
  plugins: [
    // ...
    require('@archway-kit/tailwind-plugin')({
      ...
    }),
  ],
}

It will add core styles and tailwind components, as well as css palette variables.

Configuration

To customize how the plugin handles themes, you need to provide configuration object:

// tailwind.config.js
module.exports = {
  // ...
  plugins: [
    // ...
    require('@archway-kit/tailwind-plugin')({
      lightThemeClass: 'my-custom-light-class',
      darkThemeClass: 'my-custom-dark-class',
      ignorePreferences: false,
      fallbackDark: false,
    }),
  ],
}

More

For full documentation about the Archway Network and its ecosystem, visit Archway Docs.

Community

For help, discussion about best practices, or any other conversation that would benefit from being searchable:

Discuss Archway Kit on GitHub