FxTransfer 穿梭框

基础用法

数据通过 data 属性传入。数据需为对象数组，每个对象应包含：key（唯一标识）、label（显示文本）、disabled（是否禁用）。目标列内容与 v-model 绑定变量同步，该变量值为目标项 key 数组；初始化 v-model 即可预选目标项。

<template>
  <FxTransfer v-model="value" :data="data" />
</template>

<script setup lang="ts">
import { ref } from "vue"

interface Option {
  key: number
  label: string
  disabled: boolean
}

const generateData = (): Option[] => {
  const data: Option[] = []
  for (let i = 1; i <= 15; i++) {
    data.push({
      key: i,
      label: `选项 ${i}`,
      disabled: i % 4 === 0,
    })
  }
  return data
}

const data = ref<Option[]>(generateData())
const value = ref<number[]>([])
</script>

可搜索

可搜索过滤数据项。设置 filterable 为 true 开启过滤；默认按 label 包含匹配。也可通过 filter-method 自定义过滤逻辑——该方法接收搜索关键字与每个数据项，返回 true 即纳入结果。

<template>
  <FxTransfer
    v-model="value"
    filterable
    :filter-method="filterMethod"
    filter-placeholder="请输入拼音缩写"
    :data="data"
  />
</template>

<script setup lang="ts">
import { ref } from "vue"

interface Option {
  key: number
  label: string
  initial: string
}

const provinces = [
  "广东",
  "浙江",
  "江苏",
  "四川",
  "福建",
  "湖北",
  "山东",
]
const initials = ["GD", "ZJ", "JS", "SC", "FJ", "HB", "SD"]

const generateData = (): Option[] => {
  const data: Option[] = []
  provinces.forEach((label, index) => {
    data.push({ label, key: index, initial: initials[index] })
  })
  return data
}

const data = ref<Option[]>(generateData())
const value = ref<number[]>([])

const filterMethod = (query: string, item: Option) => {
  return item.initial.toLowerCase().includes(query.toLowerCase())
}
</script>

自定义

可自定义列标题、按钮文本、数据项渲染、列表头部勾选计数文本、列底部内容。分别用 titles、button-texts、render-content / 默认作用域插槽、format、left-footer / right-footer。left-default-checked 与 right-default-checked 可设置初始勾选项。

<template>
  <p class="demo-tip">使用 render-content 自定义数据项</p>
  <div class="demo-center">
    <FxTransfer
      v-model="leftValue"
      filterable
      :left-default-checked="[2, 3]"
      :right-default-checked="[1]"
      :render-content="renderFunc"
      :titles="['源列表', '目标列表']"
      :button-texts="['移到左边', '移到右边']"
      :format="{
        noChecked: '${total}',
        hasChecked: '${checked}/${total}',
      }"
      :data="data"
      @change="handleChange"
    >
      <template #left-footer>
        <FxBtn class="transfer-footer" size="small">操作</FxBtn>
      </template>
      <template #right-footer>
        <FxBtn class="transfer-footer" size="small">操作</FxBtn>
      </template>
    </FxTransfer>
  </div>

  <p class="demo-tip">使用作用域插槽自定义数据项</p>
  <div class="demo-center">
    <FxTransfer
      v-model="rightValue"
      filterable
      :left-default-checked="[2, 3]"
      :right-default-checked="[1]"
      :titles="['源列表', '目标列表']"
      :button-texts="['移到左边', '移到右边']"
      :format="{
        noChecked: '${total}',
        hasChecked: '${checked}/${total}',
      }"
      :data="data"
      @change="handleChange"
    >
      <template #default="{ option }">
        <span>{{ option.key }} - {{ option.label }}</span>
      </template>
      <template #left-footer>
        <FxBtn class="transfer-footer" size="small">操作</FxBtn>
      </template>
      <template #right-footer>
        <FxBtn class="transfer-footer" size="small">操作</FxBtn>
      </template>
    </FxTransfer>
  </div>
</template>

<script setup lang="ts">
import { h, ref } from "vue"

import type {
  TransferDataItem,
  TransferDirection,
  TransferKey,
} from "@fx/components"

interface Option {
  key: number
  label: string
  disabled: boolean
}

const generateData = (): Option[] => {
  const data: Option[] = []
  for (let i = 1; i <= 15; i++) {
    data.push({
      key: i,
      label: `选项 ${i}`,
      disabled: i % 4 === 0,
    })
  }
  return data
}

const data = ref(generateData())
const leftValue = ref<number[]>([1])
const rightValue = ref<number[]>([1])

const renderFunc = (_h: typeof h, option: TransferDataItem) =>
  h("span", null, option.label)

const handleChange = (
  value: TransferKey[],
  direction: TransferDirection,
  movedKeys: TransferKey[],
) => {
  console.log(value, direction, movedKeys)
}
</script>

<style scoped>
.demo-tip {
  text-align: center;
  margin: 0 0 20px;
}
.demo-center {
  text-align: center;
}
:deep(.transfer-footer) {
  margin-left: 15px;
  padding: 6px 5px;
}
</style>

自定义空态

可自定义列表为空、或过滤无匹配结果时的内容。通过 left-empty 与 right-empty 插槽分别定制两侧面板的空态。

<template>
  <FxTransfer v-model="value" :data="data">
    <template #left-empty>
      <FxEmpty :image-size="60" description="暂无数据" />
    </template>
    <template #right-empty>
      <FxEmpty :image-size="60" description="暂无数据" />
    </template>
  </FxTransfer>
</template>

<script setup lang="ts">
import { ref } from "vue"

interface Option {
  key: number
  label: string
  disabled: boolean
}

const generateData = (): Option[] => {
  const data: Option[] = []
  for (let i = 1; i <= 15; i++) {
    data.push({
      key: i,
      label: `选项 ${i}`,
      disabled: i % 4 === 0,
    })
  }
  return data
}

const data = ref<Option[]>(generateData())
const value = ref<number[]>([])
</script>

字段别名

默认情况下，穿梭框会在数据项中查找 key、label 与 disabled。若数据项字段名不同，可用 props 属性定义别名。

<template>
  <FxTransfer
    v-model="value"
    :props="{
      key: 'value',
      label: 'desc',
    }"
    :data="data"
  />
</template>

<script setup lang="ts">
import { ref } from "vue"

interface Option {
  value: number
  desc: string
  disabled: boolean
}

const generateData = (): Option[] => {
  const data: Option[] = []
  for (let i = 1; i <= 15; i++) {
    data.push({
      value: i,
      desc: `选项 ${i}`,
      disabled: i % 4 === 0,
    })
  }
  return data
}

const data = ref<Option[]>(generateData())
const value = ref<number[]>([])
</script>

虚拟滚动

数据量较大时可开启虚拟滚动提升性能。设置 virtual-scroll 为 true 开启，可用 item-size 自定义行高（默认 30px）。

<template>
  <FxTransfer v-model="value" :data="data" virtual-scroll :item-size="30" />
</template>

<script setup lang="ts">
import { ref } from "vue"

interface Option {
  key: number
  label: string
  disabled: boolean
}

const generateData = (): Option[] => {
  const data: Option[] = []
  for (let i = 1; i <= 2000; i++) {
    data.push({
      key: i,
      label: `选项 ${i}`,
      disabled: i % 4 === 0,
    })
  }
  return data
}

const data = ref<Option[]>(generateData())
const value = ref<number[]>([])
</script>

API

Attributes

属性	说明	类型	默认值
model-value (v-model)	绑定值	Array<string | number>	[]
data	数据源	Record<string, any>[]	[]
filterable	是否可过滤	boolean	false
filter-placeholder	过滤框占位文本	string	'请输入搜索内容'
filter-method	自定义过滤方法	(query: string, item: Record<string, any>) => boolean	—
target-order	目标列排序策略：original 保持源顺序 / push 追加底部 / unshift 插入顶部	'original' / 'push' / 'unshift'	original
titles	自定义列标题	[string, string]	['列表 1', '列表 2']
button-texts	自定义按钮文本	[string, string]	[]
render-content	自定义渲染函数	(h, option) => VNode | VNode[]	—
format	列表头部勾选状态文本格式	TransferFormat	{}
props	数据源字段别名	TransferPropsAlias	—
left-default-checked	左列初始勾选项 key 数组	Array<string | number>	[]
right-default-checked	右列初始勾选项 key 数组	Array<string | number>	[]
validate-event	是否在值变化时触发表单校验	boolean	true
virtual-scroll	是否开启虚拟滚动	boolean	false
item-size	虚拟滚动单项高度	number	30

Events

事件名	说明	类型
change	目标列变化时触发	(value: TransferKey[], direction: TransferDirection, movedKeys: TransferKey[]) => void
left-check-change	左列任一项勾选状态变化时触发	(value: TransferKey[], movedKeys?: TransferKey[]) => void
right-check-change	右列任一项勾选状态变化时触发	(value: TransferKey[], movedKeys?: TransferKey[]) => void

Slots

插槽名	说明	类型
default	自定义数据项内容	{ option: TransferDataItem }
left-footer	左列底部内容	—
right-footer	右列底部内容	—
left-empty	左列为空或过滤无匹配时的内容	—
right-empty	右列为空或过滤无匹配时的内容	—

Exposes

名称	说明	类型
clearQuery	清空某侧面板的过滤关键字	(which: TransferDirection) => void
leftPanel	左侧面板实例	Ref<FxTransferPanelInstance | undefined>
rightPanel	右侧面板实例	Ref<FxTransferPanelInstance | undefined>

Transfer Panel API

Transfer Panel Exposes

名称	说明	类型
query	当前过滤关键字	string

类型声明

展开声明

type TransferKey = string | number
type TransferDirection = "left" | "right"
type TransferDataItem = Record<string, any>

interface TransferFormat {
  noChecked?: string
  hasChecked?: string
}

interface TransferPropsAlias {
  label?: string
  key?: string
  disabled?: string
}