@vismaux/tailwindcss-vud

1.0.1 • Public • Published

@vismaux/tailwindcss-vud

npm version

Visma Unified Design (VUD) theme configuration for tailwindcss.

Usage

Note: This guide expects to have tailwindcss already in place.
If not, please refer to tailwindcss installation guide.

This package supports two different configurations:

  • Complementary - for use together with @vismaux/vud;
  • Vanilla - standalone configuration of the VUD theme (not available yet).

Complementary (to @vismaux/vud)

  1. Install this package npm i @vismaux/tailwindcss-vud -D;
  2. Add it to your tailwind.config.js:
const { complementaryTheme } = require('@vismaux/tailwindcss-vud');

module.exports = {
  /**
   * Main property to set the theme.
   * If needed, values can be overwritten by using the spread syntax:
   * `theme: { ...complementaryTheme, colors: myColors }`
   * or taking use of special `extend` property, more on that:
   * https://tailwindcss.com/docs/theme#extending-the-default-theme
   */
  theme: complementaryTheme,

  // recommended, to avoid name conflicts with the classes coming from `vud` library
  prefix: 'tw-',

  // recommended, to give higher specificity for tailwind utilities than `vud` styles
  important: true,

  // recommended, because `vud` library already handles the font family
  corePlugins: {
    fontFamily: false,
  },

  // ... the rest of your configuration ...
};

Vanilla

not available yet

Readme

Keywords

none

Package Sidebar

Install

npm i @vismaux/tailwindcss-vud

Weekly Downloads

9

Version

1.0.1

License

Visma License

Unpacked Size

8.6 kB

Total Files

6

Last publish

Collaborators

  • daceakmene
  • annemarija-irbite
  • jmeteor
  • lars-visma
  • uxvisma
  • cristina.iftode
  • mihai.baciu
  • dzonatan
  • dreiv
  • janispp