cloud-ui.vusion/src/components/u-region-select.vue/api.yaml

Vusion Cloud UI

- name: u-region-select
  title: 地区选择
  icon: region-select
  labels:
    - Selector
  description: 该组件从 UCascader 继承，仅填充了中国的行政区数据，其他功能与 UCascader 相同。
  attrs:
    - name: join
      title: 连接符
      type: string
      options:
        - value: ","
          title: 以','连接
        - value: "|"
          title: 以'|'连接
        - value: " / "
          title: 以' / '连接
      default: " / "
      description: 将选中的值以选择的符号作为连接符，转为字符串格式,不可为空值
      advanced: true
    - name: converter
      title: 转换器
      type: string
      options:
        - value: name
          title: 地区名称
        - value: code
          title: 地区码
      description: 选择地区名称，返回：浙江省/杭州市/滨江区（不加空格）；选择地区码，返回：330108
    - name: data
      title: 数据源
      type: Array<{ text, value }>
      description: 支持动态绑定集合类型变量（List\<T>）或输出参数为集合类型的逻辑。
      group: 数据属性
      brifeDoc: ""
      docDescription: "- 支持动态绑定集合类型变量（List\\<T>）或输出参数为集合类型的逻辑。"
      tooltipLink: ""
    - name: value
      title: 值
      type: any
      sync: true
      model: true
      description: ""
      group: 数据属性
      brifeDoc: ""
      docDescription: 当前选择的值
      tooltipLink: ""
    - name: field
      title: 文本字段
      type: string
      default: text
      description: ""
      group: 数据属性
      brifeDoc: ""
      docDescription: 集合的元素类型中，用于显示文本的属性名称，支持自定义变更
      tooltipLink: ""
    - name: filterable
      title: 筛选
      type: boolean
      default: false
      description: 设置是否可以筛选，开启将会显示搜索框。
      group: 数据属性
      brifeDoc: ""
      docDescription: 开启后选择框可输入文本进行筛选
      tooltipLink: ""
    - name: placeholder
      title: 占位符
      type: string
      default: 请选择
      description: 为空时显示的占位符文本
      group: 主要属性
      brifeDoc: ""
      docDescription: 选择框无内容时的提示信息，支持自定义编辑，默认为请选择
      tooltipLink: ""
    - name: showFinalValue
      title: 只显示最后一项
      type: boolean
      default: false
      description: 定义是否显示完整的路径，ture时只显示最后一项
      group: 主要属性
      brifeDoc: ""
      docDescription: 控制选择地区项后输入框里展示的形式，开启时只展示最后一项目，未开启时展示所有项路径。默认关闭。
      tooltipLink: ""
    - name: autofocus
      title: 自动获取焦点
      type: boolean
      default: false
      description: 设置是否自动获取焦点
      designer-value: false
      group: 主要属性
      brifeDoc: ""
      docDescription: 控制是否在进入页面时聚焦到该组件
      tooltipLink: ""
    - name: trigger
      title: 触发方式
      type: string
      options:
        - value: click
          title: 点击
        - value: hover
          title: 悬浮
      default: click
      description: ""
      group: 交互属性
      brifeDoc: ""
      docDescription: 地区选择时下一层级的展开方式，可以点击展开或者鼠标悬浮时展开
      tooltipLink: ""
    - name: clearable
      title: 可清空
      type: boolean
      default: false
      description: 设置是否可以清空搜索框，开启后将在有内容时显示清除按钮。
      group: 交互属性
      brifeDoc: ""
      docDescription: 控制是否显示清除按钮，支持一键清除所选内容
      tooltipLink: ""
    - name: disabled
      title: 禁用
      type: boolean
      default: false
      description: 置灰显示，且禁止任何交互（焦点、点击、选择、输入等）
      group: 状态属性
      brifeDoc: ""
      docDescription: 置灰显示，且禁止任何交互（焦点、点击、选择、输入等）
      tooltipLink: ""
    - name: opened
      title: 弹出状态
      type: boolean
      default: false
      description: 弹出状态分为“True(弹出)/False(关闭)”，默认为“弹出”
      group: 状态属性
      brifeDoc: ""
      docDescription: 开启时加载下拉框时，下拉框自动弹出，默认关闭
      tooltipLink: ""
  events:
    - name: input
      title: 输入时
      description: 选择某一项时触发
      params:
        - name: $event
          type: any
          description: 选择项的值
          schema:
            $ref: "#/basicTypes/String"
        - name: senderVM
          type: UCascader
          description: 发送事件实例
    - name: select
      title: 选择后
      description: 选择某一项时触发
      params:
        - name: $event
          type: object
          description: 自定义事件对象
          schema:
            $ref: "#/systemTypes/CascadeCapsulesEvent"
        - name: $event.level
          type: number
          description: 选择的层级
        - name: $event.value
          type: any
          description: 改变后的值
        - name: $event.values
          type: Array
          description: 改变后每项值的数组
        - name: senderVM
          type: UCascader
          description: 发送事件实例
    - name: focus
      title: 获得焦点
      description: 获得焦点时触发。
      params:
        - name: $event
          type: FocusEvent
          description: 原生事件对象
          schema:
            $ref: "#/systemTypes/FocusEvent"
        - name: senderVM
          type: UInput
          description: 发送事件实例
    - name: blur
      title: 失去焦点
      description: 失去焦点时触发。
      params:
        - name: $event
          type: FocusEvent
          description: 原生事件对象
          schema:
            $ref: "#/systemTypes/FocusEvent"
        - name: senderVM
          type: UInput
          description: 发送事件实例
    - name: clear
      title: 清空后
      description: 清空后触发。
      params:
        - name: $event
          type: object
          description: 自定义事件对象
          schema:
            $ref: "#/systemTypes/ChangeEvent"
        - name: $event.value
          type: string
          description: 清空后的值
        - name: $event.oldValue
          type: string
          description: 旧的值
        - name: senderVM
          type: UInput
          description: 发送事件实例
  methods:
    - name: open
      description: 弹出实例。
      params: []
    - name: close
      description: 关闭实例。
      params: []
    - name: clear
      description: 清空输入框。
      params: []