@ray-js/smart-ui 2.13.2-beta-0 → 2.13.2-beta-2

package/lib/tree-select/README.md

@@ -0,0 +1,348 @@
+---
+category: 数据录入
+assets: TreeSelection
+---
+
+
+# TreeSelect 分类选择
+
+### 介绍
+
+用于从一组相关联的数据集合中进行选择。
+
+### 引入
+
+```jsx
+import { TreeSelect } from '@ray-js/smart-ui';
+```
+
+## 代码演示
+
+### 单选模式
+
+可以在任意位置上使用 TreeSelect 组件。传入对应的数据即可。此组件支持单选或多选，具体行为完全基于事件 onClickItem 的实现逻辑如何为属性 activeId 赋值，当 activeId 为数组时即为多选状态。
+
+```jsx
+import { TreeSelect } from '@ray-js/smart-ui';
+import React, { useState, useMemo, useCallback } from 'react';
+
+const items = [
+  {
+    text: '浙江',
+    options: [
+      {
+        text: '杭州',
+        id: 1,
+      },
+      {
+        text: '温州',
+        id: 2,
+      },
+      {
+        text: '宁波',
+        id: 3,
+        disabled: true,
+      },
+      {
+        text: '义乌',
+        id: 4,
+      },
+    ],
+  },
+  {
+    text: '江苏',
+    options: [
+      [
+        {
+          text: '南京',
+          id: 5,
+        },
+        {
+          text: '无锡',
+          id: 6,
+        },
+        {
+          text: '徐州',
+          id: 7,
+        },
+        {
+          text: '苏州',
+          id: 8,
+        },
+      ],
+    ],
+  },
+  {
+    text: '福建',
+    disabled: true,
+    options: [
+      {
+        text: '泉州',
+        id: 9,
+      },
+    ],
+  },
+];
+
+export default function Demo() {
+  const [mainActiveIndex, setmainActiveIndex] = useState(0);
+  const [activeId, setactiveId] = useState(0);
+  const onClickNav = useCallback(({ detail }) => {
+    setmainActiveIndex(detail.index || 0);
+  }, []);
+
+  const onClickItem = useCallback(
+    ({ detail }) => {
+      const id = activeId === detail.id ? null : detail.id;
+      setactiveId(id);
+    },
+    [activeId]
+  );
+  return (
+    <TreeSelect
+      items={items}
+      mainActiveIndex={mainActiveIndex}
+      activeId={activeId}
+      onClickItem={onClickItem}
+      onClickNav={onClickNav}
+    />
+  );
+}
+```
+
+### 多选模式
+
+```jsx
+import { TreeSelect } from '@ray-js/smart-ui';
+import React, { useState, useMemo, useCallback } from 'react';
+
+const items = [
+  {
+    text: '浙江',
+    options: [
+      {
+        text: '杭州',
+        id: 1,
+      },
+      {
+        text: '温州',
+        id: 2,
+      },
+      {
+        text: '宁波',
+        id: 3,
+        disabled: true,
+      },
+      {
+        text: '义乌',
+        id: 4,
+      },
+    ],
+  },
+  {
+    text: '江苏',
+    options: [
+      [
+        {
+          text: '南京',
+          id: 5,
+        },
+        {
+          text: '无锡',
+          id: 6,
+        },
+        {
+          text: '徐州',
+          id: 7,
+        },
+        {
+          text: '苏州',
+          id: 8,
+        },
+      ],
+    ],
+  },
+  {
+    text: '福建',
+    disabled: true,
+    options: [
+      {
+        text: '泉州',
+        id: 9,
+      },
+    ],
+  },
+];
+
+export default function Demo() {
+  const [mainActiveIndex, setmainActiveIndex] = useState(0);
+  const [activeId, setactiveId] = useState([]);
+  const onClickNav = useCallback(({ detail }) => {
+    setmainActiveIndex(detail.index || 0);
+  }, []);
+
+  const onClickItem = useCallback(
+    ({ detail }) => {
+      const result = [...activeIdMulti];
+      const idx = result.indexOf(detail.id);
+      if (idx > -1) {
+        result.splice(idx, 1);
+      } else {
+        result.push(detail.id);
+      }
+
+      setactiveId(result);
+    },
+    [activeId]
+  );
+  return (
+    <TreeSelect
+      items={items}
+      max={2}
+      mainActiveIndex={mainActiveIndex}
+      activeId={activeId}
+      onClickItem={onClickItem}
+      onClickNav={onClickNav}
+    />
+  );
+}
+```
+
+### 自定义内容
+
+```jsx
+import { TreeSelect, Image } from '@ray-js/smart-ui';
+import React, { useState, useMemo, useCallback } from 'react';
+
+export default function Demo() {
+  const [mainActiveIndex, setmainActiveIndex] = useState(0);
+  const [activeId, setactiveId] = useState([]);
+  const onClickNav = useCallback(({ detail }) => {
+    setmainActiveIndex(detail.index || 0);
+  }, []);
+
+  const onClickItem = useCallback(
+    ({ detail }) => {
+      const result = [...activeIdMulti];
+      const idx = result.indexOf(detail.id);
+      if (idx > -1) {
+        result.splice(idx, 1);
+      } else {
+        result.push(detail.id);
+      }
+
+      setactiveId(result);
+    },
+    [activeId]
+  );
+  return (
+    <TreeSelect
+      items={[{ text: '分组 1' }, { text: '分组 2' }]}
+      height="55vw"
+      mainActiveIndex={mainActiveIndex}
+      activeId={activeId}
+      onClickItem={onClickItem}
+      onClickNav={onClickNav}
+      slot={{
+        content: (
+          <Image
+            src={
+              mainActiveIndex === 0
+                ? 'https://static1.tuyacn.com/static/tuya-miniapp-doc/_next/static/images/logo.png'
+                : 'https://static1.tuyacn.com/static/tuya-miniapp-doc/_next/static/images/logo.png'
+            }
+            width="100%"
+            height="100%"
+          />
+        ),
+      }}
+    />
+  );
+}
+```
+
+## API
+
+### Props
+
+| 参数              | 说明                          | 类型                        | 默认值      |
+| ----------------- | ----------------------------- | --------------------------- | ----------- |
+| activeId | 右侧选中项的 id，支持传入数组 | _string \| number \| Array_ | `0` |
+| height | 高度，默认单位为`px` | _number \| string_ | `300` |
+| items | 分类显示所需的数据 | _Array_ | `[]` |
+| mainActiveIndex | 左侧选中项的索引 | _number_ | `0` |
+| max | 右侧项最大选中个数 | _number_ | _Infinity_ |
+| selectedIcon | 自定义右侧栏选中状态的图标 | _string_ | `Checkmark` |
+
+### Events
+
+| 事件名          | 说明                             | 回调参数                               |
+| --------------- | -------------------------------- | -------------------------------------- |
+| onClickItem | 右侧选择项被点击时，会触发的事件 | event.detail: 该点击项的数据 |
+| onClickNav | 左侧导航点击时，触发的事件 | 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,
+      },
+    ],
+  },
+];
+```
+
+### 外部样式类
+
+| 类名                   | 说明               |
+| ---------------------- | ------------------ |
+| contentActiveClass | 右侧选项选中样式类 |
+| contentDisabledClass | 右侧选项禁用样式类 |
+| contentItemClass | 右侧选项样式类 |
+| mainActiveClass | 左侧选项选中样式类 |
+| mainDisabledClass | 左侧选项禁用样式类 |
+| mainItemClass | 左侧选项样式类 |
+
+### 样式变量
+
+组件提供了下列 CSS 变量，可用于自定义样式，使用方法请参考 [ConfigProvider 组件](/material/smartui?comId=config-provider)。
+
+| 名称                          | 默认值                                 | 描述 |
+| ----------------------------- | -------------------------------------- | ---- |
+| --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))_ | 禁用状态选择项颜色  |

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@ray-js/smart-ui",
-  "version": "2.13.2-beta-0",
+  "version": "2.13.2-beta-2",
   "description": "轻量、可靠的智能小程序 UI 组件库",
   "scripts": {
     "syncMiniappData": "node ./build/syncMiniappData.js",
     "dev": "tsc -w -p tsconfig.build.es.json",
-    "build": "rimraf es lib && tsc -p tsconfig.build.es.json && tsc -p tsconfig.build.lib.json",
+    "build": "rimraf es lib && tsc -p tsconfig.build.es.json && tsc -p tsconfig.build.lib.json && node ./build/postBuild.js",
     "build:tuya": "yarn build && cd ./example && ray build --target=tuya"
   },
   "main": "lib/index.js",
@@ -42,7 +42,7 @@
   },
   "dependencies": {
     "@ray-js/components-ty-slider": "^0.3.9",
-    "@tuya-miniapp/smart-ui": "2.13.2-beta-0",
+    "@tuya-miniapp/smart-ui": "2.13.2-beta-2",
     "lodash-es": "^4.17.21"
   },
   "devDependencies": {