Themer

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

npm install ca-ui-themer --save

Usage with CSS Modules

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 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 to do proper tagged commits.| |release|Uses semantic-release to trigger releases.|

How Can You Contribute

Your contributions are welcome and much appreciated. To learn more, see the Contribution Guidelines.

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