Skip to content

Commit e8bb332

Browse files
authored
Package publication and minor fixes (#1)
* 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
1 parent 3cc9f40 commit e8bb332

File tree

11 files changed

+369
-93
lines changed

11 files changed

+369
-93
lines changed

.meta.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
imageUrl: https://raw.githubusercontent.com/adidas/choicesjs-stencil/master/logo.png
2+
backgroundColor: '#eef5cc'
3+
keywords:
4+
- select
5+
- multiselect
6+
- choicesjs
7+
- stenciljs
8+
- webcomponent

.npmignore

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.idea
2+
.gitattributes
3+
.gitignore
4+
.stencil
5+
index.html
6+
jestconfig.json
7+
tsconfig.json
8+
tslint.json
9+
docs
10+
node_modules
11+
test

.travis.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
dist: trusty
2+
language: node_js
3+
node_js:
4+
- "10"
5+
6+
install:
7+
- npm install
8+
9+
script:
10+
- npm run lint
11+
- npm run build
12+
- npm run test
13+
14+
before_deploy:
15+
- npm run doc
16+
- npm run copy:example
17+
18+
deploy:
19+
- provider: npm
20+
skip_cleanup: true
21+
22+
api_key: $NPM_TOKEN
23+
on:
24+
branch: master
25+
- provider: pages
26+
skip-cleanup: true
27+
local-dir: ./example
28+
github-token: $GITHUB_TOKEN
29+
on:
30+
branch: master

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
# Choices Web Component
1+
![](./logo.png)
22

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].
48

59
The Select component allows a user to select from dropdowns, browser between multiple options, add tags to an input, etc...
610

@@ -10,7 +14,7 @@ It is written using [_Typescript_][typescript] with [_JSX_][jsx].
1014

1115
## Use cases
1216

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.
1418

1519
All the available use cases of the original library can be perform using this Web Component.
1620

@@ -20,7 +24,7 @@ For more information read the [library documentation][choicesjs-documentation].
2024

2125
[NodeJS and NPM][node] are required to work with the repository.
2226

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`.
2428

2529
This dependency can be added to the bundle as external library, or it can just be added to the page via CDN script:
2630

@@ -204,6 +208,7 @@ For further information open the [adidas terms and conditions][terms-and-conditi
204208

205209
[choicesjs]: https://github.com/jshjohnson/Choices
206210
[choicesjs-documentation]: https://github.com/jshjohnson/Choices/tree/master
211+
[demo]: https://adidas.github.io/choicesjs-stencil
207212
[jest]: https://jestjs.io/
208213
[jsx]: https://jsx.github.io/
209214
[peer-dependencies]: https://docs.npmjs.com/files/package.json#peerdependencies

index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -521,7 +521,7 @@ <h4 class="modal-title">Custom Styles</h4>
521521
<label for="classNames">
522522
Class names
523523
</label>
524-
<span class="description" data-toggle="tooltip" data-placement="right" title="Classes added to HTML generated by Choices. By default classnames follow the BEM notation.">
524+
<span class="description" data-toggle="tooltip" data-placement="right" title="Classes added to HTML generated by ChoicesJS. By default classnames follow the BEM notation.">
525525
<span class="glyphicon glyphicon glyphicon-question-sign"></span>
526526
</span>
527527
</div>

logo.png

23.6 KB
Loading

0 commit comments

Comments
 (0)