@akinon/ui-space 0.4.0 → 1.0.0

package/dist/cjs/index.d.ts

@@ -1,5 +1,26 @@
 import * as React from 'react';
 import type { CompactSpaceProps, SpaceProps } from './types';
+/**
+ * Space component for arranging elements with consistent spacing.
+ *
+ * The Space component is designed to provide uniform spacing between child elements
+ * in either a horizontal or vertical direction. It simplifies the creation of layouts
+ * with proper alignment and spacing, ensuring a clean and consistent design.
+ *
+ * Features:
+ * - **Customizable Size**: Supports predefined sizes (`small`, `middle`, `large`) or a custom numeric value.
+ * - **Direction**: Easily switch between horizontal or vertical stacking of child elements.
+ * - **Alignment**: Aligns items with options like `start`, `end`, `center`, or `baseline`.
+ * - **Wrap Support**: Automatically wraps items to the next line if they exceed the container width.
+ * - **Split Element**: Add a customizable separator between child elements.
+ * - **Block Mode**: Enables full-width layout for the space.
+ * - **Flexible Class Names**: Allows customization through `className` and `rootClassName` props.
+ *
+ * Additionally, the `CompactSpaceProps` interface extends functionality for compact layouts,
+ * providing tighter spacing and alignment options for more space-efficient designs.
+ *
+ * Ideal for consistent spacing between buttons, icons, or other grouped elements in a layout.
+ */
 export declare const Space: ({ children, block, ...restSpaceProps }: SpaceProps) => React.JSX.Element;
 /**
  * Supported child components:

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAI7D,eAAO,MAAM,KAAK,2CAA4C,UAAU,sBASvE,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,EAAE,CAAC,iBAAiB,CAKpD,CAAC;AAEF,YAAY,EAAE,iBAAiB,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAI7D;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,eAAO,MAAM,KAAK,2CAA4C,UAAU,sBASvE,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,EAAE,CAAC,iBAAiB,CAKpD,CAAC;AAEF,YAAY,EAAE,iBAAiB,EAAE,CAAC"}

package/dist/cjs/index.js

@@ -15,6 +15,27 @@ exports.CompactSpace = exports.Space = void 0;
 const antd_1 = require("antd");
 const React = require("react");
 const AntdCompact = antd_1.Space.Compact;
+/**
+ * Space component for arranging elements with consistent spacing.
+ *
+ * The Space component is designed to provide uniform spacing between child elements
+ * in either a horizontal or vertical direction. It simplifies the creation of layouts
+ * with proper alignment and spacing, ensuring a clean and consistent design.
+ *
+ * Features:
+ * - **Customizable Size**: Supports predefined sizes (`small`, `middle`, `large`) or a custom numeric value.
+ * - **Direction**: Easily switch between horizontal or vertical stacking of child elements.
+ * - **Alignment**: Aligns items with options like `start`, `end`, `center`, or `baseline`.
+ * - **Wrap Support**: Automatically wraps items to the next line if they exceed the container width.
+ * - **Split Element**: Add a customizable separator between child elements.
+ * - **Block Mode**: Enables full-width layout for the space.
+ * - **Flexible Class Names**: Allows customization through `className` and `rootClassName` props.
+ *
+ * Additionally, the `CompactSpaceProps` interface extends functionality for compact layouts,
+ * providing tighter spacing and alignment options for more space-efficient designs.
+ *
+ * Ideal for consistent spacing between buttons, icons, or other grouped elements in a layout.
+ */
 const Space = (_a) => {
     var { children, block } = _a, restSpaceProps = __rest(_a, ["children", "block"]);
     return (React.createElement(antd_1.Space, Object.assign({}, restSpaceProps, (block && { style: { width: '100%' } })), children));

package/dist/cjs/types.d.ts

@@ -0,0 +1,83 @@
+import type { DO_NOT_USE_OR_YOU_WILL_BE_FIRED_INTERNAL_STYLE } from '@akinon/ui-theme';
+import type React from 'react';
+
+export type SpaceSize = 'small' | 'middle' | 'large' | number;
+
+export type SpaceDirection = 'horizontal' | 'vertical';
+
+export interface SpaceProps extends React.HTMLAttributes<HTMLDivElement> {
+  /**
+   * Space's class name
+   */
+  className?: string;
+
+  /**
+   * Space's root class name
+   */
+  rootClassName?: string;
+
+  /**
+   * Space's size
+   */
+  size?: SpaceSize | [SpaceSize, SpaceSize];
+
+  /**
+   * Whether to make the space block (full width)
+   */
+  block?: boolean;
+
+  /**
+   * Space's direction
+   */
+  direction?: SpaceDirection;
+
+  /**
+   * Space's alignment
+   */
+  align?: 'start' | 'end' | 'center' | 'baseline';
+
+  /**
+   * Space's split element
+   */
+  split?: React.ReactNode;
+
+  /**
+   * Whether to wrap the space items
+   */
+  wrap?: boolean;
+
+  /**
+   * Space's item class names
+   */
+  classNames?: {
+    item: string;
+  };
+
+  /**
+   * @ignore
+   */
+  styles?: DO_NOT_USE_OR_YOU_WILL_BE_FIRED_INTERNAL_STYLE;
+}
+
+export interface CompactSpaceProps
+  extends React.HTMLAttributes<HTMLDivElement> {
+  /**
+   * Compact space's size
+   */
+  size?: Exclude<SpaceSize, number>;
+
+  /**
+   * Compact space's direction
+   */
+  direction?: SpaceDirection;
+
+  /**
+   * Whether to make the compact space block
+   */
+  block?: boolean;
+
+  /**
+   * Compact space's root class name
+   */
+  rootClassName?: string;
+}

package/dist/esm/index.d.ts

@@ -1,5 +1,26 @@
 import * as React from 'react';
 import type { CompactSpaceProps, SpaceProps } from './types';
+/**
+ * Space component for arranging elements with consistent spacing.
+ *
+ * The Space component is designed to provide uniform spacing between child elements
+ * in either a horizontal or vertical direction. It simplifies the creation of layouts
+ * with proper alignment and spacing, ensuring a clean and consistent design.
+ *
+ * Features:
+ * - **Customizable Size**: Supports predefined sizes (`small`, `middle`, `large`) or a custom numeric value.
+ * - **Direction**: Easily switch between horizontal or vertical stacking of child elements.
+ * - **Alignment**: Aligns items with options like `start`, `end`, `center`, or `baseline`.
+ * - **Wrap Support**: Automatically wraps items to the next line if they exceed the container width.
+ * - **Split Element**: Add a customizable separator between child elements.
+ * - **Block Mode**: Enables full-width layout for the space.
+ * - **Flexible Class Names**: Allows customization through `className` and `rootClassName` props.
+ *
+ * Additionally, the `CompactSpaceProps` interface extends functionality for compact layouts,
+ * providing tighter spacing and alignment options for more space-efficient designs.
+ *
+ * Ideal for consistent spacing between buttons, icons, or other grouped elements in a layout.
+ */
 export declare const Space: ({ children, block, ...restSpaceProps }: SpaceProps) => React.JSX.Element;
 /**
  * Supported child components:

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAI7D,eAAO,MAAM,KAAK,2CAA4C,UAAU,sBASvE,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,EAAE,CAAC,iBAAiB,CAKpD,CAAC;AAEF,YAAY,EAAE,iBAAiB,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAI7D;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,eAAO,MAAM,KAAK,2CAA4C,UAAU,sBASvE,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,EAAE,CAAC,iBAAiB,CAKpD,CAAC;AAEF,YAAY,EAAE,iBAAiB,EAAE,CAAC"}

package/dist/esm/index.js

@@ -12,6 +12,27 @@ var __rest = (this && this.__rest) || function (s, e) {
 import { Space as AntSpace } from 'antd';
 import * as React from 'react';
 const AntdCompact = AntSpace.Compact;
+/**
+ * Space component for arranging elements with consistent spacing.
+ *
+ * The Space component is designed to provide uniform spacing between child elements
+ * in either a horizontal or vertical direction. It simplifies the creation of layouts
+ * with proper alignment and spacing, ensuring a clean and consistent design.
+ *
+ * Features:
+ * - **Customizable Size**: Supports predefined sizes (`small`, `middle`, `large`) or a custom numeric value.
+ * - **Direction**: Easily switch between horizontal or vertical stacking of child elements.
+ * - **Alignment**: Aligns items with options like `start`, `end`, `center`, or `baseline`.
+ * - **Wrap Support**: Automatically wraps items to the next line if they exceed the container width.
+ * - **Split Element**: Add a customizable separator between child elements.
+ * - **Block Mode**: Enables full-width layout for the space.
+ * - **Flexible Class Names**: Allows customization through `className` and `rootClassName` props.
+ *
+ * Additionally, the `CompactSpaceProps` interface extends functionality for compact layouts,
+ * providing tighter spacing and alignment options for more space-efficient designs.
+ *
+ * Ideal for consistent spacing between buttons, icons, or other grouped elements in a layout.
+ */
 export const Space = (_a) => {
     var { children, block } = _a, restSpaceProps = __rest(_a, ["children", "block"]);
     return (React.createElement(AntSpace, Object.assign({}, restSpaceProps, (block && { style: { width: '100%' } })), children));

package/dist/esm/types.d.ts

@@ -0,0 +1,83 @@
+import type { DO_NOT_USE_OR_YOU_WILL_BE_FIRED_INTERNAL_STYLE } from '@akinon/ui-theme';
+import type React from 'react';
+
+export type SpaceSize = 'small' | 'middle' | 'large' | number;
+
+export type SpaceDirection = 'horizontal' | 'vertical';
+
+export interface SpaceProps extends React.HTMLAttributes<HTMLDivElement> {
+  /**
+   * Space's class name
+   */
+  className?: string;
+
+  /**
+   * Space's root class name
+   */
+  rootClassName?: string;
+
+  /**
+   * Space's size
+   */
+  size?: SpaceSize | [SpaceSize, SpaceSize];
+
+  /**
+   * Whether to make the space block (full width)
+   */
+  block?: boolean;
+
+  /**
+   * Space's direction
+   */
+  direction?: SpaceDirection;
+
+  /**
+   * Space's alignment
+   */
+  align?: 'start' | 'end' | 'center' | 'baseline';
+
+  /**
+   * Space's split element
+   */
+  split?: React.ReactNode;
+
+  /**
+   * Whether to wrap the space items
+   */
+  wrap?: boolean;
+
+  /**
+   * Space's item class names
+   */
+  classNames?: {
+    item: string;
+  };
+
+  /**
+   * @ignore
+   */
+  styles?: DO_NOT_USE_OR_YOU_WILL_BE_FIRED_INTERNAL_STYLE;
+}
+
+export interface CompactSpaceProps
+  extends React.HTMLAttributes<HTMLDivElement> {
+  /**
+   * Compact space's size
+   */
+  size?: Exclude<SpaceSize, number>;
+
+  /**
+   * Compact space's direction
+   */
+  direction?: SpaceDirection;
+
+  /**
+   * Whether to make the compact space block
+   */
+  block?: boolean;
+
+  /**
+   * Compact space's root class name
+   */
+  rootClassName?: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akinon/ui-space",
-  "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"
+    "antd": "5.22.6"
   },
   "devDependencies": {
     "clean-package": "2.2.0",
     "copyfiles": "^2.4.1",
     "rimraf": "^5.0.5",
-    "typescript": "^5.2.2",
-    "@akinon/typescript-config": "0.3.0",
-    "@akinon/ui-theme": "0.6.0"
+    "typescript": "*",
+    "@akinon/ui-theme": "1.0.0",
+    "@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"
   }