@sheinx/base 3.0.0-alpha.1 → 3.0.0-alpha.10

package/esm/tree/tree.type.d.ts

@@ -1,59 +1,169 @@
 /// <reference types="react" />
 import { CommonType } from '../common/type';
-import { BaseTreeProps, ObjectKey, KeygenResult, TreePathType } from '@sheinx/hooks';
+import { BaseTreeProps, ObjectKey, KeygenResult, TreePathType, useTree } from '@sheinx/hooks';
 import { SpinClasses } from '../spin/spin.type';
+import { TreeClasses } from '@sheinx/shineout-style';
 import { CheckboxClasses } from '../checkbox/checkbox.type';
-export interface TreeClasses {
-    tree: string;
-    root: string;
-    line: string;
-    noline: string;
-    content: string;
-    childnode: string;
-    checkbox: string;
-    contentWrapper: string;
-    inlineContent: string;
-    text: string;
-    list: string;
-    iconWrapper: string;
-    icon: string;
-    node: string;
-    children: string;
-    leaf: string;
-    placement: string;
-}
 export declare type TreeRenderItemType<DataItem> = ((item: DataItem, expanded: boolean, active: boolean, id: KeygenResult) => React.ReactNode) | ObjectKey<DataItem>;
 export declare type JsstyleType = {
     tree: () => TreeClasses;
     spin: () => SpinClasses;
     checkbox: () => CheckboxClasses;
 };
-export interface TreeProps<DataItem> extends BaseTreeProps<DataItem>, Pick<CommonType, 'className' | 'style'> {
-    jssStyle: JsstyleType;
+export declare type DatumType<DataItem> = ReturnType<typeof useTree<DataItem>>;
+export interface TreeProps<DataItem, Value extends any[]> extends Omit<BaseTreeProps<DataItem>, 'isControlled'>, Pick<CommonType, 'className' | 'style'> {
+    jssStyle?: JsstyleType;
+    /**
+     * @en The default selected keys of the tree
+     * @cn 默认选中的 key （非受控）
+     */
+    defaultValues?: Value;
+    /**
+     * @en The keys of selected
+     * @cn 选中的 key （受控）
+     */
+    value?: Value;
+    /**
+     * @en Whether show line
+     * @cn 是否显示连接线
+     * @default true
+     */
     line?: boolean;
+    /**
+     * @en Class name of icon
+     * @cn 展开/收起按钮的类名
+     */
     iconClass?: string;
+    /**
+     * @en Class name of node
+     * @cn 节点的class，如果是函数，参数为该节点数据
+     */
     nodeClass?: string | ((data: DataItem) => string);
+    /**
+     * @en Class name of content
+     * @cn 内容样式
+     */
+    contentClass?: string | ((data: DataItem) => string);
+    /**
+     * @en The class of leaf, the params of function is data
+     * @cn 叶子节点的 class, 函数的参数为该条叶子节点数据
+     */
     leafClass?: string;
+    /**
+     * @en Custom expand/collapse buttons
+     * @cn 自定义展开/收起按钮
+     */
     expandIcons?: (React.ReactNode | ((d: DataItem) => React.ReactNode))[];
+    /**
+     * @en The class of children, the params of function is data
+     * @cn 子节点 class, 函数的参数为该条叶子节点数据
+     */
     childrenClass?: ((data: DataItem) => string) | string;
+    /**
+     * @en When setting the onDrop attribute, it is draggable
+     * @cn 设置 onDrop 属性时，为可拖动状态
+     */
     onDrop?: (data: DataItem[], key: KeygenResult, targetKey: KeygenResult, position: number) => void;
+    /**
+     * @en Active node key
+     * @cn 激活节点的key
+     */
     active?: KeygenResult;
+    /**
+     * @en If need to double-click to expand
+     * @cn 双击是否展开节点
+     * @default false
+     */
     doubleClickExpand?: boolean;
+    /**
+     * @en Expand by click parent node
+     * @cn 点击父节点展开
+     * @default false
+     */
     parentClickExpand?: boolean;
+    /**
+     * @en Selector when dray image
+     * @cn 定义拖拽图片的选择器
+     */
     dragImageSelector?: ((data?: DataItem) => string) | string;
+    /**
+     * @en Expand event
+     * @cn 节点展开回调，参数为当前展开节点 key 数组
+     */
     onExpand?: (value: KeygenResult[]) => void;
+    /**
+     * @en When it is a string, return d[string]. When it is a function, return the result of the function
+     * @cn 为 string 时，返回 d[string]。 为 function 时，返回函数结果
+     * @default index
+     */
     renderItem: TreeRenderItemType<DataItem>;
-    onChange?: (value: KeygenResult[]) => void;
+    /**
+     * @en Change event
+     * @cn 设置 onChange 属性时，显示 选择框。参数为当前选中值，和 mode 属性相关
+     */
+    onChange?: (value: Value) => void;
+    /**
+     * @en Dom style when drop images
+     * @cn 拖拽图片的原生 style 样式
+     */
     dragImageStyle?: React.CSSProperties;
+    /**
+     * @en Whether it can only be dragged at the same level
+     * @cn 是否只能平级拖拽
+     */
     dragSibling?: boolean;
+    /**
+     * @en Automatically expand nodes with child nodes when dragging
+     * @cn 拖拽时自动展开含有子节点的节点
+     * @default false
+     */
     dragHoverExpand?: boolean;
+    /**
+     * @en Whether the node is inline
+     * @cn 节点是否内联
+     * @default false
+     */
     inlineNode?: boolean;
+    /**
+     * @en Whether to highlight the node when clicked
+     * @cn 点击节点高亮
+     * @default true
+     */
     highlight?: boolean;
+    /**
+     * @en Dynamically load nodes
+     * @cn 设置 loader 属性后，未定义 children 的节点视为动态加载节点，点击展开触发 loader事件，children 为 null 或者长度为 0 视为叶子节点
+     */
     loader?: (key: KeygenResult, data: DataItem) => void;
+    /**
+     * @en Ref
+     * @cn ref
+     */
+    onRef?: (datum: DatumType<DataItem>['datum']) => void;
+    /**
+     * @en Click event
+     * @cn 节点点击事件
+     */
     onClick?: (data: DataItem, id: KeygenResult, path?: TreePathType) => void;
+    /**
+     * @en Drag start event
+     * @cn 拖拽开始事件
+     */
     onDragStart?: (e: React.DragEvent, data: DataItem) => void;
+    /**
+     * @en Drag end event
+     * @cn 拖拽结束事件
+     */
     onDragEnd?: (e: React.DragEvent, data: DataItem) => void;
+    /**
+     * @en Drag over event
+     * @cn 拖拽经过事件
+     */
     onDragOver?: (e: React.DragEvent, data: DataItem) => void;
+    /**
+     * @en Drag leave event
+     * @cn 拖拽离开事件
+     */
     onDragLeave?: (e: React.DragEvent, data: DataItem) => void;
 }
 //# sourceMappingURL=tree.type.d.ts.map

package/esm/tree/tree.type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tree.type.d.ts","sourceRoot":"","sources":["tree.type.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAE5D,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;CACnB;AACD,oBAAY,kBAAkB,CAAC,QAAQ,IACnC,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,YAAY,KAAK,KAAK,CAAC,SAAS,CAAC,GAC3F,SAAS,CAAC,QAAQ,CAAC,CAAC;AAExB,oBAAY,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,WAAW,CAAC;IACxB,IAAI,EAAE,MAAM,WAAW,CAAC;IACxB,QAAQ,EAAE,MAAM,eAAe,CAAC;CACjC,CAAC;AAEF,MAAM,WAAW,SAAS,CAAC,QAAQ,CACjC,SAAQ,aAAa,CAAC,QAAQ,CAAC,EAC7B,IAAI,CAAC,UAAU,EAAE,WAAW,GAAG,OAAO,CAAC;IACzC,QAAQ,EAAE,WAAW,CAAC;IACtB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,QAAQ,KAAK,MAAM,CAAC,CAAC;IAClD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,EAAE,QAAQ,KAAK,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;IACvE,aAAa,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,QAAQ,KAAK,MAAM,CAAC,GAAG,MAAM,CAAC;IACtD,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,GAAG,EAAE,YAAY,EAAE,SAAS,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IAClG,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,iBAAiB,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,QAAQ,KAAK,MAAM,CAAC,GAAG,MAAM,CAAC;IAC3D,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,IAAI,CAAC;IAC3C,UAAU,EAAE,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACzC,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,IAAI,CAAC;IAC3C,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IACrC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,MAAM,CAAC,EAAE,CAAC,GAAG,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC;IACrD,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,EAAE,YAAY,KAAK,IAAI,CAAC;IAC1E,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC;IAC3D,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC;IACzD,UAAU,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC;IAC1D,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC;CAC5D"}
+{"version":3,"file":"tree.type.d.ts","sourceRoot":"","sources":["tree.type.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC9F,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAE5D,oBAAY,kBAAkB,CAAC,QAAQ,IACnC,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,YAAY,KAAK,KAAK,CAAC,SAAS,CAAC,GAC3F,SAAS,CAAC,QAAQ,CAAC,CAAC;AAExB,oBAAY,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,WAAW,CAAC;IACxB,IAAI,EAAE,MAAM,WAAW,CAAC;IACxB,QAAQ,EAAE,MAAM,eAAe,CAAC;CACjC,CAAC;AAEF,oBAAY,SAAS,CAAC,QAAQ,IAAI,UAAU,CAAC,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;AAEvE,MAAM,WAAW,SAAS,CAAC,QAAQ,EAAE,KAAK,SAAS,GAAG,EAAE,CACtD,SAAQ,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,cAAc,CAAC,EACnD,IAAI,CAAC,UAAU,EAAE,WAAW,GAAG,OAAO,CAAC;IACzC,QAAQ,CAAC,EAAE,WAAW,CAAC;IACvB;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC;IACtB;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,QAAQ,KAAK,MAAM,CAAC,CAAC;IAClD;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,QAAQ,KAAK,MAAM,CAAC,CAAC;IACrD;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,WAAW,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,EAAE,QAAQ,KAAK,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;IACvE;;;OAGG;IACH,aAAa,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,QAAQ,KAAK,MAAM,CAAC,GAAG,MAAM,CAAC;IACtD;;;OAGG;IACH,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,GAAG,EAAE,YAAY,EAAE,SAAS,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IAClG;;;OAGG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,QAAQ,KAAK,MAAM,CAAC,GAAG,MAAM,CAAC;IAC3D;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,IAAI,CAAC;IAC3C;;;;OAIG;IACH,UAAU,EAAE,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACzC;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAClC;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IACrC;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,MAAM,CAAC,EAAE,CAAC,GAAG,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC;IACrD;;;OAGG;IACH,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;IACtD;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,EAAE,YAAY,KAAK,IAAI,CAAC;IAC1E;;;OAGG;IACH,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC;IAC3D;;;OAGG;IACH,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC;IACzD;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC;IAC1D;;;OAGG;IACH,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC;CAC5D"}

package/esm/tree-select/index.d.ts

@@ -0,0 +1,4 @@
+export { default, default as TreeSelect } from './tree-select';
+export type { TreeSelectProps, TreeSelectValueType } from './tree-select.type';
+export type { ComponentRef as TreeSelectRef } from './tree-select.type';
+//# sourceMappingURL=index.d.ts.map

package/esm/tree-select/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,eAAe,CAAC;AAC/D,YAAY,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC/E,YAAY,EAAE,YAAY,IAAI,aAAa,EAAE,MAAM,oBAAoB,CAAC"}

package/esm/tree-select/index.js

@@ -0,0 +1,19 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "TreeSelect", {
+  enumerable: true,
+  get: function get() {
+    return _treeSelect.default;
+  }
+});
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function get() {
+    return _treeSelect.default;
+  }
+});
+var _treeSelect = _interopRequireDefault(require("./tree-select"));

package/esm/tree-select/tree-select.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { KeygenResult } from '@sheinx/hooks';
+import { TreeSelectProps } from './tree-select.type';
+export declare type TreeSelectValueType = KeygenResult | KeygenResult[];
+declare const TreeSelect: <DataItem, Value extends TreeSelectValueType>(props: TreeSelectProps<DataItem, Value>) => JSX.Element;
+export default TreeSelect;
+//# sourceMappingURL=tree-select.d.ts.map

package/esm/tree-select/tree-select.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree-select.d.ts","sourceRoot":"","sources":["tree-select.tsx"],"names":[],"mappings":";AACA,OAAO,EAQL,YAAY,EACb,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,eAAe,EAAc,MAAM,oBAAoB,CAAC;AAUjE,oBAAY,mBAAmB,GAAG,YAAY,GAAG,YAAY,EAAE,CAAC;AAEhE,QAAA,MAAM,UAAU,uGAuhBf,CAAC;AAEF,eAAe,UAAU,CAAC"}