project init & fix ui
This commit is contained in:
60
miniprogram_npm/tdesign-miniprogram/side-bar/README.md
Normal file
60
miniprogram_npm/tdesign-miniprogram/side-bar/README.md
Normal file
@@ -0,0 +1,60 @@
|
||||
---
|
||||
title: SideBar 侧边导航
|
||||
description: 用于内容分类后的展示切换。
|
||||
spline: navigation
|
||||
isComponent: true
|
||||
---
|
||||
|
||||
<div style="background: #ecf2fe; display: flex; align-items: center; line-height: 20px; padding: 14px 24px; border-radius: 3px; color: #555a65">
|
||||
<svg fill="none" viewBox="0 0 16 16" width="16px" height="16px" style="margin-right: 5px">
|
||||
<path fill="#0052d9" d="M8 15A7 7 0 108 1a7 7 0 000 14zM7.4 4h1.2v1.2H7.4V4zm.1 2.5h1V12h-1V6.5z" fillOpacity="0.9"></path>
|
||||
</svg>
|
||||
该组件于 0.25.0 版本上线,请留意版本。
|
||||
</div>
|
||||
|
||||
## 引入
|
||||
|
||||
全局引入,在 miniprogram 根目录下的`app.json`中配置,局部引入,在需要引入的页面或组件的`index.json`中配置。
|
||||
|
||||
```json
|
||||
{
|
||||
"usingComponents": {
|
||||
"t-side-bar": "tdesign-miniprogram/side-bar/side-bar",
|
||||
"t-side-bar-item": "tdesign-miniprogram/side-bar-item/side-bar-item",
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 代码演示
|
||||
|
||||
### 锚点用法
|
||||
|
||||
{{ base }}
|
||||
|
||||
### 切页用法
|
||||
|
||||
{{ switch }}
|
||||
|
||||
## API
|
||||
### SideBar Props
|
||||
|
||||
名称 | 类型 | 默认值 | 说明 | 必传
|
||||
-- | -- | -- | -- | --
|
||||
value | String / Number | - | 选项值 | N
|
||||
default-value | String / Number | undefined | 选项值。非受控属性 | N
|
||||
|
||||
### SideBar Events
|
||||
|
||||
名称 | 参数 | 描述
|
||||
-- | -- | --
|
||||
change | `(value: number \| string, label: string)` | 选项值发生变化时触发
|
||||
click | `(value: number \| string, label: string)` | 点击选项时触发
|
||||
|
||||
### SideBarItem Props
|
||||
|
||||
名称 | 类型 | 默认值 | 说明 | 必传
|
||||
-- | -- | -- | -- | --
|
||||
badge-props | Object | - | 透传至 Badge 组件 | N
|
||||
disabled | Boolean | false | 是否禁用 | N
|
||||
label | String | - | 展示的标签 | N
|
||||
value | String / Number | - | 当前选项的值 | N
|
||||
Reference in New Issue
Block a user