README.md

sass-thematize

A SASS utility for generating multiple themes.

Install with npm:

npm:

npm install sass-thematize --save

Usage

A lot of applications typically have light and dark themes. Often these applications want to utilize both themes on the same page. A typical pattern is to create inverted colors. This requires duplicating rules but with a different set of colors. One approach to simplifying this is to write rules once, but generate multiple sets of those rules with different color, or other property, values.

The following example creates a single color palette with multiple themes.

// create your palettes
$theme-color-palette: (
  'blue': (
    1: #A3E9FF,
    2: #8ED5EF,
    3: #7AC1E0,
    4: #65ADD1,
    5: #519AC2,
    6: #3D86B2,
    7: #2872A3,
    8: #145E94,
    9: #004B85
  )
);

// define your theme properties
$themes: (
  'default': (
    font-size: 16px,
    text-color: black,
    background-color: white,
    primary-color: (blue, 6),
    button-color: '$text-color' // reference to `text-color`
  ),
  'dark': (
    text-color: white,
    background-color: black,
    primary-color: (blue, 3)
    // no need to re-define `button-color` because the reference will pick up the `dark` `text-color`
  )
);

// use the thematize mixin to generate multiple themes
@include thematize {
  .button {
    font-size: theme(font-size);
    color: theme(button-color);
    background-color: theme(background-color);

    &:hover,
    &:focus {
      color: theme(background-color);
      background-color: theme(primary-color)
    }

    &:active {
      color: theme(background-color);
      background-color: theme(primary-color, 2);
    }
  }
}

The generated CSS from the above SASS is:

.button {
  font-size: 16px;
  color: black;
  background-color: white;
}

.button:hover,
.button:focus {
  color: white;
  background-color: #3d86b2;
}

.button:active {
  color: white;
  background-color: #145e94;
}

.theme-dark .button {
  color: white;
  background-color: black;
}

.theme-dark .button:hover,
.theme-dark .button:focus {
  color: black;
  background-color: #7ac1e0;
}

.theme-dark .button:active {
  color: black;
  background-color: #519ac2;
}

Push and Pull Colors

This utility has a feature to assign values up and down a palette scale of colors. Typically organizations have their own defined palette of colors with varying shades. When interacting with elements it is often necessary to push or a pull a color up or down the scale in order to emphasize an interaction. Adjusting colors through lightening or darkening by a given percent is often used to generate dynamic colors. However, the generated colors don't necessarily match the organizations choices. Instead, by defining theme variables as palette colors and using the theme functions' second parameter to push or pull a color, it's possible assign dynamic colors that adhere to the organizations choices.

In this example, the icon is colored primary-color. On hover, the color is given the same primary-color but 2 stops lighter on the scale. Similarly, the active color is primary-color but 2 stops darker on the scale. This feature ensures that the assigned colors are taken from the palette.

$theme-color-palette: (
  'blue': (
    1: #A3E9FF,
    2: #8ED5EF,
    3: #7AC1E0,
    4: #65ADD1,
    5: #519AC2,
    6: #3D86B2,
    7: #2872A3,
    8: #145E94,
    9: #004B85
  )
);

$themes: (
  'default': (
    primary-color: (blue, 5)
  )
);

@include thematize {
  .icon {
    color: theme(primary-color);

    &:hover,
    &:focus {
      color: theme(primary-color, -2);
    }

    &:active {
      color: theme(primary-color, 2);
    }
  }
}

The generated CSS from the above SASS is:

.icon {
  color: #519AC2;
}

.icon:hover,
.icon:focus {
  color: #7AC1E0;
}

.icon:active {
  color: #2872A3;
}