0.10.0 • Published 3 years ago
@webapp-suite/elements.checkbox v0.10.0
➤ Properties
| Property | Attribute | Type | Default | Description |
|---|---|---|---|---|
| name | name | String | '' | Name of checkbox |
| value | value | String | Value of checkbox | |
| dir | dir | String | ltr | Direction of the component 'rtl' or 'ltr' |
| label | data-label | String | Label of checkbox. To customize the label and have something more than simple string, use the slot, and remove this attribute | |
| checked | checked | Boolean | false | Status of checkbox |
| disabled | disabled | Boolean | false | disabled |
| readonly | readonly | Boolean | false | readonly, user can't change the value like disabled, but with different styling |
➤ Slots
| Name | Description |
|---|---|
| default | To customized checkbox label (links, ...). Remember you need to remove 'data-label' attribute. |
➤ How to use it
- Install the package of checkbox
$ npm i @webapp-suite/elements.checkbox --save- Import the component
import '@webapp-suite/elements.checkbox';or
<script src="node_modules/@webapp-suite/elements.checkbox/lib/checkbox.umd.js"></script>Use it like demo
Our components rely on having the
Open Sansavailable, You can see thefont-weightandfont-styleyou need to load here, or you can just load it from our package (for now)
<link rel="stylesheet" href="node_modules/@webapp-suite/elements/src/fonts.css" />➤ Polyfills
For supporting IE11 you need to add couple of things
- Don't shim CSS Custom Properties in IE11
<!-- Place this in the <head>, before the Web Component polyfills are loaded -->
<script>
if (!window.Promise) {
window.ShadyCSS = { nativeCss: true };
}
</script>You have two options for polyfills library:
- Installation
$ npm i @open-wc/polyfills-loader- Load it
import loadPolyfills from '@open-wc/polyfills-loader';
loadPolyfills().then(() => import('./my-app.js'));- Installation
$ npm i @webcomponents/webcomponentsjs --save- Enable ES5 class-less Custom Elements
<script src="/node_modules/@webcomponents/webcomponentsjs/custom-elements-es5-adapter.js"></script>- Load appropriate polyfills and shims with
@webcomponents/webcomponentsjs
<script src="/node_modules/@webcomponents/webcomponentsjs/webcomponents-loader.js" defer></script>➤ How to contribute
Thanks for your interest and help!
- First thing you need to do is read this [Component Checklist] which contains lots of important information about what you need to consider when you are creating/changing components
General info
You can find some links to useful materials about what we are using and some tutorials and articles that can help you get started.
➤ Polyfill Limitations
You can see a list of limitations that we should watch out for, here
➤ License
- You can always create forks on GitHub, submit Issues and Pull Requests.
- You can only use webapp-suite Elements to make apps on a webapp-suite platform, e.g. webapp-suite.com.
- You can fix a bug until the bugfix is deployed by webapp-suite.
- You can host webapp-suite Elements yourself.
- If you want to make a bigger change or just want to talk with us, reach out to our team here on GitHub.
You can read the full license agreement in the LICENSE.md.