Skip to content
This repository has been archived by the owner on Dec 6, 2022. It is now read-only.

Latest commit

 

History

History
111 lines (74 loc) · 2.78 KB

README.md

File metadata and controls

111 lines (74 loc) · 2.78 KB

Next.css Material Colors Module

Material Colors Module is part of Next.css framework. This module contains original Material Color Palette CSS styles for your Next.css project. You can use in all modern websites with module bundlers, like webpack, rollup, parcel.

Next.css on GitHub

How to Install

You can install with npm or yarn package managers.

npm i @nextcss/material-colors
yarn add @nextcss/material-colors

Simple import to your project, and add class rules to you HTML tags. Check available selector rules below.

import '@nextcss/material-colors';

Features

  • Text colors (foreground)
  • Background colors
  • Border colors
  • Hover states
  • Active states
  • Focus states
  • Focus-In states

How to use

<!-- Set background color -->
<h1 class="bg-blue-500">...</h1>

<!-- Set background, border and text colors -->
<div class="bg-pink-50 b-pink-100 fg-pink-700">...</div>

<!-- Set text color, background and hover state background -->
<button class="fg-white bg-blue-500 hover:bg-blue-700">...</button>

Selector formula

[state:]prefix-color[-scale]

state

After state must use colon, state is not required.

hover,active,focus,focus-in

prefix

After prefix must use hyphen, state is required.

fg - foreground, bg - background, b - border

color (scalable)

After color must be set scale value. color is required.

red, pink, purple, deep-purple, indigo, blue, light-blue,cyan,teal,green,light-green,lime,yellow,amber,orange,deep-orange,brown,grey,blues-grey

color (not scalable)

After color can not set scale value. color is required.

black,white

scale

Before scale must use hyphen, scale is required for scalable color only.

100,200,300,400,500,600,700,800,900

Production build

We strongly recommend to use postcss with autoprefixer and postcss-purgecss. This stack will extend the CSS rules with browser specific prefixes, like -webkit and will remove unused styles in production build.

npm i -D postcss autoprefixer @fullhuman/postcss-purgecss

Our postcss.config.js config. You need to configure the content parameter for your project.

module.exports = {
  plugins:
    process.env.NODE_ENV === 'production'
      ? [
          'autoprefixer',
          [
            '@fullhuman/postcss-purgecss',
            {
              content: ['./{pages,components}/**/*.{js,jsx}'],
              safelist: ['html', 'body'],
              defaultExtractor: (content) => content.match(/[\w-/:]+(?<!:)/g) || [],
            },
          ],
        ]
      : ['autoprefixer'],
};

License

MIT License. Copyright (c) 2021 Zsolt Tovis