npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

themie

v0.0.5

Published

A CSS variable theming library

Downloads

3

Readme

Themie is a CSS variable theming library that can be used to easily create Material Design themes for web applications.

Quick Start

1) Install

Install Themie from NPM:

npm i themie --save

2) Import Themie

import { themie } from 'themie/themie.js';
import { MaterialTheme } from 'themie/material-theme.js';

3) Create a Theme

/*
primary, lightPrimary, darkPrimary, secondary, lightSecondary, darkSecondary,
onPrimary, onLightPrimary, onDarkPrimary, onSecondary, onLightSecondary, onDarkSecondary,
surface, background, error, notification, 
onSurface, onBackground, onError, onNotification,
textPrimary, textSecondary, textDisabled, 
divider
*/
const blueTeal = new MaterialTheme('#6002ee', '#9c47ff', '#0000ba', '#00bfa5', '#5df2d6', '#008e76', 
                           '#FFFFFF', '#FFFFFF', '#FFFFFF', '#000000', '#000000', '#FFFFFF',
                           '#FFFFFF', '#FAFAFA', '#B00020', '#323232', 
                           'rgba(0, 0, 0, 0.87)', 'rgba(0, 0, 0, 0.87)', '#FFFFFF', 'rgba(255, 255, 255, 0.87)',
                           'rgba(0, 0, 0, 0.87)', 'rgba(0, 0, 0, 0.54)', 'rgba(0, 0, 0, 0.38)', 
                           'rgba(0, 0, 0, 0.20)');

4) Register the Theme

themie.register('blue-teal', blueTeal);

5) Apply the Theme

A theme can be applied globally (to the document).

themie.apply('blue-teal');

Or to a DOM node (and its children).

const el = document.getElementById('something');

themie.apply('blue-teal', el);

6) Use the Theme

Since a theme is just a bunch of CSS variables, you use them in CSS selectors as normal.

.something {
    color: var(--theme-on-primary-color);
    background: var(--theme-primary-color);
    border: 1px solid var(--theme-divider-color);
}

Different themes can be applied to different nodes, and a theme applied to a child node will override any inherited theme.

Themes

Themie currently supports Material Design themes only, but any object can be used to register a theme. The generated CSS variable names are based on the camelCase property names, which are converted to snake-case with a --theme- prefix and -color suffix. For example, you could do something like this:

import { themie } from 'themie/themie.js';

const customTheme = {
    main: 'cornflowerblue',
    accent: 'lightgreen',
    text: 'black'
}

themie.register('custom-theme', customTheme);
themie.apply('custom-theme');

And use the theme like this:

.main {
    color: var(--theme-text-color);
    background: var(--theme-main-color);
}

.accent {
    color: var(--theme-text-color);
    background: var(--theme-accent-color);
}

Material Theme Variables

To use the Material Design theme object, import MaterialTheme from material-theme.js. The constructor parameters are shown in the table below.

import { MaterialTheme } from 'themie/material-theme.js';

|Parameter |Variable |Description | |----------------|--------------------------------|-------------------------------------------------------------------------| |primary |--theme-primary-color |The primary color | |lightPrimary |--theme-light-primary-color |A light variant of the primary color | |darkPrimary |--theme-dark-primary-color |A dark variant of the primary color | |secondary |--theme-secondary-color |The secondary or accent color | |lightSecondary |--theme-light-secondary-color |A light variant of the secondary color | |darkSecondary |--theme-dark-secondary-color |A dark variant of the secondary color | |onPrimary |--theme-on-primary-color |The text/icon color on a primary color background | |onLightPrimary |--theme-on-light-primary-color |The text/icon color on a light primary color background | |onDarkPrimary |--theme-on-dark-primary-color |The text/icon color on a dark primary color background | |onSecondary |--theme-on-secondary-color |The text/icon color on a secondary color background | |onLightSecondary|--theme-on-light-secondary-color|The text/icon color on a light secondary color background | |onDarkSecondary |--theme-on-dark-secondary-color |The text/icon color on a dark secondary color background | |surface |--theme-surface-color |The background color for container surfaces, such as dialogs, etc. | |background |--theme-background-color |The background color for application windows | |error |--theme-error-color |The background color for error containers, or error/validation text color| |notification |--theme-notification-color |The background color for notifications, such as toast or tooltips | |onSurface |--theme-on-surface-color |The text/icon color on a surface color background | |onBackground |--theme-on-background-color |The text/icon color on a background color background | |onError |--theme-on-error-color |The text/icon color on an error color background | |onNotification |--theme-on-notification-color |The text/icon color on a notification color background | |textPrimary |--theme-text-primary-color |The color of primary text on (usually) surface backgrounds | |textSecondary |--theme-text-secondary-color |The color of secondary text on (usually) surface backgrounds | |textDisabled |--theme-text-disabled-color |The color of disabled text on (usually) surface backgrounds | |divider |--theme-divider-color |The color of dividers on (usually) surface backgrounds |

Predefined Themes

There's a couple of predefined themes in the themes.js modules. To use theme just import the theme(s) you want and register them (you can use whatever name you want to register the predefined themes).

import { themie, Theme } from 'themie/themie.js';
import { blueTeal, darkOrange } from 'themie/themes.js';

themie.register('blue-teal', blueTeal);
themie.register('dark-orange', darkOrange);

themie.apply('blue-teal');

These are the currently available predefined themes.

|Theme |Type |Description | |----------|---------------|-----------------------------------------------------------| |blueTeal |Material Design|A light theme with blue primary and teal secondary colors | |darkOrange|Material Design|A dark theme with brown primary and orange secondary colors|

These predefined themes are still a work in progress.