@apia/components 4.0.27 → 4.0.29

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import * as React$1 from 'react';
 import React__default, { ReactNode, Ref, RefObject, DetailedHTMLProps, TextareaHTMLAttributes, ChangeEventHandler, FocusEvent, MouseEvent as MouseEvent$1, KeyboardEvent, FC, PropsWithChildren, FunctionComponent, ForwardedRef, ComponentType, ReactElement } from 'react';
 import * as _apia_util from '@apia/util';
 import { IOnFocusConfiguration, TFocusRetriever, TId as TId$1, EventEmitter, StatefulEmitter, TModify, TApiaFilter, TApiaFilterValue } from '@apia/util';
-import { BoxProps, TPalette, InputProps, ThemeUIStyleObject, IconButtonProps, ButtonProps, ThemeUICSSObject, SelectProps } from '@apia/theme';
+import { BoxProps, TPalette, InputProps, ThemeUIStyleObject, IconButtonProps, ButtonProps, ThemeUICSSObject, SelectProps, LabelProps } from '@apia/theme';
 import { TIconName, TIconType } from '@apia/icons';
 import { MenuItemProps, ControlledMenuProps } from '@szhsin/react-menu';
 export { ControlledMenuProps, MenuItemProps } from '@szhsin/react-menu';
@@ -2061,6 +2061,46 @@ declare const Uploader: (({ handler }: {
     displayName: string;
 };
 
+interface IPagination {
+    appliedFilters?: number;
+    /**
+     * Este valor determina si el boton de eliminar filtros debe mostrarse como si hubieran filtros sin aplicar (en caso de que haya filtros aplicados por defecto) o si debe mostrarse como si todos los filtros con valor estan aplicados a la busqueda actual. Se deberia verificar con el slice de redux correspondiente a la tabla.
+     */
+    areAllFiltersApplied?: boolean;
+    className?: string;
+    currentPage: number | string;
+    disabled?: boolean;
+    disableReduced?: boolean;
+    hideInfo?: boolean;
+    hideMaximizeButton?: boolean;
+    hideRefreshButton?: boolean;
+    isLoading?: boolean;
+    /**
+     * Valor obtenido del buttonsSlice para bloquear los botones de la paginacion mientras se estan ejecutando acciones
+     */
+    isPerforming?: boolean;
+    /**
+     * Si se pasa un método onDeleteFilters, aparece el botón "Eliminar filtros"
+     * cerca del refresh
+     */
+    onDeleteFilters?: () => unknown;
+    onPageChange: (page: number) => unknown;
+    onRefresh: (page: number) => unknown;
+    pageCount: number | string;
+    reachedMax?: boolean | undefined;
+    hasMore?: boolean | undefined;
+    /**
+     * Si la cantidad de registros se obtiene desde un lugar distinto de Redux,
+     * se puede pasar como number directamente
+     */
+    recordsCount?: number;
+    showMaximizeOnSmallBreakpoints?: boolean;
+    variant?: 'primary' | 'secondary' | 'datagrid';
+    onMaximize?: () => unknown;
+    isMaximized?: boolean;
+}
+declare const Pagination: React__default.MemoExoticComponent<({ appliedFilters, areAllFiltersApplied, className, currentPage, disabled, disableReduced, hasMore, hideInfo, hideMaximizeButton, hideRefreshButton, isLoading, isPerforming, onDeleteFilters, onPageChange, onRefresh, pageCount, recordsCount: outerRecordsCount, reachedMax, showMaximizeOnSmallBreakpoints, variant, isMaximized, onMaximize, }: IPagination) => React__default.JSX.Element>;
+
 interface IAsidePanel {
     title?: string;
     toolTip?: string;
@@ -2069,18 +2109,130 @@ interface IAsidePanel {
     spacer?: boolean;
     className?: string;
 }
+declare const AsidePanel: ({ title, toolTip, children, columns, spacer, className, }: IAsidePanel) => React$1.JSX.Element;
 
 declare function isFavoriteIcon(): boolean;
+declare const FavoriteIcon: () => React$1.JSX.Element;
+
+declare const Label: ({ variant, ...props }: LabelProps) => React$1.JSX.Element;
 
 interface IMenuDefinition {
     menu: React__default.ReactNode;
     stage: string;
 }
+type TMenuEvents = {
+    updateMenu: React__default.ReactNode;
+};
+declare class MenuController extends EventEmitter<TMenuEvents> {
+    #private;
+    on<K extends keyof TMenuEvents>(eventName: K, fn: (ev: TMenuEvents[K]) => unknown): () => void;
+    getCurrent(): string | number | boolean | React__default.ReactElement<any, string | React__default.JSXElementConstructor<any>> | Iterable<React__default.ReactNode> | null;
+    remove(stage: string): void;
+    setMenu(definition: IMenuDefinition): () => void;
+}
+/**
+ * El menú controller pretende solucionar el problema de tener múltiples menúes
+ * para distintas pantallas dentro del mismo flujo de trabajo. El problema
+ * original surge en administración de grupos. Al presionar modificar se
+ * cambia de pantalla y por lo tanto de menú, pero se sigue estando en el mismo
+ * flujo y se pretende que al presionar regresar, se restaure el menú original.
+ * Todo esto sin afectar la responsividad de los mismos.
+ *
+ * Para solucionar esta problemática, se introduce este controlador, cuyo
+ * funcionamiento es muy sencillo. Cada vez que un componente quiere setear un
+ * menú para una pantalla particular, hace uso del método
+ * menuController.setMenu.
+ *
+ * Una vez que la pantalla se está desmontando, debe desmontar su menú haciendo
+ * uso del método menuController.remove.
+ *
+ * Mediante el hook useMenu provisto en este documento, se puede hacer uso del
+ * menú actual, sin preocuparse de la existencia de varios elementos que
+ * coincidan.
+ */
+declare const menuController: MenuController;
 /**
  * Este hook permite insertar el menú en un componente.
  */
 declare function useMenu(breakPoints?: number[], initialMenu?: IMenuDefinition): React__default.ReactNode;
 
+/**
+ * Con el código comentado dentro de FooterButtons se hace
+ * que se muestren los botones cuando se está haciendo scroll
+ * hacia abajo.
+ */
+/**
+ *
+ */
+declare const FooterButtons: (props: BoxProps) => React$1.JSX.Element;
+
+/**
+ * Este aside aparece en la vista twoColumnList en los
+ * breakpoints de vista móvil.
+ */
+declare const AccordionAside: () => React$1.ReactNode;
+
+/**
+ * Este aside aparece por defecto en los breakpoints
+ * de desktop.
+ */
+declare const Aside: () => React$1.JSX.Element;
+
+type TAsideLoader = Partial<IMenuDefinition> & {
+    children: React__default.ReactNode;
+    variant?: string;
+};
+declare const AsideLoader: (definition: TAsideLoader) => null;
+
+/**
+ * Aside del template twoColumns. Breakpoints: 0,1,2.
+ *
+ * Este aside aparece por defecto en la vista móvil del
+ * twoColumns.
+ */
+declare const BodyAside: () => React$1.ReactNode;
+
+/**
+ * Aside del template twoColumns. Breakpoints: 0,1,2.
+ *
+ * Este aside es el que aparece cuando el usuario hizo scroll
+ * en la vista responsiva, y luego hizo scroll hacia arriba.
+ */
+declare const FloatingAside: () => React__default.JSX.Element | null;
+
+declare const FooterResponsiveButtons: ({ breakpoint, children, className, }: {
+    breakpoint?: number;
+    children: React__default.ReactNode;
+    className?: string;
+}) => React__default.JSX.Element | null;
+
+/**
+ * Este aside solamente aparece en el breakpoint 3 y es el que
+ * se muestra en el menú de hamburguesa.
+ */
+declare const HamburguerMenu: ({ container, header, forceVisibility, }: {
+    container: string;
+    forceVisibility?: boolean;
+    header: string;
+}) => React__default.JSX.Element;
+
+interface IHeader {
+    title: string;
+    description?: string;
+    image?: string;
+}
+declare const Header: ({ title, description, image: imageUrl }: IHeader) => React$1.JSX.Element;
+
+declare const HeaderButtons: () => React$1.JSX.Element;
+
+declare const ShowResponsive: ({ show, children, display, }: {
+    display?: string;
+    show?: boolean[];
+    children: React$1.ReactNode;
+}) => React$1.JSX.Element;
+
+declare const CenteredHeaderButtons: () => React__default.JSX.Element;
+
 declare class TableParameter extends Parameter<ITableParameterProps> {
     constructor(params: ITableParameterProps);
 }
@@ -2467,5 +2619,5 @@ declare class Templater {
     parseString(content: string, options?: IAlterDefaultOptions): string | JSX.Element | JSX.Element[];
 }
 
-export { Accordion, AccordionContext, AccordionItem, AccordionItemButton, AccordionItemContent, AccordionItemContext, AlertModal, ApiaFilter, ApiaUtil, ApiaUtilModalHandler, ApiaUtilTooltip, AutoEllipsis, Autocomplete, type AutocompleteCmpProps, AutocompleteController, type AutocompleteOption, type AutocompleteProps, AutogrowTextarea, AutoscrollContainer, BaseButton, CalendarModal, Captcha, ChatController, ChatMessage, Checkbox, CollapsiblePanel, Confirm, ConfirmModal, ContainerWithHeader, DateInput, DeadSessionModal, DefaultAccordionItemButton, DefaultIconRenderer, DefaultTabsLabelRenderer, DialogButtonBar, Dropzone, FieldErrorMessage, FieldLabel, FileCard, FilterConditionDTO, FilterDTO, FiltersStore, FloatingChatController, type IAccordionItemButton, type IAccordionItemProps, type IAccordionProps, type IAlert, type IApiaFilter, type IAsidePanel, type IAttachment, type ICalendarModal, type IConfirm, type IDialogButtonBar, type IDialogHeader, type IField, type IFieldErrorMessage, type IFilterCondition, type IFilterDTOState, type IFilterValue, type IIconInput, type IMenuDefinition, type IOverlay, type IParameter, type IParametersGroup, type IRequiredMark, type IResponsiveComponent, type ISimpleButton, type ITableParameterProps, IconButton, IconInput, IconsList, LabelBox, LinearLoader, ListSkeletonLoader, Listbox, ListboxItem, LoaderSpinner, type MessageCallbackProps, type MessageSubmitCallback, Modal, NumberInput, Overlay, Parameter, type ParameterObject, type ParameterPossibleValue, ParameterRender, type ParameterRenderer, type ParameterRendererProps, type ParameterType, Parameters, type ParametersDefinition, ParametersGroup, type ParametersGroupRenderer, ParametersStore, ParametersTable, type Payload, ProgressBar, RequiredMark, ScreenLocker, SimpleButton, SortableList, SortableListItem, type TAccordionHandler, type TAccordionItemButton, type TApiaButtonType, type TApiaIconButton, type TChatControllerState, type TCheckbox, type TCssProps, type TDateProps, type TFieldLabel, type TFilterOp, type TFilterPayload, type TFilterType, type TFilterValue, type TFilterValueType, type TGetTabsController, type TIcon, type TIconButton, type TIconRenderer, type TIconSize, type TIconsList, type TListbox, type TMenuItem, type TMessageType, type TModal, type TModalSize, type TNumberInput, type TNumberInputChangeEvent, type TOnClickNode, type TOnConfirmSelection, type TOnSelectionChange, type TOpenModal, type TParameterType, type TSubmenu, type TTab, type TTabLabelRenderer as TTabRenderer, type TToolbarIconButton as TToolDefinition, type TTooltip, type TUploadHandlerProps, type TUploadInProgress, type TUploadedFile, type TUseModalConfiguration, type TVisualizationType, Tab, Tabs, TabsContent, TabsController, TabsList, Templater, Toolbar, ToolbarController, ToolbarIconButton, ToolbarInput, ToolbarSelect, ToolbarSeparator, ToolbarTextButton, UnstyledSortableList, UploadHandler, Uploader, WaiTypeAhead, getBase64FromBlob, getBase64FromFile, getFieldErrorStyles, getFieldTouchedStyles, getFileExtension, importComponent, isFavoriteIcon, isImage, isParametersGroup, makeResponsiveComponent, parseNumberInputValueToNumber, parseNumberValueToNumberInput, useAccordionContext, useCurrentTab, useMenu, useModal, useModalContext, useOtherTagButton, useTabsContext };
+export { Accordion, AccordionAside, AccordionContext, AccordionItem, AccordionItemButton, AccordionItemContent, AccordionItemContext, AlertModal, ApiaFilter, ApiaUtil, ApiaUtilModalHandler, ApiaUtilTooltip, Aside, AsideLoader, AsidePanel, AutoEllipsis, Autocomplete, type AutocompleteCmpProps, AutocompleteController, type AutocompleteOption, type AutocompleteProps, AutogrowTextarea, AutoscrollContainer, BaseButton, BodyAside, CalendarModal, Captcha, CenteredHeaderButtons, ChatController, ChatMessage, Checkbox, CollapsiblePanel, Confirm, ConfirmModal, ContainerWithHeader, DateInput, DeadSessionModal, DefaultAccordionItemButton, DefaultIconRenderer, DefaultTabsLabelRenderer, DialogButtonBar, Dropzone, FavoriteIcon, FieldErrorMessage, FieldLabel, FileCard, FilterConditionDTO, FilterDTO, FiltersStore, FloatingAside, FloatingChatController, FooterButtons, FooterResponsiveButtons, HamburguerMenu, Header, HeaderButtons, type IAccordionItemButton, type IAccordionItemProps, type IAccordionProps, type IAlert, type IApiaFilter, type IAsidePanel, type IAttachment, type ICalendarModal, type IConfirm, type IDialogButtonBar, type IDialogHeader, type IField, type IFieldErrorMessage, type IFilterCondition, type IFilterDTOState, type IFilterValue, type IIconInput, type IMenuDefinition, type IOverlay, type IPagination, type IParameter, type IParametersGroup, type IRequiredMark, type IResponsiveComponent, type ISimpleButton, type ITableParameterProps, IconButton, IconInput, IconsList, Label, LabelBox, LinearLoader, ListSkeletonLoader, Listbox, ListboxItem, LoaderSpinner, type MessageCallbackProps, type MessageSubmitCallback, Modal, NumberInput, Overlay, Pagination, Parameter, type ParameterObject, type ParameterPossibleValue, ParameterRender, type ParameterRenderer, type ParameterRendererProps, type ParameterType, Parameters, type ParametersDefinition, ParametersGroup, type ParametersGroupRenderer, ParametersStore, ParametersTable, type Payload, ProgressBar, RequiredMark, ScreenLocker, ShowResponsive, SimpleButton, SortableList, SortableListItem, type TAccordionHandler, type TAccordionItemButton, type TApiaButtonType, type TApiaIconButton, type TChatControllerState, type TCheckbox, type TCssProps, type TDateProps, type TFieldLabel, type TFilterOp, type TFilterPayload, type TFilterType, type TFilterValue, type TFilterValueType, type TGetTabsController, type TIcon, type TIconButton, type TIconRenderer, type TIconSize, type TIconsList, type TListbox, type TMenuItem, type TMessageType, type TModal, type TModalSize, type TNumberInput, type TNumberInputChangeEvent, type TOnClickNode, type TOnConfirmSelection, type TOnSelectionChange, type TOpenModal, type TParameterType, type TSubmenu, type TTab, type TTabLabelRenderer as TTabRenderer, type TToolbarIconButton as TToolDefinition, type TTooltip, type TUploadHandlerProps, type TUploadInProgress, type TUploadedFile, type TUseModalConfiguration, type TVisualizationType, Tab, Tabs, TabsContent, TabsController, TabsList, Templater, Toolbar, ToolbarController, ToolbarIconButton, ToolbarInput, ToolbarSelect, ToolbarSeparator, ToolbarTextButton, UnstyledSortableList, UploadHandler, Uploader, WaiTypeAhead, getBase64FromBlob, getBase64FromFile, getFieldErrorStyles, getFieldTouchedStyles, getFileExtension, importComponent, isFavoriteIcon, isImage, isParametersGroup, makeResponsiveComponent, menuController, parseNumberInputValueToNumber, parseNumberValueToNumberInput, useAccordionContext, useCurrentTab, useMenu, useModal, useModalContext, useOtherTagButton, useTabsContext };
 //# sourceMappingURL=index.d.ts.map