Skip to content

Commit

Permalink
Update documentation and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
moelders committed May 21, 2020
1 parent af736a6 commit 7f93faf
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 37 deletions.
60 changes: 27 additions & 33 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,32 @@
# 1.5.0

- Update `choices.js` to version `9.0.1`. Changes:
- `hiddenState` className is removed.
- `itemOption` className is replaced by `itemChoice` className.
- New `selectedState` className is added.
- `fusejs.io` updates from `2.7.4` to version `3.4.6`. Changes:
- New options added to `FuseOptions`:
- `includeMateches`,
- `includeScore`,
- `findAllMatches`,
- `sortFn`,
- and `getFn`.
- Changes on `IchoicesProps`:
- `addItemFilterFn` renamed to `addItemFilter`. It also allows `string` and `RegExp` types.
- `sortFn` renamed to `sorter`.
- Added `uniqueItemText`.
- Added `customAddItemText`.
- Added `valueComparer`.
- Removed `ajax` on `IChoicesMethods`.
- Update `@stencil/core` to version `1.12.7`.
- See: https://github.com/ionic-team/stencil/blob/master/CHANGELOG.md
- Update other dev dependencies:
- `@babel/plugin-syntax-dynamic-import` to version `7.8.3`.
- `@stencil/sass` to version `1.3.1`.
- `@types/jest` to version `25.2.1`.
- `choices.js` to version `9.0.1`.
- `jest` to version `25.5.2`.
- `jest-dot-reporter` to version `1.0.14`.
- `rimraf` to version `3.0.2`.
- `tslint` to version `6.1.2`.
- `typedoc` to version `0.17.6`.
- `workbox-build` to version `5.1.3`.
- `fsevents` to version `2.1.3`.
- Rename `utils.tsx` to `utils.ts`
- Updated `choices.js` to version `9.0.1`.
- [Release changes](https://github.com/jshjohnson/Choices/releases).
- Updated `@stencil/core` to version `1.12.7`.
- [CHANGELOG](https://github.com/ionic-team/stencil/blob/master/CHANGELOG.md).
- Updated demo application.
- Changed web component interface:
- `ClassNames`:
- Added `selectedState`.
- Removed `hiddenState`.
- Replaced `itemOption` with `itemChoice`.
- `FuseOptions` (`fusejs.io` updates from `2.7.4` to version `3.4.6`):
- Added options:
- `includeMatches`.
- `includeScore`.
- `findAllMatches`.
- `sortFn`.
- `getFn`.
- `IchoicesProps`:
- Added properties:
- `uniqueItemText`.
- `customAddItemText`.
- `valueComparer`.
- Replaced properties:
- `addItemFilterFn` with `addItemFilter` (it allows `string` and `RegExp` types).
- `sortFn` with `sorter`.
- `IChoicesMethods`:
- Removed `ajax` method.

# 1.4.0

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The library is based on [ChoicesJS][choicesjs], but it is not bundle along with
This dependency can be added to the bundle as external library, or it can just be added to the page via GitHub script:

```html
<script src="https://rawgit.com/jshjohnson/Choices/v7.0.0/public/assets/scripts/choices.js"></script>
<script src="https://cdn.jsdelivr.net/npm/choices.js@9.0.1/public/assets/scripts/choices.js"></script>
```

## Installation and running
Expand Down
6 changes: 3 additions & 3 deletions src/components/choicesjs-stencil/interfaces.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,16 @@ export type ClassNames = {
};

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

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

0 comments on commit 7f93faf

Please sign in to comment.