@akinon/ui-spin 0.4.0 → 1.0.0

package/dist/cjs/index.d.ts

@@ -1,5 +1,15 @@
 import * as React from 'react';
 import type { SpinProps } from './types';
 export type { SpinProps } from './types';
+/**
+ * Spin component is used to indicate loading states in the application. It can be used with or without wrapping content.
+ *
+ * - The `spinning` property controls the visibility of the spin animation.
+ * - The `size` property allows customization of the spinner size (`small`, `default`, or `large`).
+ * - A custom loading indicator can be provided using the `indicator` property.
+ * - When used with children, the `tip` property can display descriptive content to provide additional context about the loading state.
+ * - The `fullscreen` property enables a backdrop behind the spinner, making it suitable for blocking the entire screen during loading.
+ *
+ */
 export declare const Spin: (props: SpinProps) => React.JSX.Element;
 //# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEzC,YAAY,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEzC,eAAO,MAAM,IAAI,UAAW,SAAS,sBA4BpC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEzC,YAAY,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEzC;;;;;;;;;GASG;AAEH,eAAO,MAAM,IAAI,UAAW,SAAS,sBA4BpC,CAAC"}

package/dist/cjs/index.js

@@ -5,6 +5,16 @@ const ui_theme_1 = require("@akinon/ui-theme");
 const cssinjs_1 = require("@ant-design/cssinjs");
 const antd_1 = require("antd");
 const React = require("react");
+/**
+ * Spin component is used to indicate loading states in the application. It can be used with or without wrapping content.
+ *
+ * - The `spinning` property controls the visibility of the spin animation.
+ * - The `size` property allows customization of the spinner size (`small`, `default`, or `large`).
+ * - A custom loading indicator can be provided using the `indicator` property.
+ * - When used with children, the `tip` property can display descriptive content to provide additional context about the loading state.
+ * - The `fullscreen` property enables a backdrop behind the spinner, making it suitable for blocking the entire screen during loading.
+ *
+ */
 const Spin = (props) => {
     const { getPrefixCls, theme } = React.useContext(antd_1.ConfigProvider.ConfigContext);
     const { token, hashId } = (0, ui_theme_1.useToken)();

package/dist/cjs/types.d.ts

@@ -0,0 +1,73 @@
+export type SpinProps = Omit<AntSpinProps, 'prefixCls' | 'style' | 'styles'>;
+
+declare const SpinSizes: readonly ['small', 'default', 'large'];
+
+export type SpinSize = (typeof SpinSizes)[number];
+
+export type SpinIndicator = React.ReactElement<HTMLElement>;
+
+export interface AntSpinProps {
+  /**
+   * The prefixCls of the component
+   */
+  prefixCls?: string;
+
+  /**
+   * The additional css class
+   */
+  className?: string;
+
+  /**
+   * ClassName on the root element
+   */
+  rootClassName?: string;
+
+  /**
+   * Whether Spin is visible
+   */
+  spinning?: boolean;
+
+  /**
+   * Inline styles for the spin component.
+   */
+  style?: React.CSSProperties;
+
+  /**
+   * The size of Spin
+   */
+  size?: SpinSize;
+
+  /**
+   * Customize description content when Spin has children
+   */
+  tip?: React.ReactNode;
+
+  /**
+   * Specifies a delay in milliseconds for loading state (prevent flush)
+   */
+  delay?: number;
+
+  /**
+   * The className of wrapper when Spin has children
+   */
+  wrapperClassName?: string;
+
+  /**
+   * React node of the spinning indicator
+   */
+  indicator?: SpinIndicator;
+
+  /**
+   * The children of the spin.
+   */
+  children?: React.ReactNode;
+
+  /**
+   * Display a backdrop with the Spin component
+   */
+  fullscreen?: boolean;
+}
+
+export type SpinType = React.FC<SpinProps> & {
+  setDefaultIndicator: (indicator: React.ReactNode) => void;
+};

package/dist/esm/index.d.ts

@@ -1,5 +1,15 @@
 import * as React from 'react';
 import type { SpinProps } from './types';
 export type { SpinProps } from './types';
+/**
+ * Spin component is used to indicate loading states in the application. It can be used with or without wrapping content.
+ *
+ * - The `spinning` property controls the visibility of the spin animation.
+ * - The `size` property allows customization of the spinner size (`small`, `default`, or `large`).
+ * - A custom loading indicator can be provided using the `indicator` property.
+ * - When used with children, the `tip` property can display descriptive content to provide additional context about the loading state.
+ * - The `fullscreen` property enables a backdrop behind the spinner, making it suitable for blocking the entire screen during loading.
+ *
+ */
 export declare const Spin: (props: SpinProps) => React.JSX.Element;
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEzC,YAAY,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEzC,eAAO,MAAM,IAAI,UAAW,SAAS,sBA4BpC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEzC,YAAY,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEzC;;;;;;;;;GASG;AAEH,eAAO,MAAM,IAAI,UAAW,SAAS,sBA4BpC,CAAC"}

package/dist/esm/index.js

@@ -2,6 +2,16 @@ import { useToken } from '@akinon/ui-theme';
 import { useStyleRegister } from '@ant-design/cssinjs';
 import { ConfigProvider, Spin as AntSpin } from 'antd';
 import * as React from 'react';
+/**
+ * Spin component is used to indicate loading states in the application. It can be used with or without wrapping content.
+ *
+ * - The `spinning` property controls the visibility of the spin animation.
+ * - The `size` property allows customization of the spinner size (`small`, `default`, or `large`).
+ * - A custom loading indicator can be provided using the `indicator` property.
+ * - When used with children, the `tip` property can display descriptive content to provide additional context about the loading state.
+ * - The `fullscreen` property enables a backdrop behind the spinner, making it suitable for blocking the entire screen during loading.
+ *
+ */
 export const Spin = (props) => {
     const { getPrefixCls, theme } = React.useContext(ConfigProvider.ConfigContext);
     const { token, hashId } = useToken();

package/dist/esm/types.d.ts

@@ -0,0 +1,73 @@
+export type SpinProps = Omit<AntSpinProps, 'prefixCls' | 'style' | 'styles'>;
+
+declare const SpinSizes: readonly ['small', 'default', 'large'];
+
+export type SpinSize = (typeof SpinSizes)[number];
+
+export type SpinIndicator = React.ReactElement<HTMLElement>;
+
+export interface AntSpinProps {
+  /**
+   * The prefixCls of the component
+   */
+  prefixCls?: string;
+
+  /**
+   * The additional css class
+   */
+  className?: string;
+
+  /**
+   * ClassName on the root element
+   */
+  rootClassName?: string;
+
+  /**
+   * Whether Spin is visible
+   */
+  spinning?: boolean;
+
+  /**
+   * Inline styles for the spin component.
+   */
+  style?: React.CSSProperties;
+
+  /**
+   * The size of Spin
+   */
+  size?: SpinSize;
+
+  /**
+   * Customize description content when Spin has children
+   */
+  tip?: React.ReactNode;
+
+  /**
+   * Specifies a delay in milliseconds for loading state (prevent flush)
+   */
+  delay?: number;
+
+  /**
+   * The className of wrapper when Spin has children
+   */
+  wrapperClassName?: string;
+
+  /**
+   * React node of the spinning indicator
+   */
+  indicator?: SpinIndicator;
+
+  /**
+   * The children of the spin.
+   */
+  children?: React.ReactNode;
+
+  /**
+   * Display a backdrop with the Spin component
+   */
+  fullscreen?: boolean;
+}
+
+export type SpinType = React.FC<SpinProps> & {
+  setDefaultIndicator: (indicator: React.ReactNode) => void;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akinon/ui-spin",
-  "version": "0.4.0",
+  "version": "1.0.0",
   "private": false,
   "type": "module",
   "main": "dist/esm/index.js",
@@ -9,15 +9,15 @@
     "dist"
   ],
   "dependencies": {
-    "antd": "5.17.0",
-    "@akinon/ui-theme": "0.6.0"
+    "antd": "5.22.6",
+    "@akinon/ui-theme": "1.0.0"
   },
   "devDependencies": {
     "clean-package": "2.2.0",
     "copyfiles": "^2.4.1",
     "rimraf": "^5.0.5",
-    "typescript": "^5.2.2",
-    "@akinon/typescript-config": "0.3.0"
+    "typescript": "*",
+    "@akinon/typescript-config": "1.0.0"
   },
   "peerDependencies": {
     "react": ">=18",
@@ -37,7 +37,7 @@
     "build": "pnpm run build:esm && pnpm run build:commonjs && pnpm run copy:files",
     "build:esm": "tsc --outDir dist/esm",
     "build:commonjs": "tsc --module commonjs --outDir dist/cjs",
-    "copy:files": "copyfiles -u 1 src/**/*.css dist/esm && copyfiles -u 1 src/**/*.css dist/cjs",
+    "copy:files": "copyfiles -u 1 \"src/**/*.!(ts|tsx)\" dist/esm && copyfiles -u 1 \"src/**/*.!(ts|tsx)\" dist/cjs",
     "clean": "rimraf dist/",
     "typecheck": "tsc --noEmit"
   }