@celery/ui-components
Advanced tools
Comparing version
{ | ||
"name": "@celery/ui-components", | ||
"version": "2.0.0-11", | ||
"version": "2.0.0-12", | ||
"description": "Shared UI Components and Styles", | ||
@@ -5,0 +5,0 @@ "main": "components/index.less", |
@@ -6,27 +6,20 @@ UI Components | ||
## Config vs Index | ||
All components come with at least `config.less` and `index.less`. `config.less` includes all the configuration/variables and mixins. `index.less` actually defines the component rulesets or invokes mixins. If you do not want to include the default components, you can just include the config and use that to create your own components based on the variables and mixins. | ||
## Styleguide | ||
* `npm install` | ||
* `npm run build && npm run styleguide` | ||
* Open `styleguide/index.html` | ||
* Open `styleguide/index.html` in browser | ||
## Components | ||
## Usage | ||
* Border | ||
* Breakpoint | ||
* Button | ||
* Color | ||
* Grid | ||
* Input | ||
* Link | ||
* Logo | ||
* Radio | ||
* Select | ||
* Transition | ||
* Typography | ||
You must be an approved npm user for the `@celery` namespace/private modules. | ||
``` | ||
npm install @celery/ui-components | ||
``` | ||
### Config vs Index | ||
All components come with at least `config.less` and `index.less`. `config.less` includes all the configuration/variables and mixins. `index.less` actually defines the component rulesets or invokes mixins. If you do not want to include the default components, you can just include the config and use that to create your own components based on the variables and mixins. | ||
## Development | ||
@@ -43,5 +36,13 @@ | ||
Open the styleguide by opening `styleguide/index.html` in your browser. | ||
Don't forget to document things in the comments of the index files. Use [Styledown syntax](https://github.com/styledown/styledown/blob/master/docs/Documenting.md). | ||
## TODO | ||
* Livereload styles | ||
* Express server to serve styleguide | ||
* Migrate more components from other projects | ||
## License | ||
MIT |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
42758
2.27%42
5%47
2.17%