shineout 3.8.0-beta.3 → 3.8.0-beta.31

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README-zh_CN.md CHANGED
@@ -11,7 +11,7 @@
11
11
  <p align="center">
12
12
  <a href="https://www.npmjs.com/package/shineout"><img src="https://img.shields.io/npm/v/shineout.svg?style=flat-square"></a>
13
13
  <a href="https://www.npmjs.com/package/shineout"><img src="https://img.shields.io/npm/dm/shineout.svg?style=flat-square"></a>
14
- <img src="https://img.shields.io/badge/React-%3E%3D16.8.0-green.svg?style=flat-square">
14
+ <img src="https://img.shields.io/badge/React-%3E%3D16.14.0-green.svg?style=flat-square">
15
15
  </p>
16
16
 
17
17
  ## ✨ 特性
package/README.md CHANGED
@@ -11,7 +11,7 @@ English | [简体中文](./README-zh_CN.md)
11
11
  <p align="center">
12
12
  <a href="https://www.npmjs.com/package/shineout"><img src="https://img.shields.io/npm/v/shineout.svg?style=flat-square"></a>
13
13
  <a href="https://www.npmjs.com/package/shineout"><img src="https://img.shields.io/npm/dm/shineout.svg?style=flat-square"></a>
14
- <img src="https://img.shields.io/badge/React-%3E%3D16.8.0-green.svg?style=flat-square">
14
+ <img src="https://img.shields.io/badge/React-%3E%3D16.14.0-green.svg?style=flat-square">
15
15
  </p>
16
16
 
17
17
  ## ✨ Features
@@ -17,7 +17,8 @@ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol"
17
17
  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); }
18
18
  var jssStyle = {
19
19
  breadcrumb: _shineoutStyle.useBreadcrumbStyle,
20
- popover: _shineoutStyle.usePopoverStyle
20
+ popover: _shineoutStyle.usePopoverStyle,
21
+ tooltip: _shineoutStyle.useTooltipStyle
21
22
  };
22
23
  var _default = exports.default = function _default(props) {
23
24
  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_base.Breadcrumb, _objectSpread({
@@ -19,12 +19,12 @@ var jssStyle = {
19
19
  checkbox: _shineoutStyle.useCheckboxStyle,
20
20
  input: _shineoutStyle.useInputStyle
21
21
  };
22
- var BaseCheckboxGroup = function BaseCheckboxGroup(props) {
22
+ var CheckboxGroup = function CheckboxGroup(props) {
23
23
  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_base.CheckboxGroup, _objectSpread(_objectSpread({}, props), {}, {
24
24
  jssStyle: jssStyle
25
25
  }));
26
26
  };
27
27
  var CheckboxGroupWithField = function CheckboxGroupWithField(props) {
28
- return (0, _useFieldCommon.default)(props, BaseCheckboxGroup, 'array');
28
+ return (0, _useFieldCommon.default)(props, CheckboxGroup, 'array');
29
29
  };
30
30
  var _default = exports.default = CheckboxGroupWithField;
@@ -24,7 +24,7 @@ var jssStyle = {
24
24
  popover: _shineoutStyle.usePopoverStyle,
25
25
  link: _shineoutStyle.useLinkStyle
26
26
  };
27
- var BaseDatePicker = function BaseDatePicker(props) {
27
+ var DatePicker = function DatePicker(props) {
28
28
  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_base.DatePicker, _objectSpread({
29
29
  jssStyle: jssStyle
30
30
  }, props));
@@ -55,5 +55,5 @@ var _default = exports.default = function _default(props) {
55
55
  }, []);
56
56
  return (0, _useFieldCommon.default)(_objectSpread(_objectSpread({}, props), {}, {
57
57
  defaultValue: defaultValue
58
- }), BaseDatePicker);
58
+ }), DatePicker);
59
59
  };
@@ -1,5 +1,19 @@
1
+ /// <reference types="react" />
1
2
  import { EmptyProps as UnStyledEmptyProps } from '@sheinx/base';
2
3
  /**
3
4
  * @title Empty
4
5
  */
5
- export type EmptyProps = Omit<UnStyledEmptyProps, 'jssStyle'>;
6
+ export interface EmptyProps extends Omit<UnStyledEmptyProps, 'jssStyle' | 'icon' | 'description'> {
7
+ /**
8
+ * @en Empty state icon. Enhanced in v3.8.0 to support global configuration via setConfig
9
+ * @cn 空状态图标。3.8.0版本增强,支持通过setConfig进行全局配置
10
+ * @version 3.8.0
11
+ */
12
+ icon?: React.ReactNode;
13
+ /**
14
+ * @en Description, if false, the description will not be displayed. Enhanced in v3.8.0 to support global configuration via setConfig
15
+ * @cn 描述,若为false则不显示描述。3.8.0版本增强,支持通过setConfig进行全局配置
16
+ * @version 3.8.0
17
+ */
18
+ description?: React.ReactNode | boolean;
19
+ }
@@ -1,43 +1,60 @@
1
- import { FormFieldProps as UiFormFieldProps, FormFieldSetProps as UiFormFieldSetProps, FormItemProps as UiFormItemProps, FormProps as UiFormProps, ObjectType, FormFlowProps as UiFormFlowProps, FormRef as UiFormRef } from '@sheinx/base';
1
+ 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';
2
2
  /**
3
3
  * @title FormRef
4
4
  * @sort 6
5
+ * @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
6
+ * @cn 表单引用对象,提供了一系列操作表单的方法。通过 ref 或 useForm 获取实例后,可以主动控制表单的校验、提交、重置等行为
5
7
  */
6
8
  export type FormRef<T> = UiFormRef<T>;
9
+ /**
10
+ * @title FormDatum
11
+ * @sort 7
12
+ * @en Form data management object, used to manage the internal data state and validation logic of the form
13
+ * @cn 表单数据管理对象,用于管理表单内部的数据状态和校验逻辑
14
+ */
15
+ export type FormDatum = UiFormDatum;
7
16
  /**
8
17
  * @title Form
9
18
  * @sort 1
10
19
  */
11
20
  export interface FormProps<T extends ObjectType> extends Omit<UiFormProps<T>, 'jssStyle'> {
12
21
  /**
13
- * @en Form value
14
- * @cn 表单数据
22
+ * @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.
23
+ * @cn 设置后表单变为受控组件,需要配合 onChange 使用。适用于需要外部管理表单状态的场景,如跨组件共享表单数据、实时同步表单数据到状态管理器等
15
24
  * @override object
16
25
  */
17
26
  value?: T;
18
27
  /**
19
- * @en callback function, executed when the value is changing
20
- * @cn 表单内组件值变化函数
28
+ * @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
29
+ * @cn 在受控模式下必须设置此函数来更新外部状态。每当表单内任意字段值改变时都会触发,参数为整个表单的最新数据
21
30
  */
22
31
  onChange?: (value: T) => void;
23
32
  }
24
33
  /**
25
34
  * @title Form.Item
26
35
  * @sort 2
36
+ * @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
37
+ * @cn 表单项组件,用于包装表单控件并提供标签、错误提示等功能。每个表单控件都应该被 Form.Item 包裹,以便正确显示标签和校验信息
27
38
  */
28
39
  export type FormItemProps = Omit<UiFormItemProps, 'jssStyle'>;
29
40
  /**
30
41
  * @title Form.Field
31
42
  * @sort 3
43
+ * @en Form field component for creating custom form controls. Provides form data binding, validation and other functions, suitable for encapsulating complex custom form components
44
+ * @cn 表单字段组件,用于创建自定义的表单控件。提供了表单数据绑定、校验等功能,适用于封装复杂的自定义表单组件
32
45
  */
33
46
  export type FormFieldProps<T> = UiFormFieldProps<T>;
34
47
  /**
35
48
  * @title Form.FieldSet
36
49
  * @sort 4
50
+ * @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
51
+ * @cn 表单字段集组件,用于管理一组相关的表单字段。适用于处理对象或数组类型的表单数据,如动态表单列表、嵌套对象等复杂场景
37
52
  */
38
53
  export type FormFieldSetProps<T> = UiFormFieldSetProps<T>;
39
54
  /**
40
55
  * @title Form.Flow
41
56
  * @sort 5
57
+ * @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
58
+ * @cn 表单流程组件,用于监听表单数据变化并执行相应的副作用。适用于实现表单联动、条件渲染等场景
42
59
  */
43
60
  export type FormFlowProps = UiFormFlowProps;
@@ -1,3 +1,3 @@
1
1
  export type { FormRef as Ref, FormFieldChildrenFunc as FieldChildrenFunc, FormFieldSetChildrenFunc as FieldSetChildrenFunc, } from '@sheinx/base';
2
- export type { FormProps as Props, FormItemProps as ItemProps, FormFieldProps as FieldProps, FormFieldSetProps as FieldSetProps, } from './form.type';
2
+ export type { FormProps as Props, FormItemProps as ItemProps, FormFieldProps as FieldProps, FormFieldSetProps as FieldSetProps, FormFlowProps as FlowProps, FormDatum as Datum, } from './form.type';
3
3
  export type { ButtonProps as SubmitProps, ButtonProps as ResetProps } from '../button/button.type';
package/cjs/index.d.ts CHANGED
@@ -53,7 +53,7 @@ export { setConfig, config, setLocale, setIcons, icons } from '@sheinx/base';
53
53
  export type { ConfigOption } from '@sheinx/base';
54
54
  export { setToken, useToken } from '@sheinx/theme';
55
55
  export { JssProvider, SheetsRegistry, setJssConfig, scopeNormalizeStyle, } from '@sheinx/shineout-style';
56
- export * as utls from './utils';
56
+ export * as utils from './utils';
57
57
  export * from './deprecated';
58
58
  export * as TYPE from './type';
59
59
  declare const _default: {
package/cjs/index.js CHANGED
@@ -68,7 +68,7 @@ var _exportNames = {
68
68
  SheetsRegistry: true,
69
69
  setJssConfig: true,
70
70
  scopeNormalizeStyle: true,
71
- utls: true,
71
+ utils: true,
72
72
  TYPE: true
73
73
  };
74
74
  Object.defineProperty(exports, "Alert", {
@@ -445,7 +445,7 @@ Object.defineProperty(exports, "useToken", {
445
445
  return _theme.useToken;
446
446
  }
447
447
  });
448
- exports.utls = void 0;
448
+ exports.utils = void 0;
449
449
  var _alert = _interopRequireDefault(require("./alert"));
450
450
  var _avatar = _interopRequireDefault(require("./avatar"));
451
451
  var _badge = _interopRequireDefault(require("./badge"));
@@ -500,8 +500,8 @@ var _upload = _interopRequireDefault(require("./upload"));
500
500
  var _base = require("@sheinx/base");
501
501
  var _theme = require("@sheinx/theme");
502
502
  var _shineoutStyle = require("@sheinx/shineout-style");
503
- var _utls = _interopRequireWildcard(require("./utils"));
504
- exports.utls = _utls;
503
+ var _utils = _interopRequireWildcard(require("./utils"));
504
+ exports.utils = _utils;
505
505
  var _deprecated = require("./deprecated");
506
506
  Object.keys(_deprecated).forEach(function (key) {
507
507
  if (key === "default" || key === "__esModule") return;
@@ -522,5 +522,5 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
522
522
  // 此文件由脚本自动生成,请勿直接修改。
523
523
  // This file was generated automatically by a script. Please do not modify it directly.
524
524
  var _default = exports.default = {
525
- version: '3.8.0-beta.3'
525
+ version: '3.8.0-beta.31'
526
526
  };
@@ -19,12 +19,12 @@ var jssStyle = {
19
19
  radio: _shineoutStyle.useRadioStyle,
20
20
  button: _shineoutStyle.useButtonStyle
21
21
  };
22
- var BaseRadioGroup = function BaseRadioGroup(props) {
22
+ var RadioGroup = function RadioGroup(props) {
23
23
  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_base.RadioGroup, _objectSpread(_objectSpread({}, props), {}, {
24
24
  jssStyle: jssStyle
25
25
  }));
26
26
  };
27
27
  var RadioGroupWithField = function RadioGroupWithField(props) {
28
- return (0, _useFieldCommon.default)(props, BaseRadioGroup, 'array');
28
+ return (0, _useFieldCommon.default)(props, RadioGroup, 'array');
29
29
  };
30
30
  var _default = exports.default = RadioGroupWithField;
package/cjs/rate/rate.js CHANGED
@@ -18,17 +18,17 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
18
18
  var jssStyle = {
19
19
  rate: _shineoutStyle.useRateStyle
20
20
  };
21
- var BaseRate = function BaseRate(props) {
21
+ var Rate = function Rate(props) {
22
22
  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_base.Rate, _objectSpread({
23
23
  jssStyle: jssStyle
24
24
  }, props));
25
25
  };
26
- var Rate = function Rate(props) {
27
- return (0, _useFieldCommon.default)(props, BaseRate, 'number');
26
+ var WrappedRate = function WrappedRate(props) {
27
+ return (0, _useFieldCommon.default)(props, Rate, 'number');
28
28
  };
29
29
  var _default = exports.default = function _default(background, front, opts) {
30
30
  var RateIns = function RateIns(props) {
31
- return /*#__PURE__*/(0, _jsxRuntime.jsx)(Rate, _objectSpread(_objectSpread({}, opts), {}, {
31
+ return /*#__PURE__*/(0, _jsxRuntime.jsx)(WrappedRate, _objectSpread(_objectSpread({}, opts), {}, {
32
32
  background: background,
33
33
  front: front || background
34
34
  }, props));
@@ -1,5 +1,5 @@
1
1
  /// <reference types="react" />
2
2
  import { SelectPropsA, SelectPropsB } from './select.type';
3
- declare function Select<DataItem, Value>(props: SelectPropsA<DataItem, Value>): JSX.Element;
4
- declare function Select<DataItem, Value>(props: SelectPropsB<DataItem, Value>): JSX.Element;
5
- export default Select;
3
+ declare function SelectComponent<DataItem, Value>(props: SelectPropsA<DataItem, Value>): JSX.Element;
4
+ declare function SelectComponent<DataItem, Value>(props: SelectPropsB<DataItem, Value>): JSX.Element;
5
+ export default SelectComponent;
@@ -27,12 +27,12 @@ var jssStyle = {
27
27
  spin: _shineoutStyle.useSpinStyle,
28
28
  common: _shineoutStyle.useCommonStyle
29
29
  };
30
- function SelectComponent(props) {
30
+ function Select(props) {
31
31
  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_base.Select, _objectSpread({
32
32
  jssStyle: jssStyle
33
33
  }, props));
34
34
  }
35
- function Select(props) {
36
- return (0, _useFieldCommon.default)(props, SelectComponent, 'array');
35
+ function SelectComponent(props) {
36
+ return (0, _useFieldCommon.default)(props, Select, 'array');
37
37
  }
38
- var _default = exports.default = Select;
38
+ var _default = exports.default = SelectComponent;
@@ -18,11 +18,11 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
18
18
  var jssStyle = {
19
19
  switch: _shineoutStyle.useSwitchStyle
20
20
  };
21
- var BaseSwitch = function BaseSwitch(props) {
21
+ var Switch = function Switch(props) {
22
22
  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_base.Switch, _objectSpread({
23
23
  jssStyle: jssStyle
24
24
  }, props));
25
25
  };
26
26
  var _default = exports.default = function _default(props) {
27
- return (0, _useFieldCommon.default)(props, BaseSwitch);
27
+ return (0, _useFieldCommon.default)(props, Switch);
28
28
  };
@@ -20,11 +20,11 @@ var jssStyle = {
20
20
  popover: _shineoutStyle.usePopoverStyle,
21
21
  innerTitle: _shineoutStyle.useInnerTitleStyle
22
22
  };
23
- var BaseTextarea = function BaseTextarea(props) {
23
+ var Textarea = function Textarea(props) {
24
24
  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_base.Textarea, _objectSpread(_objectSpread({}, props), {}, {
25
25
  jssStyle: jssStyle
26
26
  }));
27
27
  };
28
28
  var _default = exports.default = function _default(props) {
29
- return (0, _useFieldCommon.default)(props, BaseTextarea);
29
+ return (0, _useFieldCommon.default)(props, Textarea);
30
30
  };