https://github.com/ElementUI/element-theme
Theme generator cli tool for Element.
https://github.com/ElementUI/element-theme
Last synced: 11 months ago
JSON representation
Theme generator cli tool for Element.
- Host: GitHub
- URL: https://github.com/ElementUI/element-theme
- Owner: ElementUI
- License: mit
- Created: 2016-11-01T10:09:24.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T09:16:14.000Z (over 3 years ago)
- Last Synced: 2025-03-29T02:38:59.439Z (12 months ago)
- Language: JavaScript
- Size: 221 KB
- Stars: 495
- Watchers: 20
- Forks: 141
- Open Issues: 63
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - ElementUI/element-theme - Theme generator cli tool for Element. (JavaScript)
README
# element-theme
[](https://travis-ci.org/ElementUI/element-theme)
[](https://www.npmjs.com/package/element-theme)
> Theme generator cli tool for Element.
> The current version is compatible with element-ui@2.x. For element-ui@1.x, please check out the legacy branch.
## Installation
install local or global
```shell
npm i element-theme -D
```
install `theme-chalk`
```shell
npm i element-theme-chalk -D
# or from github
npm i https://github.com/ElementUI/theme-chalk -D
```
## CLI
```shell
# init variables file
et --init [file path]
# watch then build
et --watch [--config variable file path] [--out theme path]
# build
et [--config variable file path] [--out theme path] [--minimize]
```
## Node API
```javascript
var et = require('element-theme')
// watch mode
et.watch({
config: 'variables/path',
out: 'output/path'
})
// build
et.run({
config: 'variables/path',
out: 'output/path',
minimize: true
})
```
## Options
### config
Variable file path, default `./element-variables.css`.
### out
Theme output path, default `./theme`.
### minimize
Compressed file.
### browsers
set browsers, default `['ie > 9', 'last 2 versions']`.
### watch
watch variable file changes then build.
### components
A lists of components that you want to generate themes for. All by default.
## Config
You can configure some options in `element-theme` by putting it in package.json:
```json
{
"element-theme": {
"browsers": ["ie > 9", "last 2 versions"],
"out": "./theme",
"config": "./element-variables.css",
"theme": "element-theme-chalk",
"minimize": false,
"components": ["button", "input"]
}
}
```
## License
MIT