You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Fix documentation
* Add npm ignore file
* Add script to copy the example files
* Update stencil core
* Add logo and meta file
* Add function to process the static svg files in sass files
* Add travis configuration file
* Update travis to copy example after deployment
Copy file name to clipboardExpand all lines: README.md
+9-4Lines changed: 9 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,10 @@
1
-
# Choices Web Component
1
+

2
2
3
-
Select Web Component. It just wraps [Choices.js][choicesjs] library using StencilJS.
3
+
# ChoicesJS Web Component
4
+
5
+
Select Web Component. It just wraps [ChoicesJS][choicesjs] library using [StencilJS][stenciljs].
6
+
7
+
The demo is available at [**adidas.github.io/choicesjs-stencil**][demo].
4
8
5
9
The Select component allows a user to select from dropdowns, browser between multiple options, add tags to an input, etc...
6
10
@@ -10,7 +14,7 @@ It is written using [_Typescript_][typescript] with [_JSX_][jsx].
10
14
11
15
## Use cases
12
16
13
-
The purpose of this project is to create a simple Web Component wrapper from the [Choices.js][choicesjs] library.
17
+
The purpose of this project is to create a simple Web Component wrapper from the [ChoicesJS][choicesjs] library.
14
18
15
19
All the available use cases of the original library can be perform using this Web Component.
16
20
@@ -20,7 +24,7 @@ For more information read the [library documentation][choicesjs-documentation].
20
24
21
25
[NodeJS and NPM][node] are required to work with the repository.
22
26
23
-
The library is based on [Choices.js][choicesjs], but it is not bundle along with the wrapper. It has been defined as part of [`peerDependencies`][peer-dependencies], therefore it has to be included in your own `dependencies`.
27
+
The library is based on [ChoicesJS][choicesjs], but it is not bundle along with the wrapper. It has been defined as part of [`peerDependencies`][peer-dependencies], therefore it has to be included in your own `dependencies`.
24
28
25
29
This dependency can be added to the bundle as external library, or it can just be added to the page via CDN script:
26
30
@@ -204,6 +208,7 @@ For further information open the [adidas terms and conditions][terms-and-conditi
<spanclass="description" data-toggle="tooltip" data-placement="right" title="Classes added to HTML generated by Choices. By default classnames follow the BEM notation.">
524
+
<spanclass="description" data-toggle="tooltip" data-placement="right" title="Classes added to HTML generated by ChoicesJS. By default classnames follow the BEM notation.">
0 commit comments