SharpUI

Appearance

Select 选择器 ​

当选项过多时，使用下拉菜单展示并选择内容。

基础用法 ​

适用广泛的基础单选 v-model 的值为当前被选中的 option 的 value 属性值。

model-value: 1

<script setup>
import { ref } from 'vue'
import Select from '@/components/Select/Select.vue'
const test = ref('1')
const options2 = [
  { label: 'hello', value: '1' },
  { label: 'xyz', value: '2' },
  { label: 'testing', value: '3' },
  { label: 'check', value: '4', disabled: true }
]
</script>
<template>
  <Select v-model="test" placeholder="基础选择器，请选择" :options="options2" />
  <h4 class="text">model-value: {{test}}</h4>
</template>
<style scoped>
  .text {
    margin: 10px;
  }
</style>

可清空单选 ​

您可以使用清除图标来清除选择。

设置 clearable 属性，则可将选择器清空。

<script setup>
import { ref } from 'vue'
import Select from '@/components/Select/Select.vue'
const test = ref('1')
const options2 = [
  { label: 'hello', value: '1' },
  { label: 'xyz', value: '2' },
  { label: 'testing', value: '3' },
  { label: 'check', value: '4', disabled: true }
]
</script>
<template>
  <Select v-model="test" placeholder="可清空选择器，请选择" :options="options2" clearable />
</template>

自定义模板 ​

你可以自定义如何来渲染每一个选项, 使用 renderLabel 属性，它接受一个回调函数，返回 vNode 类型。

<script setup>
import { ref, h } from 'vue'
import Select from '@/components/Select/Select.vue'
const test = ref('')
const options2 = [
  { label: 'hello', value: '1' },
  { label: 'xyz', value: '2' },
  { label: 'testing', value: '3' },
  { label: 'check', value: '4', disabled: true }
]
const customRender = (option) => {
  return h('div', { className: 'xyz' }, [h('b', option.label), h('span', option.value)])
}
</script>
<template>
  <Select v-model="test" placeholder="基础选择器，请选择" :options="options2" :renderLabel="customRender"/>
</template>
<style>
.vk-select__menu-item, .xyz  {
  display: flex;
  align-items: center;
  justify-content: space-between;
  width: 100%;
}
</style>

筛选选项 ​

可以利用筛选功能快速查找选项。

添加 filterable 属性即可启用搜索功能。 默认情况下，Select 会找出所有 label 属性包含输入值的选项。 如果希望使用其他的搜索逻辑，可以通过传入一个 filter-method 来实现。 filter-method 为一个 Function，它会在输入值发生变化时调用，参数为当前输入值。

<script setup>
import { ref } from 'vue'
import Select from '@/components/Select/Select.vue'
const test = ref('')
const options2 = [
  { label: 'hello', value: '1' },
  { label: 'xyz', value: '2' },
  { label: 'testing', value: '3' },
  { label: 'check', value: '4', disabled: true }
]
</script>
<template>
  <Select 
    v-model="test" 
    placeholder="可以过滤的选择器，请输入" 
    :options="options2"
    filterable
  />
</template>

远程搜索 ​

输入关键字以从远程服务器中查找数据。

服务器搜索数据，输入关键字进行查找。为了启用远程搜索，需要将 filterable 和 remote 设置为true，同时传入一个remote-method。 remote-method 为一个返回 Promise 的Function，类型为 (value: string) => Promise<SelectOption[]> 。

<script setup>
import { ref } from 'vue'
import Select from '@/components/Select/Select.vue'
const test = ref('')
const states = [
  'Alabama',
  'Alaska',
  'Arizona',
  'Arkansas',
  'California',
  'Colorado',
  'Connecticut',
  'Delaware',
  'Florida',
  'Georgia',
  'Hawaii',
  'Idaho',
  'Illinois',
  'Indiana',
  'Iowa',
  'Kansas',
  'Kentucky',
  'Louisiana',
  'Maine',
  'Maryland',
  'Massachusetts',
  'Michigan',
  'Minnesota',
  'Mississippi',
  'Missouri',
  'Montana',
  'Nebraska',
  'Nevada',
  'New Hampshire',
  'New Jersey',
  'New Mexico',
  'New York',
  'North Carolina',
  'North Dakota',
  'Ohio',
  'Oklahoma',
  'Oregon',
  'Pennsylvania',
  'Rhode Island',
  'South Carolina',
  'South Dakota',
  'Tennessee',
  'Texas',
  'Utah',
  'Vermont',
  'Virginia',
  'Washington',
  'West Virginia',
  'Wisconsin',
  'Wyoming',
]

const remoteFilter = (query) => {
  return new Promise((resolve) => {
    if (query) {
      setTimeout(() => {
        const options = states.filter((item) => {
          return item.toLowerCase().includes(query.toLowerCase())
        }).map(label => {
          return { label, value: label }
        })
        resolve(options)
      }, 500)
    } else {
      resolve([])
    }
  })
}
const handleFetch = (query) => {
  if (!query) return Promise.resolve([])
  return fetch(`https://api.github.com/search/repositories?q=${query}`)
  .then(res => res.json())
  .then(( { items }) => {
    return items.slice(0, 10).map(item => ({ label: item.name, value: item.node_id }))
  })
}
</script>
<template>
  <Select 
    v-model="test" 
    placeholder="搜索远程结果"
    filterable
    remote
    :remote-method="remoteFilter"
  />
</template>

Select Attributes ​

参数说明类型可选值默认值
v-model绑定值string——
disabled是否禁用boolean—false
clearable是否可以清空选项boolean—false
filterable是否支持搜索boolean—false
multiple是否多选boolean—false
remote是否为远程搜索boolean—false
remote-method远程搜索的方法function——
placeholder占位符string—请选择
size输入框尺寸stringmedium/small/mini—
loading是否处于加载状态boolean—false
loading-text加载中的文字描述string—加载中...
no-match-text搜索条件无匹配时显示的文字，也可以使用slot="empty"设置string—无匹配数据
no-data-text选项为空时显示的文字，也可以使用slot="empty"设置string—无数据
popper-classSelect 下拉框的类名string——
popper-append-to-body是否将弹出框插入至 body 元素。在弹出框的定位出现问题时，可将该属性设置为 falseboolean—true
name原生 name 属性string——
autocomplete原生 autocomplete 属性string—off
auto-complete自动补全string—off
automatic-dropdown对于不可搜索的 Select，是否在输入框获得焦点后自动弹出选项菜单boolean—false
popper-options菜单配置，具体配置参考 popper.js 文档object——
reserve-keyword多选且可搜索时，是否在选中一个选项后保留当前的搜索关键词boolean—false
default-first-option在输入框按下回车，选择第一个匹配项。需配合 filterable 或 remote 使用boolean—false
popper-classSelect 下拉框的类名string——
debounce搜索关键词输入的去抖延迟，毫秒，默认 300number—300
filter-method自定义搜索方法function——
remote是否为远程搜索boolean—false
remote-method远程搜索的方法function——
loading-text远程加载时显示的文字string—加载中...
no-match-text远程搜索无匹配时显示的文字，也可以使用slot="empty"设置string—无匹配数据
popper-classSelect 下拉框的类名string——

Select Events ​

事件名称说明会调参数
change选中值发生变化时触发目前的选中值
visible-change下拉框出现/隐藏时触发出现则为 true，隐藏则为 false
remove-tag多选模式下，移除tag时触发移除的tag值
clear可清空的单选模式下用户点击清空按钮时触发—
blur当 input 失去焦点时触发(event: Event)
focus当 input 获得焦点时触发(event: Event)
click点击 Select 时触发(event: Event)

Released under the MIT License.

Copyright © 2024-present liuyunhe