@foris/avocado-suite 0.10.0 → 0.11.0

package/dist/avocado-suite/src/components/DataTable/DataTable.d.ts

@@ -0,0 +1,8 @@
+declare const DataTable: {
+    Action: import("react").FC<import("./components/DataTableAction/DataTableAction").IDataTableAction>;
+    ActionsGroup: import("react").FC<import("./components/DataTableAction/DataTableActionsGroup").IDataTableActionsGroup>;
+    Content: import("react").FC<import("./components/DataTableContent/DataTableContent").IDataTableContent>;
+    Header: import("react").FC<import("./components/DataTableHeader/DataTableHeader").IDataTableHeader>;
+    Row: import("react").FC<import("./components/DataTableRow/DataTableRow").IDataTableRow>;
+};
+export default DataTable;

package/dist/avocado-suite/src/components/DataTable/components/DataTableAction/DataTableAction.d.ts

@@ -0,0 +1,28 @@
+import { FC, ReactNode } from 'react';
+import { IconTypes } from '../../../../../../avocado-icons/src/types/icons.type.ts';
+import IconSize from '../../../../../../avocado-icons/src/types/size.enum';
+export type DataTableActionPosition = 'left' | 'right';
+export type DataTableActionType = 'primary' | 'success' | 'warning' | 'danger';
+export interface IDataTableAction {
+    /** replace icon with another element */
+    children?: ReactNode | string;
+    /** overwrite children classnames */
+    classname?: {
+        aside?: string;
+        icon?: string;
+    };
+    /** disabled state */
+    disabled?: boolean;
+    /** icon value */
+    icon?: IconTypes;
+    /** icon size */
+    iconSize?: keyof typeof IconSize;
+    /** position value */
+    position: DataTableActionPosition;
+    /** type value */
+    type?: DataTableActionType;
+    /** option to action in anchor*/
+    onClick?: () => void;
+}
+declare const DataTableAction: FC<IDataTableAction>;
+export default DataTableAction;

package/dist/avocado-suite/src/components/DataTable/components/DataTableAction/DataTableActionsGroup.d.ts

@@ -0,0 +1,10 @@
+import * as React from 'react';
+import DataTableAction from './DataTableAction';
+export interface IDataTableActionsGroup {
+    /** actions */
+    children: React.ReactElement<typeof DataTableAction> | React.ReactElement<typeof DataTableAction>[];
+    /** overwrite className */
+    className?: string;
+}
+declare const DataTableActionsGroup: React.FC<IDataTableActionsGroup>;
+export default DataTableActionsGroup;

package/dist/avocado-suite/src/components/DataTable/components/DataTableContent/DataTableContent.d.ts

@@ -0,0 +1,71 @@
+import React, { CSSProperties } from 'react';
+import DataTableAction from '../DataTableAction/DataTableAction';
+import DataTableActionsGroup from '../DataTableAction/DataTableActionsGroup';
+export type DataTableContentType = 'accordion' | 'regular';
+export type DataTableSubContentStyle = 'inheritance' | 'custom';
+export interface IColumn {
+    accessor: string;
+    header: string;
+    position: number;
+    styles?: CSSProperties;
+    renderCell?: (value: any) => void;
+    tooltip?: boolean | string;
+}
+export interface IResponsiveStylesOptions {
+    maxWidth?: string;
+    minWidth?: string;
+    padding?: string;
+    width?: string;
+    textAlign?: 'left' | 'right' | 'center';
+}
+export interface IResponsiveOptions {
+    position?: number;
+    styles?: IResponsiveStylesOptions;
+}
+export interface IColumnResponsive {
+    allDevices?: IResponsiveOptions;
+    desktop?: IResponsiveOptions;
+    mobile?: IResponsiveOptions;
+}
+export interface IDataTableContentColumn {
+    /** This string is used to build the data model for your column. */
+    accessor: string;
+    /** Column's name */
+    header: string;
+    /** The responsive configuration for the column. */
+    responsive?: IColumnResponsive;
+    /** This function (or component) is primarily used for formatting the column value */
+    renderCell?: (value: any) => void;
+    /** Tooltip to display the cell content or an extra value. */
+    tooltip?: boolean | string;
+}
+export interface IDataTableContentActions {
+    /** Column's name */
+    header?: React.ReactNode | string;
+    /** Column's visibility */
+    visibility: boolean;
+    /** This function (or component) is primarily used for formatting the column value */
+    renderComponent: (value: any) => React.ReactElement<typeof DataTableAction> | React.ReactElement<typeof DataTableActionsGroup> | null;
+}
+export interface IDataTableContent {
+    /** overwrite className */
+    className?: string;
+    /** The columns configuration for the table. */
+    columns: IDataTableContentColumn[];
+    /** The data that you want to display on the table. */
+    data: any[];
+    /** Left action or actions on the table */
+    leftActions?: IDataTableContentActions;
+    /** Right action or actions on the table */
+    rightActions?: IDataTableContentActions;
+    /** content type: regular | accordion */
+    contentType?: DataTableContentType;
+    /** key to render sub data */
+    keyBody?: string;
+    /** style of sub content: inheritance | custom */
+    styleBody?: DataTableSubContentStyle;
+    /** event to render each sub row  */
+    renderBody?: (body: any) => any;
+}
+declare const DataTableContent: React.FC<IDataTableContent>;
+export default DataTableContent;

package/dist/avocado-suite/src/components/DataTable/components/DataTableHeader/DataTableHeader.d.ts

@@ -0,0 +1,20 @@
+import React from 'react';
+import { DataTableContentType, DataTableSubContentStyle, IDataTableContentActions, IDataTableContentColumn } from '../DataTableContent/DataTableContent';
+export interface IDataTableHeader {
+    /** overwrite className */
+    className?: string;
+    /** The columns configuration for the table. */
+    columns: IDataTableContentColumn[];
+    /** content type: regular | accordion */
+    contentType?: DataTableContentType;
+    /** Check if is mobile device */
+    isMobile?: boolean;
+    /** Left action or actions on the table */
+    leftActions?: IDataTableContentActions;
+    /** Right action or actions on the table */
+    rightActions?: IDataTableContentActions;
+    /** style of sub content: inheritance | custom */
+    styleBody?: DataTableSubContentStyle;
+}
+declare const DataTableHeader: React.FC<IDataTableHeader>;
+export default DataTableHeader;

package/dist/avocado-suite/src/components/DataTable/components/DataTableRow/DataTableRow.d.ts

@@ -0,0 +1,16 @@
+import { FC } from 'react';
+import { IColumn, IDataTableContentActions } from '../DataTableContent/DataTableContent';
+export interface IDataTableRow {
+    /** The columns parsed for the table. */
+    columns: IColumn[][];
+    /** The data that you want to display on the table. */
+    data: any;
+    /** Check if is mobile device */
+    isMobile?: boolean;
+    /** Left action or actions on the table */
+    leftActions?: IDataTableContentActions;
+    /** Right action or actions on the table */
+    rightActions?: IDataTableContentActions;
+}
+declare const DataTableRow: FC<IDataTableRow>;
+export default DataTableRow;

package/dist/avocado-suite/src/components/DataTable/components/DataTableRow/DataTableRowAccordion.d.ts

@@ -0,0 +1,18 @@
+import React from 'react';
+import { DataTableSubContentStyle } from '../DataTableContent/DataTableContent';
+export interface IDataTableRowAccordion {
+    /** The columns parsed for the table. */
+    columns: any[];
+    /** The data that you want to display on the table. */
+    data: any;
+    /** Check if is mobile device */
+    isMobile?: boolean;
+    /** key to render sub data */
+    keyBody?: string;
+    /** style of sub content: inheritance | custom */
+    styleBody?: DataTableSubContentStyle;
+    /** event to render each sub row  */
+    renderBody?: (body: any) => any;
+}
+declare const DataTableRowAccordion: React.FC<IDataTableRowAccordion>;
+export default DataTableRowAccordion;

package/dist/avocado-suite/src/components/DataTable/utils/dataTableUtil.d.ts

@@ -0,0 +1,18 @@
+import { IDataTableContentColumn, IResponsiveOptions, IResponsiveStylesOptions } from '../components/DataTableContent/DataTableContent';
+export declare const getStyles: (options?: IResponsiveOptions) => {
+    maxWidth: string;
+    minWidth: string;
+    padding: string;
+    textAlign: "center" | "left" | "right";
+    width: string;
+};
+export declare const parseColumn: (column: IDataTableContentColumn, index: number) => {
+    accessor: string;
+    header: string;
+    renderCell?: ((value: any) => void) | undefined;
+    tooltip?: string | boolean | undefined;
+    position: number;
+    styles: IResponsiveStylesOptions;
+};
+export declare const verifyActionComponent: (element: any) => any;
+export declare const verifyActionsGroupComponent: (element: any) => any;

package/dist/avocado-suite/src/components/Pill/Pill.d.ts

@@ -0,0 +1,23 @@
+import React from 'react';
+import { IconTypes } from '../../../../../../../../avocado-icons/src/types/icons.type';
+import { Color } from '../../../../../../../../avocado-icons/src/types/color.enum';
+export interface PillProps {
+    /** Optional Icon name */
+    icon?: IconTypes;
+    /** Overwrite icon original color */
+    iconColor?: `${Color}`;
+    /** Icon filled state */
+    iconFilled?: boolean;
+    /** Overwrite pill original color */
+    color?: `${Color}`;
+    /** Overwrite pill original text color */
+    textColor?: `${Color}`;
+    /** Controls pill outlined state */
+    outlined?: boolean;
+    /** content pill */
+    children: React.ReactNode | string;
+    /** overwrite className */
+    className?: string;
+}
+declare const Pill: React.FC<PillProps>;
+export default Pill;

package/dist/avocado-suite/src/components/Pill/Pill.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/avocado-suite/src/components/box/Box.d.ts

@@ -0,0 +1,11 @@
+import { FC, ReactNode } from 'react';
+export interface BoxProps {
+    /** content card */
+    children: ReactNode | string;
+    /** Overwrite className */
+    className?: string;
+    /** Use dark colors palette*/
+    darkMode?: boolean;
+}
+declare const Box: FC<BoxProps>;
+export default Box;

package/dist/avocado-suite/src/components/breadcrumbs/Breadcrumbs.d.ts

@@ -0,0 +1,19 @@
+import React from 'react';
+export interface BreadcrumbItem {
+    /** To integrate with react-router component */
+    component?: React.ReactElement;
+    /** Path working with `href` attribute */
+    path?: string;
+    /** Navigation item name */
+    title: string;
+}
+interface BreadcrumbsProps {
+    /** Overwrite className */
+    className?: string;
+    /** Use dark colors palette*/
+    darkMode?: boolean;
+    /** The navigation stack */
+    items: BreadcrumbItem[];
+}
+declare const Breadcrumbs: React.FC<BreadcrumbsProps>;
+export default Breadcrumbs;

package/dist/avocado-suite/src/components/button/Button.d.ts

@@ -0,0 +1,19 @@
+import React, { FC } from 'react';
+import { IconTypes } from '../../../../avocado-icons/src/types/icons.type.ts';
+export type ButtonVariant = 'primary' | 'secondary' | 'ghost' | 'danger';
+export interface ButtonProps extends React.DetailedHTMLProps<React.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement> {
+    /** Render content button */
+    children: React.ReactNode | string;
+    /** Overwrite className */
+    className?: string;
+    /** Loading state */
+    loading?: boolean;
+    /** Show icon on the left */
+    leftIcon?: IconTypes;
+    /** Show icon on the right */
+    rightIcon?: IconTypes;
+    /** Use the variant prop to change the visual style of the Button */
+    variant?: ButtonVariant;
+}
+declare const Button: FC<ButtonProps>;
+export default Button;

package/dist/avocado-suite/src/components/card/Card.d.ts

@@ -0,0 +1,17 @@
+import { FC, ReactNode } from 'react';
+interface CardProps {
+    /** Content card */
+    children: ReactNode;
+    /** Overwrite className */
+    className?: string;
+    /** Color id */
+    colorId?: number;
+    /** Overwrite content className  */
+    classNameContent?: string;
+    /** Disabled state */
+    disabled?: boolean;
+    /** OnClick event */
+    onClick?: () => void;
+}
+declare const Card: FC<CardProps>;
+export default Card;

package/dist/avocado-suite/src/components/card-notification/CardNotification.d.ts

@@ -0,0 +1,27 @@
+import { FC } from 'react';
+import { ReactElement } from 'react';
+declare enum NotificationState {
+    Warning = "warning",
+    Error = "error",
+    Info = "info",
+    Success = "success"
+}
+interface CardNotificationProps {
+    /** State or variant of the notification */
+    state: `${NotificationState}`;
+    /** Outlined variant */
+    outlined?: boolean;
+    /** Overwrite className */
+    className?: string;
+    /** Title of the notification */
+    title: ReactElement | string;
+    /** Description of the notification */
+    description?: ReactElement | string;
+    /** Action of the notification */
+    action?: {
+        text: string;
+        onClick: () => void;
+    };
+}
+declare const CardNotification: FC<CardNotificationProps>;
+export default CardNotification;

package/dist/avocado-suite/src/components/checkbox/Checkbox.d.ts

@@ -0,0 +1,16 @@
+import { FC, ReactNode } from 'react';
+export interface CheckboxProps extends React.DetailedHTMLProps<React.InputHTMLAttributes<HTMLInputElement>, HTMLInputElement> {
+    /** Overwrite className */
+    className?: string;
+    /** Overwrite className in checkbox */
+    classNameCheckbox?: string;
+    /** label Left side checkbox */
+    labelLeft?: ReactNode | string;
+    /** label Right side checkbox */
+    labelRight?: ReactNode | string;
+    /** disabled state */
+    disabled?: boolean;
+    ref?: any;
+}
+declare const Checkbox: FC<CheckboxProps>;
+export default Checkbox;

package/dist/avocado-suite/src/components/divider/Divider.d.ts

@@ -0,0 +1,11 @@
+import { FC } from 'react';
+interface DividerProps {
+    /** Overwrite className */
+    className?: string;
+    /** Disabled state */
+    disabled?: boolean;
+    /** Set the position vertical */
+    vertical?: boolean;
+}
+declare const Divider: FC<DividerProps>;
+export default Divider;

package/dist/avocado-suite/src/components/donut/Donut.d.ts

@@ -0,0 +1,18 @@
+import { FC } from 'react';
+export interface IDonutItem {
+    name: string;
+    percentage: number;
+    value: number;
+}
+export interface DonutProps {
+    /** overwrite className */
+    className?: string;
+    /** data */
+    data: IDonutItem[];
+    /** height */
+    height?: string;
+    /** width */
+    width?: string;
+}
+declare const Donut: FC<DonutProps>;
+export default Donut;

package/dist/avocado-suite/src/components/donut/donut-labels/DonutLabels.d.ts

@@ -0,0 +1,10 @@
+import { FC } from 'react';
+import { IDonutItem } from '../Donut';
+export interface DonutLabelsProps {
+    /** overwrite className */
+    className?: string;
+    /** data */
+    data: IDonutItem[];
+}
+declare const DonutLabels: FC<DonutLabelsProps>;
+export default DonutLabels;

package/dist/avocado-suite/src/components/donut/donut-legend/DonutLegend.d.ts

@@ -0,0 +1,14 @@
+import { FC } from 'react';
+import { IDonutItem } from '../Donut';
+export interface DonutLegendProps {
+    /** overwrite className */
+    className?: string;
+    /** data */
+    data: IDonutItem[];
+    /** Overwrite total label */
+    totalLabel?: string;
+    /** Show or not the total label */
+    showTotal?: boolean;
+}
+declare const DonutLegend: FC<DonutLegendProps>;
+export default DonutLegend;

package/dist/avocado-suite/src/components/heading/Heading.d.ts

@@ -0,0 +1,13 @@
+import { ReactNode, FC } from 'react';
+export interface HeadingProps {
+    /** Render content */
+    children: ReactNode | string;
+    /** Overwrite className */
+    className?: string;
+    /** Use dark colors palette*/
+    darkMode?: boolean;
+    /** Set importance. Match with h1, h2, h3 and h4 */
+    type: 'h1' | 'h2' | 'h3' | 'h4';
+}
+declare const Heading: FC<HeadingProps>;
+export default Heading;

package/dist/avocado-suite/src/components/link/Link.d.ts

@@ -0,0 +1,22 @@
+import { FC } from 'react';
+import { IconTypes } from '../../../../avocado-icons/src/types/icons.type';
+export interface LinkProps extends React.DetailedHTMLProps<React.AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement> {
+    /** Render content link */
+    children: React.ReactNode | string;
+    /** Overwrite className */
+    className?: string;
+    /** Set disabled value */
+    disabled?: boolean;
+    /** Set icon left */
+    iconLeft?: IconTypes;
+    /** Set icon right */
+    iconRight?: IconTypes;
+    /** Use when the background is dark */
+    inverse?: boolean;
+    /** Use size 'sm' or 'md'. Default 'md' */
+    size?: 'sm' | 'md';
+    /** Handle onClock event */
+    onClick?: () => void;
+}
+declare const Link: FC<LinkProps>;
+export default Link;

package/dist/avocado-suite/src/components/menu/Menu.d.ts

@@ -0,0 +1,14 @@
+import { FC } from 'react';
+import { MenuItem } from '../../types/menu.types.ts';
+interface MenuProps {
+    /** Control if you want to close the list after clicking one of the options or not */
+    closeOnClick?: boolean;
+    /** From where to start to render the list */
+    listOrigin?: 'left' | 'right';
+    /** List of the items to render when the menu is open */
+    items: MenuItem[];
+    /** Overwrite className */
+    className?: string;
+}
+declare const Menu: FC<MenuProps>;
+export default Menu;

package/dist/avocado-suite/src/components/pager/Pager.d.ts

@@ -0,0 +1,49 @@
+import { FC } from 'react';
+export type PagerProps = {
+    /** Overwrite children classNames */
+    classname?: {
+        global?: string;
+        nav?: string;
+        arrow?: string;
+        button?: string;
+    };
+    /**
+     * Current page
+     */
+    page: number;
+    /**
+     * Size per page
+     */
+    size: number;
+    /**
+     * Total number of items
+     */
+    total: number;
+    /**
+     * Total number of pages
+     */
+    totalPages?: number;
+    /**
+     * Callback: Action `onClick` on page
+     * @param page number of page
+     * @returns
+     */
+    onChange?: (page: number) => void;
+    /**
+     * Deprecated use "onChange" prop.
+     * @deprecated use "onChange" prop.
+     */
+    onPageChange?: (page: number) => void;
+    /**
+     * Deprecated is not used in the component
+     * @deprecated is not used in the component
+     */
+    hasPreviousPage?: boolean;
+    /**
+     * Deprecated is not used in the component
+     * @deprecated is not used in the component
+     */
+    hasNextPage?: boolean;
+};
+declare const Pager: FC<PagerProps>;
+export default Pager;

package/dist/avocado-suite/src/components/pager/components/ArrowPager.d.ts

@@ -0,0 +1,9 @@
+import { FC } from 'react';
+interface ArrowProps {
+    className?: string;
+    onClick: () => void;
+    icon: 'chevron-left' | 'chevron-right' | 'chevrons-left' | 'chevrons-right';
+    disabled: boolean;
+}
+declare const Arrow: FC<ArrowProps>;
+export default Arrow;

package/dist/avocado-suite/src/components/pager/components/ButtonPager.d.ts

@@ -0,0 +1,11 @@
+import { FC } from 'react';
+interface ButtonPagerProps {
+    className?: string;
+    onClick: () => void;
+    page: number;
+    currentPage: number;
+    ellipsisAsNumber: number;
+    disabled?: boolean;
+}
+declare const ButtonPager: FC<ButtonPagerProps>;
+export default ButtonPager;

package/dist/avocado-suite/src/components/pager/utils/generateArrayOfPages.d.ts

@@ -0,0 +1,2 @@
+declare const generateArrayOfPages: (currentPage: number, numberOfPages: number, ellipsisAsNumber: number) => number[];
+export default generateArrayOfPages;

package/dist/avocado-suite/src/components/processing/Processing.d.ts

@@ -0,0 +1,3 @@
+import { FC } from 'react';
+declare const Processing: FC;
+export default Processing;

package/dist/avocado-suite/src/components/progress-bar/ProgressBar.d.ts

@@ -0,0 +1,13 @@
+import { FC } from 'react';
+export interface ProgressBarProps {
+    /** overwrite className */
+    className?: string;
+    /** done */
+    done?: number;
+    /** inProgress */
+    inProgress?: number;
+    /** total */
+    total: number;
+}
+declare const ProgressBar: FC<ProgressBarProps>;
+export default ProgressBar;

package/dist/avocado-suite/src/components/radio-button/RadioButton.d.ts

@@ -0,0 +1,17 @@
+import { FC, ReactNode, DetailedHTMLProps, InputHTMLAttributes } from 'react';
+export interface RadioButtonProps extends DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement> {
+    /** overwrite className */
+    className?: string;
+    /** overwrite className in RadioButton */
+    classNameRadioButton?: string;
+    /** Text or ReactNode to be displayed at the left of the radio input */
+    labelLeft?: ReactNode | string;
+    /** Label Right side RadioButton*/
+    labelRight?: ReactNode | string;
+    /** disabled state */
+    disabled?: boolean;
+    /** Reference used on the input component */
+    ref?: any;
+}
+declare const RadioButton: FC<RadioButtonProps>;
+export default RadioButton;

package/dist/avocado-suite/src/components/round-button/RoundButton.d.ts

@@ -0,0 +1,17 @@
+import { FC } from 'react';
+import { ButtonVariant } from '../button/Button';
+import { IconTypes } from '../../../../../../../../avocado-icons/src/types/icons.type.ts';
+interface RoundButtonProps extends Partial<React.DetailedHTMLProps<React.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>> {
+    /** Icon name */
+    icon: IconTypes;
+    /** Variant of the button */
+    variant?: ButtonVariant;
+    /** Overwrite className */
+    className?: string;
+    /** Loading state */
+    loading?: boolean;
+    /** Disabled state */
+    disabled?: boolean;
+}
+declare const RoundButton: FC<RoundButtonProps>;
+export default RoundButton;