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

Vusion Cloud UI

- name: u-crumb
  title: 面包屑
  labels:
    - Navigation
  description: 导航指引
  icon: crumb
  attrs:
    - name: auto
      title: 自动生成
      type: boolean
      default: false
      description: 是否自动根据子页面配置的面包屑属性自动生成
      group: 主要属性
      brifeDoc: ""
      docDescription: 支持控制面包屑生成方式。
      tooltipLink: ""
    - name: separator
      title: 样式类型
      type: string
      options:
        - value: arrow
          title: 基础样式
        - value: slash
          title: 分隔符样式
      default: arrow
      description: 设置面包屑分隔样式类型，基础样式为箭头，分隔符样式为斜杠
      group: 主要属性
      brifeDoc: ""
      docDescription: 支持控制面包屑样式，包含基础样式和分隔符样式。
      tooltipLink: ""
    - name: icon
      title: 显示面包屑图标
      type: boolean
      default: false
      description: ""
      group: 主要属性
      brifeDoc: ""
      docDescription: 支持控制面包屑选项图标显隐，开启后显示面包屑选项图标。
      tooltipLink: ""
  slots:
    - concept: Slot
      name: default
      description: 插入`<u-crumb-item>`子组件。
      support:
        - name: u-crumb-item
          title: 面包屑选项
          snippet: <u-crumb-item><u-text text="面包屑"></u-text></u-crumb-item>
- name: u-crumb-item
  title: 面包屑选项
  attrs:
    - name: text
      title: 文本
      type: string
      description: 文本内容
      advanced: true
    - name: replace
      title: 替换
      type: boolean
      default: false
      description: 需要
        vue-router，与`<router-link>`的`replace`属性相同。如果为`true`，当点击时，会调用`router.replace()`而不是`router.push()`，于是导航后不会留下`history
        `记录。
      advanced: true
    - name: append
      title: 追加路径
      type: boolean
      default: false
      description: 需要 vue-router，与`<router-link>`的`append`属性相同。如果为`true`，则在当前路径后追加`to`的路径。
      advanced: true
    - name: icon
      title: 图标
      type: icon
      description: ""
      group: 主要属性
      brifeDoc: ""
      docDescription: 支持从图标库选择或上传自定义图标。
      tooltipLink: ""
    - name: type
      title: 类型
      type: string
      options:
        - value: link
          title: 链接
        - value: text
          title: 显示为默认颜色文本，不可点
      default: link
      description: ""
      hidden: true
      group: 主要属性
      brifeDoc: ""
      docDescription: ""
      tooltipLink: ""
    - name: linkType
      title: 链接类型
      type: string
      options:
        - value: destination
          title: 页面跳转
        - value: download
          title: 下载链接
      default: destination
      description: ""
      compType: linkTypeSelect
      bindHide: true
      group: 交互属性
      brifeDoc: ""
      docDescription: 支持页面跳转、下载链接。
      tooltipLink: ""
    - name: hrefAndTo
      title: 链接地址
      type: string
      description: ""
      compType: linkHrefInput
      group: 交互属性
      brifeDoc: ""
      docDescription: 设置链接路径。
      tooltipLink: ""
    - name: target
      title: 链接打开方式
      type: string
      options:
        - value: _blank
          title: 新窗口
        - value: _self
          title: 当前窗口
        - value: _parent
          title: 父级窗口
          advanced: true
        - value: _top
          title: 顶级窗口
          advanced: true
      default: _self
      description: 链接打开后的展示方式，父级窗口和顶级窗口仅适用于iframe组件嵌套的情况，若不存在嵌套，则其打开方式同当前窗口。
      group: 交互属性
      brifeDoc: ""
      docDescription: 可选新窗口、当前窗口、父级窗口或顶级窗口，父级窗口和顶级窗口仅适用于iframe组件嵌套的情况，若不存在嵌套，则打开方式同当前窗口。
      tooltipLink: ""
    - name: disabled
      title: 禁用
      type: boolean
      default: false
      description: 置灰显示，且禁止任何交互（焦点、点击、选择、输入等）
      group: 状态属性
      brifeDoc: ""
      docDescription: 置灰显示，且禁止任何交互（焦点、点击、选择、输入等）。
      tooltipLink: ""
  events:
    - name: $listeners
      kind: trigger
      description: 监听所有`<a>`元素的事件。
      params:
        - name: $event
          type: object
          description: 自定义事件对象
      advanced: true
    - name: click
      title: 点击
      description: 点击链接时触发，与原生 click 事件不同的是，它只会在非禁用状态下触发。
      params:
        - name: $event
          type: MouseEvent
          description: 鼠标事件对象
          schema:
            $ref: "#/systemTypes/MouseEvent"
        - name: senderVM
          type: UCrumb
          description: 发送事件实例
    - name: before-navigate
      title: 导航前
      advanced: true
      description: 使用 router 相关属性切换路由前触发
      params:
        - name: $event
          type: object
          description: 自定义事件对象
          schema:
            $ref: "#/systemTypes/NavigateEvent"
        - name: $event.to
          type: string, Location
          description: "`to`属性的值"
        - name: $event.replace
          type: boolean
          description: "`replace`属性的值"
        - name: $event.append
          type: boolean
          description: "`append`属性的值"
        - name: $event.preventDefault
          type: Function
          description: 阻止切换流程
        - name: senderVM
          type: UCrumb
          description: 发送事件实例
    - name: navigate
      title: 导航
      advanced: true
      description: 使用router相关属性切换路由时触发
      params:
        - name: $event
          type: object
          description: 自定义事件对象
          schema:
            $ref: "#/systemTypes/NavigateEvent"
        - name: $event.to
          type: string, Location
          description: "`to`属性的值"
        - name: $event.replace
          type: boolean
          description: "`replace`属性的值"
        - name: $event.append
          type: boolean
          description: "`append`属性的值"
        - name: senderVM
          type: UCrumb
          description: 发送事件实例
  description: 面包屑选项