@apia/components 3.0.9 → 3.0.11

package/dist/index.d.ts

@@ -248,6 +248,145 @@ declare class ApiaUtilNotifications {
     Component: () => React$1.JSX.Element;
 }
 
+declare const TabsList: (({ arrowsBehavior }: {
+    arrowsBehavior?: "open" | "focus" | undefined;
+}) => React__default.JSX.Element | null) & {
+    displayName: string;
+};
+
+declare class Tab<TabType extends TTab = TTab> {
+    state: TabType;
+    controller: TabsController<TabType>;
+    constructor(state: TabType, controller: TabsController<TabType>);
+    get id(): string;
+    /**
+     * El parámetro force evita que se muestre cartel de confirmación al usuario cuando puede haber pérdida de datos.
+     */
+    close(force?: boolean): Promise<boolean>;
+    open(): void;
+}
+declare class TabsController<TabType extends TTab = TTab> {
+    #private;
+    id: string;
+    props: Omit<TabsControllerProps<TabType>, 'id'>;
+    state: TTabsListState<TabType>;
+    getActiveTab(): Tab<TabType>;
+    /**
+     * Es el tab que está abierto
+     */
+    get activeTab(): Tab<TabType>;
+    getTab(id: string): Tab<TabType> | undefined;
+    get tabsList(): Tab<TabType>[];
+    constructor(id: string, props: Omit<TabsControllerProps<TabType>, 'id'>);
+    /**
+     * Obviamente agrega un tab al listado de tabs
+     */
+    append(tab: TabType): void;
+    closeAll(closeFixedTabsAsWell?: boolean, force?: boolean): Promise<void>;
+    closeOpenTab(force?: boolean): void;
+    closeToRight(targetId: string, force?: boolean): Promise<void>;
+    closeToLeft(targetId: string, force?: boolean): Promise<void>;
+    closeOthers(targetId: string, force?: boolean): Promise<void>;
+    closeTab(tabId: string, force?: boolean): Promise<boolean>;
+    focusNextTab(): Tab<TabType> | null;
+    focusPreviousTab(): Tab<TabType> | null;
+    focusTab(tabId: string): void;
+    getTabElement(tabId: string): Element | null;
+    handleKeyDown(ev: React__default.KeyboardEvent): void;
+    openNextTab(): Tab<TabType> | null;
+    openPreviousTab(): Tab<TabType> | null;
+    /**
+     * Se utiliza para hacer que el tab aparezca visible en el listado
+     */
+    openTab(tabId: string): void;
+}
+
+type TOrientation = 'horizontal' | 'vertical';
+type TabsControllerProps<TabType extends TTab> = {
+    id: string;
+    initialTabs?: TabType[];
+    getController?: (controller: TabsController) => unknown;
+    onCloseTab?: (tan: Tab) => void;
+    orientation: TOrientation;
+};
+type TTab = {
+    addEvent?: (ev: 'onFocusTab', cb: (ev: {
+        stop: () => void;
+    }) => unknown) => unknown;
+    content: React__default.FunctionComponent<{
+        tab: Tab;
+    }>;
+    icon?: TIconName | TIconType;
+    /**
+     * El id es importante ya que se utiliza por temas de accesibilidad. Es
+     * importante asegurarse de que sea único.
+     */
+    id: string;
+    isClosable?: boolean;
+    isDisabled?: boolean;
+    /**
+     * Los tabs que estén marcados como fixed aparecerán al inicio del listado.
+     */
+    isFixed?: boolean;
+    isFocused?: boolean;
+    /**
+     * Si se marca como iconTab, se oculta el label y solamente se muestra el
+     * ícono.
+     */
+    isIconTab?: boolean;
+    isLoading?: boolean;
+    isOpen?: boolean;
+    /**
+     * Si un tab se marca como lazy, el iframe no se inicializará hasta que no
+     * sea abierta por primera vez.
+     */
+    lazy?: boolean;
+    /**
+     * Cuando se cierra un tab que tiene un método onBeforeClose, el mismo será
+     * llamado y deberá devolver un boolean o un string. Si devuelve true, se
+     * cierra. Si devuelve false, se muestra un cartel de confirmación genérico y
+     * si se devuelve un string, se muestra un cartel de confirmación con el
+     * string devuelto. En caso de que el usuario confirme el cuadro de diálogo,
+     * el tab será cerrado de todas formas. Es decir, no hay forma de evitar que
+     * el tab sea cerrado si el usuario decide continuar con la acción. Para
+     * evitar que un tab sea cerrado, debe pasarse isClosable=false
+     */
+    onBeforeClose?: () => boolean | string | Promise<boolean | string>;
+    /**
+     * Este callback será llamado cada vez que el tab sea abierto
+     */
+    onFocus?: (ev: Tab) => unknown;
+    /**
+     * Es el texto que se va a mostrar en el tab
+     */
+    label: string;
+    labelRenderer?: TTabLabelRenderer;
+    /**
+     * Se pueden pasar propiedades adicionales que serán recibidas en cada
+     * evento, de forma de poder compartir piezas de información útiles en las
+     * distintas partes de la aplicación.
+     */
+    additionalProps?: any;
+    tabId: string;
+    title?: string;
+};
+type TTabLabelRenderer = (props: {
+    tab: Tab<TTab>;
+}) => React__default.ReactElement;
+type TTabsListState<TabType extends TTab> = {
+    openTabs: Set<Tab<TabType>>;
+    tabs: Map<string, Tab<TabType>>;
+    timestamp: number;
+};
+
+declare const DefaultTabsLabelRenderer: TTabLabelRenderer;
+
+declare const TabsContent: ((props: Omit<BoxProps, 'children'>) => React$1.JSX.Element | null) & {
+    displayName: string;
+};
+
+declare const Tabs: ({ id, getController, initialTabs, orientation, ...props }: TabsControllerProps<TTab> & Omit<BoxProps, 'id' | 'as' | 'role'>, ref: React__default.ForwardedRef<HTMLDivElement>) => React__default.JSX.Element | null;
+
 declare class ApiaUtilTabsController {
     get currentTab(): Tab<TTab>;
     closeTab(tabId: string, force?: boolean): void;
@@ -298,7 +437,16 @@ declare class ApiaUtilParsers {
      * separadores de decimales.
      */
     addThousSeparator(nStr: string | number): string;
+    /**
+     * Toma un número y lo devuelve formateado con los parámetros de Apia
+     */
     apiaNumber(pValue: number): number | string;
+    /**
+     * Toma una cadena de caracteres y lo parsea en el formato de Apia.
+     * Esta cadena de caracteres podría venir por ejemplo de un evento
+     * onChange en un campo de tipo input.
+     */
+    apiaNumber(pValue: string): string;
     /**
      * Toma un número en formato Apia y lo devuelve como float en javascript.
      */
@@ -450,7 +598,9 @@ declare class AutomaticTooltip {
     #private;
     private handler;
     ref: (el: HTMLElement | null) => void;
-    constructor(tooltip: Partial<TTooltip> | null | undefined, handler: ApiaUtilTooltips);
+    constructor(tooltip: (Partial<TTooltip> & {
+        timeout?: number | undefined;
+    }) | null | undefined, handler: ApiaUtilTooltips);
     update: (tooltip: Partial<TTooltip>) => void;
 }
 
@@ -462,7 +612,9 @@ declare class ApiaUtilTooltips {
      * Permite crear un tooltip que se abrirá automáticamente al estar parado
      * sobre un elemento durante 300ms
      */
-    useHover: (tooltip?: Partial<TTooltip>) => AutomaticTooltip;
+    useHover: (tooltip?: Partial<TTooltip> & {
+        timeout?: number;
+    }) => AutomaticTooltip;
     close: (id: string) => void;
     closeAll: () => void;
     open: (tooltip: TTooltip) => ApiaUtilTooltip;
@@ -518,145 +670,6 @@ declare class ApiaUtil {
     Component: () => React$1.JSX.Element;
 }
 
-declare const TabsList: (({ arrowsBehavior }: {
-    arrowsBehavior?: "open" | "focus" | undefined;
-}) => React__default.JSX.Element | null) & {
-    displayName: string;
-};
-
-declare class Tab<TabType extends TTab = TTab> {
-    state: TabType;
-    controller: TabsController<TabType>;
-    constructor(state: TabType, controller: TabsController<TabType>);
-    get id(): string;
-    /**
-     * El parámetro force evita que se muestre cartel de confirmación al usuario cuando puede haber pérdida de datos.
-     */
-    close(force?: boolean): Promise<boolean>;
-    open(): void;
-}
-declare class TabsController<TabType extends TTab = TTab> {
-    #private;
-    id: string;
-    props: Omit<TabsControllerProps<TabType>, 'id'>;
-    state: TTabsListState<TabType>;
-    getActiveTab(): Tab<TabType>;
-    /**
-     * Es el tab que está abierto
-     */
-    get activeTab(): Tab<TabType>;
-    getTab(id: string): Tab<TabType> | undefined;
-    get tabsList(): Tab<TabType>[];
-    constructor(id: string, props: Omit<TabsControllerProps<TabType>, 'id'>);
-    /**
-     * Obviamente agrega un tab al listado de tabs
-     */
-    append(tab: TabType): void;
-    closeAll(closeFixedTabsAsWell?: boolean, force?: boolean): Promise<void>;
-    closeOpenTab(force?: boolean): void;
-    closeToRight(targetId: string, force?: boolean): Promise<void>;
-    closeToLeft(targetId: string, force?: boolean): Promise<void>;
-    closeOthers(targetId: string, force?: boolean): Promise<void>;
-    closeTab(tabId: string, force?: boolean): Promise<boolean>;
-    focusNextTab(): Tab<TabType> | null;
-    focusPreviousTab(): Tab<TabType> | null;
-    focusTab(tabId: string): void;
-    getTabElement(tabId: string): Element | null;
-    handleKeyDown(ev: React__default.KeyboardEvent): void;
-    openNextTab(): Tab<TabType> | null;
-    openPreviousTab(): Tab<TabType> | null;
-    /**
-     * Se utiliza para hacer que el tab aparezca visible en el listado
-     */
-    openTab(tabId: string): void;
-}
-
-type TOrientation = 'horizontal' | 'vertical';
-type TabsControllerProps<TabType extends TTab> = {
-    id: string;
-    initialTabs?: TabType[];
-    getController?: (controller: TabsController) => unknown;
-    onCloseTab?: (tan: Tab) => void;
-    orientation: TOrientation;
-};
-type TTab = {
-    addEvent?: (ev: 'onFocusTab', cb: (ev: {
-        stop: () => void;
-    }) => unknown) => unknown;
-    content: React__default.FunctionComponent<{
-        tab: Tab;
-    }>;
-    icon?: TIconName | TIconType;
-    /**
-     * El id es importante ya que se utiliza por temas de accesibilidad. Es
-     * importante asegurarse de que sea único.
-     */
-    id: string;
-    isClosable?: boolean;
-    isDisabled?: boolean;
-    /**
-     * Los tabs que estén marcados como fixed aparecerán al inicio del listado.
-     */
-    isFixed?: boolean;
-    isFocused?: boolean;
-    /**
-     * Si se marca como iconTab, se oculta el label y solamente se muestra el
-     * ícono.
-     */
-    isIconTab?: boolean;
-    isLoading?: boolean;
-    isOpen?: boolean;
-    /**
-     * Si un tab se marca como lazy, el iframe no se inicializará hasta que no
-     * sea abierta por primera vez.
-     */
-    lazy?: boolean;
-    /**
-     * Cuando se cierra un tab que tiene un método onBeforeClose, el mismo será
-     * llamado y deberá devolver un boolean o un string. Si devuelve true, se
-     * cierra. Si devuelve false, se muestra un cartel de confirmación genérico y
-     * si se devuelve un string, se muestra un cartel de confirmación con el
-     * string devuelto. En caso de que el usuario confirme el cuadro de diálogo,
-     * el tab será cerrado de todas formas. Es decir, no hay forma de evitar que
-     * el tab sea cerrado si el usuario decide continuar con la acción. Para
-     * evitar que un tab sea cerrado, debe pasarse isClosable=false
-     */
-    onBeforeClose?: () => boolean | string | Promise<boolean | string>;
-    /**
-     * Este callback será llamado cada vez que el tab sea abierto
-     */
-    onFocus?: (ev: Tab) => unknown;
-    /**
-     * Es el texto que se va a mostrar en el tab
-     */
-    label: string;
-    labelRenderer?: TTabLabelRenderer;
-    /**
-     * Se pueden pasar propiedades adicionales que serán recibidas en cada
-     * evento, de forma de poder compartir piezas de información útiles en las
-     * distintas partes de la aplicación.
-     */
-    additionalProps?: any;
-    tabId: string;
-    title?: string;
-};
-type TTabLabelRenderer = (props: {
-    tab: Tab<TTab>;
-}) => React__default.ReactElement;
-type TTabsListState<TabType extends TTab> = {
-    openTabs: Set<Tab<TabType>>;
-    tabs: Map<string, Tab<TabType>>;
-    timestamp: number;
-};
-
-declare const DefaultTabsLabelRenderer: TTabLabelRenderer;
-
-declare const TabsContent: ((props: Omit<BoxProps, 'children'>) => React$1.JSX.Element | null) & {
-    displayName: string;
-};
-
-declare const Tabs: ({ id, getController, initialTabs, orientation, ...props }: TabsControllerProps<TTab> & Omit<BoxProps, 'id' | 'as' | 'role'>, ref: React__default.ForwardedRef<HTMLDivElement>) => React__default.JSX.Element | null;
-
 interface ITab {
     fncId: number;
     tabId: string;
@@ -950,6 +963,7 @@ interface IIconInput extends IField {
     icon?: TIconType | TIconName;
     inputProps?: Partial<InputProps>;
     inputRef?: React__default.RefObject<HTMLInputElement>;
+    mask?: string;
     onClick?: (ev: React__default.MouseEvent) => void;
     onBlur?: React__default.FocusEventHandler;
     [key: string]: unknown;
@@ -1017,16 +1031,8 @@ type TNumberInput = Omit<InputProps, 'type' | 'onChange' | 'onBlur' | 'value' |
     value?: string;
     defaultValue?: string;
     avoidDecimalRestriction?: boolean;
+    deleteValueOnError?: boolean;
 };
-declare global {
-    interface Window {
-        AMOUNT_DECIMAL_SEPARATOR: string;
-        AMOUNT_DECIMAL_ZEROS: string;
-        CHAR_DECIMAL_SEPARATOR: string;
-        CHAR_THOUS_SEPARATOR: string;
-        ADD_THOUSAND_SEPARATOR: boolean;
-    }
-}
 declare function parseNumberInputValueToNumber(value: string): number;
 declare function parseNumberValueToNumberInput(value: string | number): string;
 declare const NumberInput: React__default.ForwardRefExoticComponent<Omit<TNumberInput, "ref"> & React__default.RefAttributes<HTMLInputElement>>;
@@ -1595,6 +1601,7 @@ type TIcon<P = Record<string, unknown>> = {
     className?: string;
     id: TId$1;
     icon?: TIconName | TIconType;
+    iconRenderer?: TIconRenderer<P>;
     imageUrl?: string;
     /**
      * Es el texto que se mostrará debajo de la imagen.
@@ -1712,6 +1719,7 @@ type TToolbarIconButton = {
      * entonces el estado de toggle será controlado internamente en el toolbar
      */
     allowToggle?: boolean;
+    className?: string;
     /**
      * Si se desea usar defaultToggled, debería pasarse también allowToggle
      */
@@ -1736,7 +1744,7 @@ type TToolInput = {
 
 declare const ToolbarTextButton: (props: ISimpleButton) => React$1.JSX.Element;
 
-declare const ToolbarIconButton: ({ id, action, actionSource, allowToggle, defaultToggled, disabled, icon, iconSize, isLoading: outerIsLoading, title, toggled: toggledProp, }: TToolbarIconButton) => React$1.JSX.Element;
+declare const ToolbarIconButton: ({ id, action, actionSource, allowToggle, className, defaultToggled, disabled, icon, iconSize, isLoading: outerIsLoading, title, toggled: toggledProp, }: TToolbarIconButton) => React$1.JSX.Element;
 
 declare const ToolbarInput: (tool: TToolInput) => React$1.JSX.Element;