docs: prefer using ref (#9285)

* docs: prefer using ref

* docs: fix lint error
This commit is contained in:
neverland
2021-08-18 16:39:09 +08:00
committed by GitHub
parent 5adaeb704d
commit c3ad21791b
23 changed files with 577 additions and 621 deletions
+47 -47
View File
@@ -22,42 +22,42 @@ app.use(List);
```html
<van-list
v-model:loading="state.loading"
:finished="state.finished"
v-model:loading="loading"
:finished="finished"
finished-text="Finished"
@load="onLoad"
>
<van-cell v-for="item in state.list" :key="item" :title="item" />
<van-cell v-for="item in list" :key="item" :title="item" />
</van-list>
```
```js
import { reactive } from 'vue';
import { ref } from 'vue';
export default {
setup() {
const state = reactive({
list: [],
loading: false,
finished: false,
});
const list = ref([]);
const loading = ref(false);
const finished = ref(false);
const onLoad = () => {
setTimeout(() => {
for (let i = 0; i < 10; i++) {
state.list.push(state.list.length + 1);
list.value.push(list.value.length + 1);
}
state.loading = false;
loading.value = false;
if (state.list.length >= 40) {
state.finished = true;
if (list.value.length >= 40) {
finished.value = true;
}
}, 1000);
};
return {
state,
list,
onLoad,
loading,
finished,
};
},
};
@@ -67,35 +67,34 @@ export default {
```html
<van-list
v-model:loading="state.loading"
v-model:error="state.error"
v-model:loading="loading"
v-model:error="error"
error-text="Request failed. Click to reload"
@load="onLoad"
>
<van-cell v-for="item in state.list" :key="item" :title="item" />
<van-cell v-for="item in list" :key="item" :title="item" />
</van-list>
```
```js
import { reactive } from 'vue';
import { ref } from 'vue';
export default {
setup() {
const state = reactive({
list: [],
error: false,
loading: false,
});
const list = ref([]);
const error = ref(false);
const loading = ref(false);
const onLoad = () => {
fetchSomeThing().catch(() => {
state.error = true;
error.value = true;
});
};
return {
state,
list,
error,
onLoad,
loading,
};
},
};
@@ -104,58 +103,59 @@ export default {
### PullRefresh
```html
<van-pull-refresh v-model="state.refreshing" @refresh="onRefresh">
<van-pull-refresh v-model="refreshing" @refresh="onRefresh">
<van-list
v-model:loading="state.loading"
:finished="state.finished"
v-model:loading="loading"
:finished="finished"
finished-text="Finished"
@load="onLoad"
>
<van-cell v-for="item in state.list" :key="item" :title="item" />
<van-cell v-for="item in list" :key="item" :title="item" />
</van-list>
</van-pull-refresh>
```
```js
import { reactive } from 'vue';
import { ref } from 'vue';
export default {
setup() {
const state = reactive({
list: [],
loading: false,
finished: false,
refreshing: false,
});
const list = ref([]);
const loading = ref(false);
const finished = ref(false);
const refreshing = ref(false);
const onLoad = () => {
setTimeout(() => {
if (state.refreshing) {
state.list = [];
state.refreshing = false;
if (refreshing.value) {
list.value = [];
refreshing.value = false;
}
for (let i = 0; i < 10; i++) {
state.list.push(state.list.length + 1);
list.value.push(list.value.length + 1);
}
state.loading = false;
loading.value = false;
if (state.list.length >= 40) {
state.finished = true;
if (list.value.length >= 40) {
finished.value = true;
}
}, 1000);
};
const onRefresh = () => {
state.finished = false;
state.loading = true;
finished.value = false;
loading.value = true;
onLoad();
};
return {
state,
list,
onLoad,
loading,
finished,
onRefresh,
refreshing,
};
},
};
+47 -47
View File
@@ -24,47 +24,47 @@ List 组件通过 `loading` 和 `finished` 两个变量控制加载状态,当
```html
<van-list
v-model:loading="state.loading"
:finished="state.finished"
v-model:loading="loading"
:finished="finished"
finished-text="没有更多了"
@load="onLoad"
>
<van-cell v-for="item in state.list" :key="item" :title="item" />
<van-cell v-for="item in list" :key="item" :title="item" />
</van-list>
```
```js
import { reactive } from 'vue';
import { ref } from 'vue';
export default {
setup() {
const state = reactive({
list: [],
loading: false,
finished: false,
});
const list = ref([]);
const loading = ref(false);
const finished = ref(false);
const onLoad = () => {
// 异步更新数据
// setTimeout 仅做示例,真实场景中一般为 ajax 请求
setTimeout(() => {
for (let i = 0; i < 10; i++) {
state.list.push(state.list.length + 1);
list.value.push(list.value.length + 1);
}
// 加载状态结束
state.loading = false;
loading.value = false;
// 数据全部加载完成
if (state.list.length >= 40) {
state.finished = true;
if (list.value.length >= 40) {
finished.value = true;
}
}, 1000);
};
return {
state,
list,
onLoad,
loading,
finished,
};
},
};
@@ -76,35 +76,34 @@ export default {
```html
<van-list
v-model:loading="state.loading"
v-model:error="state.error"
v-model:loading="loading"
v-model:error="error"
error-text="请求失败,点击重新加载"
@load="onLoad"
>
<van-cell v-for="item in state.list" :key="item" :title="item" />
<van-cell v-for="item in list" :key="item" :title="item" />
</van-list>
```
```js
import { reactive } from 'vue';
import { ref } from 'vue';
export default {
setup() {
const state = reactive({
list: [],
error: false,
loading: false,
});
const list = ref([]);
const error = ref(false);
const loading = ref(false);
const onLoad = () => {
fetchSomeThing().catch(() => {
state.error = true;
error.value = true;
});
};
return {
state,
list,
error,
onLoad,
loading,
};
},
};
@@ -115,62 +114,63 @@ export default {
List 组件可以与 [PullRefresh](#/zh-CN/pull-refresh) 组件结合使用,实现下拉刷新的效果。
```html
<van-pull-refresh v-model="state.refreshing" @refresh="onRefresh">
<van-pull-refresh v-model="refreshing" @refresh="onRefresh">
<van-list
v-model:loading="state.loading"
:finished="state.finished"
v-model:loading="loading"
:finished="finished"
finished-text="没有更多了"
@load="onLoad"
>
<van-cell v-for="item in state.list" :key="item" :title="item" />
<van-cell v-for="item in list" :key="item" :title="item" />
</van-list>
</van-pull-refresh>
```
```js
import { reactive } from 'vue';
import { ref } from 'vue';
export default {
setup() {
const state = reactive({
list: [],
loading: false,
finished: false,
refreshing: false,
});
const list = ref([]);
const loading = ref(false);
const finished = ref(false);
const refreshing = ref(false);
const onLoad = () => {
setTimeout(() => {
if (state.refreshing) {
state.list = [];
state.refreshing = false;
if (refreshing.value) {
list.value = [];
refreshing.value = false;
}
for (let i = 0; i < 10; i++) {
state.list.push(state.list.length + 1);
list.value.push(list.value.length + 1);
}
state.loading = false;
loading.value = false;
if (state.list.length >= 40) {
state.finished = true;
if (list.value.length >= 40) {
finished.value = true;
}
}, 1000);
};
const onRefresh = () => {
// 清空列表数据
state.finished = false;
finished.value = false;
// 重新加载数据
// 将 loading 设置为 true,表示处于加载状态
state.loading = true;
loading.value = true;
onLoad();
};
return {
state,
list,
onLoad,
loading,
finished,
onRefresh,
refreshing,
};
},
};