# themy

> lite package to toggle themes

Latest version **1.0.3** (published 2020-08-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install themy
pnpm add themy
yarn add themy
bun add themy
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2020-08-11 |
| First published | 2020-08-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 19.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | hamid814 |
| Maintainers | hamid814 |
| Keywords | theme, css |

## Links

- npm: https://www.npmjs.com/package/themy
- Repository: https://github.com/hamid814/themy
- Homepage: https://github.com/hamid814/themy#readme
- Issues: https://github.com/hamid814/themy/issues
- npm.io page: https://npm.io/package/themy

## Alternatives

- [style-dictionary](https://npm.io/package/style-dictionary.md) — 2.0M weekly downloads
- [postcss-merge-idents](https://npm.io/package/postcss-merge-idents.md) — 1.7M weekly downloads
- [@fontsource/noto-sans](https://npm.io/package/@fontsource/noto-sans.md) — 93.0K weekly downloads
- [uglifycss](https://npm.io/package/uglifycss.md) — 71.6K weekly downloads
- [mat4-interpolate](https://npm.io/package/mat4-interpolate.md) — 23.3K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2020-08-11

## README

# Themy

Lightwaighy library to create, test and toggle themes and color palettes

## Installation

Use the [npm](https://npmjs.com) to install themy.

```bash
npm i themy
```

## Usage

#### import

```js
/* es6 */
import themy from 'themy';

/* es5 */
const themy = require('themy');
```

#### Create themes

```js
const coolTheme = {
  primary: '#f00',
  secondary: 'rgb(23, 176, 235)',
};

const awesomeTheme = {
  primary: '#66cc99',
  secondary: '#cc9966',
};
```

#### Initialize

```js
const themes = { coolTheme, awesomeTheme };

const theme = new themy(themes);

// Change theme
theme.setTheme('awesomeTheme');
```

#### Change the theme

```js
theme.setTheme('awesomeTheme');
```

#### Add a new theme

```js
const themeName = {
  primary: '#9c1de7',
  secodary: '#9c1de7',
};

theme.addTheme({ themeName });

// Set the theme as active theme
theme.setTheme('themeName');
```

#### Methods

```js
// get acitve theme
theme.getTheme(); // themeName

// get an array of themes
theme.getThemes(); // ['coolTheme', 'awesomeTheme', 'themeName']
```

#### Options

Create and add options like this:

```js
const options = {
  acitve: 'theme1', // Active theme at the start of app
  prefix: 'site', // Classname prefix for classes
  showPanel: true, // Wether show a box to change theme or not
  utils: true, // To add utility classes or not
};

// Then add options as second argument
const theme = new themy(themes, options);
```

Valid options:

| option name             | valid values        | description                                    | default     |
| ----------------------- | ------------------- | ---------------------------------------------- | ----------- |
| active                  | name of your themes | active theme at the start of app               | first theme |
| debug                   | boolean             | to show errors in the console                  | false       |
| utils                   | boolean             | add utility classes like: 'm-1' = margin: 1em  | false       |
| transition              | boolean or number   | add transition time to make color changes soft | 0.3 (s)     |
| showPanel               | boolean             | to show a panel of buttons to change tehemes   | false       |
| prefix                  | string              | any name to add before calssnames              | none        |
| shades                  | array of numbers    | you can choose just the shades you want        | [1-9]       |
| panelOptions            | object              | cofigure panel settings                        | {}          |
| panelOptions.position   | 'top-right' and ... | position of panel on the screen                | 'top-right' |
| panelOptions.background | string ( color )    | background color of panel on the screen        | '#ccc'      |
| panelOptions.direction  | 'row', 'column'     | direction of buttons in panel                  | 'column'    |

## Your HTML

You just need to add classes

```html
<div class="text-primary">Some text with primary color</div>

<div class="bg-primary">Some text with primary background</div>
```

### Add shades of colors

Descripition is not ready

### Table of classes

| classname           | example                            | description                 |
| ------------------- | ---------------------------------- | --------------------------- |
| text-primary        | `<div class='text-primary'>`       | text color primary          |
| text-primary-dark   | `<div class='text-primary-dark'>`  | 30% darker primary          |
| text-primary-light  | `<div class='text-primary-light'>` | 30% lighter primary         |
| text-primary-d(1-9) | `<div class='text-primary-d4'>`    | 40% darker primary          |
| text-primary-l(1-9) | `<div class='text-primary-l6'>`    | 60% lighter primary         |
| bg-primary          | `<div class='bg-primary'>`         | background color of primary |
| border-primary      | `<div class='border-primary'>`     | border color of primary     |

## Licens

MIT

---
_Source: https://npm.io/package/themy · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._