Skip to content

Commit

Permalink
chore: build, release 2.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
adamberecz committed Dec 16, 2021
1 parent 2bfd793 commit e626c0c
Show file tree
Hide file tree
Showing 9 changed files with 98 additions and 40 deletions.
21 changes: 21 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
## v2.3.0

> `2021-12-16`
### 🎉 Feature
- **Deprecated:** `appendNewTag`, `createTag`, `addTagOn` props and `@tag` event.
- Added `appendNewOption`, `createOption`, `addOptionOn` props and `@option` event [#150](https://github.com/vueform/multiselect/issues/150).
- Added `selectAll` method [#172](https://github.com/vueform/multiselect/issues/172).
- The `trackBy` prop now defaults to `label` [#175](https://github.com/vueform/multiselect/issues/175).
- Replaces focus on search when an option is selected [#163](https://github.com/vueform/multiselect/issues/163).
- Added `<span>` wrapper for single label with `singleLabelText` class key [#157](https://github.com/vueform/multiselect/issues/157).

### 🐞 Bug Fixes
- Don't show spinner when not active [#156](https://github.com/vueform/multiselect/issues/156).
- TailwindCSS 3 compatibility issue fix [#176](https://github.com/vueform/multiselect/issues/176).
- Don't show caret when `showOptions` are disabled [#173](https://github.com/vueform/multiselect/issues/173).
- Resolved headless UI modal click issue [#148](https://github.com/vueform/multiselect/issues/148).
- Resolved TailwindCSS/form ring issue [#135](https://github.com/vueform/multiselect/issues/135).
- Made classes reactive [#126](https://github.com/vueform/multiselect/issues/126).
- The `addTagOn` prop uses `key` instead of `keyCode` internally [#125](https://github.com/vueform/multiselect/issues/125).

## v2.2.1

> `2021-11-23`
Expand Down
100 changes: 67 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,13 +89,43 @@ Learn more: [https://vueform.com](https://vueform.com)
* Custom slots
* Events
* CSS vars support
* Tailwind & utility class support
* **Tailwind** & utility class support
* Fully configurable
* CSP compilant

## Sections

* [Demo](#demo)
* [Installation](#installation)
* [Using with Vue 3](#using-with-vue-3)
* [Using with Vue 2](#using-with-vue-2)
* [Using with Nuxt.js](#using-with-nuxtjs)
* [Support](#support)
* [Configuration](#configuration)
* [Basic props](#basic-props)
* [Advanced props](#advanced-props)
* [API](#api)
* [Events](#events)
* [Slots](#slots)
* [Styling](#styling)
* [Styling with CSS vars](#styling-with-css-vars)
* [Styling with Tailwind CSS](#styling-with-tailwind-css)
* [Examples](#examples)
* [Single select](#single-select)
* [Multiselect with object options](#multiselect-with-object-options)
* [Multiselect with disabled options](#multiselect-with-disabled-options)
* [Multiselect with groups](#multiselect-with-groups)
* [Tags with search, create and array of objects options](#tags-with-search-create-and-array-of-objects-options)
* [Autocomplete with async options](#autocomplete-with-async-options)
* [Tags with async options](#tags-with-async-options)
* [Select with custom options slot](#select-with-custom-options-slot)
* [Multiselect with custom label slot](#multiselect-with-custom-label-slot)
* [Tags with custom tags slot](#tags-with-custom-tags-slot)
* [License](#license)

## Demo

Check out our <a href="https://jsfiddle.net/4q3oauy6/6/" target="_blank">demo</a>.
Check out our <a href="https://jsfiddle.net/xf0jzoct/" target="_blank">demo</a>.

## Installation

Expand Down Expand Up @@ -191,7 +221,9 @@ For more information on using `@nuxtjs/composition-api` read [their documentatio

Join our [Discord channel](https://discord.gg/WhX2nG6GTQ) or [open an issue](https://github.com/vueform/multiselect/issues).

## Basic props
## Configuration

### Basic props

| Name | Type | Default | Description |
| --- | --- | --- | --- |
Expand Down Expand Up @@ -327,7 +359,9 @@ mounted() {

> Note: we don't use camelCase because they are [normalized back to lowercase](https://github.com/vuejs/vue/issues/9449#issuecomment-461170017) when written in DOM.
## Styling with CSS vars
## Styling

### Styling with CSS vars

The following CSS variables can be used to customize multiselect when using `default.css`:

Expand Down Expand Up @@ -448,7 +482,7 @@ Or on an instance level:
}
```

## Styling with Tailwind CSS
### Styling with Tailwind CSS

To use `Multiselect` with Tailwind CSS first you need to add background images to `tailwind.config.js`:

Expand Down Expand Up @@ -489,12 +523,12 @@ Then you need to import `themes/tailwind.scss` to you main component:
// ...
</script>
<script lang="scss">
<style lang="scss">
@import 'path/to/node_modules/@vueform/multiselect/themes/tailwind.scss'
</script>
</style>
```

### Using `:classes` prop
#### Using `:classes` prop

Alternatively you can define class names directly by passing them to the `Multiselect` component via `classes` property. When using this approach you don't need to import `tailwind.scss`. Here's a default styling for Tailwind CSS (the same included in `tailwind.scss`):

Expand Down Expand Up @@ -579,15 +613,15 @@ In case you need to override the same type of utility you might use [@neojp/tail
/>
```

<a href="https://jsfiddle.net/4q3oauy6/6/" target="_blank">JSFiddle - Example #1</a>
<a href="https://jsfiddle.net/xf0jzoct/" target="_blank">JSFiddle - Example #1</a>

### Multiselect with object options

``` vue
<Multiselect
v-model="value"
mode="multiple"
:closeOnSelect="false"
:close-on-select="false"
:options="{
batman: 'Batman',
robin: 'Robin',
Expand All @@ -596,15 +630,15 @@ In case you need to override the same type of utility you might use [@neojp/tail
/>
```

<a href="https://jsfiddle.net/4q3oauy6/6/" target="_blank">JSFiddle - Example #2</a>
<a href="https://jsfiddle.net/xf0jzoct/" target="_blank">JSFiddle - Example #2</a>

### Multiselect with disabled options

``` vue
<Multiselect
v-model="value"
mode="multiple"
:closeOnSelect="false"
:close-on-select="false"
:options="[
{ value: 'batman', label: 'Batman' },
{ value: 'robin', label: 'Robin', disabled: true },
Expand All @@ -613,15 +647,15 @@ In case you need to override the same type of utility you might use [@neojp/tail
/>
```

<a href="https://jsfiddle.net/4q3oauy6/6/" target="_blank">JSFiddle - Example #3</a>
<a href="https://jsfiddle.net/xf0jzoct/" target="_blank">JSFiddle - Example #3</a>

### Multiselect with groups

``` vue
<Multiselect
v-model="value"
mode="multiple"
:closeOnSelect="false"
:close-on-select="false"
:groups="true"
:options="[
{
Expand All @@ -636,17 +670,17 @@ In case you need to override the same type of utility you might use [@neojp/tail
/>
```

<a href="https://jsfiddle.net/4q3oauy6/6/" target="_blank">JSFiddle - Example #4</a>
<a href="https://jsfiddle.net/xf0jzoct/" target="_blank">JSFiddle - Example #4</a>

### Tags with search, create and array of objects options

``` vue
<Multiselect
v-model="value"
mode="tags"
:closeOnSelect="false"
:close-on-select="false"
:searchable="true"
:createTag="true"
:create-option="true"
:options="[
{ value: 'batman', label: 'Batman' },
{ value: 'robin', label: 'Robin' },
Expand All @@ -655,17 +689,17 @@ In case you need to override the same type of utility you might use [@neojp/tail
/>
```

<a href="https://jsfiddle.net/4q3oauy6/6/" target="_blank">JSFiddle - Example #5</a>
<a href="https://jsfiddle.net/xf0jzoct/" target="_blank">JSFiddle - Example #5</a>

### Autocomplete with async options

``` vue
<Multiselect
v-model="value"
placeholder="Choose a programming language"
:filterResults="false"
:minChars="1"
:resolveOnLoad="false"
:filter-results="false"
:min-chars="1"
:resolve-on-load="false"
:delay="0"
:searchable="true"
:options="async function(query) {
Expand All @@ -674,7 +708,7 @@ In case you need to override the same type of utility you might use [@neojp/tail
/>
```

<a href="https://jsfiddle.net/4q3oauy6/6/" target="_blank">JSFiddle - Example #6</a>
<a href="https://jsfiddle.net/xf0jzoct/" target="_blank">JSFiddle - Example #6</a>

### Tags with async options

Expand All @@ -683,10 +717,10 @@ In case you need to override the same type of utility you might use [@neojp/tail
v-model="value"
mode="tags"
placeholder="Choose your stack"
:closeOnSelect="false"
:filterResults="false"
:minChars="1"
:resolveOnLoad="false"
:close-on-select="false"
:filter-results="false"
:min-chars="1"
:resolve-on-load="false"
:delay="0"
:searchable="true"
:options="async function(query) {
Expand All @@ -695,7 +729,7 @@ In case you need to override the same type of utility you might use [@neojp/tail
/>
```

<a href="https://jsfiddle.net/4q3oauy6/6/" target="_blank">JSFiddle - Example #7</a>
<a href="https://jsfiddle.net/xf0jzoct/" target="_blank">JSFiddle - Example #7</a>

### Select with custom options slot

Expand Down Expand Up @@ -723,7 +757,7 @@ In case you need to override the same type of utility you might use [@neojp/tail
```

<a href="https://jsfiddle.net/4q3oauy6/6/" target="_blank">JSFiddle - Example #8</a>
<a href="https://jsfiddle.net/xf0jzoct/" target="_blank">JSFiddle - Example #8</a>

### Multiselect with custom label slot

Expand All @@ -732,7 +766,7 @@ In case you need to override the same type of utility you might use [@neojp/tail
v-model="value"
mode="multiple"
placeholder="Select your characters"
:closeOnSelect="false"
:close-on-select="false"
:options="{
batman: 'Batman',
robin: 'Robin',
Expand All @@ -748,7 +782,7 @@ In case you need to override the same type of utility you might use [@neojp/tail
```

<a href="https://jsfiddle.net/4q3oauy6/6/" target="_blank">JSFiddle - Example #9</a>
<a href="https://jsfiddle.net/xf0jzoct/" target="_blank">JSFiddle - Example #9</a>

### Tags with custom tags slot

Expand All @@ -758,9 +792,9 @@ In case you need to override the same type of utility you might use [@neojp/tail
v-model="value"
mode="tags"
placeholder="Select employees"
trackBy="name"
track-by="name"
label="name"
:closeOnSelect="false"
:close-on-select="false"
:search="true"
:options="[
{ value: 'judy', name: 'Judy', image: 'https://randomuser.me/api/portraits/med/women/1.jpg' },
Expand Down Expand Up @@ -814,7 +848,7 @@ In case you need to override the same type of utility you might use [@neojp/tail
</style>
```

<a href="https://jsfiddle.net/4q3oauy6/6/" target="_blank">JSFiddle - Example #10</a>
<a href="https://jsfiddle.net/xf0jzoct/" target="_blank">JSFiddle - Example #10</a>

## License

Expand Down
2 changes: 1 addition & 1 deletion dist/multiselect.global.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/multiselect.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/multiselect.vue2.global.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/multiselect.vue2.js

Large diffs are not rendered by default.

5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@vueform/multiselect",
"version": "2.2.1",
"version": "2.3.0",
"private": false,
"description": "Vue 3 multiselect component with single select, multiselect and tagging options.",
"license": "MIT",
Expand All @@ -10,6 +10,9 @@
"module": "./dist/multiselect.js",
"unpkg": "./dist/multiselect.global.js",
"style": "./themes/default.css",
"exports": {
".": "./dist/multiselect.js"
},
"repository": {
"type": "git",
"url": "git+https://github.com/vueform/multiselect.git"
Expand Down
Loading

0 comments on commit e626c0c

Please sign in to comment.