project init & fix ui

miniprogram_npm/tdesign-miniprogram/navbar/README.md

@@ -0,0 +1,73 @@
+---
+title: Navbar 导航栏
+description: 用于不同页面之间切换或者跳转，位于内容区的上方，系统状态栏的下方。
+spline: navigation
+isComponent: true
+---
+
+<span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20lines-97%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20functions-87%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20statements-95%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20branches-84%25-blue" /></span>
+## 引入
+
+全局引入，在 miniprogram 根目录下的`app.json`中配置，局部引入，在需要引入的页面或组件的`index.json`中配置。
+
+```json
+"usingComponents": {
+  "t-navbar": "tdesign-miniprogram/navbar/navbar",
+}
+```
+
+## 代码演示
+
+### 基础导航栏
+
+{{ base }}
+
+### 带返回导航栏
+
+{{ back }}
+
+### 带返回，主页按钮导航栏
+
+{{ back-home }}
+
+### 带搜索导航栏
+
+{{ search }}
+
+### 带图片导航栏
+
+{{ img }}
+
+### 标题左对齐
+
+{{ left-title }}
+
+### 自定义颜色
+
+{{ custom-color }}
+
+## API
+### Navbar Props
+
+名称 | 类型 | 默认值 | 说明 | 必传
+-- | -- | -- | -- | --
+animation | Boolean | true | 是否添加动画效果 | N
+capsule | Slot | - | 左侧胶囊区域 | N
+custom-style | String | - | `0.25.0`。自定义组件样式 | N
+delta | Number | 1 | 后退按钮后退层数，含义参考 [wx.navigateBack](https://developers.weixin.qq.com/miniprogram/dev/api/route/wx.navigateBack.html)，特殊的，传入 0 不会发生执行 wx.navigateBack | N
+external-classes | Array | - | 组件类名，分别用于设置组件外层元素、标题、左侧图标、首页图标、胶囊等元素类名。`['t-class', 't-class-title', 't-class-left-icon', 't-class-home-icon', 't-class-capsule']` | N
+fixed | Boolean | true | 是否固定在顶部 | N
+left | Slot | - | `0.26.0`。左侧内容区域 | N
+left-arrow | Boolean | false | `0.26.0`。是否展示左侧箭头 | N
+title | String / Slot | - | 页面标题 | N
+title-max-length | Number | - | 标题文字最大长度，超出的范围使用 `...` 表示 | N
+visible | Boolean | true | 是否显示 | N
+
+### Navbar Events
+
+名称 | 参数 | 描述
+-- | -- | --
+complete | \- | navigateBack 执行完成后触发（失败或成功均会触发）
+fail | \- | navigateBack 执行失败后触发
+go-back | \- | 点击左侧箭头时触发
+success | \- | navigateBack 执行成功后触发