cloud-ui.vusion

- name: u-sidebar title: 侧边栏 icon: sidebar labels: - Navigation description: 通常用于页面左侧的导航栏。 attrs: - name: has-data-source title: 数据源配置 type: boolean sync: false model: false bindHide: true default: false group: 数据属性 brifeDoc: "" tooltipLink: "" toggleclear: - data-source - data-schema - text-field - to-field - icon-field - value-field - parent-field - link-type-field - target-field - name: data-source title: 数据源 type: Array<Item> | Function | object | DataSource description: 展示数据的输入源，可设置为集合类型变量（List<T>）或输出参数为集合类型的逻辑。 designer-value: "[{}, {}, {}]" group: 数据属性 brifeDoc: "" docDescription: 支持动态绑定集合类型变量（List\<T>）或输出参数为集合类型的逻辑 tooltipLink: "" dependency: - "has-data-source": true - name: data-schema title: 数据类型 type: schema description: 数据源返回的数据结构的类型，自动识别类型进行展示说明 group: 数据属性 compType: dataTypeSelect brifeDoc: "" docDescription: 该属性为只读状态，当数据源动态绑定集合List<T>后，会自动识别T的类型并进行展示 tooltipLink: "" dependency: - "has-data-source": true - name: text-field title: 文本字段 type: string default: text description: 集合的元素类型中，用于显示文本的属性名称 group: 数据属性 dependency: - "has-data-source": true - name: value-field title: 值字段 type: string default: value description: 集合的元素类型中，用于标识选中值的属性 group: 数据属性 dependency: - "has-data-source": true brifeDoc: "" docDescription: 集合的元素类型中，用于标识选中值的属性，支持自定义变更 tooltipLink: "" - name: icon-field title: 图标属性字段 type: string default: icon description: 集合的元素类型中，用于图标的属性名称 group: 数据属性 dependency: - "has-data-source": true - name: to-field title: 跳转链接字段 type: string default: to description: 集合的元素类型中，用于跳转链接的属性名称 group: 数据属性 dependency: - "has-data-source": true - name: parent-field title: 父级值字段 type: string default: "" description: 集合的元素类型中，用于标识父节点的属性 group: 数据属性 dependency: - "has-data-source": true brifeDoc: "" docDescription: 集合的元素类型中，用于标识父级字段的属性，支持自定义变更 tooltipLink: "" - name: router title: 使用路由 type: boolean default: true description: 是否根据 vue-router 来控制选择哪一项 toggleclear: - value group: 数据属性 brifeDoc: "" docDescription: 设置是否根据vue-router来控制选择哪一项，默认关闭。开启后当前所在的侧边栏项底部会有标识， tooltipLink: "" - name: value title: 选中值 type: any sync: true model: true description: 当前选中的值 dependency: - router: false group: 数据属性 brifeDoc: "" docDescription: 当前选择的值，值仅在不适用路由下支持编辑 tooltipLink: "" - name: collapsible title: 菜单项可折叠 type: boolean default: false description: 设置菜单项是否可以展开/折叠 group: 交互属性 brifeDoc: "" docDescription: 设置分组是否可折叠。 tooltipLink: "" - name: accordion title: 手风琴模式 type: boolean default: false description: 设置是否每次只展开一个 group: 交互属性 brifeDoc: "" docDescription: " 开启后每次仅会展开一个分组。" tooltipLink: "" dependency: - collapsible: true - name: expand-trigger title: 展开触发方式 type: string options: - value: click title: 整行点击均可触发 - value: click-expander title: 仅点击小箭头时触发 default: click description: 展开/折叠操作的触发方式 group: 交互属性 brifeDoc: "" docDescription: 支持整行点击均可触发和仅点击小箭头时触发两种方式 tooltipLink: "" dependency: - collapsible: true - name: enable-collapse title: 侧边栏可折叠 type: boolean default: false description: 设置侧边栏是否可以展开/折叠 group: 交互属性 brifeDoc: "" tooltipLink: "" - name: collapseMode title: 默认状态 type: string options: - value: fold title: 收起 - value: expand title: 展开 default: expand group: 交互属性 tooltipLink: "" description: 侧边栏是否折叠 dependency: - "enable-collapse": true - name: expand-icon title: 展开图标 type: icon default: expand description: 侧边栏展开图标 group: 交互属性 dependency: - "enable-collapse": true - name: fold-icon title: 折叠图标 type: icon default: fold description: 侧边栏折叠图标 group: 交互属性 dependency: - "enable-collapse": true - name: readonly title: 只读 type: boolean default: false description: 正常显示，但禁止选择/输入 group: 状态属性 brifeDoc: "" docDescription: 正常显示，但禁止选择或输入 tooltipLink: "" - name: disabled title: 禁用 type: boolean default: false description: 置灰显示，且禁止任何交互（焦点、点击、选择、输入等） group: 状态属性 brifeDoc: "" docDescription: 置灰显示，且禁止任何交互（焦点、点击、选择、输入等） tooltipLink: "" slots: - concept: Slot name: default description: 插入`<u-sidebar-item>`、`<u-sidebar-divider>`或`<u-sidebar-group>`子组件。 support: - name: u-sidebar-group title: 侧边栏分组 snippet: '<u-sidebar-group><template #title><u-text text="分组"></u-text></template><u-sidebar-item><u-text text="侧边栏项"></u-text></u-sidebar-item></u-sidebar-group>' - name: u-sidebar-item title: 侧边栏项 snippet: <u-sidebar-item><u-text text="侧边栏项"></u-text></u-sidebar-item> - name: u-sidebar-divider title: 分隔线 snippet: <u-sidebar-divider></u-sidebar-divider> events: - name: select title: 选择后 description: 选择某一项后触发。 params: - name: $event type: object description: 自定义事件对象 schema: $ref: "#/systemTypes/ChangeItemEvent" - name: $event.value type: any description: 改变后的值 - name: $event.oldValue type: any description: 旧的值 - name: $event.item type: object description: 选择项相关对象 - name: $event.oldItem type: object description: 旧的选择项相关对象 - name: $event.itemVM type: USidebarItem description: 选择项子组件 - name: $event.oldVM type: USidebarItem description: 旧的选择项子组件 - name: senderVM type: USidebar description: 发送事件实例 methods: - name: toggleAll description: 展开/折叠所有分组 params: - name: expanded type: boolean description: 展开/折叠 schema: $ref: "#/systemTypes/CollapseEvent" - name: u-sidebar-item title: 侧边栏项 attrs: - name: text title: 文本 type: string description: 文本内容 advanced: true - name: item title: 相关对象 type: object description: 相关对象。当选择此项时，抛出的事件会传递该对象，便于开发 advanced: true - name: to title: 路由链接 type: string, Location description: 需要 vue-router，与`<router-link>`的`to`属性相同。可以是一个字符串或者是描述目标位置的对象。 advanced: true - name: replace title: 替换 type: boolean default: false description: 需要 vue-router，与`<router-link>`的`replace`属性相同。如果为`true`，当点击时，会调用`router.replace()`而不是`router.push()`，于是导航后不会留下`history `记录。 advanced: true - name: exact title: 精确匹配 type: boolean default: false description: 需要 vue-router，与`<router-link>`的`exact`属性相同。是否与路由完全一致时才高亮显示。 advanced: true - name: value title: 值 type: any description: 用于标识此项的值 group: 数据属性 brifeDoc: "" docDescription: 用于标识此项的值 tooltipLink: "" - name: icon title: 图标 type: icon default: "" description: "" 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: 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: UNavbarItemMulti description: 发送事件实例 description: 侧边栏项 - name: u-sidebar-group title: 侧边栏分组 attrs: - name: title title: 标题 type: string description: 显示的标题 advanced: true - name: collapsible title: 可折叠 type: boolean default: false description: 设置是否可以展开/折叠 group: 交互属性 brifeDoc: "" docDescription: 设置分组是否可折叠 tooltipLink: "" - name: expanded title: 展开状态 type: boolean sync: true default: false description: 展开状态分为“True(展开)/False(折叠)”，默认为“展开” group: 状态属性 brifeDoc: "" docDescription: 设置分组的展开折叠状态。在某些场景下需要预置分组的展开或者折叠状态 tooltipLink: "" - name: disabled title: 禁用展开/折叠 type: boolean default: false description: 置灰显示，且禁止展开/折叠操作 group: 状态属性 brifeDoc: "" docDescription: 置灰显示，且禁止任何交互（焦点、点击、选择、输入等） tooltipLink: "" slots: - concept: Slot name: default description: 插入`<u-sidebar-item>`或`<u-sidebar-divider>`子组件。 support: - name: u-sidebar-group title: 侧边栏分组 snippet: '<u-sidebar-group><template #title><u-text text="分组"></u-text></template><u-sidebar-item><u-text text="侧边栏项"></u-text></u-sidebar-item></u-sidebar-group>' - name: u-sidebar-item title: 侧边栏项 snippet: <u-sidebar-item><u-text text="侧边栏项"></u-text></u-sidebar-item> - name: u-sidebar-divider title: 分隔线 snippet: <u-sidebar-divider></u-sidebar-divider> - name: title description: 自定义标题文本。 - name: extra description: 在右侧可以附加内容。 description: 侧边栏分组 - name: u-sidebar-divider title: 侧边栏分隔线 description: 侧边栏分隔线