shineout 3.8.0-beta.9 → 3.8.0

package/README-zh_CN.md

@@ -11,7 +11,7 @@
 <p align="center">
   <a href="https://www.npmjs.com/package/shineout"><img src="https://img.shields.io/npm/v/shineout.svg?style=flat-square"></a>
   <a href="https://www.npmjs.com/package/shineout"><img src="https://img.shields.io/npm/dm/shineout.svg?style=flat-square"></a>
-  <img src="https://img.shields.io/badge/React-%3E%3D16.8.0-green.svg?style=flat-square">
+  <img src="https://img.shields.io/badge/React-%3E%3D16.14.0-green.svg?style=flat-square">
 </p>
 
 ## ✨ 特性

package/README.md

@@ -11,7 +11,7 @@ English | [简体中文](./README-zh_CN.md)
 <p align="center">
   <a href="https://www.npmjs.com/package/shineout"><img src="https://img.shields.io/npm/v/shineout.svg?style=flat-square"></a>
   <a href="https://www.npmjs.com/package/shineout"><img src="https://img.shields.io/npm/dm/shineout.svg?style=flat-square"></a>
-  <img src="https://img.shields.io/badge/React-%3E%3D16.8.0-green.svg?style=flat-square">
+  <img src="https://img.shields.io/badge/React-%3E%3D16.14.0-green.svg?style=flat-square">
 </p>
 
 ## ✨ Features

package/cjs/breadcrumb/breadcrumb.js

@@ -17,7 +17,8 @@ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol"
 function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 var jssStyle = {
   breadcrumb: _shineoutStyle.useBreadcrumbStyle,
-  popover: _shineoutStyle.usePopoverStyle
+  popover: _shineoutStyle.usePopoverStyle,
+  tooltip: _shineoutStyle.useTooltipStyle
 };
 var _default = exports.default = function _default(props) {
   return /*#__PURE__*/(0, _jsxRuntime.jsx)(_base.Breadcrumb, _objectSpread({

package/cjs/cascader/cascader.d.ts

@@ -1,4 +1,7 @@
 import { KeygenResult } from '@sheinx/hooks';
 import { CascaderProps } from './cascader.type';
-declare const _default: <DataItem, Value extends KeygenResult[]>(props: CascaderProps<DataItem, Value>) => import("react/jsx-runtime").JSX.Element;
+declare const _default: {
+    <DataItem, Value extends KeygenResult[]>(props: CascaderProps<DataItem, Value>): import("react/jsx-runtime").JSX.Element;
+    displayName: string;
+};
 export default _default;

package/cjs/cascader/cascader.js

@@ -34,6 +34,7 @@ var Cascader = function Cascader(props) {
     jssStyle: jssStyle
   }));
 };
+Cascader.displayName = 'ShineoutCascader';
 var _default = exports.default = /*#__PURE__*/(0, _react.memo)(function (props) {
   return (0, _useFieldCommon.default)(props, Cascader, 'array');
 });

package/cjs/checkbox/checkbox.js

@@ -25,6 +25,7 @@ var BaseCheckbox = function BaseCheckbox(props) {
     jssStyle: jssStyle
   }));
 };
+BaseCheckbox.displayName = 'ShineoutCheckbox';
 var Checkbox = function Checkbox(props) {
   return (0, _useFieldCommon.default)(props, BaseCheckbox);
 };

package/cjs/checkbox/group.js

@@ -19,12 +19,13 @@ var jssStyle = {
   checkbox: _shineoutStyle.useCheckboxStyle,
   input: _shineoutStyle.useInputStyle
 };
-var BaseCheckboxGroup = function BaseCheckboxGroup(props) {
+var CheckboxGroup = function CheckboxGroup(props) {
   return /*#__PURE__*/(0, _jsxRuntime.jsx)(_base.CheckboxGroup, _objectSpread(_objectSpread({}, props), {}, {
     jssStyle: jssStyle
   }));
 };
+CheckboxGroup.displayName = 'ShineoutCheckboxGroup';
 var CheckboxGroupWithField = function CheckboxGroupWithField(props) {
-  return (0, _useFieldCommon.default)(props, BaseCheckboxGroup, 'array');
+  return (0, _useFieldCommon.default)(props, CheckboxGroup, 'array');
 };
 var _default = exports.default = CheckboxGroupWithField;

package/cjs/date-picker/date-picker.js

@@ -24,11 +24,12 @@ var jssStyle = {
   popover: _shineoutStyle.usePopoverStyle,
   link: _shineoutStyle.useLinkStyle
 };
-var BaseDatePicker = function BaseDatePicker(props) {
+var DatePicker = function DatePicker(props) {
   return /*#__PURE__*/(0, _jsxRuntime.jsx)(_base.DatePicker, _objectSpread({
     jssStyle: jssStyle
   }, props));
 };
+DatePicker.displayName = 'ShineoutDatePicker';
 var _default = exports.default = function _default(props) {
   var _useConfig = (0, _base.useConfig)(),
     locale = _useConfig.locale;
@@ -55,5 +56,5 @@ var _default = exports.default = function _default(props) {
   }, []);
   return (0, _useFieldCommon.default)(_objectSpread(_objectSpread({}, props), {}, {
     defaultValue: defaultValue
-  }), BaseDatePicker);
+  }), DatePicker);
 };

package/cjs/editable-area/editable-area.js

@@ -25,6 +25,7 @@ var EditableArea = function EditableArea(props) {
     jssStyle: jssStyle
   }, props));
 };
+EditableArea.displayName = 'ShineoutEditableArea';
 var _default = exports.default = function _default(props) {
   return (0, _useFieldCommon.default)(props, EditableArea);
 };

package/cjs/empty/empty.type.d.ts

@@ -1,5 +1,19 @@
+/// <reference types="react" />
 import { EmptyProps as UnStyledEmptyProps } from '@sheinx/base';
 /**
  * @title Empty
  */
-export type EmptyProps = Omit<UnStyledEmptyProps, 'jssStyle'>;
+export interface EmptyProps extends Omit<UnStyledEmptyProps, 'jssStyle' | 'icon' | 'description'> {
+    /**
+     * @en Empty state icon. Enhanced in v3.8.0 to support global configuration via setConfig
+     * @cn 空状态图标。3.8.0版本增强，支持通过setConfig进行全局配置
+     * @version 3.8.0
+     */
+    icon?: React.ReactNode;
+    /**
+     * @en Description, if false, the description will not be displayed. Enhanced in v3.8.0 to support global configuration via setConfig
+     * @cn 描述，若为false则不显示描述。3.8.0版本增强，支持通过setConfig进行全局配置
+     * @version 3.8.0
+     */
+    description?: React.ReactNode | boolean;
+}

package/cjs/form/form.type.d.ts

@@ -1,12 +1,17 @@
 import { FormFieldProps as UiFormFieldProps, FormFieldSetProps as UiFormFieldSetProps, FormItemProps as UiFormItemProps, FormProps as UiFormProps, ObjectType, FormFlowProps as UiFormFlowProps, FormRef as UiFormRef, FormDatum as UiFormDatum } from '@sheinx/base';
+import { ButtonProps } from '../button/button.type';
 /**
  * @title FormRef
  * @sort 6
+ * @en Form reference object that provides a series of methods to operate the form. After obtaining the instance through ref or useForm, you can actively control the form's validation, submission, reset and other behaviors
+ * @cn 表单引用对象，提供了一系列操作表单的方法。通过 ref 或 useForm 获取实例后，可以主动控制表单的校验、提交、重置等行为
  */
 export type FormRef<T> = UiFormRef<T>;
 /**
  * @title FormDatum
  * @sort 7
+ * @en Form data management object, used to manage the internal data state and validation logic of the form
+ * @cn 表单数据管理对象，用于管理表单内部的数据状态和校验逻辑
  */
 export type FormDatum = UiFormDatum;
 /**
@@ -15,34 +20,56 @@ export type FormDatum = UiFormDatum;
  */
 export interface FormProps<T extends ObjectType> extends Omit<UiFormProps<T>, 'jssStyle'> {
     /**
-     * @en Form value
-     * @cn 表单数据
+     * @en When set, the form becomes a controlled component and needs to be used with onChange. Suitable for scenarios where external management of form state is required, such as sharing form data across components, real-time synchronization of form data to state managers, etc.
+     * @cn 设置后表单变为受控组件，需要配合 onChange 使用。适用于需要外部管理表单状态的场景，如跨组件共享表单数据、实时同步表单数据到状态管理器等
      * @override object
      */
     value?: T;
     /**
-     * @en callback function, executed when the value is changing
-     * @cn 表单内组件值变化函数
+     * @en Must be set in controlled mode to update external state. Triggered whenever any field value in the form changes, with the parameter being the latest data of the entire form
+     * @cn 在受控模式下必须设置此函数来更新外部状态。每当表单内任意字段值改变时都会触发，参数为整个表单的最新数据
      */
     onChange?: (value: T) => void;
 }
 /**
  * @title Form.Item
  * @sort 2
+ * @en Form item component, used to wrap form controls and provide label, error tips and other functions. Each form control should be wrapped with Form.Item to properly display labels and validation information
+ * @cn 表单项组件，用于包装表单控件并提供标签、错误提示等功能。每个表单控件都应该被 Form.Item 包裹，以便正确显示标签和校验信息
  */
 export type FormItemProps = Omit<UiFormItemProps, 'jssStyle'>;
 /**
  * @title Form.Field
  * @sort 3
+ * @en Form field component for creating custom form controls. Provides form data binding, validation and other functions, suitable for encapsulating complex custom form components
+ * @cn 表单字段组件，用于创建自定义的表单控件。提供了表单数据绑定、校验等功能，适用于封装复杂的自定义表单组件
  */
 export type FormFieldProps<T> = UiFormFieldProps<T>;
 /**
  * @title Form.FieldSet
  * @sort 4
+ * @en Form field set component for managing a group of related form fields. Suitable for handling object or array type form data, such as dynamic form lists, nested objects and other complex scenarios
+ * @cn 表单字段集组件，用于管理一组相关的表单字段。适用于处理对象或数组类型的表单数据，如动态表单列表、嵌套对象等复杂场景
  */
 export type FormFieldSetProps<T> = UiFormFieldSetProps<T>;
 /**
  * @title Form.Flow
  * @sort 5
+ * @en Form flow component for listening to form data changes and executing corresponding side effects. Suitable for implementing form linkage, conditional rendering and other scenarios
+ * @cn 表单流程组件，用于监听表单数据变化并执行相应的副作用。适用于实现表单联动、条件渲染等场景
  */
 export type FormFlowProps = UiFormFlowProps;
+/**
+ * @title Form.Button
+ * @sort 8
+ * @en Form button component with htmlType='button'. Prevents accidental form submission when users press Enter in form inputs. Users must explicitly click the button to submit the form. Internally calls formFunc.submit() for better control over submission logic
+ * @cn 表单按钮组件，htmlType='button'。防止用户在表单输入框中按回车键时意外提交表单。用户必须显式点击按钮才能提交表单。内部调用 formFunc.submit() 以更好地控制提交逻辑
+ */
+export type FormButtonProps = ButtonProps;
+/**
+ * @title Form.Submit
+ * @sort 9
+ * @en Form submit button component with htmlType='submit'. Uses native browser submit behavior. When users press Enter in any form input, it will trigger this button automatically. Suitable for simple forms where Enter-to-submit behavior is desired
+ * @cn 表单提交按钮组件，htmlType='submit'。使用浏览器原生提交行为。当用户在任何表单输入框中按回车键时，会自动触发此按钮。适用于希望支持回车提交的简单表单
+ */
+export type FormSubmitProps = ButtonProps;

package/cjs/index.js

@@ -522,5 +522,5 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 // 此文件由脚本自动生成，请勿直接修改。
 // This file was generated automatically by a script. Please do not modify it directly.
 var _default = exports.default = {
-  version: '3.8.0-beta.9'
+  version: '3.8.0'
 };

package/cjs/input/input.js

@@ -28,6 +28,7 @@ var Input = function Input(props) {
     jssStyle: jssStyle
   }));
 };
+Input.displayName = 'ShineoutInput';
 var _default = exports.default = /*#__PURE__*/(0, _react.memo)(function (props) {
   return (0, _useFieldCommon.default)(props, Input);
 });

package/cjs/input/number.js

@@ -26,6 +26,7 @@ var InputNumber = function InputNumber(props) {
     jssStyle: jssStyle
   }));
 };
+InputNumber.displayName = 'ShineoutInputNumber';
 var _default = exports.default = function _default(props) {
   return (0, _useFieldCommon.default)(props, InputNumber, 'number');
 };

package/cjs/input/password.js

@@ -25,6 +25,7 @@ var InputPassword = function InputPassword(props) {
     jssStyle: jssStyle
   }));
 };
+InputPassword.displayName = 'ShineoutInputPassword';
 var _default = exports.default = function _default(props) {
   return (0, _useFieldCommon.default)(props, InputPassword);
 };

package/cjs/radio/group.js

@@ -19,12 +19,13 @@ var jssStyle = {
   radio: _shineoutStyle.useRadioStyle,
   button: _shineoutStyle.useButtonStyle
 };
-var BaseRadioGroup = function BaseRadioGroup(props) {
+var RadioGroup = function RadioGroup(props) {
   return /*#__PURE__*/(0, _jsxRuntime.jsx)(_base.RadioGroup, _objectSpread(_objectSpread({}, props), {}, {
     jssStyle: jssStyle
   }));
 };
+RadioGroup.displayName = 'ShineoutRadioGroup';
 var RadioGroupWithField = function RadioGroupWithField(props) {
-  return (0, _useFieldCommon.default)(props, BaseRadioGroup, 'array');
+  return (0, _useFieldCommon.default)(props, RadioGroup, 'array');
 };
 var _default = exports.default = RadioGroupWithField;

package/cjs/rate/rate.js

@@ -18,17 +18,18 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 var jssStyle = {
   rate: _shineoutStyle.useRateStyle
 };
-var BaseRate = function BaseRate(props) {
+var Rate = function Rate(props) {
   return /*#__PURE__*/(0, _jsxRuntime.jsx)(_base.Rate, _objectSpread({
     jssStyle: jssStyle
   }, props));
 };
-var Rate = function Rate(props) {
-  return (0, _useFieldCommon.default)(props, BaseRate, 'number');
+Rate.displayName = 'ShineoutRate';
+var WrappedRate = function WrappedRate(props) {
+  return (0, _useFieldCommon.default)(props, Rate, 'number');
 };
 var _default = exports.default = function _default(background, front, opts) {
   var RateIns = function RateIns(props) {
-    return /*#__PURE__*/(0, _jsxRuntime.jsx)(Rate, _objectSpread(_objectSpread({}, opts), {}, {
+    return /*#__PURE__*/(0, _jsxRuntime.jsx)(WrappedRate, _objectSpread(_objectSpread({}, opts), {}, {
       background: background,
       front: front || background
     }, props));

package/cjs/select/select.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
 import { SelectPropsA, SelectPropsB } from './select.type';
-declare function Select<DataItem, Value>(props: SelectPropsA<DataItem, Value>): JSX.Element;
-declare function Select<DataItem, Value>(props: SelectPropsB<DataItem, Value>): JSX.Element;
-export default Select;
+declare function SelectComponent<DataItem, Value>(props: SelectPropsA<DataItem, Value>): JSX.Element;
+declare function SelectComponent<DataItem, Value>(props: SelectPropsB<DataItem, Value>): JSX.Element;
+export default SelectComponent;

package/cjs/select/select.js

@@ -27,12 +27,13 @@ var jssStyle = {
   spin: _shineoutStyle.useSpinStyle,
   common: _shineoutStyle.useCommonStyle
 };
-function SelectComponent(props) {
+function Select(props) {
   return /*#__PURE__*/(0, _jsxRuntime.jsx)(_base.Select, _objectSpread({
     jssStyle: jssStyle
   }, props));
 }
-function Select(props) {
-  return (0, _useFieldCommon.default)(props, SelectComponent, 'array');
+Select.displayName = 'ShineoutSelect';
+function SelectComponent(props) {
+  return (0, _useFieldCommon.default)(props, Select, 'array');
 }
-var _default = exports.default = Select;
+var _default = exports.default = SelectComponent;

package/cjs/slider/slider.js

@@ -24,6 +24,7 @@ var BaseSlider = function BaseSlider(props) {
     jssStyle: jssStyle
   }, props));
 };
+BaseSlider.displayName = 'ShineoutSlider';
 var _default = exports.default = function _default(props) {
   return (0, _useFieldCommon.default)(props, BaseSlider, 'number');
 };

package/cjs/switch/switch.js

@@ -18,11 +18,12 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 var jssStyle = {
   switch: _shineoutStyle.useSwitchStyle
 };
-var BaseSwitch = function BaseSwitch(props) {
+var Switch = function Switch(props) {
   return /*#__PURE__*/(0, _jsxRuntime.jsx)(_base.Switch, _objectSpread({
     jssStyle: jssStyle
   }, props));
 };
+Switch.displayName = 'ShineoutSwitch';
 var _default = exports.default = function _default(props) {
-  return (0, _useFieldCommon.default)(props, BaseSwitch);
+  return (0, _useFieldCommon.default)(props, Switch);
 };

package/cjs/textarea/textarea.js

@@ -20,11 +20,12 @@ var jssStyle = {
   popover: _shineoutStyle.usePopoverStyle,
   innerTitle: _shineoutStyle.useInnerTitleStyle
 };
-var BaseTextarea = function BaseTextarea(props) {
+var Textarea = function Textarea(props) {
   return /*#__PURE__*/(0, _jsxRuntime.jsx)(_base.Textarea, _objectSpread(_objectSpread({}, props), {}, {
     jssStyle: jssStyle
   }));
 };
+Textarea.displayName = 'ShineoutTextarea';
 var _default = exports.default = function _default(props) {
-  return (0, _useFieldCommon.default)(props, BaseTextarea);
+  return (0, _useFieldCommon.default)(props, Textarea);
 };

package/cjs/tree-select/tree-select.js

@@ -34,6 +34,7 @@ var TreeSelectComponent = function TreeSelectComponent(props) {
     jssStyle: jssStyle
   }, props));
 };
+TreeSelectComponent.displayName = 'ShineoutTreeSelect';
 var TreeSelect = function TreeSelect(props) {
   return (0, _useFieldCommon.default)(props, TreeSelectComponent, 'array');
 };

package/cjs/upload/button.js

@@ -29,6 +29,7 @@ var BaseUploadButton = function BaseUploadButton(props) {
     jssStyle: jssStyle
   }, props));
 };
+BaseUploadButton.displayName = 'ShineoutUploadButton';
 var _default = exports.default = function _default(props) {
   var customProps = (0, _useUploadCommon.default)({
     rules: props.rules

package/cjs/upload/image.js

@@ -29,6 +29,7 @@ var BaseUploadImage = function BaseUploadImage(props) {
     jssStyle: jssStyle
   }, props));
 };
+BaseUploadImage.displayName = 'ShineoutUploadImage';
 var _default = exports.default = function _default(props) {
   var customProps = (0, _useUploadCommon.default)({
     rules: props.rules

package/cjs/upload/upload.js

@@ -29,6 +29,7 @@ var BaseUpload = function BaseUpload(props) {
     jssStyle: jssStyle
   }, props));
 };
+BaseUpload.displayName = 'ShineoutUpload';
 var _default = exports.default = function _default(props) {
   var customProps = (0, _useUploadCommon.default)({
     rules: props.rules