@tuya-miniapp/smart-ui 2.13.2-beta-0 → 2.13.2-beta-2

package/dist/toast/README.md

@@ -0,0 +1,220 @@
+---
+category: 反馈
+---
+
+# Toast 轻提示
+
+### 介绍
+
+在页面中间弹出黑色半透明提示，用于消息通知、加载提示、操作结果提示等场景。
+
+### 引入
+
+在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](/material/smartui?comId=help-getting-started&appType=miniapp)。
+
+```json
+"usingComponents": {
+  "smart-toast": "@tuya-miniapp/smart-ui/lib/toast/index"
+}
+```
+
+## 代码演示
+
+### 文字提示
+
+```javascript
+import ToastInstance from '@tuya-miniapp/smart-ui/toast/toast';
+
+ToastInstance('我是提示文案，建议不超过十五字~');
+```
+
+```html
+<smart-toast id="smart-toast" />
+```
+
+### 加载提示
+
+使用 `ToastInstance.loading` 方法展示加载提示，通过 `forbidClick` 属性可以禁用背景点击，通过 `loadingType` 属性可以自定义加载图标类型。
+
+```javascript
+ToastInstance.loading({
+  message: '加载中...',
+  forbidClick: true,
+});
+
+// 自定义加载图标
+ToastInstance.loading({
+  message: '加载中...',
+  forbidClick: true,
+  loadingType: 'spinner',
+});
+```
+
+### 成功/失败提示
+
+```javascript
+ToastInstance.success('成功文案');
+ToastInstance.fail('失败文案');
+```
+
+
+### 警告提示
+
+```js
+ToastInstance.warn('警告文案');
+```
+
+### 动态更新提示
+
+```javascript
+const toast = ToastInstance.loading({
+  duration: 0, // 持续展示 toast
+  forbidClick: true,
+  message: '倒计时 3 秒',
+  selector: '#custom-selector',
+  width: 120,
+});
+
+let second = 3;
+const timer = setInterval(() => {
+  second--;
+  if (second) {
+    toast.setData({
+      message: `倒计时 ${second} 秒`,
+    });
+  } else {
+    clearInterval(timer);
+    ToastInstance.clear();
+  }
+}, 1000);
+```
+
+```html
+<smart-toast id="custom-selector" />
+```
+
+### OnClose 回调函数
+
+```javascript
+ToastInstance({
+  type: 'success',
+  message: '提交成功',
+  onClose: () => {
+    console.log('执行OnClose函数');
+  },
+});
+```
+
+### 自定义宽度
+
+通过 `width` 属性可以自定义弹窗宽度。
+
+```javascript
+ToastInstance.loading({
+  message: '加载中...',
+  forbidClick: true,
+  width: 200,
+});
+```
+
+### 位置设置
+
+通过 `position` 属性可以设置提示的位置，可选值为 `top`、`middle`、`bottom`。
+
+```javascript
+// 底部位置
+ToastInstance({
+  position: 'bottom',
+  message: '我是提示文案，建议不超过十五字~',
+});
+
+// 顶部位置
+ToastInstance({
+  position: 'top',
+  message: '我是提示文案，建议不超过十五字~',
+});
+```
+
+
+### 自定义颜色 `v2.8.0`
+
+通过 `textColor` 属性可以自定义文字颜色，通过 `iconColor` 属性可以自定义图标颜色。
+
+```javascript
+// 自定义文字颜色
+ToastInstance({
+  message: '我是提示文案，建议不超过十五字~',
+  textColor: '#1989FA',
+});
+
+// 自定义成功提示的颜色
+ToastInstance.success({
+  message: '成功文案',
+  textColor: '#1989FA',
+  iconColor: '#1989FA',
+});
+```
+
+## API
+
+### 方法
+
+| 方法名    | 参数   | 返回值     | 介绍   |
+| ---------- | ------------ | ---------- | --------- |
+| ToastInstance                     | `options \| message` | toast 实例 | 展示提示                        |
+| ToastInstance.clear               | `clearAll`           | `void`     | 关闭提示                        |
+| ToastInstance.fail                | `options \| message` | toast 实例 | 展示失败提示                    |
+| ToastInstance.loading             | `options \| message` | toast 实例 | 展示加载提示                    |
+| ToastInstance.resetDefaultOptions | -                    | `void`     | 重置默认配置，对所有 Toast 生效 |
+| ToastInstance.setDefaultOptions   | `options`            | `void`     | 修改默认配置，对所有 Toast 生效 |
+| ToastInstance.success             | `options \| message` | toast 实例 | 展示成功提示                    |
+
+### Options
+
+| 参数        | 说明               | 类型       | 默认值        |
+| ----------- | ------------------------ | ---------- | ------------- |
+| context     | 选择器的选择范围，可以传入自定义组件的 this 作为上下文          | _object_   | 当前页面      |
+| duration    | 展示时长(ms)，值为 0 时，toast 不会消失         | _number_   | `2000`        |
+| forbidClick | 是否禁止背景点击        | _boolean_  | `false`       |
+| loadingType | 加载图标类型, 可选值为 `spinner`     | _string_   | `circular`    |
+| mask        | 是否显示遮罩层             | _boolean_  | `false`       |
+| message     | 内容                   | _string_   | `''`          |
+| textColor `v2.8.0`   | 文字颜色               | _string_   | -             |
+| iconColor `v2.8.0`   | 图标颜色               | _string_   | `white`       |
+| onClose     | 关闭时的回调函数                  | _Function_ | -             |
+| position    | 位置，可选值为 `top` `middle` `bottom`       | _string_   | `middle`      |
+| selector    | 自定义选择器                  | _string_   | `#smart-toast` |
+| type        | 提示类型，可选值为 `loading` `success` `fail` `warn` `html` (`^v2.0.0`支持`warn`) | _string_   | `text`        |
+| zIndex      | z-index 层级                       | _number_   | `1000`        |
+| width `v2.1.7`     | 自定义弹窗宽度               | _number_   | `''`        |
+| nativeDisabled `v2.5.0`     | 开启弹框期间是否禁用本地手势       | _boolean_   | `false`        |
+
+### Slot
+
+| 名称 | 说明       |
+| ---- | ---------- |
+| -    | 自定义内容 |
+
+### 样式变量
+
+组件提供了下列 CSS 变量，可用于自定义样式，使用方法请参考 [ConfigProvider 组件](/material/smartui?comId=config-provider&appType=miniapp)。
+
+| 名称                          | 默认值                                 | 描述 |
+| ----------------------------- | -------------------------------------- | ---- |
+| --toast-text-min-width `v2.12.0` | _96px_ | 文字提示最小宽度 |
+| --toast-text-max-width `v2.12.0` | _280px_ | 文字提示最大宽度 |
+| --toast-min-width `v2.6.0` | _56px_ `v2.6.0` _82px_ `v2.12.0` | 图标提示最小宽度 |
+| --toast-max-width | _calc(100vw - 48px)_ `v2.0.0` _280px_ `v2.12.0` | 图标提示最大宽度 |
+| --toast-font-size | _14px_ | 提示字体大小 |
+| --toast-text-color | _#fff_ | 提示文本颜色 |
+| --toast-line-height | _20px_ `v2.0.0` _16px_ `v2.12.0` | 提示行高 |
+| --toast-background-color | _rgba(0,0,0,.7)_  `v2.0.0` _#5C5C5C_ `v2.12.0` | 提示背景颜色 |
+| --toast-border-radius | _12px_ | 提示圆角半径 |
+| --toast-border `v2.12.0` | _1px solid rgba(255, 255, 255, 0.05)_ | 提示边框 |
+| --toast-box-shadow `v2.12.0` | _0 4px 12px rgba(0, 0, 0, 0.1), 0 16px 32px rgba(0, 0, 0, 0.12)_ | 提示阴影 |
+| --toast-icon-size | _36px_ | 图标提示图标大小 |
+| --toast-text-padding | _14px 16px_ | 文字提示内边距 |
+| --toast-default-padding | _22px 14px 14px_ `v2.0.0` _19px 15px_ `v2.12.0` | 图标提示内边距 |
+| --toast-default-width `@deprecated v2.12.0` | _56px_ | 提示默认宽度（已废弃，请使用 --toast-min-width） |
+| --toast-default-min-height | _56px_ | 图标提示默认最小高度 |
+| --toast-icon-text-padding-top `v2.12.0` | _8px_ | 图标提示文字上间距 |

package/dist/transition/README.md

@@ -0,0 +1,114 @@
+---
+category: 展示
+---
+
+# Transition 动画
+
+### 介绍
+
+使元素从一种样式逐渐变化为另一种样式的效果。
+
+### 引入
+
+在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](/material/smartui?comId=help-getting-started&appType=miniapp)。
+
+```json
+"usingComponents": {
+  "smart-transition": "@tuya-miniapp/smart-ui/lib/transition/index"
+}
+```
+
+## 代码演示
+
+### 基础用法
+
+将元素包裹在 transition 组件内，在元素展示/隐藏时，会有相应的过渡动画。
+
+```html
+<smart-transition show="{{ show }}" custom-class="block">内容</smart-transition>
+```
+
+### 动画类型
+
+transition 组件内置了多种动画，可以通过`name`字段指定动画类型。
+
+```html
+<smart-transition name="fade-up" />
+```
+
+### 高级用法
+
+可以通过外部样式类自定义过渡效果，还可以定制进入和移出的持续时间。
+
+```html
+<smart-transition
+  show="{{ show }}"
+  name=""
+  duration="{{ { enter: 300, leave: 1000 } }}"
+  enter-class="smart-enter-class"
+  enter-active-class="smart-enter-active-class"
+  leave-active-class="smart-leave-active-class"
+  leave-to-class="smart-leave-to-class"
+/>
+```
+
+```css
+.smart-enter-active-class,
+.smart-leave-active-class {
+  transition-property: background-color, transform;
+}
+
+.smart-enter-class,
+.smart-leave-to-class {
+  background-color: red;
+  transform: rotate(-360deg) translate3d(-100%, -100%, 0);
+}
+```
+
+## API
+
+### Props
+
+| 参数         | 说明                 | 类型               | 默认值 |
+| ------------ | -------------------- | ------------------ | ------ |
+| custom-style | 自定义样式           | _string_           | -      |
+| duration     | 动画时长，单位为毫秒 | _number \| object_ | `300`  |
+| name         | 动画类型             | _string_           | `fade` |
+| show         | 是否展示组件         | _boolean_          | `true` |
+
+### Events
+
+| 事件名            | 说明       | 参数 |
+| ----------------- | ---------- | ---- |
+| bind:after-enter  | 进入后触发 | -    |
+| bind:after-leave  | 离开后触发 | -    |
+| bind:before-enter | 进入前触发 | -    |
+| bind:before-leave | 离开前触发 | -    |
+| bind:enter        | 进入中触发 | -    |
+| bind:leave        | 离开中触发 | -    |
+
+### 外部样式类
+
+| 类名               | 说明                                                                                                                                                                |
+| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| custom-class       | 根节点样式类                                                                                                                                                        |
+| enter-active-class | 定义进入过渡生效时的状态。在整个进入过渡的阶段中应用，在元素被插入之前生效，在过渡/动画完成之后移除。这个类可以被用来定义进入过渡的过程时间，延迟和曲线函数。       |
+| enter-class        | 定义进入过渡的开始状态。在元素被插入之前生效，在元素被插入之后的下一帧移除。                                                                                        |
+| enter-to-class     | 定义进入过渡的结束状态。在元素被插入之后下一帧生效 (与此同时 enter-class 被移除)，在过渡/动画完成之后移除。                                                         |
+| leave-active-class | 定义离开过渡生效时的状态。在整个离开过渡的阶段中应用，在离开过渡被触发时立刻生效，在过渡/动画完成之后移除。这个类可以被用来定义离开过渡的过程时间，延迟和曲线函数。 |
+| leave-class        | 定义离开过渡的开始状态。在离开过渡被触发时立刻生效，下一帧被移除。                                                                                                  |
+| leave-to-class     | 定义离开过渡的结束状态。在离开过渡被触发之后下一帧生效 (与此同时 leave-class 被删除)，在过渡/动画完成之后移除。                                                     |
+
+### 动画类型
+
+| 名称        | 说明     |
+| ----------- | -------- |
+| fade        | 淡入     |
+| fade-down   | 下滑淡入 |
+| fade-left   | 左滑淡入 |
+| fade-right  | 右滑淡入 |
+| fade-up     | 上滑淡入 |
+| slide-down  | 下滑进入 |
+| slide-left  | 左滑进入 |
+| slide-right | 右滑进入 |
+| slide-up    | 上滑进入 |

package/dist/tree-select/README.md

@@ -0,0 +1,199 @@
+---
+category: 数据录入
+---
+
+# TreeSelect 分类选择
+
+### 介绍
+
+用于从一组相关联的数据集合中进行选择。
+
+### 引入
+
+在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](/material/smartui?comId=help-getting-started&appType=miniapp)。
+
+```json
+"usingComponents": {
+  "smart-tree-select": "@tuya-miniapp/smart-ui/lib/tree-select/index"
+}
+```
+
+## 代码演示
+
+### 单选模式
+
+可以在任意位置上使用 smart-tree-select 标签。传入对应的数据即可。此组件支持单选或多选，具体行为完全基于事件 click-item 的实现逻辑如何为属性 active-id 赋值，当 active-id 为数组时即为多选状态。
+
+```html
+<smart-tree-select
+  items="{{ items }}"
+  main-active-index="{{ mainActiveIndex }}"
+  active-id="{{ activeId }}"
+  bind:click-nav="onClickNav"
+  bind:click-item="onClickItem"
+/>
+```
+
+```javascript
+Page({
+  data: {
+    mainActiveIndex: 0,
+    activeId: null,
+  },
+
+  onClickNav({ detail = {} }) {
+    this.setData({
+      mainActiveIndex: detail.index || 0,
+    });
+  },
+
+  onClickItem({ detail = {} }) {
+    const activeId = this.data.activeId === detail.id ? null : detail.id;
+
+    this.setData({ activeId });
+  },
+});
+```
+
+### 多选模式
+
+```html
+<smart-tree-select
+  items="{{ items }}"
+  main-active-index="{{ mainActiveIndex }}"
+  active-id="{{ activeId }}"
+  max="{{ max }}"
+  bind:click-nav="onClickNav"
+  bind:click-item="onClickItem"
+/>
+```
+
+```javascript
+Page({
+  data: {
+    mainActiveIndex: 0,
+    activeId: [],
+    max: 2,
+  },
+
+  onClickNav({ detail = {} }) {
+    this.setData({
+      mainActiveIndex: detail.index || 0,
+    });
+  },
+
+  onClickItem({ detail = {} }) {
+    const { activeId } = this.data;
+
+    const index = activeId.indexOf(detail.id);
+    if (index > -1) {
+      activeId.splice(index, 1);
+    } else {
+      activeId.push(detail.id);
+    }
+
+    this.setData({ activeId });
+  },
+});
+```
+
+### 自定义内容
+
+```html
+<smart-tree-select
+  items="{{ items }}"
+  height="55vw"
+  main-active-index="{{ mainActiveIndex }}"
+  active-id="{{ activeId }}"
+  bind:click-nav="onClickNav"
+  bind:click-item="onClickItem"
+>
+  <image src="https://static1.tuyacn.com/static/tuya-miniapp-doc/_next/static/images/logo-small.png" slot="content" />
+</smart-tree-select>
+```
+
+## API
+
+### Props
+
+| 参数              | 说明                          | 类型                        | 默认值      |
+| ----------------- | ----------------------------- | --------------------------- | ----------- |
+| active-id         | 右侧选中项的 id，支持传入数组 | _string \| number \| Array_ | `0`         |
+| height            | 高度，默认单位为`px`          | _number \| string_          | `300`       |
+| items             | 分类显示所需的数据            | _Array_                     | `[]`        |
+| main-active-index | 左侧选中项的索引              | _number_                    | `0`         |
+| max               | 右侧项最大选中个数            | _number_                    | _Infinity_  |
+| selected-icon     | 自定义右侧栏选中状态的图标    | _string_                    | `Checkmark` |
+
+### Events
+
+| 事件名          | 说明                             | 回调参数                               |
+| --------------- | -------------------------------- | -------------------------------------- |
+| bind:click-item | 右侧选择项被点击时，会触发的事件 | event.detail: 该点击项的数据           |
+| bind:click-nav  | 左侧导航点击时，触发的事件       | event.detail.index：被点击的导航的索引 |
+
+### Slots
+
+| 名称    | 说明                                             |
+| ------- | ------------------------------------------------ |
+| content | 自定义右侧区域内容，如果存在 items，则插入在顶部 |
+
+### items 数据结构
+
+`items` 整体为一个数组，数组内包含一系列描述分类的对象。每个分类里，text 表示当前分类的名称。options 表示分类里的可选项，为数组结构，id 被用来唯一标识每个选项。
+
+```javascript
+[
+  {
+    // 导航名称
+    text: '所有城市',
+    // 导航名称右上角徽标
+    badge: 3,
+    // 是否在导航名称右上角显示小红点
+    dot: true,
+    // 禁用选项
+    disabled: false,
+    // 该导航下所有的可选项
+    options: [
+      {
+        // 名称
+        text: '温州',
+        // id，作为匹配选中状态的标识
+        id: 1,
+        // 禁用选项
+        disabled: true,
+      },
+      {
+        text: '杭州',
+        id: 2,
+      },
+    ],
+  },
+];
+```
+
+### 外部样式类
+
+| 类名                   | 说明               |
+| ---------------------- | ------------------ |
+| content-active-class   | 右侧选项选中样式类 |
+| content-disabled-class | 右侧选项禁用样式类 |
+| content-item-class     | 右侧选项样式类     |
+| main-active-class      | 左侧选项选中样式类 |
+| main-disabled-class    | 左侧选项禁用样式类 |
+| main-item-class        | 左侧选项样式类     |
+
+### 样式变量
+
+组件提供了下列 CSS 变量，可用于自定义样式，使用方法请参考 [ConfigProvider 组件](/material/smartui?comId=config-provider&appType=miniapp)。
+
+| 名称                          | 默认值                                 | 描述 |
+| ----------------------------- | -------------------------------------- | ---- |
+| --tree-select-font-color      | _var(--app-B6-N1, rgba(0, 0, 0, 1))_   | 树形选择字体颜色        |
+| --tree-select-font-size       | _14px_                                 | 树形选择字体大小        |
+| --tree-select-nav-background-color | _var(--app-B3, #ffffff)_           | 树形选择导航背景颜色    |
+| --tree-select-content-background-color | _var(--app-B3, #ffffff)_       | 树形选择内容背景颜色    |
+| --tree-select-nav-item-padding | _@padding-sm @padding-xs @padding-sm @padding-sm_ | 树形选择导航项内边距 |
+| --tree-select-item-height     | _44px_                                 | 树形选择项高度          |
+| --tree-select-item-active-color | _#ee0a24_                             | 活动状态选择项颜色      |
+| --tree-select-item-disabled-color | _var(--app-B6-N4, rgba(0, 0, 0, 0.4))_ | 禁用状态选择项颜色  |