Skip to content

Commit 7f93faf

Browse files
committed
Update documentation and changelog
1 parent af736a6 commit 7f93faf

File tree

3 files changed

+31
-37
lines changed

3 files changed

+31
-37
lines changed

CHANGELOG.md

Lines changed: 27 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,32 @@
11
# 1.5.0
22

3-
- Update `choices.js` to version `9.0.1`. Changes:
4-
- `hiddenState` className is removed.
5-
- `itemOption` className is replaced by `itemChoice` className.
6-
- New `selectedState` className is added.
7-
- `fusejs.io` updates from `2.7.4` to version `3.4.6`. Changes:
8-
- New options added to `FuseOptions`:
9-
- `includeMateches`,
10-
- `includeScore`,
11-
- `findAllMatches`,
12-
- `sortFn`,
13-
- and `getFn`.
14-
- Changes on `IchoicesProps`:
15-
- `addItemFilterFn` renamed to `addItemFilter`. It also allows `string` and `RegExp` types.
16-
- `sortFn` renamed to `sorter`.
17-
- Added `uniqueItemText`.
18-
- Added `customAddItemText`.
19-
- Added `valueComparer`.
20-
- Removed `ajax` on `IChoicesMethods`.
21-
- Update `@stencil/core` to version `1.12.7`.
22-
- See: https://github.com/ionic-team/stencil/blob/master/CHANGELOG.md
23-
- Update other dev dependencies:
24-
- `@babel/plugin-syntax-dynamic-import` to version `7.8.3`.
25-
- `@stencil/sass` to version `1.3.1`.
26-
- `@types/jest` to version `25.2.1`.
27-
- `choices.js` to version `9.0.1`.
28-
- `jest` to version `25.5.2`.
29-
- `jest-dot-reporter` to version `1.0.14`.
30-
- `rimraf` to version `3.0.2`.
31-
- `tslint` to version `6.1.2`.
32-
- `typedoc` to version `0.17.6`.
33-
- `workbox-build` to version `5.1.3`.
34-
- `fsevents` to version `2.1.3`.
35-
- Rename `utils.tsx` to `utils.ts`
3+
- Updated `choices.js` to version `9.0.1`.
4+
- [Release changes](https://github.com/jshjohnson/Choices/releases).
5+
- Updated `@stencil/core` to version `1.12.7`.
6+
- [CHANGELOG](https://github.com/ionic-team/stencil/blob/master/CHANGELOG.md).
7+
- Updated demo application.
8+
- Changed web component interface:
9+
- `ClassNames`:
10+
- Added `selectedState`.
11+
- Removed `hiddenState`.
12+
- Replaced `itemOption` with `itemChoice`.
13+
- `FuseOptions` (`fusejs.io` updates from `2.7.4` to version `3.4.6`):
14+
- Added options:
15+
- `includeMatches`.
16+
- `includeScore`.
17+
- `findAllMatches`.
18+
- `sortFn`.
19+
- `getFn`.
20+
- `IchoicesProps`:
21+
- Added properties:
22+
- `uniqueItemText`.
23+
- `customAddItemText`.
24+
- `valueComparer`.
25+
- Replaced properties:
26+
- `addItemFilterFn` with `addItemFilter` (it allows `string` and `RegExp` types).
27+
- `sortFn` with `sorter`.
28+
- `IChoicesMethods`:
29+
- Removed `ajax` method.
3630

3731
# 1.4.0
3832

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The library is based on [ChoicesJS][choicesjs], but it is not bundle along with
2929
This dependency can be added to the bundle as external library, or it can just be added to the page via GitHub script:
3030

3131
```html
32-
<script src="https://rawgit.com/jshjohnson/Choices/v7.0.0/public/assets/scripts/choices.js"></script>
32+
<script src="https://cdn.jsdelivr.net/npm/[email protected]/public/assets/scripts/choices.js"></script>
3333
```
3434

3535
## Installation and running

src/components/choicesjs-stencil/interfaces.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,16 @@ export type ClassNames = {
3131
};
3232

3333
/**
34-
* @link https://github.com/krisk/Fuse/tree/v2.7.4#weighted-search
34+
* @link https://github.com/krisk/Fuse/blob/v3.6.1/src/typings.d.ts#L51
3535
*/
3636
export type WeightedField = {
3737
[key: string]: any;
3838
weight: number;
3939
};
4040

4141
/**
42-
* @version 3.4.6
43-
* @link https://fusejs.io/api/options.html#basic-options
42+
* @version 3.6.1
43+
* @link https://github.com/krisk/Fuse/blob/v3.6.1/src/typings.d.ts#L43
4444
*/
4545
export type FuseOptions = {
4646
id?: string;

0 commit comments

Comments
 (0)