@akinon/ui-layout 0.5.0 → 1.0.0

package/dist/cjs/Layout/Sider/index.js

@@ -18,21 +18,51 @@ const cssinjs_1 = require("@ant-design/cssinjs");
 const antd_1 = require("antd");
 const React = require("react");
 const { Sider: AntSider } = antd_1.Layout;
+/**
+ * Sider component for building collapsible sidebars in user interfaces.
+ *
+ * The Sider component is designed to provide a flexible and customizable sidebar
+ * that integrates seamlessly with layouts, menus, and responsive designs.
+ *
+ * Features:
+ * - **Collapsible**: Option to collapse the sidebar manually or automatically.
+ * - **Custom Triggers**: Supports custom triggers or hiding the trigger altogether.
+ * - **Width Options**: Configure both default and collapsed widths.
+ * - **Responsive Breakpoints**: Adjusts behavior based on predefined screen sizes.
+ * - **Theming**: Offers `light` and `dark` themes to match application aesthetics.
+ * - **Callbacks**:
+ *   - `onCollapse`: Triggered when the sidebar is collapsed or expanded.
+ *   - `onBreakpoint`: Triggered when responsive breakpoints are reached.
+ * - **Custom Styling**:
+ *   - `className` for additional styling.
+ *   - `zeroWidthTriggerStyle` for styling triggers when the collapsed width is zero.
+ *   - `brandImageUrl` and `iconUrl` for branding and visual customization.
+ *
+ * Ideal for dashboards, navigation menus, and applications requiring collapsible or responsive side navigation.
+ *
+ */
 const Sider = (_a) => {
-    var { children, collapsed, iconUrl, brandImageUrl } = _a, restSiderProps = __rest(_a, ["children", "collapsed", "iconUrl", "brandImageUrl"]);
+    var { children, collapsed, iconUrl, brandImageUrl, position = 'left' } = _a, restSiderProps = __rest(_a, ["children", "collapsed", "iconUrl", "brandImageUrl", "position"]);
     const { getPrefixCls, theme } = React.useContext(antd_1.ConfigProvider.ConfigContext);
     const { token, hashId } = (0, ui_theme_1.useToken)();
-    //const layoutToken = (token as GlobalToken).Layout;
+    const layoutToken = token.Layout;
     const useStyle = (0, cssinjs_1.useStyleRegister)({
         token: token,
         path: ['Sider'],
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         theme: theme
     }, () => {
-        const prefixCls = `:where(.${hashId}).${getPrefixCls()}-sider`;
-        const prefixClsWithoutHash = `.${getPrefixCls()}-sider`;
+        const prefixCls = `:where(.${hashId}).${getPrefixCls()}-layout-sider`;
+        const prefixClsWithoutHash = `.${getPrefixCls()}-layout-sider`;
         return {
-            [prefixCls]: {},
+            [prefixCls]: {
+                '&-left': {
+                    borderInlineEnd: layoutToken.mainBorder
+                },
+                '&-right': {
+                    borderInlineStart: layoutToken.mainBorder
+                }
+            },
             [prefixClsWithoutHash]: {}
         };
     });
@@ -42,7 +72,7 @@ const Sider = (_a) => {
             React.createElement("img", { className: "logo", src: iconUrl, alt: "icon", width: 20, height: 20 }),
             React.createElement("img", { className: "brand-image", src: brandImageUrl, alt: "brand-image", height: 20 })));
     }
-    return useStyle(React.createElement(AntSider, Object.assign({ collapsible: true, collapsed: collapsed, trigger: null, width: 250 }, restSiderProps),
+    return useStyle(React.createElement(AntSider, Object.assign({ className: `${getPrefixCls()}-layout-sider-${position}`, collapsible: true, collapsed: collapsed, trigger: null, width: 250, collapsedWidth: 56 }, restSiderProps),
         LogoContainer,
         children));
 };

package/dist/cjs/Layout/Sider/types.d.ts

@@ -0,0 +1,134 @@
+// TODO integrate with antd menu types
+/**
+ * Interface for items within the left sider.
+ */
+export type LeftSiderItem = {
+  /**
+   * Unique key for the menu item.
+   */
+  key: string;
+
+  /**
+   * Display label for the menu item.
+   */
+  label: string;
+
+  /**
+   * Optional icon for the menu item.
+   */
+  icon?: React.ReactNode;
+
+  /**
+   * Additional CSS class for the menu item.
+   */
+  className?: string;
+
+  /**
+   * Callback function triggered when the menu item is clicked.
+   */
+  onClick?: () => void;
+
+  /**
+   * Nested children items for creating submenus.
+   */
+  children?: LeftSiderItem[];
+
+  /**
+   * Whether the menu item is disabled.
+   */
+  disabled?: boolean;
+};
+
+export type SiderProps = Omit<AntSiderProps, 'prefixCls' | 'style' | 'styles'>;
+
+export interface AntSiderProps extends React.HTMLAttributes<HTMLDivElement> {
+  /**
+   * Sider position for border position.
+   * If it is left, the border will be on the right side.
+   * Other is other side.
+   *
+   * @default left
+   */
+  position?: 'left' | 'right';
+
+  /**
+   * Whether can be collapsed
+   */
+  collapsible?: boolean;
+
+  /**
+   * To set the current status
+   */
+  collapsed?: boolean;
+
+  /**
+   * To set the initial status
+   */
+  defaultCollapsed?: boolean;
+
+  /**
+   * Reverse direction of arrow, for a sider that expands from the right
+   */
+  reverseArrow?: boolean;
+
+  /**
+   * The callback function, executed by clicking the trigger or activating the responsive layout
+   */
+  onCollapse?: (collapsed: boolean, type: CollapseType) => void;
+
+  /**
+   * To customize the styles of the special trigger that appears when <code>collapsedWidth</code> is 0
+   */
+  zeroWidthTriggerStyle?: React.CSSProperties;
+
+  /**
+   * Specify the customized trigger, set to null to hide the trigger
+   */
+  trigger?: React.ReactNode;
+
+  /**
+   * Width of the sidebar
+   */
+  width?: number | string;
+
+  /**
+   * Width of the collapsed sidebar, by setting to 0 a special trigger will appear
+   */
+  collapsedWidth?: number | string;
+
+  /**
+   * Breakpoints of the responsive layout
+   */
+  breakpoint?: 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl';
+
+  /**
+   * Color theme of the sidebar
+   */
+  theme?: SiderTheme;
+
+  /**
+   * The callback function, executed when breakpoints changed
+   */
+  onBreakpoint?: (broken: boolean) => void;
+
+  /**
+   * URL for the sidebar's custom icon. This can be used for branding or visual enhancement.
+   * If provided, the icon will be displayed in the sidebar header or a designated area.
+   */
+  iconUrl?: string;
+
+  /**
+   * URL for the sidebar's brand image. Typically used to display a logo or branding element in the sidebar.
+   * This can enhance the sidebar's appearance and provide a visual identity for the application.
+   */
+  brandImageUrl?: string;
+
+  /**
+   * The additional css class
+   */
+  className?: string;
+}
+
+type SiderTheme = 'light' | 'dark';
+
+type CollapseType = 'clickTrigger' | 'responsive';

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

@@ -1,5 +1,11 @@
 import * as React from 'react';
 import type { LayoutProps } from './types';
 export type { LayoutProps } from './types';
+/**
+ * Layout component, which acts as the container for building structured page layouts.
+ * It provides a framework to integrate Sider, Header, Footer, and Content components cohesively.
+ *
+ * This component is commonly used in applications to establish a consistent and flexible layout structure.
+ */
 export declare const Layout: ({ children, ...restLayoutProps }: LayoutProps) => React.JSX.Element;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Layout/index.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE3C,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE3C,eAAO,MAAM,MAAM,qCAAsC,WAAW,sBA4BnE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Layout/index.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE3C,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE3C;;;;;GAKG;AAEH,eAAO,MAAM,MAAM,qCAAsC,WAAW,sBA4BnE,CAAC"}

package/dist/cjs/Layout/index.js

@@ -16,6 +16,12 @@ const ui_theme_1 = require("@akinon/ui-theme");
 const cssinjs_1 = require("@ant-design/cssinjs");
 const antd_1 = require("antd");
 const React = require("react");
+/**
+ * Layout component, which acts as the container for building structured page layouts.
+ * It provides a framework to integrate Sider, Header, Footer, and Content components cohesively.
+ *
+ * This component is commonly used in applications to establish a consistent and flexible layout structure.
+ */
 const Layout = (_a) => {
     var { children } = _a, restLayoutProps = __rest(_a, ["children"]);
     const { getPrefixCls, theme } = React.useContext(antd_1.ConfigProvider.ConfigContext);

package/dist/cjs/Layout/types.d.ts

@@ -0,0 +1,32 @@
+export type LayoutProps = Omit<
+  AntLayoutProps,
+  'prefixCls' | 'suffixCls' | 'style' | 'styles'
+>;
+
+export interface AntLayoutProps extends React.HTMLAttributes<HTMLDivElement> {
+  /**
+   * Suffix class for custom styling.
+   */
+  suffixCls?: string;
+
+  /**
+   * ClassName on the root element.
+   */
+  rootClassName?: string;
+
+  /**
+   * Indicates whether the layout contains a Sider component.
+   * This property is usually inferred automatically but can be explicitly set to avoid style flickering in SSR scenarios.
+   */
+  hasSider?: boolean;
+
+  /**
+   * The children elements to render within the layout.
+   */
+  children: React.ReactNode;
+
+  /**
+   * The additional CSS class for styling.
+   */
+  className?: string;
+}

package/dist/cjs/NavCard/index.css

@@ -13,45 +13,45 @@
   align-items: center;
   justify-content: center;
   width: 180px;
+}
 
-  /* Overriding SVG so you will not have to pass size prop to Icon component. */
-  svg {
-    width: 28px !important;
-    height: 28px !important;
-  }
+/* Overriding SVG so you will not have to pass size prop to Icon component. */
+.nav-card__icon svg {
+  width: 28px !important;
+  height: 28px !important;
+}
 
-  /* Change bg color based on the class set on .nav-card */
-  &:is(.nav-card-akinon *) {
-    background-color: var(--color-akinon-500);
-  }
+/* Change bg color based on the class set on .nav-card */
+.nav-card-akinon .nav-card__icon {
+  background-color: var(--color-akinon-500);
+}
 
-  &:is(.nav-card-azure *) {
-    background-color: var(--color-azure-500);
-  }
+.nav-card-azure .nav-card__icon {
+  background-color: var(--color-azure-500);
+}
 
-  &:is(.nav-card-blue *) {
-    background-color: var(--color-blue-500);
-  }
+.nav-card-blue .nav-card__icon {
+  background-color: var(--color-blue-500);
+}
 
-  &:is(.nav-card-orange *) {
-    background-color: var(--color-orange-500);
-  }
+.nav-card-orange .nav-card__icon {
+  background-color: var(--color-orange-500);
+}
 
-  &:is(.nav-card-red *) {
-    background-color: var(--color-red-500);
-  }
+.nav-card-red .nav-card__icon {
+  background-color: var(--color-red-500);
+}
 
-  &:is(.nav-card-green *) {
-    background-color: var(--color-green-500);
-  }
+.nav-card-green .nav-card__icon {
+  background-color: var(--color-green-500);
+}
 
-  &:is(.nav-card-pink *) {
-    background-color: var(--color-pink-500);
-  }
+.nav-card-pink .nav-card__icon {
+  background-color: var(--color-pink-500);
+}
 
-  &:is(.nav-card-purple *) {
-    background-color: var(--color-purple-500);
-  }
+.nav-card-purple .nav-card__icon {
+  background-color: var(--color-purple-500);
 }
 
 .nav-card__content {

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

@@ -2,5 +2,29 @@ import './index.css';
 import * as React from 'react';
 import type { NavCardProps } from './types';
 export type { NavCardProps } from './types';
+/**
+ * NavCard component for navigation or highlighting sections in the interface.
+ *
+ * The NavCard component is designed to provide a visually engaging and functional card
+ * that serves as a navigation element or as a callout section in a user interface.
+ *
+ * Features:
+ * - **Title**: A required title to provide the primary context for the NavCard.
+ * - **Description**: A short description to elaborate on the title or purpose of the card.
+ * - **Icon**: Optionally display an icon to visually represent the NavCard's content or functionality.
+ * - **Color Variants**: Offers a range of predefined color options for theming, including:
+ *   - `akinon`
+ *   - `azure`
+ *   - `blue`
+ *   - `orange`
+ *   - `red`
+ *   - `green`
+ *   - `pink`
+ *   - `purple`
+ * - **Custom Styling**: Allows additional customizations via the `className` prop.
+ *
+ * Ideal for use in dashboards, navigation menus, or any scenario where visually distinct
+ * and thematically consistent navigation elements are required.
+ */
 export declare const NavCard: ({ title, description, icon, variant, className }: NavCardProps) => React.JSX.Element;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/NavCard/index.tsx"],"names":[],"mappings":"AAAA,OAAO,aAAa,CAAC;AAGrB,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE5C,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE5C,eAAO,MAAM,OAAO,qDAMjB,YAAY,sBAad,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/NavCard/index.tsx"],"names":[],"mappings":"AAAA,OAAO,aAAa,CAAC;AAGrB,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE5C,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,eAAO,MAAM,OAAO,qDAMjB,YAAY,sBAad,CAAC"}

package/dist/cjs/NavCard/index.js

@@ -4,6 +4,30 @@ exports.NavCard = void 0;
 require("./index.css");
 const clsx_1 = require("clsx");
 const React = require("react");
+/**
+ * NavCard component for navigation or highlighting sections in the interface.
+ *
+ * The NavCard component is designed to provide a visually engaging and functional card
+ * that serves as a navigation element or as a callout section in a user interface.
+ *
+ * Features:
+ * - **Title**: A required title to provide the primary context for the NavCard.
+ * - **Description**: A short description to elaborate on the title or purpose of the card.
+ * - **Icon**: Optionally display an icon to visually represent the NavCard's content or functionality.
+ * - **Color Variants**: Offers a range of predefined color options for theming, including:
+ *   - `akinon`
+ *   - `azure`
+ *   - `blue`
+ *   - `orange`
+ *   - `red`
+ *   - `green`
+ *   - `pink`
+ *   - `purple`
+ * - **Custom Styling**: Allows additional customizations via the `className` prop.
+ *
+ * Ideal for use in dashboards, navigation menus, or any scenario where visually distinct
+ * and thematically consistent navigation elements are required.
+ */
 const NavCard = ({ title, description, icon, variant, className }) => {
     const variantClass = variant ? `nav-card-${variant}` : '';
     return (React.createElement("div", { className: (0, clsx_1.default)('nav-card', variantClass, className) },

package/dist/cjs/NavCard/types.d.ts

@@ -0,0 +1,36 @@
+export type NavCardColorVariant =
+  | 'akinon'
+  | 'azure'
+  | 'blue'
+  | 'orange'
+  | 'red'
+  | 'green'
+  | 'pink'
+  | 'purple';
+
+export interface NavCardProps {
+  /**
+   * The title of the NavCard.
+   */
+  title: string;
+
+  /**
+   * The description of the NavCard.
+   */
+  description: string;
+
+  /**
+   * The icon of the NavCard.
+   */
+  icon?: React.ReactNode;
+
+  /**
+   * The color variant of the NavCard.
+   */
+  variant?: NavCardColorVariant;
+
+  /**
+   * The additional css class
+   */
+  className?: string;
+}

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

@@ -1,6 +1,8 @@
-import './index.css';
 import * as React from 'react';
 import type { PageContentProps } from './types';
-export type { PageContentProps } from './types';
+/**
+ * It is used to generate content for a standard page.
+ */
 export declare const PageContent: ({ children, className, ...restProps }: PageContentProps) => React.JSX.Element;
+export type * from './types';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/PageContent/index.tsx"],"names":[],"mappings":"AAAA,OAAO,aAAa,CAAC;AAGrB,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhD,YAAY,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhD,eAAO,MAAM,WAAW,0CAIrB,gBAAgB,sBAIlB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/PageContent/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhD;;GAEG;AAEH,eAAO,MAAM,WAAW,0CAIrB,gBAAgB,sBAMlB,CAAC;AAEF,mBAAmB,SAAS,CAAC"}

package/dist/cjs/PageContent/index.js

@@ -12,11 +12,12 @@ var __rest = (this && this.__rest) || function (s, e) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PageContent = void 0;
-require("./index.css");
-const clsx_1 = require("clsx");
 const React = require("react");
+/**
+ * It is used to generate content for a standard page.
+ */
 const PageContent = (_a) => {
-    var { children, className } = _a, restProps = __rest(_a, ["children", "className"]);
-    return (React.createElement("div", Object.assign({ className: (0, clsx_1.default)('akinon-page-content', className) }, restProps), children));
+    var { children, className = '' } = _a, restProps = __rest(_a, ["children", "className"]);
+    return (React.createElement("div", Object.assign({ className: className, style: { padding: '30px' } }, restProps), children));
 };
 exports.PageContent = PageContent;

package/dist/cjs/PageContent/types.d.ts

@@ -0,0 +1,11 @@
+export interface PageContentProps extends React.HTMLAttributes<HTMLDivElement> {
+  /**
+   * The content of the page.
+   */
+  children: React.ReactNode;
+
+  /**
+   * The additional css class.
+   */
+  className?: string;
+}

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

@@ -1,6 +1,9 @@
-import './index.css';
 import * as React from 'react';
 import type { PageHeadingProps } from './types';
-export type { PageHeadingProps } from './types';
+/**
+ * It is used to generate title, description and actions for a standard page.
+ * See the [PageContent](/docs/layout-pagecontent--docs) component for more information.
+ */
 export declare const PageHeading: ({ title, description, actions, className }: PageHeadingProps) => React.JSX.Element;
+export type * from './types';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/PageHeading/index.tsx"],"names":[],"mappings":"AAAA,OAAO,aAAa,CAAC;AAGrB,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhD,YAAY,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhD,eAAO,MAAM,WAAW,+CAKrB,gBAAgB,sBAalB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/PageHeading/index.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhD;;;GAGG;AAEH,eAAO,MAAM,WAAW,+CAKrB,gBAAgB,sBA4BlB,CAAC;AAEF,mBAAmB,SAAS,CAAC"}

package/dist/cjs/PageHeading/index.js

@@ -1,14 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PageHeading = void 0;
-require("./index.css");
-const clsx_1 = require("clsx");
+const antd_1 = require("antd");
 const React = require("react");
+/**
+ * It is used to generate title, description and actions for a standard page.
+ * See the [PageContent](/docs/layout-pagecontent--docs) component for more information.
+ */
 const PageHeading = ({ title, description, actions, className }) => {
-    return (React.createElement("div", { className: (0, clsx_1.default)('akinon-page-heading', className) },
-        React.createElement("div", { className: "akinon-page-heading__content" },
-            React.createElement("h1", { className: "akinon-page-heading__title" }, title),
-            description && (React.createElement("p", { className: "akinon-page-heading__description" }, description))),
-        actions && React.createElement("div", { className: "akinon-page-heading__actions" }, actions)));
+    return (React.createElement(antd_1.Flex, { justify: "space-between", align: "flex-start", className: className, style: {
+            padding: '18px 30px',
+            borderBlockEnd: 'solid 1px var(--color-gray-900)'
+        } },
+        React.createElement(antd_1.Space, { direction: "vertical", size: 4 },
+            React.createElement(antd_1.Typography.Title, { level: 4, style: { margin: 0 } }, title),
+            description && (React.createElement(antd_1.Typography.Paragraph, { type: "secondary", style: { margin: 0, fontSize: 10 } }, description))),
+        actions && React.createElement(antd_1.Space, null, actions)));
 };
 exports.PageHeading = PageHeading;

package/dist/cjs/PageHeading/types.d.ts

@@ -0,0 +1,21 @@
+export interface PageHeadingProps {
+  /**
+   * The title of the PageHeading.
+   */
+  title: string;
+
+  /**
+   * The description of the PageHeading.
+   */
+  description?: string;
+
+  /**
+   * The action items of the PageHeading.
+   */
+  actions?: React.ReactNode;
+
+  /**
+   * The additional css class
+   */
+  className?: string;
+}

package/dist/cjs/types.d.ts

@@ -0,0 +1,12 @@
+import { Layout } from './Layout';
+import { Content } from './Layout/Content';
+import { Footer } from './Layout/Footer';
+import { Header } from './Layout/Header';
+import { Sider } from './Layout/Sider';
+
+export type LayoutType = typeof Layout & {
+  Header: typeof Header;
+  Footer: typeof Footer;
+  Content: typeof Content;
+  Sider: typeof Sider;
+};

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

@@ -1,5 +1,16 @@
 import * as React from 'react';
 import type { FlexProps } from './types';
-export type { FlexProps } from './types';
+export type * from './types';
+/**
+ * The `Flex` component is a wrapper for creating flexible layouts using the flexbox model.
+ * It provides a clean and simple API to manage alignment, spacing, and direction
+ * of child elements, ensuring responsive and adaptable designs.
+ *
+ * Features include:
+ * - Vertical and horizontal layouts with optional wrapping.
+ * - Customizable alignment for both main and cross axes.
+ * - Support for predefined or custom gap sizes between child elements.
+ * - Flexibility to use any custom HTML element or React component as the container.
+ */
 export declare const Flex: ({ children, ...restFlexProps }: FlexProps) => React.JSX.Element;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Flex/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,mCAAoC,SAAS,sBA4B7D,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Flex/index.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEzC,mBAAmB,SAAS,CAAC;AAE7B;;;;;;;;;;GAUG;AAEH,eAAO,MAAM,IAAI,mCAAoC,SAAS,sBA4B7D,CAAC"}

package/dist/esm/Flex/index.js

@@ -13,6 +13,17 @@ import { useToken } from '@akinon/ui-theme';
 import { useStyleRegister } from '@ant-design/cssinjs';
 import { ConfigProvider, Flex as AntFlex } from 'antd';
 import * as React from 'react';
+/**
+ * The `Flex` component is a wrapper for creating flexible layouts using the flexbox model.
+ * It provides a clean and simple API to manage alignment, spacing, and direction
+ * of child elements, ensuring responsive and adaptable designs.
+ *
+ * Features include:
+ * - Vertical and horizontal layouts with optional wrapping.
+ * - Customizable alignment for both main and cross axes.
+ * - Support for predefined or custom gap sizes between child elements.
+ * - Flexibility to use any custom HTML element or React component as the container.
+ */
 export const Flex = (_a) => {
     var { children } = _a, restFlexProps = __rest(_a, ["children"]);
     const { getPrefixCls, theme } = React.useContext(ConfigProvider.ConfigContext);