# ca-ui-themer

> Framework agnostic utility to make generic JavaScript components themeable and extensible.

Latest version **2.3.0** (published 2017-04-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install ca-ui-themer
pnpm add ca-ui-themer
yarn add ca-ui-themer
bun add ca-ui-themer
```

## 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 | 2.3.0 |
| Published | 2017-04-13 |
| First published | 2017-01-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | CA Technologies |
| Maintainers | catechnologies |
| Keywords | JS, CSS, Themer |

## Links

- npm: https://www.npmjs.com/package/ca-ui-themer
- Repository: https://github.com/CAAPIM/themer
- Homepage: https://github.com/CAAPIM/themer#readme
- Issues: https://github.com/CAAPIM/themer/issues
- npm.io page: https://npm.io/package/ca-ui-themer

## Dependencies (2)

- [uuid](https://npm.io/package/uuid.md) ^3.0.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.4

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 2.3.0 (latest) — 2017-04-13
- 2.2.2 — 2017-04-07
- 2.2.1 — 2017-03-30
- 2.2.0 — 2017-03-14
- 2.1.2 — 2017-03-02
- 2.1.1 — 2017-03-01
- 2.1.0 — 2017-02-28
- 2.0.0 — 2017-02-27
- 1.1.1 — 2017-02-25
- 1.1.0 — 2017-02-06
- 1.0.0 — 2017-01-13

## README

# Themer

[![Greenkeeper badge](https://badges.greenkeeper.io/CAAPIM/themer.svg)](https://greenkeeper.io/)
[![Build Status](https://travis-ci.org/CAAPIM/themer.svg?branch=master)](https://travis-ci.org/CAAPIM/themer)
[![codecov](https://codecov.io/gh/CAAPIM/themer/branch/master/graph/badge.svg)](https://codecov.io/gh/CAAPIM/themer)
[![dependencies](https://david-dm.org/CAAPIM/themer.svg)](https://david-dm.org/CAAPIM/themer)
[![devDependency Status](https://david-dm.org/CAAPIM/themer/dev-status.svg)](https://david-dm.org/CAAPIM/themer#info=devDependencies)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

## Overview
Framework agnostic utility to make generic JavaScript components themeable and extensible.

This library defines a standard theme schema that developers can use to add styles to their components. Other developers will then be able to easily replace or extend the default component theme.

This library supports all class-based styling mechanisms, for example:
* Global CSS
* CSS Modules
* JSS
* CSJS
* Aphrodite

This library is meant to be used in all CA components.

## Installation

```js
npm install ca-ui-themer --save
```

## Usage with CSS Modules

```js
import themer from 'ca-ui-themer';
import theme from './styles.css'; // CSS Modules

const headerHtmlSnippet = ({ classes, content }) => `
  <div class="${classes.root}">
    <h1 class="${classes.title}">${content}</p>
  </div>
`;

export default themer(theme)(headerHtmlSnippet);
```

## Development

|`npm run <script>`|Description|
|------------------|-----------|
|`lint`| Runs eslint against all `.js` files in `./src` folder.|
|`test`|Runs [Mocha](https://github.com/mochajs/mocha) against all `./src/*.spec.js` files.|
|`test:watch`|Runs long running `test` command.|
|`test:coverage`|Runs `test` command and generates coverage report.|
|`deploy`|Runs `lint`, `test` commands.|
|`commit`|Uses [commitizen](https://github.com/commitizen/cz-cli) to do proper tagged commits.|
|`release`|Uses [semantic-release](https://github.com/semantic-release/semantic-release) to trigger releases.|

## How Can You Contribute
Your contributions are welcome and much appreciated. To learn more, see the [Contribution Guidelines](CONTRIBUTING.md).

This project supports `commitizen`. You can use `npm run commit` to run the local instance of `commitizen` or `git cz` if you have it installed globally.

Alternatively, if you are simply using `git commit`, you must follow this format:
`git commit -m "<type>: <subject>"`

## License
Copyright (c) 2017 CA. All rights reserved.
This software may be modified and distributed under the terms of the MIT license. To learn more, see the [License](LICENSE.md)

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