@arcblock/ux 2.5.50 → 2.5.52

package/lib/Button/index.js

@@ -11,6 +11,9 @@ var _wrap = _interopRequireDefault(require("./wrap"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-var _default = (0, _wrap.default)(_Button.default);
+// @ts-check
 
+/** @type {import('./wrap').ButtonComponent} */
+const ButtonComponent = (0, _wrap.default)(_Button.default);
+var _default = ButtonComponent;
 exports.default = _default;

package/lib/Button/wrap.js

@@ -62,11 +62,15 @@ const extendedColors = {
  * } & import('@mui/material').ButtonProps} ButtonProps
  */
 
+/**
+ * @typedef {React.ForwardRefExoticComponent<React.PropsWithoutRef<ButtonProps> & React.RefAttributes<HTMLButtonElement>>} ButtonComponent
+ */
+
 /**
  * @description
  * @export
  * @param {import('@mui/material').ExtendButtonBase<import('@mui/material').ButtonTypeMap<{}, "button">>} BaseComponent
- * @return {React.ForwardRefExoticComponent<React.PropsWithoutRef<ButtonProps> & React.RefAttributes<HTMLButtonElement>>}
+ * @return {ButtonComponent}
  */
 
 function _default(BaseComponent) {

package/lib/Dialog/dialog.js

@@ -72,7 +72,7 @@ function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) r
 /**
  * @description
  * @param {DialogProps} props
- * @return {React.ReactComponentElement}
+ * @return {React.ReactComponentElement<any, DialogProps>}
  */
 function Dialog(_ref) {
   let {

package/lib/SplitButton/index.js

@@ -52,7 +52,7 @@ function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) r
  * @typedef {{
  *  size?: 'small' | 'medium' | 'large';
  *  color?: 'primary' | 'secondary' | 'inherit';
- *  menu?: Array<import('@mui/material').MenuItem> | import('@mui/material').MenuItem>;
+ *  menu?: Array<import('@mui/material').MenuItem> | import('@mui/material').MenuItem;
  *  children?: JSX.Element | (() => JSX.Element);
  *  variant?: 'outlined' | 'contained';
  *  onClick?: () => void;
@@ -61,12 +61,13 @@ function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) r
  */
 
 /**
- * SplitButton allows the user to execute a default action which is bound to a Button or to choose a predefined action from a drop-down list.
+ * @description SplitButton allows the user to execute a default action which is bound to a Button or to choose a predefined action from a drop-down list.
+ * @export
  * @param {SplitButtonProps} props
- * @returns {JSX.Element}
+ * @return {JSX.Element}
  */
-function SplitButton(_ref) {
-  let {
+function SplitButton(props) {
+  const {
     size,
     color,
     menu,
@@ -74,8 +75,8 @@ function SplitButton(_ref) {
     variant,
     onClick,
     menuButtonProps
-  } = _ref,
-      rest = _objectWithoutProperties(_ref, _excluded);
+  } = props,
+        rest = _objectWithoutProperties(props, _excluded);
 
   const [open, setOpen] = (0, _react.useState)(false);
   const anchorRef = (0, _react.useRef)(null);

package/lib/Toast/index.js

@@ -24,6 +24,12 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
+/**
+ *
+ * @typedef {(message: import('notistack').SnackbarMessage, options?: import('notistack').OptionsObject, ...args: any[]) => import('notistack').SnackbarKey} EnqueueSnackbarFunc
+ *
+ */
+
 /**
  * @type {import('notistack').ProviderContext['enqueueSnackbar']}
  */
@@ -95,10 +101,7 @@ function Toast() {
 
 var _default = {
   /**
-   *
-   * @param {import('notistack').SnackbarMessage} message
-   * @param {import('notistack').OptionsObject} options
-   * @returns {import('notistack').SnackbarKey}
+   * @type {EnqueueSnackbarFunc}
    */
   success: function success(message) {
     let options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
@@ -111,10 +114,7 @@ var _default = {
   },
 
   /**
-   *
-   * @param {import('notistack').SnackbarMessage} message
-   * @param {import('notistack').OptionsObject} options
-   * @returns {import('notistack').SnackbarKey}
+   * @type {EnqueueSnackbarFunc}
    */
   error: function error(message) {
     let options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
@@ -127,10 +127,7 @@ var _default = {
   },
 
   /**
-   *
-   * @param {import('notistack').SnackbarMessage} message
-   * @param {import('notistack').OptionsObject} options
-   * @returns {import('notistack').SnackbarKey}
+   * @type {EnqueueSnackbarFunc}
    */
   warning: function warning(message) {
     let options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
@@ -143,10 +140,7 @@ var _default = {
   },
 
   /**
-   *
-   * @param {import('notistack').SnackbarMessage} message
-   * @param {import('notistack').OptionsObject} options
-   * @returns {import('notistack').SnackbarKey}
+   * @type {EnqueueSnackbarFunc}
    */
   info: function info(message) {
     let options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcblock/ux",
-  "version": "2.5.50",
+  "version": "2.5.52",
   "description": "Common used react components for arcblock products",
   "keywords": [
     "react",
@@ -47,11 +47,11 @@
   "peerDependencies": {
     "react": ">=18.1.0"
   },
-  "gitHead": "8969051be94b3e5107e3f25034661a60fd3da6bb",
+  "gitHead": "6ce02db5c5b7fdf26509dd37161ccb35f3a22ff2",
   "dependencies": {
     "@arcblock/did-motif": "^1.1.10",
-    "@arcblock/icons": "^2.5.50",
-    "@arcblock/react-hooks": "^2.5.50",
+    "@arcblock/icons": "^2.5.52",
+    "@arcblock/react-hooks": "^2.5.52",
     "@babel/plugin-syntax-dynamic-import": "^7.8.3",
     "@emotion/react": "^11.10.4",
     "@emotion/styled": "^11.10.4",

package/src/Button/index.js

@@ -1,4 +1,9 @@
+// @ts-check
+
 import Button from '@mui/material/Button';
 import wrap from './wrap';
 
-export default wrap(Button);
+/** @type {import('./wrap').ButtonComponent} */
+const ButtonComponent = wrap(Button);
+
+export default ButtonComponent;

package/src/Button/wrap.js

@@ -27,11 +27,15 @@ const extendedColors = {
  * } & import('@mui/material').ButtonProps} ButtonProps
  */
 
+/**
+ * @typedef {React.ForwardRefExoticComponent<React.PropsWithoutRef<ButtonProps> & React.RefAttributes<HTMLButtonElement>>} ButtonComponent
+ */
+
 /**
  * @description
  * @export
  * @param {import('@mui/material').ExtendButtonBase<import('@mui/material').ButtonTypeMap<{}, "button">>} BaseComponent
- * @return {React.ForwardRefExoticComponent<React.PropsWithoutRef<ButtonProps> & React.RefAttributes<HTMLButtonElement>>}
+ * @return {ButtonComponent}
  */
 export default function (BaseComponent) {
   /**

package/src/Dialog/dialog.js

@@ -38,7 +38,7 @@ import { styled, useTheme } from '../Theme';
 /**
  * @description
  * @param {DialogProps} props
- * @return {React.ReactComponentElement}
+ * @return {React.ReactComponentElement<any, DialogProps>}
  */
 function Dialog({ children, title, prepend, toolbar, actions, showCloseButton, actionsPosition, PaperProps, ...rest }) {
   const theme = useTheme();

package/src/SplitButton/index.js

@@ -16,7 +16,7 @@ import { styled } from '../Theme';
  * @typedef {{
  *  size?: 'small' | 'medium' | 'large';
  *  color?: 'primary' | 'secondary' | 'inherit';
- *  menu?: Array<import('@mui/material').MenuItem> | import('@mui/material').MenuItem>;
+ *  menu?: Array<import('@mui/material').MenuItem> | import('@mui/material').MenuItem;
  *  children?: JSX.Element | (() => JSX.Element);
  *  variant?: 'outlined' | 'contained';
  *  onClick?: () => void;
@@ -25,11 +25,14 @@ import { styled } from '../Theme';
  */
 
 /**
- * SplitButton allows the user to execute a default action which is bound to a Button or to choose a predefined action from a drop-down list.
+ * @description SplitButton allows the user to execute a default action which is bound to a Button or to choose a predefined action from a drop-down list.
+ * @export
  * @param {SplitButtonProps} props
- * @returns {JSX.Element}
+ * @return {JSX.Element}
  */
-export default function SplitButton({ size, color, menu, children, variant, onClick, menuButtonProps, ...rest }) {
+export default function SplitButton(props) {
+  const { size, color, menu, children, variant, onClick, menuButtonProps, ...rest } = props;
+
   const [open, setOpen] = useState(false);
   const anchorRef = useRef(null);
   const menuItems = Array.isArray(menu)

package/src/Toast/index.js

@@ -3,6 +3,12 @@ import { SnackbarProvider, useSnackbar } from 'notistack';
 import IconButton from '@mui/material/IconButton';
 import CloseIcon from '@mui/icons-material/Close';
 
+/**
+ *
+ * @typedef {(message: import('notistack').SnackbarMessage, options?: import('notistack').OptionsObject, ...args: any[]) => import('notistack').SnackbarKey} EnqueueSnackbarFunc
+ *
+ */
+
 /**
  * @type {import('notistack').ProviderContext['enqueueSnackbar']}
  */
@@ -70,34 +76,22 @@ export { ToastProvider };
 
 export default {
   /**
-   *
-   * @param {import('notistack').SnackbarMessage} message
-   * @param {import('notistack').OptionsObject} options
-   * @returns {import('notistack').SnackbarKey}
+   * @type {EnqueueSnackbarFunc}
    */
   success: (message, options = {}, ...args) => success(message, options, ...args),
 
   /**
-   *
-   * @param {import('notistack').SnackbarMessage} message
-   * @param {import('notistack').OptionsObject} options
-   * @returns {import('notistack').SnackbarKey}
+   * @type {EnqueueSnackbarFunc}
    */
   error: (message, options = {}, ...args) => error(message, options, ...args),
 
   /**
-   *
-   * @param {import('notistack').SnackbarMessage} message
-   * @param {import('notistack').OptionsObject} options
-   * @returns {import('notistack').SnackbarKey}
+   * @type {EnqueueSnackbarFunc}
    */
   warning: (message, options = {}, ...args) => warning(message, options, ...args),
 
   /**
-   *
-   * @param {import('notistack').SnackbarMessage} message
-   * @param {import('notistack').OptionsObject} options
-   * @returns {import('notistack').SnackbarKey}
+   * @type {EnqueueSnackbarFunc}
    */
   info: (message, options = {}, ...args) => info(message, options, ...args),
 };