kiban-design-system 1.0.281-alpha.0 → 1.0.282-alpha.0

package/dist/components/Modal/components/Header/Header.props.d.ts

@@ -1,32 +1,31 @@
-/// <reference types="react" />
-import type { IconName } from '../../../Icon';
-import type { MediaProps } from '../../../Media';
-export interface ModalHeaderProps {
-    /**
-     * Function to execute when click in button 'X', if it is null
-     * buyon 'X' wil not be displayed
-     */
-    onClose?: () => void;
-    /**
-     * Component to display as a title
-     */
-    title?: React.ReactNode;
-    /**
-     * Icon name to show in Media component, if media is null Media
-     * component will not be displayed
-     */
-    media?: IconName;
-    /**
-     * Flag show or hide the header
-     * @default 'true'
-     */
-    hideHeader?: boolean;
-    /**
-     * Media appearance
-     */
-    mediaTheme?: MediaProps['themeAppearance'];
-    /**
-     * Label to use in automatic tests
-     */
-    ariaLabel?: string;
-}
+import type { IconName } from '../../../Icon';
+import type { MediaProps } from '../../../Media';
+export interface ModalHeaderProps {
+    /**
+     * Function to execute when click in button 'X', if it is null
+     * buyon 'X' wil not be displayed
+     */
+    onClose?: () => void;
+    /**
+     * Component to display as a title
+     */
+    title?: React.ReactNode;
+    /**
+     * Icon name to show in Media component, if media is null Media
+     * component will not be displayed
+     */
+    media?: IconName;
+    /**
+     * Flag show or hide the header
+     * @default 'true'
+     */
+    hideHeader?: boolean;
+    /**
+     * Media appearance
+     */
+    mediaTheme?: MediaProps['themeAppearance'];
+    /**
+     * Label to use in automatic tests
+     */
+    ariaLabel?: string;
+}

package/dist/components/Modal/components/Header/index.d.ts

@@ -1,3 +1,3 @@
-import ModalHeader from './Header';
-export type { ModalHeaderProps } from './Header.props';
-export { ModalHeader };
+import ModalHeader from './Header';
+export type { ModalHeaderProps } from './Header.props';
+export { ModalHeader };

package/dist/components/Modal/components/Pane/Pane.d.ts

@@ -1,13 +1,12 @@
-/// <reference types="react" />
-import type { PaneProps } from './Pane.props';
-import './Pane.styles.scss';
-/**
- * Modal component is used to display any content in a pop up
- * box
- *
- * @param {PaneProps} PaneProps - Pane props
- * @param {ReactNode} PaneProps.children - Children component
- * @param {string} PaneProps.size - Pane size
- */
-declare const Pane: ({ children, size }: PaneProps) => JSX.Element;
-export default Pane;
+import type { PaneProps } from './Pane.props';
+import './Pane.styles.scss';
+/**
+ * Modal component is used to display any content in a pop up
+ * box
+ *
+ * @param {PaneProps} PaneProps - Pane props
+ * @param {ReactNode} PaneProps.children - Children component
+ * @param {string} PaneProps.size - Pane size
+ */
+declare const Pane: ({ children, size }: PaneProps) => import("react/jsx-runtime").JSX.Element;
+export default Pane;

package/dist/components/Modal/components/Pane/Pane.props.d.ts

@@ -1,14 +1,13 @@
-/// <reference types="react" />
-import type { ModalHeaderProps } from '../../components/Header';
-import type { ModalFooterProps } from '../../components/Footer';
-export interface PaneProps extends ModalHeaderProps, ModalFooterProps {
-    /**
-     * Content to display in modal
-     */
-    children?: React.ReactNode;
-    /**
-     * Panel size
-     * @default 'full'
-     */
-    size?: 'full' | 'half' | 'a-third' | 'two-thirds' | 'a-quarter' | 'three-quarters' | 'a-fifth' | 'two-fifths' | 'three-fifths' | 'four-fifths';
-}
+import type { ModalHeaderProps } from '../../components/Header';
+import type { ModalFooterProps } from '../../components/Footer';
+export interface PaneProps extends ModalHeaderProps, ModalFooterProps {
+    /**
+     * Content to display in modal
+     */
+    children?: React.ReactNode;
+    /**
+     * Panel size
+     * @default 'full'
+     */
+    size?: 'full' | 'half' | 'a-third' | 'two-thirds' | 'a-quarter' | 'three-quarters' | 'a-fifth' | 'two-fifths' | 'three-fifths' | 'four-fifths';
+}

package/dist/components/Modal/components/Pane/index.d.ts

@@ -1,3 +1,3 @@
-import Pane from './Pane';
-export type { PaneProps } from './Pane.props';
-export { Pane };
+import Pane from './Pane';
+export type { PaneProps } from './Pane.props';
+export { Pane };

package/dist/components/Modal/components/index.d.ts

@@ -1,4 +1,4 @@
-export * from './Footer';
-export * from './Header';
-export * from './Pane';
-export * from './Content';
+export * from './Footer';
+export * from './Header';
+export * from './Pane';
+export * from './Content';

package/dist/components/Modal/index.d.ts

@@ -1,9 +1,9 @@
-import Modal from './Modal';
-import { Footer } from './components/Footer';
-import { ModalHeader } from './components/Header';
-import { Pane } from './components/Pane';
-export type { ModalProps } from './Modal.props';
-export type { SecondaryActionProps, PrimaryActionProps, ModalFooterProps, } from './components/Footer';
-export type { ModalHeaderProps } from './components/Header';
-export type { PaneProps } from './components/Pane';
-export { Modal, Footer, ModalHeader, Pane };
+import Modal from './Modal';
+import { Footer } from './components/Footer';
+import { ModalHeader } from './components/Header';
+import { Pane } from './components/Pane';
+export type { ModalProps } from './Modal.props';
+export type { SecondaryActionProps, PrimaryActionProps, ModalFooterProps, } from './components/Footer';
+export type { ModalHeaderProps } from './components/Header';
+export type { PaneProps } from './components/Pane';
+export { Modal, Footer, ModalHeader, Pane };

package/dist/components/Nip/Nip.d.ts

@@ -1,15 +1,14 @@
-/// <reference types="react" />
-import { NipProps } from './Nip.props';
-import './Nip.styles.scss';
-/**
- * The Nip is element to write code in a page
- *
- * @param {NipProps}  Nip - Nip Props
- * @param {void} NipProps.onChange - To return value nip
- * @param {boolean} NipProps.isDisabled - To disabled element
- * @param {boolean} NipProps.nip - Nip given by user
- * @param {boolean} NipProps.nipLength - Nip length
- * @returns {symbol} - Returns the component
- */
-declare const Nip: ({ ariaLabel, onChange, isDisabled, nip, nipLength, }: NipProps) => JSX.Element;
-export default Nip;
+import type { NipProps } from "./Nip.props";
+import "./Nip.styles.scss";
+/**
+ * The Nip is element to write code in a page
+ *
+ * @param {NipProps}  Nip - Nip Props
+ * @param {void} NipProps.onChange - To return value nip
+ * @param {boolean} NipProps.isDisabled - To disabled element
+ * @param {boolean} NipProps.nip - Nip given by user
+ * @param {boolean} NipProps.nipLength - Nip length
+ * @returns {symbol} - Returns the component
+ */
+declare const Nip: ({ ariaLabel, onChange, isDisabled, nip, nipLength, }: NipProps) => import("react/jsx-runtime").JSX.Element;
+export default Nip;

package/dist/components/Nip/Nip.props.d.ts

@@ -1,7 +1,7 @@
-export interface NipProps {
-    onChange(e: string[]): void;
-    isDisabled?: boolean;
-    nip: string[];
-    nipLength?: number;
-    ariaLabel?: string;
-}
+export interface NipProps {
+    onChange(e: string[]): void;
+    isDisabled?: boolean;
+    nip: string[];
+    nipLength?: number;
+    ariaLabel?: string;
+}

package/dist/components/Nip/index.d.ts

@@ -1,3 +1,3 @@
-import Nip from './Nip';
-export * from './Nip.props';
-export { Nip };
+import Nip from './Nip';
+export * from './Nip.props';
+export { Nip };

package/dist/components/OptionList/OptionList.d.ts

@@ -1,25 +1,24 @@
-/// <reference types="react" />
-import type { OptionListProps } from './OptionList.props';
-import './OptionList.styles.scss';
-/**
- * The 'Option List' component renders an array of objects
- * that can be made up of the title of a divider and an array
- * of objects that must contain a label,
- * a value and an action to trigger with an onclick.
- *
- * @param {OptionListProps}  OptionListProps - OptionList Props
- * @param {string} OptionListProps.className - Outer class to modify styles
- * @param {Array} OptionListProps.sections - Array of objects that must contain a label
- * @param {Array} OptionListProps.items - Array of objects to render
- * @param {boolean} OptionListProps.isMultiple - Allows you to select
- * multiple items from the list
- * @param {void} OptionListProps.onChange - Function that returns the data selected
- * by the user, it can be an array of strings or just a string
- * @param {string[]} OptionListProps.selected -  Preselected data to
- * highlight in the render of the list items
- * @param {string[]} OptionListProps.parentId - ParentId to focus when select with keys
- * @param {string} InputTextProps.ariaLabel - Label to use in automatic tests
- * @returns {symbol} - Returns the component
- */
-declare const OptionList: ({ sections, items, className, isMultiple, onChange, selected, parentId, onEscKeyDown, }: OptionListProps) => JSX.Element;
-export default OptionList;
+import type { OptionListProps } from "./OptionList.props";
+import "./OptionList.styles.scss";
+/**
+ * The 'Option List' component renders an array of objects
+ * that can be made up of the title of a divider and an array
+ * of objects that must contain a label,
+ * a value and an action to trigger with an onclick.
+ *
+ * @param {OptionListProps}  OptionListProps - OptionList Props
+ * @param {string} OptionListProps.className - Outer class to modify styles
+ * @param {Array} OptionListProps.sections - Array of objects that must contain a label
+ * @param {Array} OptionListProps.items - Array of objects to render
+ * @param {boolean} OptionListProps.isMultiple - Allows you to select
+ * multiple items from the list
+ * @param {void} OptionListProps.onChange - Function that returns the data selected
+ * by the user, it can be an array of strings or just a string
+ * @param {string[]} OptionListProps.selected -  Preselected data to
+ * highlight in the render of the list items
+ * @param {string[]} OptionListProps.parentId - ParentId to focus when select with keys
+ * @param {string} InputTextProps.ariaLabel - Label to use in automatic tests
+ * @returns {symbol} - Returns the component
+ */
+declare const OptionList: ({ sections, items, className, isMultiple, onChange, selected, parentId, onEscKeyDown, }: OptionListProps) => import("react/jsx-runtime").JSX.Element;
+export default OptionList;

package/dist/components/OptionList/OptionList.props.d.ts

@@ -1,35 +1,34 @@
-/// <reference types="react" />
-export interface OptionListItemType {
-    /** Text to display in each list item */
-    label: React.ReactNode | string;
-    /** Value to return each time an item in the list is clicked */
-    value: string;
-    /**
-     * Label to use in automatic tests
-     */
-    ariaLabel?: string;
-}
-export interface OptionListSectionType {
-    /** Text to display in the divider */
-    title?: string;
-    /** Array to render in the list */
-    items?: OptionListItemType[];
-}
-export interface OptionListProps {
-    /** Sections to render in the list */
-    sections?: OptionListSectionType[];
-    /** Items to render in the list */
-    items?: OptionListItemType[];
-    /** External class to be able to modify the styles of the list */
-    className?: string;
-    /** Flag that shows us if multiple options can be selected or not */
-    isMultiple?: boolean;
-    /** Selected data to highlight in the render of the list items */
-    selected: string[];
-    /** Action that is triggered by selecting or deselecting one or more items in the list */
-    onChange?: (data: string[]) => void;
-    /** Parent id to be focused when user select an option only with keyboard */
-    parentId?: string;
-    /** Function to execute when user press Esc key and component is focused*/
-    onEscKeyDown?: () => void;
-}
+export interface OptionListItemType {
+    /** Text to display in each list item */
+    label: React.ReactNode | string;
+    /** Value to return each time an item in the list is clicked */
+    value: string;
+    /**
+     * Label to use in automatic tests
+     */
+    ariaLabel?: string;
+}
+export interface OptionListSectionType {
+    /** Text to display in the divider */
+    title?: string;
+    /** Array to render in the list */
+    items?: OptionListItemType[];
+}
+export interface OptionListProps {
+    /** Sections to render in the list */
+    sections?: OptionListSectionType[];
+    /** Items to render in the list */
+    items?: OptionListItemType[];
+    /** External class to be able to modify the styles of the list */
+    className?: string;
+    /** Flag that shows us if multiple options can be selected or not */
+    isMultiple?: boolean;
+    /** Selected data to highlight in the render of the list items */
+    selected: string[];
+    /** Action that is triggered by selecting or deselecting one or more items in the list */
+    onChange?: (data: string[]) => void;
+    /** Parent id to be focused when user select an option only with keyboard */
+    parentId?: string;
+    /** Function to execute when user press Esc key and component is focused*/
+    onEscKeyDown?: () => void;
+}

package/dist/components/OptionList/index.d.ts

@@ -1,3 +1,3 @@
-import OptionList from './OptionList';
-export type { OptionListProps, OptionListSectionType, OptionListItemType, } from './OptionList.props';
-export { OptionList };
+import OptionList from './OptionList';
+export type { OptionListProps, OptionListSectionType, OptionListItemType, } from './OptionList.props';
+export { OptionList };

package/dist/components/Page/Page.d.ts

@@ -1,28 +1,27 @@
-/// <reference types="react" />
-import type { PageProps } from './Page.props';
-import './Page.styles.scss';
-/**
- * Use to build the outer wrapper of a page, including the page
- * title and associated actions.
- *
- * @example
- * <Page title="Page title">Page content</Page>
- * @param {PageProps} PageProps - Page props.
- * @param {Node} PageProps.children - The page content.
- * @param {boolean} PageProps.isFullWidth - Whether the page should take up the full width of the container.
- * @param {boolean} PageProps.isNarrowWidth - Whether the page should take up fixed width.
- * @param {object} PageProps.breadcrumb - If Page requires an item take user back,
- * @param {string} PageProps.className - If development needs special class to Page main container,
- * @param {boolean} PageProps.hasDivider - Shows a divider between Page header and Page body,
- * @param {object} PageProps.primaryAction - Renders a Button with primary appearance on top of the page,
- * @param {Array} PageProps.secondaryActions - Renders a set of Buttons with secondary appearance on top of the page,
- * @param {string} PageProps.title - Sets Page title,
- * @param {Node} PageProps.titleMetaData - Custom component located below Title container,
- * @param {object} PagePropsthumbnail - Renders a Thumbnail component left to Title container,
- * @returns {symbol} The component.
- */
-declare const Page: {
-    ({ children, isFullWidth, isNarrowWidth, className, id, ...rest }: PageProps): JSX.Element;
-    Header: ({ breadcrumb, className, hasDivider, primaryAction, secondaryActions, title, titleMetaData, thumbnail, addon, }: import("./components").PageHeaderProps) => JSX.Element;
-};
-export default Page;
+import type { PageProps } from './Page.props';
+import './Page.styles.scss';
+/**
+ * Use to build the outer wrapper of a page, including the page
+ * title and associated actions.
+ *
+ * @example
+ * <Page title="Page title">Page content</Page>
+ * @param {PageProps} PageProps - Page props.
+ * @param {Node} PageProps.children - The page content.
+ * @param {boolean} PageProps.isFullWidth - Whether the page should take up the full width of the container.
+ * @param {boolean} PageProps.isNarrowWidth - Whether the page should take up fixed width.
+ * @param {object} PageProps.breadcrumb - If Page requires an item take user back,
+ * @param {string} PageProps.className - If development needs special class to Page main container,
+ * @param {boolean} PageProps.hasDivider - Shows a divider between Page header and Page body,
+ * @param {object} PageProps.primaryAction - Renders a Button with primary appearance on top of the page,
+ * @param {Array} PageProps.secondaryActions - Renders a set of Buttons with secondary appearance on top of the page,
+ * @param {string} PageProps.title - Sets Page title,
+ * @param {Node} PageProps.titleMetaData - Custom component located below Title container,
+ * @param {object} PagePropsthumbnail - Renders a Thumbnail component left to Title container,
+ * @returns {symbol} The component.
+ */
+declare const Page: {
+    ({ children, isFullWidth, isNarrowWidth, className, id, ...rest }: PageProps): import("react/jsx-runtime").JSX.Element;
+    Header: ({ breadcrumb, className, hasDivider, primaryAction, secondaryActions, title, titleMetaData, thumbnail, addon, }: import("./components").PageHeaderProps) => import("react/jsx-runtime").JSX.Element;
+};
+export default Page;

package/dist/components/Page/Page.props.d.ts

@@ -1,9 +1,8 @@
-/// <reference types="react" />
-import type { PageHeaderProps } from './components/Header';
-export interface PageProps extends PageHeaderProps {
-    children?: React.ReactNode;
-    isFullWidth?: boolean;
-    isNarrowWidth?: boolean;
-    className?: string;
-    id?: string;
-}
+import type { PageHeaderProps } from './components/Header';
+export interface PageProps extends PageHeaderProps {
+    children?: React.ReactNode;
+    isFullWidth?: boolean;
+    isNarrowWidth?: boolean;
+    className?: string;
+    id?: string;
+}

package/dist/components/Page/components/Header/Header.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
-import type { PageHeaderProps } from './Header.props';
-declare const Header: ({ breadcrumb, className, hasDivider, primaryAction, secondaryActions, title, titleMetaData, thumbnail, addon, }: PageHeaderProps) => JSX.Element;
-export default Header;
+import type { PageHeaderProps } from './Header.props';
+declare const Header: ({ breadcrumb, className, hasDivider, primaryAction, secondaryActions, title, titleMetaData, thumbnail, addon, }: PageHeaderProps) => import("react/jsx-runtime").JSX.Element;
+export default Header;

package/dist/components/Page/components/Header/Header.props.d.ts

@@ -1,37 +1,36 @@
-/// <reference types="react" />
-import type { ThumbnailProps } from '../../../Thumbnail';
-export declare type PageHeaderPrimaryActionType = {
-    text?: string;
-    onClick?: () => void;
-    isDisabled?: boolean;
-    isLoading?: boolean;
-    isDanger?: boolean;
-    appearance?: 'secondary' | 'tertiary' | 'transparent' | 'danger';
-    ariaLabel?: string;
-};
-export declare type PageHeaderSecondaryActionType = {
-    text?: string;
-    onClick?: () => void;
-    isDisabled?: boolean;
-    isDanger?: boolean;
-    ariaLabel?: string;
-};
-export declare type PageBreadcrumbType = {
-    onClick?: () => void;
-    text?: string;
-    ariaLabel?: string;
-};
-export interface PageHeaderThumbnailType extends ThumbnailProps {
-    size?: 'huge';
-}
-export interface PageHeaderProps {
-    hasDivider?: boolean;
-    title?: React.ReactNode;
-    primaryAction?: PageHeaderPrimaryActionType;
-    secondaryActions?: PageHeaderSecondaryActionType[];
-    titleMetaData?: React.ReactNode;
-    breadcrumb?: PageBreadcrumbType;
-    className?: string;
-    thumbnail?: PageHeaderThumbnailType;
-    addon?: React.ReactNode;
-}
+import type { ThumbnailProps } from '../../../Thumbnail';
+export type PageHeaderPrimaryActionType = {
+    text?: string;
+    onClick?: () => void;
+    isDisabled?: boolean;
+    isLoading?: boolean;
+    isDanger?: boolean;
+    appearance?: 'secondary' | 'tertiary' | 'transparent' | 'danger';
+    ariaLabel?: string;
+};
+export type PageHeaderSecondaryActionType = {
+    text?: string;
+    onClick?: () => void;
+    isDisabled?: boolean;
+    isDanger?: boolean;
+    ariaLabel?: string;
+};
+export type PageBreadcrumbType = {
+    onClick?: () => void;
+    text?: string;
+    ariaLabel?: string;
+};
+export interface PageHeaderThumbnailType extends ThumbnailProps {
+    size?: 'huge';
+}
+export interface PageHeaderProps {
+    hasDivider?: boolean;
+    title?: React.ReactNode;
+    primaryAction?: PageHeaderPrimaryActionType;
+    secondaryActions?: PageHeaderSecondaryActionType[];
+    titleMetaData?: React.ReactNode;
+    breadcrumb?: PageBreadcrumbType;
+    className?: string;
+    thumbnail?: PageHeaderThumbnailType;
+    addon?: React.ReactNode;
+}

package/dist/components/Page/components/Header/index.d.ts

@@ -1,3 +1,3 @@
-import Header from './Header';
-export * from './Header.props';
-export { Header };
+import Header from './Header';
+export * from './Header.props';
+export { Header };

package/dist/components/Page/components/index.d.ts

@@ -1 +1 @@
-export * from './Header';
+export * from './Header';

package/dist/components/Page/index.d.ts

@@ -1,4 +1,4 @@
-import Page from './Page';
-export * from './components/Header/Header.props';
-export type { PageProps } from './Page.props';
-export { Page };
+import Page from './Page';
+export * from './components/Header/Header.props';
+export type { PageProps } from './Page.props';
+export { Page };

package/dist/components/PageActions/PageActions.d.ts

@@ -1,16 +1,15 @@
-/// <reference types="react" />
-import type { PageActionsProps } from './PageActions.props';
-import './PageActions.styles.scss';
-/**
- * PageActions component is used to display the buttons
- * which are going to control wizards, forms, modals, pages
- *  or any other component
- *
- * @param {PageActionsProps}  PageActionsProps - PageActionsProps
- * @param {PageActionsButtonType}  PageActionsProps.primaryAction - Object to display the main button
- * @param {string} PageActionsProps.position - Position to display button array
- * @param {PageActionsButtonType[]} PageActionsProps.secundaryAction - Object array to display secundary buttons
- * @returns {React.ReactNode} - Element PageActions
- */
-declare const PageActions: ({ primaryAction, position, secondaryActions, isReverse, extraAction, }: PageActionsProps) => JSX.Element;
-export default PageActions;
+import type { PageActionsProps } from './PageActions.props';
+import './PageActions.styles.scss';
+/**
+ * PageActions component is used to display the buttons
+ * which are going to control wizards, forms, modals, pages
+ *  or any other component
+ *
+ * @param {PageActionsProps}  PageActionsProps - PageActionsProps
+ * @param {PageActionsButtonType}  PageActionsProps.primaryAction - Object to display the main button
+ * @param {string} PageActionsProps.position - Position to display button array
+ * @param {PageActionsButtonType[]} PageActionsProps.secundaryAction - Object array to display secundary buttons
+ * @returns {React.ReactNode} - Element PageActions
+ */
+declare const PageActions: ({ primaryAction, position, secondaryActions, isReverse, extraAction, }: PageActionsProps) => import("react/jsx-runtime").JSX.Element;
+export default PageActions;