用于将查询参数同步到 url 的参数中,该组件基于 vue3 实现

Install

1npm install use-sync-query
2# or
3yarn add use-sync-query

use

HTML:

NOTE: el-input、el-select、el-date-picker 为 element-plus 组件库提供的组件，需自行安装或使用其他组件库

1<template>
2  <div class="main">
3    <el-input v-model="value1" />
4    <el-select v-model="value2">
5      <el-option
6        v-for="item in options"
7        :key="item.value"
8        :value="item.value"
9      >
10        {{ item.label }}
11      </el-option>
12    </el-select>
13    <el-date-picker
14      v-model="value3"
15      type="daterange"
16      value-format="YYYY-MM-DD"
17    />
18    <el-date-picker
19      v-model="value4"
20      type="daterange"
21      value-format="YYYY-MM-DD"
22    />
23    <div>重复参数：{{ value5.join(',') }}</div>
24  </div>
25</template>

JS:

1<script setup lang="tsx">
2  import useSyncQuery from 'use-sync-query'
3
4  const options = [
5    { label: 'label1', value: 1 },
6    { label: 'label2', value: 2 },
7    { label: 'label3', value: 3 }
8  ]
9
10  const [value1, value2, value3, value4, value5] = useSyncQuery([
11    { key: 'a', value: '123' },
12    {
13      key: 'b',
14      value: 2,
15      encode: ({ value }) => {
16        return { b: value ? String(value) : '' }
17      },
18      decode: ({ query }) => {
19        return query.b !== '' ? Number(query.b) : undefined
20      }
21    },
22    {
23      // 将 dateRange 在url中显示为: start=2023-01-01&end=2023-01-10
24      key: 'dateRange',
25      value: ['2023-01-01', '2023-01-10'],
26      encode: ({ value }) => {
27        const [start, end] = value ?? ['', '']
28        // 这里的参数（start、end）可以任意写，只要和其他的参数不重复即可，不一定要和 key 一致
29        return {
30          start,
31          end
32        }
33      },
34      decode: ({ query }) => {
35        // start, end 取决于 encode 函数的返回值中的 keys
36        const { start, end } = query
37        return [start ?? '', end ?? '']
38      }
39    },
40    {
41      // 将 date 在url中显示为: c=2023-01-11%2C2023-01-20
42      key: 'date',
43      value: ['2023-01-11', '2023-01-20'],
44      encode: ({ value }) => {
45        // 这里的参数（c）可以任意写，只要和其他的参数不重复即可，不一定要和 key 一致
46        // 但是如果只有 1 个参数的时候，建议和 key 保持一致
47        return { c: value?.join(',') ?? '' }
48      },
49      decode: ({ query }) => {
50        return (query.c as string).split(',')
51      }
52    },
53    {
54      key: 'd',
55      value: ['1', '2', '3']
56    }
57  ])
58</script>

参数说明

1interface IEncodeDecode {
2  // config 中的 key
3  key: string;
4  // 当前配置项对应的 value，url 参数的优先级高于 config 中设置的默认值
5  value: any;
6  // 所有的 query 字段
7  query: IQuery;
8}
9
10interface IUseSyncQuery {
11  // 关键字，如果没有指定 encode，key 将作为 url 中的参数名
12  key: string;
13  // 默认值
14  value?: any;
15  // 将 value 转换成 url 中的参数
16  decode?: (options: IEncodeDecode) => any;
17  // 将 ulr 中的参数转换成 value
18  encode?: (options: IEncodeDecode) => Record<string, string>;
19}
20
21export interface IOptions {
22  // 忽略空的参数，设置为true,空字符串对应的 key 将不会同步到 url
23  // 默认：true
24  ignoreWhiteSpace?: boolean;
25}
26
27const config: IUseSyncQuery[] = [这里是你的配置];
28const options: IOptions = { ignoreWhiteSpace: true };
29const [...res] = useSyncQuery(config, options);

如果指定了 encode 函数，那么该函数必须返回一个 Object 对象

变更日志

变更日志