Skip to content

Commit

Permalink
docs: update typo
Browse files Browse the repository at this point in the history
  • Loading branch information
credred committed Jan 16, 2022
1 parent 14acf92 commit f56173f
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ const options = [ "item1", "item2", "item3" ];
</script>
<template>
<drag-select v-model="selection" drag>
<drag-select v-model="selection">
<drag-select-option v-for="item in options" :value="item" :key="item">{{item}}</drag-select-option>
</drag-select>
</template>
Expand All @@ -50,8 +50,6 @@ const options = [ "item1", "item2", "item3" ];
background: #5fdddc;
}
</style>
</script>
```

## 📖Ducumentation
Expand All @@ -67,15 +65,15 @@ selectedOptionClass | the class names of selected DragSelectOption | string | --
selectedOptionStyle | the selected styles of selected DragSelectOption | string | --
<!-- disabled | whether DragSelect is disabled | boolean | false -->

### DragSelect Methods
<!-- ### DragSelect Methods
Method | Description | Parameters
-|-|-
selectAll | select all options | --
selectOptions | select certain options | Array<string \| index>
deselectOptions | deselect certain options | Array<string \| index>
toggleOptions | toggle select status of certain options | Array<string \| index>
clearSelection | clear current selection | --
reverseSelection | reverse current selection | --
reverseSelection | reverse current selection | -- -->

### DragSelectOption Attributes
Attribute | Description | Type | Default
Expand All @@ -91,6 +89,6 @@ name | Description
drag-select__wrapper | the className of DragSelect itself
drag-select | the className of the container of dragSelectOption
drag-select__area | the className of drag area
drag-select__option | the className of dragSelectOption component
drag-select__option--selected | the className of dragSelectOption component which are selected
drag-select__option--disabled | the className of dragSelectOption component which are disabled
drag-select-option | the className of dragSelectOption component
drag-select-option--selected | the className of dragSelectOption component which are selected
drag-select-option--disabled | the className of dragSelectOption component which are disabled
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@coleqiu/vue-drag-select",
"version": "2.0.1",
"description": "Drag select component for Vue.js",
"description": "Drag select component for Vue3",
"keywords": [
"vue",
"vue3",
Expand Down

0 comments on commit f56173f

Please sign in to comment.