Skip to content

Commit 677e4ca

Browse files
committed
chore: update docs
1 parent af8898d commit 677e4ca

File tree

11 files changed

+20
-28
lines changed

11 files changed

+20
-28
lines changed

docs/.vitepress/config.mjs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@ import { defineConfig } from 'vitepress';
22
import { componentPreview, containerPreview } from '@vitepress-demo-preview/plugin';
33

44
export default defineConfig({
5-
base: '/vue3-virtual-drag-list/',
5+
base: '/vue3-virtual-sortable/',
66
lang: 'en-US',
7-
title: 'vue3-virtual-drag-list',
7+
title: 'vue3-virtual-sortable',
88
description: 'A virtual scrolling list component that can be sorted by dragging',
99

1010
themeConfig: {
1111
search: {
1212
provider: 'local',
1313
},
1414

15-
socialLinks: [{ icon: 'github', link: 'https://github.com/mfuu/vue-virtual-drag-list' }],
15+
socialLinks: [{ icon: 'github', link: 'https://github.com/mfuu/vue3-virtual-sortable' }],
1616

1717
footer: {
1818
message: 'Released under the MIT License.',

docs/components/basic.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<template v-slot:item="{ record, index, dateKey }">
1010
<div class="list-item">
1111
<div class="item-title">
12-
<span class="index">#{{ index }}</span>
12+
<span class="index">#{{ record.index }}</span>
1313
<span class="handle">☰</span>
1414
</div>
1515
<p>{{ record.desc }}</p>

docs/components/group.vue

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<template v-slot:item="{ record, index, dateKey }">
1212
<div class="list-item">
1313
<div class="item-title">
14-
<span class="index"># {{ index }}-{{ record.name }}</span>
14+
<span class="index"># {{ record.index }}-{{ record.name }}</span>
1515
<span class="handle">☰</span>
1616
</div>
1717
</div>
@@ -29,7 +29,7 @@
2929
<template v-slot:item="{ record, index, dateKey }">
3030
<div class="list-item">
3131
<div class="item-title">
32-
<span class="index"># {{ index }}-{{ record.name }}</span>
32+
<span class="index"># {{ record.index }}-{{ record.name }}</span>
3333
<span class="handle">☰</span>
3434
</div>
3535
</div>

docs/components/horizontal.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<template v-slot:item="{ record, index, dateKey }">
1212
<div class="list-item">
1313
<div class="item-title">
14-
<span class="index">#{{ index }}</span>
14+
<span class="index">#{{ record.index }}</span>
1515
<span class="handle">☰</span>
1616
</div>
1717
<p>{{ record.desc }}</p>

docs/components/infinity.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<template v-slot:item="{ record, index, dateKey }">
1111
<div class="list-item">
1212
<div class="item-title">
13-
<span class="index">#{{ index }}</span>
13+
<span class="index">#{{ record.index }}</span>
1414
<span class="handle">☰</span>
1515
</div>
1616
<p>{{ record.desc }}</p>

docs/components/scroller.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<template v-slot:item="{ record, index, dateKey }">
1111
<div class="list-item">
1212
<div class="item-title">
13-
<span class="index">#{{ index }}</span>
13+
<span class="index">#{{ record.index }}</span>
1414
<span class="handle">☰</span>
1515
</div>
1616
<p>{{ record.desc }}</p>

docs/components/scrollto.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<template v-slot:item="{ record, index, dateKey }">
2121
<div class="list-item">
2222
<div class="item-title">
23-
<span class="index">#{{ index }}</span>
23+
<span class="index">#{{ record.index }}</span>
2424
<span class="handle">☰</span>
2525
</div>
2626
<p>{{ record.desc }}</p>

docs/components/table.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
<template v-slot:item="{ record, index, dateKey }">
2020
<tr>
2121
<td>
22-
<span class="index">#{{ index }}</span>
22+
<span class="index">#{{ record.index }}</span>
2323
<span class="handle">☰</span>
2424
</td>
2525
<td>{{ record.name }}</td>

docs/guide/install.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
::: code-group
66

77
```sh [npm]
8-
$ npm i vue-virtual-draglist@next
8+
$ npm i vue-virtual-sortable@next
99
```
1010

1111
```sh [yarn]
12-
$ yarn add vue-virtual-draglist@next
12+
$ yarn add vue-virtual-sortable@next
1313
```
1414

1515
:::
@@ -31,7 +31,7 @@ $ yarn add vue-virtual-draglist@next
3131
</template>
3232
3333
<script setup>
34-
import VirtualList from 'vue-virtual-draglist';
34+
import VirtualList from 'vue-virtual-sortable';
3535
import { ref } from 'vue';
3636
3737
const list = ref([{ id: 'a', text: 'a', id: 'b', text: 'b' }]);

docs/guide/props.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -130,20 +130,12 @@ Disables the sortable if set to true
130130

131131
## `draggable`
132132

133-
| **Type** | **Default** |
134-
| -------- | ------------------------ |
135-
| `String` | `.virtual-dnd-list-item` |
133+
| **Type** | **Default** |
134+
| -------- | --------------- |
135+
| `String` | `[role="item"]` |
136136

137137
Specifies which items inside the element should be draggable
138138

139-
## `itemClass`
140-
141-
| **Type** | **Default** |
142-
| -------- | ------------------------ |
143-
| `String` | `virtual-dnd-list-item` |
144-
145-
Default list item class
146-
147139
## `animation`
148140

149141
| **Type** | **Default** |

0 commit comments

Comments
 (0)