rsuite 5.60.2 → 5.61.0

package/cjs/CheckTree/CheckTree.d.ts

@@ -0,0 +1,16 @@
+import { type CheckTreeViewProps } from './CheckTreeView';
+import type { RsRefForwardingComponent } from '../@types/common';
+import type { TreeExtraProps } from '../Tree/types';
+export declare type ValueType = (string | number)[];
+export interface CheckTreeProps<T = ValueType> extends CheckTreeViewProps<T>, TreeExtraProps {
+    /**
+     * Default selected Value
+     */
+    defaultValue?: T;
+}
+/**
+ * The `CheckTree` component is used for selecting multiple options which are organized in a tree structure.
+ * @see https://rsuitejs.com/components/check-tree
+ */
+declare const CheckTree: RsRefForwardingComponent<'div', CheckTreeProps>;
+export default CheckTree;

package/cjs/CheckTree/CheckTree.js

@@ -0,0 +1,112 @@
+'use client';
+"use strict";
+
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard");
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.default = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutPropertiesLoose"));
+var _react = _interopRequireWildcard(require("react"));
+var _utils = require("../utils");
+var _useTreeValue2 = _interopRequireDefault(require("./hooks/useTreeValue"));
+var _CheckTreeView = _interopRequireDefault(require("./CheckTreeView"));
+var _useFlattenTree = _interopRequireDefault(require("../Tree/hooks/useFlattenTree"));
+var _useTreeWithChildren2 = _interopRequireDefault(require("../Tree/hooks/useTreeWithChildren"));
+var _useExpandTree2 = _interopRequireDefault(require("../Tree/hooks/useExpandTree"));
+var _TreeProvider = require("../Tree/TreeProvider");
+/**
+ * The `CheckTree` component is used for selecting multiple options which are organized in a tree structure.
+ * @see https://rsuitejs.com/components/check-tree
+ */
+var CheckTree = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
+  var controlledValue = props.value,
+    data = props.data,
+    defaultValue = props.defaultValue,
+    _props$defaultExpandA = props.defaultExpandAll,
+    defaultExpandAll = _props$defaultExpandA === void 0 ? false : _props$defaultExpandA,
+    _props$defaultExpandI = props.defaultExpandItemValues,
+    defaultExpandItemValues = _props$defaultExpandI === void 0 ? [] : _props$defaultExpandI,
+    uncheckableItemValues = props.uncheckableItemValues,
+    controlledExpandItemValues = props.expandItemValues,
+    _props$childrenKey = props.childrenKey,
+    childrenKey = _props$childrenKey === void 0 ? 'children' : _props$childrenKey,
+    _props$labelKey = props.labelKey,
+    labelKey = _props$labelKey === void 0 ? 'label' : _props$labelKey,
+    _props$valueKey = props.valueKey,
+    valueKey = _props$valueKey === void 0 ? 'value' : _props$valueKey,
+    virtualized = props.virtualized,
+    _props$cascade = props.cascade,
+    cascade = _props$cascade === void 0 ? true : _props$cascade,
+    renderTreeIcon = props.renderTreeIcon,
+    renderTreeNode = props.renderTreeNode,
+    getChildren = props.getChildren,
+    onExpand = props.onExpand,
+    onChange = props.onChange,
+    rest = (0, _objectWithoutPropertiesLoose2.default)(props, ["value", "data", "defaultValue", "defaultExpandAll", "defaultExpandItemValues", "uncheckableItemValues", "expandItemValues", "childrenKey", "labelKey", "valueKey", "virtualized", "cascade", "renderTreeIcon", "renderTreeNode", "getChildren", "onExpand", "onChange"]);
+  var _useTreeValue = (0, _useTreeValue2.default)(controlledValue, {
+      defaultValue: defaultValue,
+      uncheckableItemValues: uncheckableItemValues
+    }),
+    value = _useTreeValue[0],
+    setValue = _useTreeValue[1];
+  var itemDataKeys = {
+    childrenKey: childrenKey,
+    labelKey: labelKey,
+    valueKey: valueKey
+  };
+  var _useTreeWithChildren = (0, _useTreeWithChildren2.default)(data, itemDataKeys),
+    treeData = _useTreeWithChildren.treeData,
+    loadingNodeValues = _useTreeWithChildren.loadingNodeValues,
+    appendChild = _useTreeWithChildren.appendChild;
+  var _useExpandTree = (0, _useExpandTree2.default)(data, (0, _extends2.default)({}, itemDataKeys, {
+      defaultExpandAll: defaultExpandAll,
+      defaultExpandItemValues: defaultExpandItemValues,
+      controlledExpandItemValues: controlledExpandItemValues,
+      onExpand: onExpand,
+      getChildren: getChildren,
+      appendChild: appendChild
+    })),
+    expandItemValues = _useExpandTree.expandItemValues,
+    handleExpandTreeNode = _useExpandTree.handleExpandTreeNode;
+  var flattenedNodes = (0, _useFlattenTree.default)(treeData, (0, _extends2.default)({}, itemDataKeys, {
+    uncheckableItemValues: uncheckableItemValues,
+    multiple: true,
+    cascade: cascade,
+    value: value
+  }));
+  var handleChange = (0, _utils.useEventCallback)(function (nextValue, event) {
+    setValue(nextValue);
+    onChange === null || onChange === void 0 ? void 0 : onChange(nextValue, event);
+  });
+  var treeContext = (0, _react.useMemo)(function () {
+    return {
+      props: {
+        labelKey: labelKey,
+        valueKey: valueKey,
+        childrenKey: childrenKey,
+        virtualized: virtualized,
+        renderTreeIcon: renderTreeIcon,
+        renderTreeNode: renderTreeNode
+      }
+    };
+  }, [childrenKey, labelKey, valueKey, virtualized, renderTreeIcon, renderTreeNode]);
+  return /*#__PURE__*/_react.default.createElement(_TreeProvider.TreeProvider, {
+    value: treeContext
+  }, /*#__PURE__*/_react.default.createElement(_CheckTreeView.default, (0, _extends2.default)({}, rest, {
+    ref: ref,
+    value: value,
+    cascade: cascade,
+    data: treeData,
+    virtualized: virtualized,
+    loadingNodeValues: loadingNodeValues,
+    flattenedNodes: flattenedNodes,
+    uncheckableItemValues: uncheckableItemValues,
+    expandItemValues: expandItemValues,
+    onChange: handleChange,
+    onExpand: handleExpandTreeNode
+  })));
+});
+CheckTree.displayName = 'CheckTree';
+var _default = CheckTree;
+exports.default = _default;

package/cjs/CheckTree/CheckTreeNode.d.ts

@@ -0,0 +1,72 @@
+import React from 'react';
+import { RsRefForwardingComponent, WithAsProps } from '../@types/common';
+import { CheckStateType } from '../utils';
+import type { TreeNode as TreeNodeData } from '../Tree/types';
+export interface CheckTreeNodeProps extends WithAsProps {
+    /**
+     * The label of the node.
+     */
+    label?: any;
+    /**
+     * The layer of the node in the tree hierarchy.
+     */
+    layer: number;
+    /**
+     * The value of the node.
+     */
+    value?: any;
+    /**
+     * Whether the node should be focused.
+     */
+    focus?: boolean;
+    /**
+     * Whether the node should be expanded.
+     */
+    expanded?: boolean;
+    /**
+     * Whether the node is in a loading state.
+     */
+    loading?: boolean;
+    /**
+     * Whether the node is visible.
+     */
+    visible?: boolean;
+    /**
+     * Additional data associated with the node.
+     */
+    nodeData?: any;
+    /**
+     * Whether the node is disabled.
+     */
+    disabled?: boolean;
+    /**
+     * The check state of the node.
+     */
+    checkState?: CheckStateType;
+    /**
+     * Whether the node has children.
+     */
+    hasChildren?: boolean;
+    /**
+     * Whether the node is uncheckable.
+     */
+    uncheckable?: boolean;
+    /**
+     * Whether all nodes are uncheckable.
+     */
+    allUncheckable?: boolean;
+    /**
+     * Reference to the tree item.
+     */
+    treeItemRef?: React.Ref<any>;
+    /**
+     * Callback function called when the node is expanded.
+     */
+    onExpand?: (nodeData: TreeNodeData, expanded?: boolean) => void;
+    /**
+     * Callback function called when the node is selected.
+     */
+    onSelect?: (nodeData: TreeNodeData, event: React.SyntheticEvent) => void;
+}
+declare const CheckTreeNode: RsRefForwardingComponent<'div', CheckTreeNodeProps>;
+export default CheckTreeNode;

package/cjs/CheckTree/CheckTreeNode.js

@@ -0,0 +1,117 @@
+'use client';
+"use strict";
+
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard");
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.default = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutPropertiesLoose"));
+var _react = _interopRequireWildcard(require("react"));
+var _ListCheckItem = _interopRequireDefault(require("../internals/Picker/ListCheckItem"));
+var _utils = require("../internals/utils");
+var _hooks = require("../internals/hooks");
+var _utils2 = require("../Tree/utils");
+var _utils3 = require("../utils");
+var _TreeProvider = require("../Tree/TreeProvider");
+var _TreeNodeToggle = _interopRequireDefault(require("../Tree/TreeNodeToggle"));
+var CheckTreeNode = /*#__PURE__*/(0, _react.forwardRef)(function (props, ref) {
+  var _props$as = props.as,
+    Component = _props$as === void 0 ? 'div' : _props$as,
+    style = props.style,
+    className = props.className,
+    _props$classPrefix = props.classPrefix,
+    classPrefix = _props$classPrefix === void 0 ? 'check-tree-node' : _props$classPrefix,
+    _props$visible = props.visible,
+    visible = _props$visible === void 0 ? true : _props$visible,
+    layer = props.layer,
+    disabled = props.disabled,
+    allUncheckable = props.allUncheckable,
+    loading = props.loading,
+    expanded = props.expanded,
+    hasChildren = props.hasChildren,
+    nodeData = props.nodeData,
+    focus = props.focus,
+    label = props.label,
+    uncheckable = props.uncheckable,
+    checkState = props.checkState,
+    value = props.value,
+    treeItemRef = props.treeItemRef,
+    onExpand = props.onExpand,
+    onSelect = props.onSelect,
+    rest = (0, _objectWithoutPropertiesLoose2.default)(props, ["as", "style", "className", "classPrefix", "visible", "layer", "disabled", "allUncheckable", "loading", "expanded", "hasChildren", "nodeData", "focus", "label", "uncheckable", "checkState", "value", "treeItemRef", "onExpand", "onSelect"]);
+  var _useCustom = (0, _utils3.useCustom)(),
+    rtl = _useCustom.rtl;
+  var _useTreeContextProps = (0, _TreeProvider.useTreeContextProps)(),
+    renderTreeNode = _useTreeContextProps.renderTreeNode,
+    virtualized = _useTreeContextProps.virtualized;
+  var _useClassNames = (0, _utils3.useClassNames)(classPrefix),
+    prefix = _useClassNames.prefix,
+    merge = _useClassNames.merge,
+    withClassPrefix = _useClassNames.withClassPrefix;
+  var labelStr = (0, _react.useMemo)(function () {
+    return (0, _utils.stringifyReactNode)(label);
+  }, [label]);
+  var handleExpand = (0, _utils3.useEventCallback)(function (event) {
+    var _event$nativeEvent, _event$nativeEvent$st;
+    // stop propagation when using custom loading icon
+    event === null || event === void 0 ? void 0 : (_event$nativeEvent = event.nativeEvent) === null || _event$nativeEvent === void 0 ? void 0 : (_event$nativeEvent$st = _event$nativeEvent.stopImmediatePropagation) === null || _event$nativeEvent$st === void 0 ? void 0 : _event$nativeEvent$st.call(_event$nativeEvent);
+    onExpand === null || onExpand === void 0 ? void 0 : onExpand(nodeData, expanded);
+  });
+  var handleSelect = (0, _utils3.useEventCallback)(function (_value, event) {
+    var isChecked = false;
+    if (checkState === _utils3.CHECK_STATE.UNCHECK || checkState === _utils3.CHECK_STATE.INDETERMINATE) {
+      isChecked = true;
+    }
+    if (checkState === _utils3.CHECK_STATE.CHECK) {
+      isChecked = false;
+    }
+    var nextNodeData = (0, _extends2.default)({}, nodeData, {
+      check: isChecked
+    });
+    onSelect === null || onSelect === void 0 ? void 0 : onSelect(nextNodeData, event);
+  });
+  var classes = merge(className, withClassPrefix({
+    disabled: disabled,
+    'all-uncheckable': !!allUncheckable,
+    'text-muted': disabled,
+    focus: focus
+  }));
+  var styles = virtualized ? (0, _extends2.default)({}, style, (0, _utils2.indentTreeNode)(rtl, layer - 1)) : style;
+  var itemRef = (0, _hooks.useFoucsVirtualListItem)(focus);
+  return visible ? /*#__PURE__*/_react.default.createElement(Component, (0, _extends2.default)({}, rest, {
+    style: styles,
+    className: classes,
+    ref: ref
+  }), /*#__PURE__*/_react.default.createElement(_TreeNodeToggle.default, {
+    "aria-label": (expanded ? 'Collapse' : 'Expand') + (" " + labelStr),
+    data: nodeData,
+    expanded: expanded,
+    loading: loading,
+    hasChildren: hasChildren,
+    onClick: handleExpand
+  }), /*#__PURE__*/_react.default.createElement(_ListCheckItem.default, {
+    as: "div",
+    role: "treeitem",
+    ref: (0, _utils3.mergeRefs)(itemRef, treeItemRef),
+    "aria-label": labelStr,
+    "aria-expanded": expanded,
+    "aria-checked": checkState === _utils3.CHECK_STATE.CHECK,
+    "aria-selected": focus,
+    "aria-disabled": disabled,
+    "aria-level": layer,
+    "data-layer": layer,
+    active: checkState === _utils3.CHECK_STATE.CHECK,
+    indeterminate: checkState === _utils3.CHECK_STATE.INDETERMINATE,
+    focus: focus,
+    checkable: !uncheckable,
+    disabled: disabled,
+    value: nodeData.refKey || value,
+    className: prefix('content'),
+    title: labelStr,
+    onSelect: handleSelect
+  }, typeof renderTreeNode === 'function' ? renderTreeNode(nodeData) : label)) : null;
+});
+CheckTreeNode.displayName = 'CheckTreeNode';
+var _default = CheckTreeNode;
+exports.default = _default;

package/cjs/CheckTree/CheckTreeView.d.ts

@@ -0,0 +1,70 @@
+import React from 'react';
+import type { RsRefForwardingComponent, ToArray, DataProps } from '../@types/common';
+import type { TreeNode, TreeNodeMap, TreeViewBaseProps } from '../Tree/types';
+/**
+ * Props for the CheckTreeView component.
+ */
+export interface CheckTreeViewProps<V = (string | number)[]> extends TreeViewBaseProps<V>, DataProps<TreeNode> {
+    /**
+     * Selected value.
+     */
+    value?: V;
+    /**
+     * Whether using virtualized list.
+     */
+    virtualized?: boolean;
+    /**
+     * Virtualized list ref object.
+     */
+    listRef?: React.RefObject<any>;
+    /**
+     * Searchbox input ref object.
+     */
+    searchInputRef?: React.RefObject<HTMLInputElement>;
+    /**
+     * Whether display search input box.
+     */
+    searchable?: boolean;
+    /**
+     * Tree node cascade.
+     */
+    cascade?: boolean;
+    /**
+     * Set the option value for the check box not to be rendered.
+     */
+    uncheckableItemValues?: V;
+    /**
+     * Disabled tree node.
+     */
+    disabledItemValues?: ToArray<NonNullable<V>>;
+    /**
+     * Called when scrolling.
+     */
+    onScroll?: (event: React.SyntheticEvent) => void;
+    /**
+     * Called after the value has been changed.
+     */
+    onChange?: (value: V, event: React.SyntheticEvent) => void;
+}
+interface CheckTreeViewInnerProps<V = (string | number)[]> extends Omit<CheckTreeViewProps<V>, 'onExpand'> {
+    /**
+     * Loading node values.
+     */
+    loadingNodeValues?: V;
+    /**
+     * Flattened nodes.
+     */
+    flattenedNodes?: TreeNodeMap;
+    /**
+     * Callback function triggered when an item is focused.
+     */
+    onFocusItem?: (value?: TreeNode['value']) => void;
+    /**
+     * A callback function that is called when a node is expanded.
+     *
+     * @param nodeData - The data of the expanded node.
+     */
+    onExpand?: (nodeData: TreeNode, expanded?: boolean) => void;
+}
+declare const CheckTreeView: RsRefForwardingComponent<'div', CheckTreeViewInnerProps>;
+export default CheckTreeView;