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

package/esm/components/use-collapse/use-collapse-item.js

@@ -0,0 +1,72 @@
+"use strict";
+
+require("core-js/modules/es.array.filter.js");
+require("core-js/modules/web.dom-collections.for-each.js");
+require("core-js/modules/es.object.get-own-property-descriptors.js");
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+require("core-js/modules/es.array.includes.js");
+var _usePersistFn = require("../../common/use-persist-fn");
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+var useCollapseItem = function useCollapseItem(props) {
+  var active = props.active,
+    keygen = props.keygen,
+    triggerRegion = props.triggerRegion,
+    disabled = props.disabled,
+    onChange = props.onChange;
+  var judgeExpanded = active.indexOf(keygen) > -1;
+  var currentDisabled = triggerRegion === 'disabled' || disabled;
+  var handleClickByRegion = (0, _usePersistFn.usePersistFn)(function (e, regionKey) {
+    if (currentDisabled) return;
+    var triggerKey = triggerRegion === 'icon' ? 0 : triggerRegion === 'header' ? 1 : 2;
+    if (regionKey === triggerKey || triggerRegion === 'header' && [0, 1].includes(regionKey)) onChange(keygen, e);
+  });
+  var getItemContentProps = function getItemContentProps() {
+    var externalProps = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    return _objectSpread(_objectSpread({}, externalProps), {}, {
+      'data-soui-disabled': !!currentDisabled,
+      tabIndex: currentDisabled ? -1 : 0,
+      onClick: function onClick(e) {
+        return handleClickByRegion(e, 2);
+      }
+    });
+  };
+  var getHeaderIconProps = function getHeaderIconProps() {
+    var externalProps = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    return _objectSpread(_objectSpread({}, externalProps), {}, {
+      onClick: function onClick(e) {
+        return handleClickByRegion(e, 0);
+      }
+    });
+  };
+  var getTitleProps = function getTitleProps() {
+    var externalProps = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    return _objectSpread(_objectSpread({}, externalProps), {}, {
+      onClick: function onClick(e) {
+        return handleClickByRegion(e, 1);
+      }
+    });
+  };
+  var getExtraProps = function getExtraProps() {
+    var externalProps = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    return _objectSpread(_objectSpread({}, externalProps), {}, {
+      onClick: function onClick(e) {
+        return e.stopPropagation();
+      }
+    });
+  };
+  return {
+    judgeExpanded: judgeExpanded,
+    getItemContentProps: getItemContentProps,
+    getHeaderIconProps: getHeaderIconProps,
+    getTitleProps: getTitleProps,
+    getExtraProps: getExtraProps
+  };
+};
+var _default = useCollapseItem;
+exports.default = _default;

package/esm/components/use-collapse/use-collapse-item.type.d.ts

@@ -0,0 +1,29 @@
+/// <reference types="react" />
+export interface BaseCollapseItemContext {
+    /**
+     * @en The currently expanded panel, controlled
+     * @cn 当前展开的面板,受控
+     */
+    active: string | string[];
+    /**
+     * @en The region that triggers the collapse
+     * @cn 触发展开折叠的区域
+     */
+    triggerRegion?: 'icon' | 'header' | 'disabled';
+    onChange: (newActive: string, event: React.MouseEvent<HTMLDivElement, MouseEvent>) => void;
+}
+export interface BaseCollapseItemProps {
+    /**
+     * @en The key of the panel
+     * @cn 面板的key，唯一标识
+     */
+    keygen: string;
+    /**
+     * @en Whether to disable
+     * @cn 是否禁用
+     * @default false
+     */
+    disabled?: boolean;
+}
+export declare type BaseCollapseType = BaseCollapseItemContext & BaseCollapseItemProps;
+//# sourceMappingURL=use-collapse-item.type.d.ts.map

package/esm/components/use-collapse/use-collapse-item.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-collapse-item.type.d.ts","sourceRoot":"","sources":["use-collapse-item.type.ts"],"names":[],"mappings":";AAAA,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC1B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IAC/C,QAAQ,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,cAAc,EAAE,UAAU,CAAC,KAAK,IAAI,CAAC;CAC5F;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,oBAAY,gBAAgB,GAAG,uBAAuB,GAAG,qBAAqB,CAAC"}

package/esm/components/use-collapse/use-collapse-item.type.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/esm/components/use-collapse/use-collapse.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import type { BaseCollapseProps } from './use-collapse.type';
+declare const useCollapse: (props: BaseCollapseProps) => {
+    active: string[];
+    onChange: (newActive: string, event: React.MouseEvent<HTMLDivElement, MouseEvent>) => void;
+};
+export default useCollapse;
+//# sourceMappingURL=use-collapse.d.ts.map

package/esm/components/use-collapse/use-collapse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-collapse.d.ts","sourceRoot":"","sources":["use-collapse.ts"],"names":[],"mappings":"AAAA,OAAO,KAAmB,MAAM,OAAO,CAAC;AACxC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAU7D,QAAA,MAAM,WAAW,UAAW,iBAAiB;;0BAWV,MAAM,SAAS,gBAAgB,CAAC,cAAc,EAAE,UAAU,CAAC;CAkB7F,CAAC;AAEF,eAAe,WAAW,CAAC"}

package/esm/components/use-collapse/use-collapse.js

@@ -0,0 +1,51 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+require("core-js/modules/es.array.concat.js");
+require("core-js/modules/es.array.slice.js");
+require("core-js/modules/es.array.includes.js");
+require("core-js/modules/es.string.includes.js");
+require("core-js/modules/es.array.filter.js");
+var _react = require("react");
+var _is = require("../../utils/is");
+var getCurrentActive = function getCurrentActive(active, accordion) {
+  // @ts-ignore
+  var res = [].concat(active);
+  if (accordion) return res.slice(0, 1);
+  return res;
+};
+var useCollapse = function useCollapse(props) {
+  var defaultActive = props.defaultActive,
+    active = props.active,
+    accordion = props.accordion,
+    onChange = props.onChange;
+  var _useState = (0, _react.useState)(getCurrentActive(defaultActive, accordion) || []),
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    currentActive = _useState2[0],
+    setCurrentActive = _useState2[1];
+  var getCurrentValue = function getCurrentValue() {
+    if (active !== undefined) return getCurrentActive(active, accordion);
+    return currentActive;
+  };
+  var handleChange = function handleChange(newActive, event) {
+    var currentActive = getCurrentValue() || [];
+    var isActive = currentActive.includes(newActive);
+    var newCurrentActive = isActive ? currentActive.filter(function (item) {
+      return item !== newActive;
+    }) : accordion ? [newActive] : [].concat((0, _toConsumableArray2.default)(currentActive), [newActive]);
+    if (active === undefined) setCurrentActive(newCurrentActive);
+    if ((0, _is.isFunc)(onChange)) onChange === null || onChange === void 0 ? void 0 : onChange(newActive, newCurrentActive, event);
+  };
+  return {
+    active: getCurrentValue(),
+    onChange: handleChange
+  };
+};
+var _default = useCollapse;
+exports.default = _default;

package/esm/components/use-collapse/use-collapse.type.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="react" />
+import type { BaseCollapseItemContext } from './use-collapse-item.type';
+export interface BaseCollapseProps extends Partial<Pick<BaseCollapseItemContext, 'active'>> {
+    /**
+     * @en The default expanded panel
+     * @cn 默认展开的面板
+     */
+    defaultActive?: string | string[];
+    /**
+     * @en Whether to enable accordion mode
+     * @cn 是否开启手风琴模式
+     * @default false
+     */
+    accordion?: boolean;
+    /**
+     * @en Callback triggered when the expanded panel changes
+     * @cn 展开面板改变时触发回调
+     */
+    onChange?: (active: string, actives: string[], e: React.MouseEvent<HTMLDivElement, MouseEvent>) => void;
+}
+//# sourceMappingURL=use-collapse.type.d.ts.map

package/esm/components/use-collapse/use-collapse.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-collapse.type.d.ts","sourceRoot":"","sources":["use-collapse.type.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,0BAA0B,CAAC;AACxE,MAAM,WAAW,iBAAkB,SAAQ,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,QAAQ,CAAC,CAAC;IACzF;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAClC;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,CACT,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EAAE,EACjB,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,cAAc,EAAE,UAAU,CAAC,KAC5C,IAAI,CAAC;CACX"}

package/esm/components/use-collapse/use-collapse.type.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/esm/components/use-datepicker/use-datepicker-format.js

@@ -31,7 +31,7 @@ var getFormat = function getFormat(format, type) {
     case 'time':
       return 'HH:mm:ss';
     case 'week':
-      return 'gggg ww';
+      return 'gggg-ww';
     case 'year':
       return 'YYYY';
     case 'quarter':

package/esm/components/use-datepicker/use-time.js

@@ -106,7 +106,7 @@ var useTime = function useTime(props) {
       var date = getTargetDate(mode, index);
       var str = index < 10 ? "0".concat(index) : "".concat(index);
       if (mode === 'h' && str === '00') str = '12';
-      if (mode === 'ampm') str = index === 0 ? 'am' : 'pm';
+      if (mode === 'ampm') str = index === 0 ? 'AM' : 'PM';
       return {
         str: str,
         date: date,

package/esm/components/use-descriptions/index.d.ts

@@ -0,0 +1,3 @@
+export { default, default as useDescriptions } from './use-descriptions';
+export type { DescriptionsItemProps, BaseDescriptionsProps } from './use-descriptions.type';
+//# sourceMappingURL=index.d.ts.map

package/esm/components/use-descriptions/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,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACzE,YAAY,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC"}

package/esm/components/use-descriptions/index.js

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

package/esm/components/use-descriptions/use-descriptions.d.ts

@@ -0,0 +1,6 @@
+import type { BaseDescriptionsProps, DescriptionsItemProps } from './use-descriptions.type';
+declare const useDescriptions: (props: BaseDescriptionsProps) => {
+    renderItem: DescriptionsItemProps[][];
+};
+export default useDescriptions;
+//# sourceMappingURL=use-descriptions.d.ts.map

package/esm/components/use-descriptions/use-descriptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-descriptions.d.ts","sourceRoot":"","sources":["use-descriptions.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAW5F,QAAA,MAAM,eAAe,UAAW,qBAAqB;;CAwDpD,CAAC;AAEF,eAAe,eAAe,CAAC"}

package/esm/components/use-descriptions/use-descriptions.js

@@ -0,0 +1,77 @@
+"use strict";
+
+require("core-js/modules/es.array.filter.js");
+require("core-js/modules/es.object.get-own-property-descriptors.js");
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+require("core-js/modules/web.dom-collections.for-each.js");
+var _react = require("react");
+var _ = require("../..");
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+var isObject = _.util.isObject,
+  isNumber = _.util.isNumber,
+  isArray = _.util.isArray;
+var responsiveArray = ['xxxl', 'xxl', 'xl', 'lg', 'md', 'sm', 'xs'];
+var getLengthByRow = function getLengthByRow(arr) {
+  return isArray(arr) ? arr.reduce(function (prev, now) {
+    return prev + (now.span || 1);
+  }, 0) : 0;
+};
+var useDescriptions = function useDescriptions(props) {
+  var items = props.items,
+    column = props.column,
+    valueStyle = props.valueStyle,
+    labelStyle = props.labelStyle;
+  var _useState = (0, _react.useState)(),
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    screen = _useState2[0],
+    setScreen = _useState2[1];
+  var responsiveToken = (0, _react.useRef)();
+  var renderItem = [];
+  (0, _react.useEffect)(function () {
+    responsiveToken.current = _.ResponsiveObserve.subscribe(function (screens) {
+      for (var i = 0; i < responsiveArray.length; i++) {
+        var breakPoint = responsiveArray[i];
+        if (screens[breakPoint]) {
+          setScreen(breakPoint);
+          break;
+        }
+      }
+    });
+    return function () {
+      _.ResponsiveObserve.unsubscribe(responsiveToken.current);
+    };
+  }, []);
+  var currentColumn = 3;
+  if (column && isObject(column)) currentColumn = column[screen] || 3;
+  if (column && isNumber(column) && column > 0) currentColumn = column;
+  if (isArray(items) && items.length && currentColumn) {
+    items.forEach(function (d) {
+      var lastRenderItem = renderItem[renderItem.length - 1];
+      var lengthRow = getLengthByRow(lastRenderItem);
+      var span = d.span ? d.span > currentColumn ? currentColumn : d.span : 1;
+      var newItem = _objectSpread(_objectSpread({}, d), {}, {
+        span: span,
+        itemValueStyle: Object.assign({}, valueStyle, d === null || d === void 0 ? void 0 : d.itemValueStyle),
+        itemLabelStyle: Object.assign({}, labelStyle, d === null || d === void 0 ? void 0 : d.itemLabelStyle)
+      });
+      if (lengthRow === 0 || lengthRow === currentColumn) renderItem.push([newItem]);else lastRenderItem.push(_objectSpread(_objectSpread({}, newItem), {}, {
+        span: d.span ? d.span > currentColumn - lengthRow ? currentColumn - lengthRow : d.span : 1
+      }));
+    });
+    var lastRenderItem = renderItem[renderItem.length - 1];
+    var lengthRow = getLengthByRow(lastRenderItem);
+    if (lengthRow < currentColumn) lastRenderItem[lastRenderItem.length - 1].span += currentColumn - lengthRow;
+  }
+  return {
+    renderItem: renderItem
+  };
+};
+var _default = useDescriptions;
+exports.default = _default;

package/esm/components/use-descriptions/use-descriptions.type.d.ts

@@ -0,0 +1,65 @@
+import React from 'react';
+export interface DescriptionsItemProps {
+    /**
+     * @private 内部属性
+     */
+    key?: React.Key;
+    /**
+     * @en Data label
+     * @cn 数据标签
+     */
+    label?: React.ReactNode;
+    /**
+     * @en Data value
+     * @cn 数据值
+     */
+    value?: React.ReactNode;
+    /**
+     * @en The number of columns occupied
+     * @cn 占据的列数
+     */
+    span?: number;
+    /**
+     * @en The style of the current data label
+     * @cn 当前数据标签样式
+     */
+    itemLabelStyle?: React.CSSProperties;
+    /**
+     * @en The style of the current data value
+     * @cn 当前数据值样式
+     */
+    itemValueStyle?: React.CSSProperties;
+}
+export interface BaseDescriptionsProps {
+    /**
+     * @en Descriptions array
+     * @cn 描述项数组,描述项对象结构见下
+     * @override ItemType[]
+     */
+    items?: DescriptionsItemProps[];
+    /**
+     * @en Label style
+     * @cn 标签样式
+     */
+    labelStyle?: React.CSSProperties;
+    /**
+     * @en Value style
+     * @cn 值样式
+     */
+    valueStyle?: React.CSSProperties;
+    /**
+     * @en The number of columns placed in each row, one data is one column, it can be configured as a number or an object, when configured as an object format, responsive arrangement is supported
+     * @cn 每行放置的列的数量，一个数据为一列，可配置为数字或对象，当配置为对象格式时，支持响应式排列
+     * @default 3
+     */
+    column?: number | {
+        xs?: number;
+        sm?: number;
+        md?: number;
+        lg?: number;
+        xl?: number;
+        xxl?: number;
+        xxxl?: number;
+    };
+}
+//# sourceMappingURL=use-descriptions.type.d.ts.map

package/esm/components/use-descriptions/use-descriptions.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-descriptions.type.d.ts","sourceRoot":"","sources":["use-descriptions.type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC;IAChB;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACxB;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACxB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IACrC;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;CACtC;AACD,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,KAAK,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAChC;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IACjC;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IACjC;;;;OAIG;IACH,MAAM,CAAC,EACH,MAAM,GACN;QACE,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACP"}

package/esm/components/use-descriptions/use-descriptions.type.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/esm/components/use-image/use-image.type.d.ts

@@ -18,27 +18,58 @@ export interface BaseImageProps {
      * @default -
      *
      */
+    /**
+     * @en Image fill type
+     * @cn 图片填充方式
+     */
     fit?: ImageFitType;
     /**
      * @title 懒加载容器
      * @description 指定懒加载的容器，如: #id
      * @default -
      */
+    /**
+     * @en Lazy load container
+     * @cn 懒加载容器
+     */
     container?: string | HTMLElement;
     /**
      * @title 自定义错误内容
      * @description 当图片加载失败时，允许自定义渲染对应的的内容。
      * @default -
      */
+    /**
+     * @en Custom error content
+     * @cn 自定义错误内容
+     */
     error?: React.ReactNode;
+    /**
+     * @en Original picture address
+     * @cn 原始图片地址
+     */
     href?: string;
+    /**
+     * @en Whether to delay loading, number to set lazy offset
+     * @cn 是否延迟加载，如果为数字则表示懒加载偏移量
+     * @default false
+     */
     lazy?: boolean | number;
+    /**
+     * @en The original property of html
+     * @cn 是否禁止 img 元素原生 draggable 属性
+     * @default false
+     */
     noImgDrag?: boolean;
     /**
      * @title 图加载时的占位内容
      * @description 图片加载过程中，允许自定义渲染加载时的的内容。
      * @default 'loading'
      */
+    /**
+     * @en Loading image placeholder content
+     * @cn 图加载时的占位内容
+     * @default 'loading
+     */
     placeholder?: React.ReactNode;
     /**
      * @title 图片形状
@@ -48,16 +79,61 @@ export interface BaseImageProps {
      * - thumbnail: 缩略图
      * @default 'rounded'
      */
+    /**
+     * @en Image shape
+     * @cn 图片形状
+     * @default 'rounded'
+     */
     shape?: ImageShapeType;
+    /**
+     * @en Target of image
+     * @cn 图片打开方式
+     * @default '_modal'
+     */
     target?: ImageTargetType;
+    /**
+     * @en The width of the image
+     * @cn 图片宽度
+     * @default '100%'
+     */
     width?: number | string;
+    /**
+     * @en The height of the image
+     * @cn 图片高度
+     * @default '100%'
+     */
     height?: number | string;
+    /**
+     * @en The picture address
+     * @cn 图片地址
+     */
     src?: string;
+    /**
+     * @en The original property of html
+     * @cn 原生 title 属性
+     */
     title?: string;
     imageRef?: React.RefObject<HTMLImageElement>;
+    /**
+     * @en The callback of click
+     * @cn 点击图片的回调
+     */
     onClick?: React.MouseEventHandler;
+    /**
+     * @en Alternate address, applied when src is invalid
+     * @cn 备用地址，src无效时会应用
+     */
     alt?: string;
+    /**
+     * @en Auto transform protocol
+     * @cn 是否根据页面自动转换协议
+     * @default false
+     */
     autoSSL?: boolean;
+    /**
+     * @en Callback of image src or alt request fail
+     * @cn src或alt 地址请求出错回调
+     */
     onError?: (e: Event, type: number) => void;
 }
 //# sourceMappingURL=use-image.type.d.ts.map

package/esm/components/use-image/use-image.type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-image.type.d.ts","sourceRoot":"","sources":["use-image.type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,oBAAY,cAAc,GAAG,SAAS,GAAG,QAAQ,GAAG,WAAW,CAAC;AAChE,oBAAY,YAAY,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,SAAS,CAAC;AACjE,oBAAY,eAAe,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,WAAW,CAAC;AAE1E,oBAAY,MAAM,GAAG;IACnB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,WAAW,cAAc;IAC7B;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,YAAY,CAAC;IAEnB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;IAEjC;;;;OAIG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAExB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAExB,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;;OAIG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAE9B;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;IAC7C,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC;IAClC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CAC5C"}
+{"version":3,"file":"use-image.type.d.ts","sourceRoot":"","sources":["use-image.type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,oBAAY,cAAc,GAAG,SAAS,GAAG,QAAQ,GAAG,WAAW,CAAC;AAChE,oBAAY,YAAY,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,SAAS,CAAC;AACjE,oBAAY,eAAe,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,WAAW,CAAC;AAE1E,oBAAY,MAAM,GAAG;IACnB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,WAAW,cAAc;IAC7B;;;;;;;;;OASG;IACH;;;OAGG;IACH,GAAG,CAAC,EAAE,YAAY,CAAC;IAEnB;;;;OAIG;IACH;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;IAEjC;;;;OAIG;IACH;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACxB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IACxB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;;OAIG;IACH;;;;OAIG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAE9B;;;;;;;OAOG;IACH;;;;OAIG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB;;;;OAIG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;IAC7C;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC;IAClC;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CAC5C"}

package/esm/components/use-input/use-input-format.type.d.ts

@@ -4,28 +4,48 @@ export interface InputFormatProps {
     value: InputValue;
     onChange: (value: InputValue) => void;
     /**
-     * 是否去除前后空格
+     * @en Whether to remove leading and trailing spaces
+     * @cn 是否去除前后空格
      */
     trim?: boolean;
+    /**
+     * @en Same as the type of the native input tag
+     * @cn 同原生 input 标签的 type
+     * @override string
+     * @default 'text'
+     */
     type?: React.InputHTMLAttributes<HTMLInputElement>['type'];
+    /**
+     * @en Number type supports "positive" and "non-negative", only works when type = number
+     * @cn 设置数字类型 支持 "positive" 和 "non-negative", 仅在 type = number 下生效
+     */
     numType?: 'non-negative' | 'positive';
+    /**
+     * @en Show as thousands separator, valid only when type is "number"
+     * @cn 以千位分隔符展示,仅当 type 为 number 时有效
+     * @default false
+     */
     coin?: boolean;
     /**
-     * 整数位数限制, 仅在 type = number 下生效
+     * @en Integer limit, only works when type = number
+     * @cn 整数位数限制, 仅在 type = number 下生效
      */
     integerLimit?: number;
     /**
-     * 小数位数限制, 仅在 type = number 下生效
+     * @en Decimal limit, only works when type = number
+     * @cn 小数位数限制, 仅在 type = number 下生效
      */
     digits?: number;
     /**
-     * 是否自动补全小数位数, 仅在 type = number 下生效
+     * @en Whether to automatically complete the number of decimal places, only works when type = number
+     * @cn 是否自动补全小数位数, 仅在 type = number 下生效
      */
     autoFix?: boolean;
     onBlur?: React.FocusEventHandler;
     onFocus?: React.FocusEventHandler;
     /**
-     * 取消 blur 触发 onChange,用于多层嵌套的格式化，只在最外层触发一次onChange
+     * @en Cancel blur trigger onChange, used for multi-layer nesting of formatting, only trigger onChange once at the outermost layer
+     * @cn 取消 blur 触发 onChange,用于多层嵌套的格式化，只在最外层触发一次onChange
      */
     cancelBlurChange?: boolean;
 }

package/esm/components/use-input/use-input-format.type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-input-format.type.d.ts","sourceRoot":"","sources":["use-input-format.type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,oBAAY,UAAU,GAAG,MAAM,GAAG,SAAS,CAAC;AAC5C,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,UAAU,CAAC;IAClB,QAAQ,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,IAAI,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;IAC3D,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC;IACtC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC;IACjC,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC;IAClC;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B"}
+{"version":3,"file":"use-input-format.type.d.ts","sourceRoot":"","sources":["use-input-format.type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,oBAAY,UAAU,GAAG,MAAM,GAAG,SAAS,CAAC;AAC5C,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,UAAU,CAAC;IAClB,QAAQ,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;IACtC;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;;;;OAKG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;IAC3D;;;OAGG;IACH,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC;IACtC;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,MAAM,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC;IACjC,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC;IAClC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B"}

package/esm/components/use-input/use-input-number.type.d.ts

@@ -3,9 +3,26 @@ export declare type NumberValue = string | number | undefined | null;
 export interface InputNumberProps extends Omit<InputFormatProps, 'value' | 'onChange' | 'autoFix' | 'trim' | 'coin' | 'type'> {
     value: NumberValue;
     onChange: (value: NumberValue) => void | undefined;
+    /**
+     * @en Minimum value
+     * @cn 最小值
+     */
     min?: number;
+    /**
+     * @en Maximum value
+     * @cn 最大值
+     */
     max?: number;
+    /**
+     * @en Allow value is null
+     * @cn 清空后值为 null
+     */
     allowNull?: boolean;
+    /**
+     * @en Change the digital span. It can be decimal
+     * @cn 改变数字跨度，可为小数
+     * @default 1
+     */
     step?: number;
     disabled?: boolean;
 }

package/esm/components/use-input/use-input-number.type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-input-number.type.d.ts","sourceRoot":"","sources":["use-input-number.type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAE3D,oBAAY,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;AAC7D,MAAM,WAAW,gBACf,SAAQ,IAAI,CAAC,gBAAgB,EAAE,OAAO,GAAG,UAAU,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC3F,KAAK,EAAE,WAAW,CAAC;IACnB,QAAQ,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,GAAG,SAAS,CAAC;IACnD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB"}
+{"version":3,"file":"use-input-number.type.d.ts","sourceRoot":"","sources":["use-input-number.type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAE3D,oBAAY,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;AAC7D,MAAM,WAAW,gBACf,SAAQ,IAAI,CAAC,gBAAgB,EAAE,OAAO,GAAG,UAAU,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC3F,KAAK,EAAE,WAAW,CAAC;IACnB,QAAQ,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,GAAG,SAAS,CAAC;IACnD;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB"}