Skip to content

Commit 55fa11b

Browse files
committed
docs: fix some readme typos
1 parent febdc9c commit 55fa11b

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
We now have a fully working and official release including a [**Live demo**](https://ghiscoding.github.io/multiple-select-vanilla/) for all available options/methods. You can also take a look at the "[Used by](#used-by)" section below to see real world applications taking advantage of this library.
1111

1212
## Description
13-
Multiple-Select-Vanilla is a fork of the popular [Multiple-Select (jQuery)](https://github.com/wenzhixin/multiple-select) library (thanks to @wenzhixin for this great lib). This fork was based on its latest known version at the time, which was `v1.5.2`, but later updated to [`v1.6.0`](https://github.com/wenzhixin/multiple-select/releases/tag/1.6.0). The main difference from the original lib is that we dropped jQuery and we now use native code and this mean zero external dependency. We also added a few extra features which you can see in the section below ([Changes vs Original lib](#changes-vs-original-lib)).
13+
Multiple-Select-Vanilla is a fork of the popular [Multiple-Select (jQuery)](https://github.com/wenzhixin/multiple-select) library (thanks to @wenzhixin for this great lib). This fork was based on its latest known version at the time, which was `v1.5.2`, but later updated to [`v1.6.0`](https://github.com/wenzhixin/multiple-select/releases/tag/1.6.0). The main difference from the original lib is that we dropped jQuery and we now use native code and this mean zero external dependency. We also added a few extra features which you can see shown below ([Changes vs Original lib](#changes-vs-original-lib)).
1414

1515
This lib allows you to select multiple elements with checkboxes :).
1616

@@ -41,14 +41,14 @@ New Multiple-Select Options:
4141
- dropped jQuery requirement and replaced necessary code with browser native code.
4242
- written in TypeScript which also brings typings support
4343
- added new features:
44-
- `showOkButton` to add an "OK" button at the end of multiple select option list (see [demo](https://ghiscoding.github.io/multiple-select-vanilla/#/options25))
45-
- `autoAdjustDropHeight` will automatically adjust the drop (up/down) height with available space (see [demo](https://ghiscoding.github.io/multiple-select-vanilla/#/options30))
44+
- `showOkButton` to add an "OK" button at the end of the multiple select option list (see [demo](https://ghiscoding.github.io/multiple-select-vanilla/#/options25))
45+
- `autoAdjustDropHeight` will automatically adjust the drop (up/down) height by available space (see [demo](https://ghiscoding.github.io/multiple-select-vanilla/#/options30))
4646
- `autoAdjustDropPosition` will find best position (top/bottom) by its available space (see [demo](https://ghiscoding.github.io/multiple-select-vanilla/#/options29))
4747
- `autoAdjustDropWidthByTextSize` automatically set the drop width size from the widest list option width
48-
- `useSelectOptionLabel` will use the `<option label="">` (from select option value) that can be used to display shorter selected option values.
49-
- example: value "1,3" instead of "January,March" (see [demo](https://ghiscoding.github.io/multiple-select-vanilla/#/options31))
48+
- `useSelectOptionLabel` will use the `<option label="">` (from select option value) that can be used to display shorter text of selected options.
49+
- example: will show "1,3" instead of "January,March" (see [demo](https://ghiscoding.github.io/multiple-select-vanilla/#/options31))
5050
- `useSelectOptionLabelToHtml` similar to `useSelectOptionLabel` but also renders HTML.
51-
- `renderOptionLabelAsHtml` will render selected options as HTML (see [demo](https://ghiscoding.github.io/multiple-select-vanilla/#/options27))
51+
- `renderOptionLabelAsHtml` will render selected options as HTML code (see [demo](https://ghiscoding.github.io/multiple-select-vanilla/#/options27))
5252
- `sanitizer` can be used to sanitize HTML code and prevent XSS cross-site scripting attacks (see [demo](https://ghiscoding.github.io/multiple-select-vanilla/#/options32)).
5353
- `dataTest` will add a `data-test` attribute on the `.ms-parent` and `.ms-drop` divs for easier E2E testing
5454

@@ -83,8 +83,8 @@ If you wish to contribute to the project, please follow these steps:
8383
#### Pull Request Contribution
8484

8585
Before submitting a PR (pull request), please make sure that you followed these steps for your PR to succeed:
86-
1. make sure that you ran `pnpm install` already
86+
1. make sure that you already ran `pnpm install`
8787
2. run the Prettier code formatting npm script (or use step 3)
8888
- `pnpm run prettier:write`
89-
3. run a full Build (this will also run Prettier format)
89+
3. run a full Build (this will also run Prettier format, so you could skip step 2)
9090
- `pnpm run build`

0 commit comments

Comments
 (0)