@acvl/frontend-components 0.0.75 → 0.0.76

package/dist/index.d.ts

@@ -2960,6 +2960,21 @@ interface DetailPageV2Props {
     responsiveTo?: DetailFormProps["responsiveTo"];
     /** @see DetailFormProps.containerBreakpoints */
     containerBreakpoints?: DetailFormProps["containerBreakpoints"];
+    /**
+     * Deja el renglón del título —con el estado y la barra de acciones— pegado al tope mientras
+     * se scrollea la ficha. Las migas se recogen al llegar arriba, así que lo que se queda es
+     * sólo lo que hace falta tener a la mano.
+     *
+     * Encendido por defecto: una ficha es larga y sus acciones viven arriba, así que sin esto
+     * editar o abrir el historial obliga a volver al principio. Vale igual capturando —ahí lo
+     * que queda a la mano es Guardar y Cancelar—, que es la otra mitad del mismo problema.
+     *
+     * Apagarlo tiene sentido en una ficha corta, donde el encabezado nunca se va. Se ignora
+     * cuando no hay renglón de título donde poner las acciones (pantalla completa, o un
+     * `pageHeader` propio que no lo reserve): ahí vuelven a la esquina flotante de siempre.
+     * @default true
+     */
+    stickyHeader?: boolean;
     slots?: {
         button?: ReactNode;
         /**
@@ -3099,6 +3114,20 @@ interface MainLayoutPageHeaderProps extends PageHeaderProps {
     fullScreen?: boolean;
     detachedPages?: DetachedPage[];
     documentTitleSuffix?: string;
+    /**
+     * El padding horizontal del panel de contenido, que el `MainLayout` le pasa tal cual.
+     *
+     * Hace falta aquí para el encabezado pegado: la banda tiene que llegar a los bordes del
+     * panel para tapar lo que pasa por debajo, y ese padding es lo que hay que descontar.
+     * @see MainLayoutProps.contentPaddingX
+     */
+    contentPaddingX?: number | string;
+    /**
+     * El fondo del panel de contenido, también del `MainLayout`. Pegada, la banda se pinta de
+     * ese color: es el suelo por el que el contenido se desliza, no una tarjeta encima de él.
+     * @see MainLayoutProps.pageBackgroundColor
+     */
+    pageBackgroundColor?: string;
 }
 
 /**
@@ -3401,6 +3430,49 @@ declare const PageBadgeHostContext: React.Context<PageBadgeHost | null>;
 /** El hueco de la insignia del encabezado, o `null` si no hay ninguno arriba. */
 declare const usePageBadgeHost: () => PageBadgeHost | null;
 
+interface StickyPageHeaderHost {
+    /** Si la página que está montada pidió que el renglón del título se quede arriba. */
+    fijo: boolean;
+    /**
+     * La página se anota al montarse y se borra al irse. Se lleva un padrón y no un booleano
+     * suelto porque al cambiar de ruta las dos páginas coexisten un instante —React desmonta la
+     * vieja después de montar la nueva—, y con un solo valor la que se va apagaría lo que acaba
+     * de pedir la que llega.
+     */
+    registrar: (id: string, pedido: boolean) => void;
+}
+/**
+ * Cómo una página le dice al encabezado que se quede pegado arriba.
+ *
+ * Va por contexto y no por prop del `MainLayout` porque la decisión es de la página, no del
+ * cascarón: una ficha quiere el título y sus acciones siempre a la mano, y una vista de lista
+ * —que ya scrollea dentro del DataGrid— no gana nada con ellos. Es el mismo viaje que hacen las
+ * acciones y el estado del registro (ver `PageActionsHostContext`), en sentido contrario: allá
+ * la página manda contenido al encabezado, aquí le manda una decisión.
+ *
+ * Fuera de un `MainLayout` el contexto es `null` y no pasa nada: el encabezado de ese proyecto
+ * se queda como estaba.
+ */
+declare const StickyPageHeaderContext: React.Context<StickyPageHeaderHost | null>;
+/** Lo lee el encabezado para saber si le toca pegarse. */
+declare const useStickyPageHeaderHost: () => StickyPageHeaderHost | null;
+/**
+ * Pide, desde una página, que el renglón del título se quede pegado al tope mientras se scrollea.
+ *
+ *     useStickyPageHeader(true);
+ *
+ * El pedido se retira solo al desmontarse la página, así que la siguiente ruta arranca con el
+ * encabezado como lo haya pedido ella. Pasar `false` es no pedir nada —sirve para apagarlo desde
+ * una prop sin romper el orden de los hooks—.
+ *
+ * Pedirlo cambia además cómo se mide el área de trabajo: en vez de quedarse en el hueco visible
+ * crece con su contenido, como un documento. No es un efecto colateral sino la condición de que
+ * la banda se quede pegada en todo el largo —`position: sticky` no se despega de su bloque
+ * contenedor—, pero conviene saberlo: una página que necesite el alto repartido para que su
+ * tabla scrollee por dentro (`<Base height={1}>`) no es candidata a encabezado pegado.
+ */
+declare const useStickyPageHeader: (pedido: boolean) => void;
+
 /**
  * Contenido por defecto de cada snack dentro de `ObjectProgressStack`.
  * Muestra una barra de progreso (determinada si `progress` viene definido,
@@ -3657,5 +3729,5 @@ interface UseColorModeResult {
 }
 declare function useColorMode(): UseColorModeResult;
 
-export { APIContext, APIProvider, AccountMenuContent, ActiveCell, ActiveIcon, Base, ButtonWithDrawer, COLOR_SCHEME_SELECTOR, CSVUpload, ChipCell, ConfirmDialog, ContentLayout, ControlledAddressAutocomplete, ControlledAmountWithCurrency, ControlledAutocomplete, ControlledColor, ControlledDate$1 as ControlledDate, ControlledDate as ControlledDate_v2, ControlledDropdown, ControlledFileField$1 as ControlledFileField, ControlledFileField as ControlledFileField_v2, FileUploadBox as ControlledFileUploadBox, ControlledNumber, ControlledPhoneNumber, ControlledSelect$1 as ControlledSelect, ControlledSelect as ControlledSelect_v2, ControlledSlider as ControlledSimpleSlider, ControlledSlider$1 as ControlledSlider, ControlledSwitch, ControlledText, ControlledTimePicker, ControlledToggleButtons, CoverPage, CreateButtonBase, CreateButtonWithMenuOptions, CrudDropdown, CustomNoRows, DEFAULT_FORM_BREAKPOINTS, DEFAULT_PAGINATION, DeleteButton, DeleteConfirmationDialog, DetailFormDialog as DetailFormDialog_v2, DetailFormDrawer as DetailFormDrawer_v2, DetailForm as DetailForm_v2, DetailPage$1 as DetailPage, DetailPage as DetailPage_v2, DrawerGrid as DrawerGrid_v2, EditButton, ExportCSV$1 as ExportCSV, ExportCSV as ExportCSV_v2, ExtraButtons, FORM_CONTAINER_NAME, GlobalSearch, HEADER_CONTAINER, HEADER_NARROW, HistorialDrawer, KpiCard, LAYER_ORDER, ListPage, Loadable, LoadingComponent, Logo, MainDrawer, MainDrawer$1 as MainDrawer_v2, MainLayout, MenuItemWithLoading, ModuleCard, MoreOptions, MyGridEditSingleSelect, NavigationContext, NavigationProvider, NormalOrIcon, NotAllowed, NotFound, NotificationItem, NotificationsBell, ObjectProgressStack, PAGE_SIZE_OPTIONS, PageActionsHostContext, PageBadgeHostContext, PageInfo, PageInfoHostContext, Panel, PollingCountdownChip, PulseDot, RESPONSIVE_ACTION_MODES, ResponsiveActions, SIDE_PANEL_WIDTH_VAR, SaveCancelButton, ServerGrid as ServerGrid_v2, SidePanelHostContext, StatusBadge, StyledMenu, Tabs, Transitions, TrueFalse, UncontrolledText, changeTitle, closeProgressSnack, composeGridProps, deleteColumn$1 as deleteColumn, deleteColumn as deleteColumn_v2, editColumn, filterQuery, formContainerSx, formGridSx, formParser, headerContainerSx, _default as headerReducer, manualCacheRefresh, mergeSettings, openProgressSnack, query, renderChipCell, renderEditCellWithErrorTooltip, resolveChipOption, resolveInitialState, resolveStatusColor, setErrors, _default$1 as snackProgressReducer, statusColors, tags, theme, togglableFields, updateProgressSnackData, useAPI, useColorMode, useDetailForm, useHasPermission, useHasPermission_v2, useKeyboardShortcut, useMutationHandler, useNavigation, usePageActionsHost, usePageBadgeHost, usePageInfoHost, useServerGrid, useSidePanelHost, valueLabel };
-export type { APIcontextProps, AccountMenuContentProps, AccountMenuItem, AddressValue, AppTheme, AutocompleteOption, ChipCellProps, ChipColor, ChipOption, ColorMode, ComoOpcionesProps, ConfirmDialogProps, ControlledAutocompleteProps, ControlledInput, CustomFilterDef, CustomToolbarProps, DeleteGridColumnsProps$1 as DeleteGridColumnsProps, DetachedPage, DetailExtraButton, DetailFormApi, DetailFormConfig, DetailFormController, DetailFormDialogProps, DetailFormDrawerNavigation, DetailFormDrawerProps, DetailFormProps, DetailFormStatus, DetailPageV2Props, DetailRenderProps, DrawerGridDrawerConfig, DrawerGridEditConfig, DrawerGridProps, EditGridColumnsProps, EditReadOnlyFields, ExportCSVProps as ExportCSVProps_v2, FieldFilter, FieldProps$1 as FieldProps, FieldValidationProps, FilterInput, FormBreakpoint, FormGridSxOptions, GlobalSearchOption, GlobalSearchProps, GridArgs, GridColDefPropsOverrides, GridLayerContribution, GridLayerId, GridLayerMap, JSONFormProps, JSONParserProps, KeyboardShortcut, KpiCardProps, MainDrawerV2Props, MainLayoutFooterConfig, MainLayoutPageHeaderProps, MainLayoutProps, MainLayoutSidebarFooterProps, MyDataGridProps, MyGridFilterModel, MyTab, MyTabProps, NotificationItemProps, NotificationsApi, NotificationsBellProps, PageActionsHost, PageBadgeHost, PageInfoHost, PageInfoProps, PageType, PanelProps, PollingCountdownChipProps, ProgressStatusProps, PulseDotProps, ResponsiveAction, ResponsiveActionsMode, ResponsiveActionsProps, RowsSnapshot, ServerGridArgs, ServerGridCreateApi, ServerGridDataApi, ServerGridDeleteApi, ServerGridEditApi, ServerGridEditToggleApi, ServerGridHandle, ServerGridProps, ServerGridSnapshot, ServerGridState, SidePanelHost, StatusColor, UseColorModeResult, UseServerGridOptions };
+export { APIContext, APIProvider, AccountMenuContent, ActiveCell, ActiveIcon, Base, ButtonWithDrawer, COLOR_SCHEME_SELECTOR, CSVUpload, ChipCell, ConfirmDialog, ContentLayout, ControlledAddressAutocomplete, ControlledAmountWithCurrency, ControlledAutocomplete, ControlledColor, ControlledDate$1 as ControlledDate, ControlledDate as ControlledDate_v2, ControlledDropdown, ControlledFileField$1 as ControlledFileField, ControlledFileField as ControlledFileField_v2, FileUploadBox as ControlledFileUploadBox, ControlledNumber, ControlledPhoneNumber, ControlledSelect$1 as ControlledSelect, ControlledSelect as ControlledSelect_v2, ControlledSlider as ControlledSimpleSlider, ControlledSlider$1 as ControlledSlider, ControlledSwitch, ControlledText, ControlledTimePicker, ControlledToggleButtons, CoverPage, CreateButtonBase, CreateButtonWithMenuOptions, CrudDropdown, CustomNoRows, DEFAULT_FORM_BREAKPOINTS, DEFAULT_PAGINATION, DeleteButton, DeleteConfirmationDialog, DetailFormDialog as DetailFormDialog_v2, DetailFormDrawer as DetailFormDrawer_v2, DetailForm as DetailForm_v2, DetailPage$1 as DetailPage, DetailPage as DetailPage_v2, DrawerGrid as DrawerGrid_v2, EditButton, ExportCSV$1 as ExportCSV, ExportCSV as ExportCSV_v2, ExtraButtons, FORM_CONTAINER_NAME, GlobalSearch, HEADER_CONTAINER, HEADER_NARROW, HistorialDrawer, KpiCard, LAYER_ORDER, ListPage, Loadable, LoadingComponent, Logo, MainDrawer, MainDrawer$1 as MainDrawer_v2, MainLayout, MenuItemWithLoading, ModuleCard, MoreOptions, MyGridEditSingleSelect, NavigationContext, NavigationProvider, NormalOrIcon, NotAllowed, NotFound, NotificationItem, NotificationsBell, ObjectProgressStack, PAGE_SIZE_OPTIONS, PageActionsHostContext, PageBadgeHostContext, PageInfo, PageInfoHostContext, Panel, PollingCountdownChip, PulseDot, RESPONSIVE_ACTION_MODES, ResponsiveActions, SIDE_PANEL_WIDTH_VAR, SaveCancelButton, ServerGrid as ServerGrid_v2, SidePanelHostContext, StatusBadge, StickyPageHeaderContext, StyledMenu, Tabs, Transitions, TrueFalse, UncontrolledText, changeTitle, closeProgressSnack, composeGridProps, deleteColumn$1 as deleteColumn, deleteColumn as deleteColumn_v2, editColumn, filterQuery, formContainerSx, formGridSx, formParser, headerContainerSx, _default as headerReducer, manualCacheRefresh, mergeSettings, openProgressSnack, query, renderChipCell, renderEditCellWithErrorTooltip, resolveChipOption, resolveInitialState, resolveStatusColor, setErrors, _default$1 as snackProgressReducer, statusColors, tags, theme, togglableFields, updateProgressSnackData, useAPI, useColorMode, useDetailForm, useHasPermission, useHasPermission_v2, useKeyboardShortcut, useMutationHandler, useNavigation, usePageActionsHost, usePageBadgeHost, usePageInfoHost, useServerGrid, useSidePanelHost, useStickyPageHeader, useStickyPageHeaderHost, valueLabel };
+export type { APIcontextProps, AccountMenuContentProps, AccountMenuItem, AddressValue, AppTheme, AutocompleteOption, ChipCellProps, ChipColor, ChipOption, ColorMode, ComoOpcionesProps, ConfirmDialogProps, ControlledAutocompleteProps, ControlledInput, CustomFilterDef, CustomToolbarProps, DeleteGridColumnsProps$1 as DeleteGridColumnsProps, DetachedPage, DetailExtraButton, DetailFormApi, DetailFormConfig, DetailFormController, DetailFormDialogProps, DetailFormDrawerNavigation, DetailFormDrawerProps, DetailFormProps, DetailFormStatus, DetailPageV2Props, DetailRenderProps, DrawerGridDrawerConfig, DrawerGridEditConfig, DrawerGridProps, EditGridColumnsProps, EditReadOnlyFields, ExportCSVProps as ExportCSVProps_v2, FieldFilter, FieldProps$1 as FieldProps, FieldValidationProps, FilterInput, FormBreakpoint, FormGridSxOptions, GlobalSearchOption, GlobalSearchProps, GridArgs, GridColDefPropsOverrides, GridLayerContribution, GridLayerId, GridLayerMap, JSONFormProps, JSONParserProps, KeyboardShortcut, KpiCardProps, MainDrawerV2Props, MainLayoutFooterConfig, MainLayoutPageHeaderProps, MainLayoutProps, MainLayoutSidebarFooterProps, MyDataGridProps, MyGridFilterModel, MyTab, MyTabProps, NotificationItemProps, NotificationsApi, NotificationsBellProps, PageActionsHost, PageBadgeHost, PageInfoHost, PageInfoProps, PageType, PanelProps, PollingCountdownChipProps, ProgressStatusProps, PulseDotProps, ResponsiveAction, ResponsiveActionsMode, ResponsiveActionsProps, RowsSnapshot, ServerGridArgs, ServerGridCreateApi, ServerGridDataApi, ServerGridDeleteApi, ServerGridEditApi, ServerGridEditToggleApi, ServerGridHandle, ServerGridProps, ServerGridSnapshot, ServerGridState, SidePanelHost, StatusColor, StickyPageHeaderHost, UseColorModeResult, UseServerGridOptions };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@acvl/frontend-components",
-    "version": "0.0.75",
+    "version": "0.0.76",
     "description": "Component library for ACV frontend projects.",
     "homepage": "https://github.com/ACV-Logistics/acv-frontend-components#readme",
     "access": "public",