# UToc 目录 - [示例](#示例) - [基本用法](#基本用法) - [value](#value) - [UToc API](#utoc-api) - [Props/Attrs](#propsattrs) - [Slots](#slots) - [Events](#events) - [UTocItem API](#utocitem-api) - [Props/Attrs](#propsattrs-2) - [Slots](#slots-2) - [Events](#events-2) **Navigation** 用于展示文档的目录 ## 示例 ### 基本用法 按照以下层级添加即可。 ``` html ``` #### 高级 ### value 将`router`属性设置为`false`，也可以用`value`控制选择项。 ``` vue ``` ``` html ``` ## UToc API ### Props/Attrs | Prop/Attr | Type | Options | Default | Description | | --------- | ---- | ------- | ------- | ----------- | | value.sync, v-model | any | | | 当前选中的值 | ### Slots #### (default) 插入``子组件。 ### Events #### @before-select 选择某一项前触发 | Param | Type | Description | | ----- | ---- | ----------- | | $event | object | 自定义事件对象 | | $event.value | any | 选择项的值 | | $event.oldValue | any | 旧的值 | | $event.item | object | 选择项相关对象 | | $event.itemVM | UTocItem | 选择项子组件 | | $event.preventDefault | Function | 阻止选择流程 | | senderVM | UToc | 发送事件实例 | #### @select 选择某一项时触发 | Param | Type | Description | | ----- | ---- | ----------- | | $event | object | 自定义事件对象 | | $event.value | any | 改变后的值 | | $event.oldValue | any | 旧的值 | | $event.item | object | 选择项相关对象 | | $event.oldItem | object | 旧的选择项相关对象 | | $event.itemVM | UTocItem | 选择项子组件 | | $event.oldVM | UTocItem | 旧的选择项子组件 | | senderVM | UToc | 发送事件实例 | ## UTocItem API ### Props/Attrs | Prop/Attr | Type | Options | Default | Description | | --------- | ---- | ------- | ------- | ----------- | | label | string | | | 集合的元素类型中，用于显示文本的属性名称 | | value | any | | | 集合的元素类型中，用于标识选中值的属性 | | item | object | | | 相关对象。当选择此项时，抛出的事件会传递该对象，便于开发 | | linkType | string | `[object Object]`
`[object Object]` | `'destination'` | | | hrefAndTo | string | | | | | target | string | `[object Object]`
`[object Object]`
`[object Object]`
`[object Object]` | `'_self'` | 链接跳转的打开方式，父级窗口和顶级窗口仅适用于iframe组件嵌套的情况，若不存在嵌套，则其打开方式同当前窗口。 | | disabled | boolean | | `false` | 置灰显示，且禁止任何交互（焦点、点击、选择、输入等） | ### Slots #### (default) 插入``子组件。 ### Events #### @click 点击此项时触发，与原生 click 事件不同的是，它只会在非只读和禁用的情况下触发。 | Param | Type | Description | | ----- | ---- | ----------- | | $event | MouseEvent | 鼠标事件对象 | | senderVM | UTocItem | 发送事件实例 |