https://github.com/nazar-pc/cleverstyle-widgets
Set of useful unstyled custom elements (Web Components) that work nicely with Shadow DOM
https://github.com/nazar-pc/cleverstyle-widgets
button clevertyle dialog dropdown form icon input label modal notification notify pagination polymer progress switcher tabs textarea tooltip webcomponents widgets
Last synced: about 2 months ago
JSON representation
Set of useful unstyled custom elements (Web Components) that work nicely with Shadow DOM
- Host: GitHub
- URL: https://github.com/nazar-pc/cleverstyle-widgets
- Owner: nazar-pc
- Created: 2018-03-03T12:21:46.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-22T15:28:09.000Z (over 7 years ago)
- Last Synced: 2025-03-15T15:18:06.270Z (7 months ago)
- Topics: button, clevertyle, dialog, dropdown, form, icon, input, label, modal, notification, notify, pagination, polymer, progress, switcher, tabs, textarea, tooltip, webcomponents, widgets
- Language: LiveScript
- Homepage:
- Size: 610 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# CleverStyle Widgets
CleverStyle Widgets is a set of useful unstyled custom elements (Web Components) that work nicely with Shadow DOM, ready for convenient data bindings and doesn't enforce any appearance by default (namely, almost no styling by default, just support for many [CSS mixins](https://www.polymer-project.org/2.0/docs/devguide/custom-css-properties#use-custom-css-mixins), so you can style them the way you need).
CleverStyle Widgets project was initially created as a part of [CleverStyle Framework](https://github.com/nazar-pc/CleverStyle-Framework)'s UI, but now available as a separate project for everyone to use.
There are no automated tests yet, if you can contribute some - definitely do so!
## How to install
```
npm install cleverstyle-widgets
```
## How to use
1. Include Polymer on your page (only Polymer 2.x is supported, legacy `window.Polymer` is used) alongside with WebComponents polyfill with Shady DOM/CSS support (`webcomponents-hi-sd-ce.js` in order to support all major modern browsers)
2. Include either `src/index.html` for using all components or pick relevant collection of separate components from `src` (make sure to include necessary bits from `src/csw-0-behaviors-and-mixins` too)
3. Look at [API](https://github.com/nazar-pc/CleverStyle-Widgets/blob/master/api.md) for available elements and functions, their options and usage examples
4. Configure appearance as you like using [CleverStyle](https://github.com/nazar-pc/CleverStyle-Framework/blob/master/themes/CleverStyle/html/widgets%20styling.html) and [DarkEnergy](https://github.com/nazar-pc/CleverStyle-Framework/blob/master/themes/DarkEnergy/html/widgets%20styling.html) themes as an example (you can find all of the mixins that are current supported in source code), see [screenshots](https://github.com/nazar-pc/CleverStyle-Widgets/tree/master/screenshots) for example of how components might look
## Contribution
Feel free to create issues and send pull requests (for big changes create an issue first and link it from the PR), they are highly appreciated!
When reading source code make sure to configure 1 tab to be 4 spaces (GitHub uses 8 by default), otherwise code might be hard to read.
## License
Free Public License 1.0.0 / Zero Clause BSD License
https://opensource.org/licenses/FPL-1.0.0
https://tldrlegal.com/license/bsd-0-clause-license