@edrlab/thorium-web 1.0.0-beta.2 → 1.0.0-beta.3

package/dist/{const-DGYvRLhk.d.mts → const-IAfi9t_g.d.mts}

@@ -1,6 +1,6 @@
-import { b as ThBreakpoints, j as ThDockingTypes, m as ThSheetTypes, n as ThSheetHeaderVariant, l as ThSettingsRangeVariant, f as ThSettingsKeys, s as ThLineHeightOptions, d as ThActionsKeys, e as ThThemeKeys, g as ThTextSettingsKeys, h as ThSpacingSettingsKeys, o as ThLayoutDirection, p as ThLayoutStrategy, T as ThScrollAffordancePref, a as ThScrollBackTo, i as ThLayoutUI, c as ThDockingKeys } from './enums-DxbWWvn7.mjs';
+import { T as ThBreakpoints, h as ThDockingTypes, k as ThSheetTypes, l as ThSheetHeaderVariant, j as ThSettingsRangeVariant, d as ThSettingsKeys, p as ThLineHeightOptions, b as ThActionsKeys, c as ThThemeKeys, e as ThTextSettingsKeys, f as ThSpacingSettingsKeys, m as ThLayoutDirection, g as ThLayoutUI, a as ThDockingKeys } from './enums-DqGQ66r1.mjs';
 import { U as UnstableShortcutRepresentation } from './keyboardUtilities-CoTR9LKx.mjs';
-import { B as BreakpointsMap, T as ThBreakpointsObject } from './useBreakpoints-I7vHrywa.mjs';
+import { B as BreakpointsMap, T as ThBreakpointsObject } from './useBreakpoints-BQaiwecQ.mjs';
 import { T as ThColorScheme, a as ThContrast } from './useContrast-Cgsrl7GS.mjs';
 import { T as ThCollapsibilityVisibility, a as ThCollapsibility } from './useCollapsibility-BmWuCzU4.mjs';
 
@@ -113,7 +113,7 @@ type ThSettingsKeyTypes = {
     [ThSettingsKeys.wordSpacing]?: ThSettingsRangePref;
     [ThSettingsKeys.zoom]?: ThSettingsRangePref;
 };
-type ThConstraintKeys = Extract<ThSheetTypes, ThSheetTypes.bottomSheet | ThSheetTypes.popover>;
+type ThConstraintKeys = Extract<ThSheetTypes, ThSheetTypes.bottomSheet | ThSheetTypes.popover> | "pagination";
 type CustomKeyType = string;
 interface CustomizableKeys {
     actionKeys: CustomKeyType;
@@ -142,12 +142,6 @@ interface ThPreferences<T extends Partial<CustomizableKeys> = {}> {
         maximalLineLength?: number | null;
         optimalLineLength: number;
         pageGutter: number;
-        layoutStrategy?: ThLayoutStrategy | null;
-    };
-    scroll: {
-        topAffordance: ThScrollAffordancePref;
-        bottomAffordance: ThScrollAffordancePref;
-        backTo: ThScrollBackTo;
     };
     theming: {
         arrow: {
@@ -162,7 +156,8 @@ interface ThPreferences<T extends Partial<CustomizableKeys> = {}> {
         };
         layout: {
             ui?: {
-                fxl: ThLayoutUI;
+                reflow?: ThLayoutUI;
+                fxl?: ThLayoutUI;
             };
             radius: number;
             spacing: number;
@@ -171,7 +166,7 @@ interface ThPreferences<T extends Partial<CustomizableKeys> = {}> {
                 scrim: string;
             };
             constraints?: {
-                [key in KeysOf<T["constraintsKeys"], ThConstraintKeys>]?: number;
+                [key in KeysOf<T["constraintsKeys"], ThConstraintKeys>]?: number | null;
             };
         };
         breakpoints: BreakpointsMap<number | null>;
@@ -187,6 +182,14 @@ interface ThPreferences<T extends Partial<CustomizableKeys> = {}> {
             };
         };
     };
+    affordances: {
+        scroll: {
+            hintInImmersive: boolean;
+            toggleOnMiddlePointer: Array<"tap" | "click">;
+            hideOnForwardScroll: boolean;
+            showOnBackwardScroll: boolean;
+        };
+    };
     actions: ThActionsPref<KeysOf<T["actionKeys"], ThActionsKeys>>;
     shortcuts: {
         representation: UnstableShortcutRepresentation;

package/dist/core/Components/index.d.mts

@@ -1,11 +1,11 @@
-import { c as ThDockingKeys } from '../../enums-DxbWWvn7.mjs';
-import { A as ActionStateObject } from '../../actionsReducer-e808e6V_.mjs';
+import { A as ActionStateObject } from '../../actionsReducer-D4Mphfuv.mjs';
+import { a as ThDockingKeys } from '../../enums-DqGQ66r1.mjs';
 export { C as CollapsiblePref, b as ThActionEntry, e as ThActionsBar, c as ThActionsBarProps, d as ThActionsTriggerVariant, a as ThCollapsibility, T as ThCollapsibilityVisibility, u as useCollapsibility } from '../../useCollapsibility-BmWuCzU4.mjs';
-import { T as ThActionButtonProps, H as HTMLAttributesWithRef, W as WithRef } from '../../ThSettingsWrapper-De4qvjsh.mjs';
-export { d as THMenuProps, c as ThActionButton, b as ThCollapsibleActionsBar, a as ThCollapsibleActionsBarProps, e as ThMenu, g as ThMenuItem, f as ThMenuItemProps, i as ThNumberField, h as ThNumberFieldProps, l as ThRadioGroup, j as ThRadioGroupItems, k as ThRadioGroupProps, q as ThSettingsEntry, r as ThSettingsPrefs, t as ThSettingsWrapper, s as ThSettingsWrapperProps, n as ThSlider, m as ThSliderProps, p as ThSwitch, o as ThSwitchProps } from '../../ThSettingsWrapper-De4qvjsh.mjs';
+import { T as ThActionButtonProps, H as HTMLAttributesWithRef, W as WithRef } from '../../ThSettingsWrapper-CA2_0nQz.mjs';
+export { d as THMenuProps, c as ThActionButton, b as ThCollapsibleActionsBar, a as ThCollapsibleActionsBarProps, e as ThMenu, g as ThMenuItem, f as ThMenuItemProps, i as ThNumberField, h as ThNumberFieldProps, l as ThRadioGroup, j as ThRadioGroupItems, k as ThRadioGroupProps, q as ThSettingsEntry, r as ThSettingsPrefs, t as ThSettingsWrapper, s as ThSettingsWrapperProps, n as ThSlider, m as ThSliderProps, p as ThSwitch, o as ThSwitchProps } from '../../ThSettingsWrapper-CA2_0nQz.mjs';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ButtonProps, HeadingProps, PopoverProps, DialogProps, ModalOverlayProps, FormProps, Button, NumberFieldProps, LabelProps, InputProps, TextFieldProps, FieldErrorProps, ValidationResult, SearchFieldProps, SelectProps, ListBoxProps, ListBox, ListBoxItemProps } from 'react-aria-components';
-import React__default, { ReactNode, HTMLAttributes } from 'react';
+import React__default, { ReactNode, HTMLAttributes, ComponentType, SVGProps } from 'react';
 import { SheetRef, Sheet } from 'react-modal-sheet';
 import { AriaOverlayProps } from 'react-aria';
 import '@reduxjs/toolkit';
@@ -200,6 +200,43 @@ declare const ThLoader: ({ ref, isLoading, loader, children, ...props }: ThLoade
 
 declare const ThHeader: ({ ref, children, ...props }: HTMLAttributesWithRef<HTMLDivElement>) => react_jsx_runtime.JSX.Element;
 
+interface ThInteractiveOverlayProps extends React.HTMLAttributes<HTMLDivElement> {
+    ref?: React.ForwardedRef<HTMLDivElement>;
+    isActive: boolean;
+    children?: never;
+}
+declare const ThInteractiveOverlay: ({ ref, isActive, className, style, ...props }: ThInteractiveOverlayProps) => react_jsx_runtime.JSX.Element | undefined;
+
+interface ThPaginationLinkProps {
+    icon?: ComponentType<SVGProps<SVGElement>> | null;
+    node: React__default.ReactNode;
+    onPress: () => void;
+}
+interface ThPaginationProps extends React__default.HTMLAttributes<HTMLDivElement> {
+    ref?: React__default.RefObject<HTMLDivElement>;
+    direction?: "left" | "right";
+    children?: React__default.ReactNode;
+    links?: {
+        previous?: ThPaginationLinkProps;
+        next?: ThPaginationLinkProps;
+    };
+    compounds?: {
+        /**
+         * Props for the list item element wrapping links and children
+         */
+        listItem?: React__default.HTMLAttributes<HTMLLIElement>;
+        /**
+         * Props for the previous button element
+         */
+        previousButton?: Exclude<WithRef<ButtonProps, HTMLButtonElement>, "type">;
+        /**
+         * Props for the next button element
+         */
+        nextButton?: Exclude<WithRef<ButtonProps, HTMLButtonElement>, "type">;
+    };
+}
+declare const ThPagination: ({ ref, direction, links, compounds, children, ...props }: ThPaginationProps) => react_jsx_runtime.JSX.Element | null;
+
 interface ThProgressionProps extends React__default.HTMLAttributes<HTMLDivElement> {
     ref?: React__default.RefObject<HTMLDivElement>;
 }
@@ -256,4 +293,13 @@ declare const ThDropdownButton: ({ ref, children, ...props }: ThDropdownButtonPr
 
 declare const ThSettingsWrapperButton: ({ label, ref, compounds, children, ...props }: ThActionButtonProps) => react_jsx_runtime.JSX.Element;
 
-export { type ComponentMap, type THContainerWithCloseProps, type THContainerWithPreviousProps, ThActionButtonProps, type ThActionMap, ThBottomSheet, type ThBottomSheetCompounds, type ThBottomSheetHeaderProps, type ThBottomSheetProps, ThCloseButton, ThContainerBody, type ThContainerBodyProps, ThContainerHeader, type ThContainerHeaderProps, ThContainerHeaderWithClose, ThContainerHeaderWithPrevious, ThDockedPanel, type ThDockedPanelProps, ThDragIndicatorButton, type ThDragIndicatorButtonProps, ThDropdown, ThDropdownButton, type ThDropdownButtonProps, type ThDropdownEntry, type ThDropdownProps, ThFooter, ThForm, ThFormNumberField, type ThFormNumberFieldProps, type ThFormProps, ThFormSearchField, type ThFormSearchFieldProps, ThFormTextField, type ThFormTextFieldProps, ThHeader, ThLoader, type ThLoaderProps, ThMenuButton, ThModal, type ThModalProps, ThNavigationButton, type ThNavigationButtonProps, ThPopover, type ThPopoverProps, ThProgression, type ThProgressionProps, ThRunningHead, type ThRunningHeadProps, ThSettingsWrapperButton, ThTypedComponentRenderer, type TypedComponentRendererProps, type UseFirstFocusableProps, useActions, useFirstFocusable };
+interface ThGridProps<T> extends HTMLAttributesWithRef<HTMLUListElement> {
+    items: T[];
+    children?: never;
+    renderItem: (item: T, index: number) => React__default.ReactNode;
+    columnWidth?: number | string;
+    gap?: number | string;
+}
+declare const ThGrid: <T extends unknown>({ ref, items, renderItem, columnWidth, gap, ...props }: ThGridProps<T>) => react_jsx_runtime.JSX.Element;
+
+export { type ComponentMap, type THContainerWithCloseProps, type THContainerWithPreviousProps, ThActionButtonProps, type ThActionMap, ThBottomSheet, type ThBottomSheetCompounds, type ThBottomSheetHeaderProps, type ThBottomSheetProps, ThCloseButton, ThContainerBody, type ThContainerBodyProps, ThContainerHeader, type ThContainerHeaderProps, ThContainerHeaderWithClose, ThContainerHeaderWithPrevious, ThDockedPanel, type ThDockedPanelProps, ThDragIndicatorButton, type ThDragIndicatorButtonProps, ThDropdown, ThDropdownButton, type ThDropdownButtonProps, type ThDropdownEntry, type ThDropdownProps, ThFooter, ThForm, ThFormNumberField, type ThFormNumberFieldProps, type ThFormProps, ThFormSearchField, type ThFormSearchFieldProps, ThFormTextField, type ThFormTextFieldProps, ThGrid, type ThGridProps, ThHeader, ThInteractiveOverlay, type ThInteractiveOverlayProps, ThLoader, type ThLoaderProps, ThMenuButton, ThModal, type ThModalProps, ThNavigationButton, type ThNavigationButtonProps, ThPagination, type ThPaginationLinkProps, type ThPaginationProps, ThPopover, type ThPopoverProps, ThProgression, type ThProgressionProps, ThRunningHead, type ThRunningHeadProps, ThSettingsWrapperButton, ThTypedComponentRenderer, type TypedComponentRendererProps, type UseFirstFocusableProps, useActions, useFirstFocusable };

package/dist/core/Components/index.mjs

@@ -1,5 +1,5 @@
-export { ThActionButton, ThActionsBar, ThActionsTriggerVariant, ThBottomSheet, ThCloseButton, ThCollapsibleActionsBar, ThContainerBody, ThContainerHeader, ThContainerHeaderWithClose, ThContainerHeaderWithPrevious, ThDockedPanel, ThDragIndicatorButton, ThDropdown, ThDropdownButton, ThFooter, ThForm, ThFormNumberField, ThFormSearchField, ThFormTextField, ThHeader, ThLoader, ThMenu, ThMenuButton, ThMenuItem, ThModal, ThNavigationButton, ThNumberField, ThPopover, ThProgression, ThRadioGroup, ThRunningHead, ThSettingsWrapper, ThSettingsWrapperButton, ThSlider, ThSwitch, ThTypedComponentRenderer, useActions, useFirstFocusable } from '../../chunk-BVSROK7Z.mjs';
+export { ThActionButton, ThActionsBar, ThActionsTriggerVariant, ThBottomSheet, ThCloseButton, ThCollapsibleActionsBar, ThContainerBody, ThContainerHeader, ThContainerHeaderWithClose, ThContainerHeaderWithPrevious, ThDockedPanel, ThDragIndicatorButton, ThDropdown, ThDropdownButton, ThFooter, ThForm, ThFormNumberField, ThFormSearchField, ThFormTextField, ThGrid, ThHeader, ThInteractiveOverlay, ThLoader, ThMenu, ThMenuButton, ThMenuItem, ThModal, ThNavigationButton, ThNumberField, ThPagination, ThPopover, ThProgression, ThRadioGroup, ThRunningHead, ThSettingsWrapper, ThSettingsWrapperButton, ThSlider, ThSwitch, ThTypedComponentRenderer, useActions, useFirstFocusable } from '../../chunk-SDVDRPT5.mjs';
 export { ThCollapsibilityVisibility, useCollapsibility } from '../../chunk-MLEYTQGK.mjs';
-import '../../chunk-3QS3WKRC.mjs';
+import '../../chunk-RQFPGXWN.mjs';
 //# sourceMappingURL=index.mjs.map
 //# sourceMappingURL=index.mjs.map

package/dist/core/Helpers/index.d.mts

@@ -1,6 +1,6 @@
-import { B as BreakpointsMap } from '../../useBreakpoints-I7vHrywa.mjs';
+import { B as BreakpointsMap } from '../../useBreakpoints-BQaiwecQ.mjs';
 export { a as UnstableKey, b as UnstableMetaKey, d as UnstableMetaKeys, g as UnstablePShortcut, c as UnstablePlatformModifier, f as UnstableShortcut, e as UnstableShortcutMetaKeywords, U as UnstableShortcutRepresentation, j as buildShortcut, h as defaultPlatformModifier, i as getPlatformModifier, m as metaKeys } from '../../keyboardUtilities-CoTR9LKx.mjs';
-import '../../enums-DxbWWvn7.mjs';
+import '../../enums-DqGQ66r1.mjs';
 
 declare const makeBreakpointsMap: <T>({ defaultValue, fromEnum, pref, disabledValue, }: {
     defaultValue: T;
@@ -18,12 +18,6 @@ declare const isMacish: () => boolean;
 declare const isIpadOS: () => boolean;
 declare const isIOSish: () => boolean;
 
-declare const localData: {
-    set(key: string, value: any): void;
-    get(key: string): any;
-    remove(key: string): void;
-};
-
 /** Converts Object properties to CSSProperties, recursively. If recursive, the prefix will be ignored for objects */
 declare const propsToCSSVars: (props: {
     [x: string]: any;
@@ -31,4 +25,4 @@ declare const propsToCSSVars: (props: {
     [key: string]: any;
 };
 
-export { getPlatform, isActiveElement, isIOSish, isInteractiveElement, isIpadOS, isKeyboardTriggered, isMacish, localData, makeBreakpointsMap, propsToCSSVars };
+export { getPlatform, isActiveElement, isIOSish, isInteractiveElement, isIpadOS, isKeyboardTriggered, isMacish, makeBreakpointsMap, propsToCSSVars };

package/dist/core/Helpers/index.mjs

@@ -1,7 +1,6 @@
-export { isActiveElement, isInteractiveElement, isKeyboardTriggered, localData, makeBreakpointsMap } from '../../chunk-GHEGQBCW.mjs';
+export { isActiveElement, isInteractiveElement, isKeyboardTriggered, makeBreakpointsMap } from '../../chunk-NOV43IG4.mjs';
 export { propsToCSSVars } from '../../chunk-TTGURRX3.mjs';
 export { UnstableShortcutMetaKeywords, UnstableShortcutRepresentation, buildShortcut, defaultPlatformModifier, getPlatform, getPlatformModifier, isIOSish, isIpadOS, isMacish, metaKeys } from '../../chunk-IEYR7QV7.mjs';
-import '../../chunk-TWGRY5SW.mjs';
-import '../../chunk-3QS3WKRC.mjs';
+import '../../chunk-RQFPGXWN.mjs';
 //# sourceMappingURL=index.mjs.map
 //# sourceMappingURL=index.mjs.map

package/dist/core/Hooks/index.d.mts

@@ -1,9 +1,11 @@
-export { B as BreakpointsMap, T as ThBreakpointsObject, u as useBreakpoints } from '../../useBreakpoints-I7vHrywa.mjs';
+export { B as BreakpointsMap, T as ThBreakpointsObject, u as useBreakpoints } from '../../useBreakpoints-BQaiwecQ.mjs';
 export { T as ThColorScheme, a as ThContrast, u as useColorScheme, b as useContrast } from '../../useContrast-Cgsrl7GS.mjs';
-export { E as EpubNavigatorLoadProps, u as useEpubNavigator } from '../../useEpubNavigator-BrV4MYJy.mjs';
-import '../../enums-DxbWWvn7.mjs';
-import '@readium/navigator';
+import * as React from 'react';
+export { a as TimelineItem, T as TocItem, U as UnstableTimeline, u as useTimeline } from '../../useTimeline-Bid5B7AQ.mjs';
+export { E as EpubNavigatorLoadProps, u as useEpubNavigator } from '../../useEpubNavigator-DFRJ_tHa.mjs';
+import '../../enums-DqGQ66r1.mjs';
 import '@readium/shared';
+import '@readium/navigator';
 
 declare const useForcedColors: (onChange?: (forcedColors: boolean) => void) => boolean;
 
@@ -12,6 +14,14 @@ declare const useFullscreen: (onChange?: (isFullscreen: boolean) => void) => {
     handleFullscreen: () => void;
 };
 
+declare const useLocalStorage: (key: string) => {
+    setLocalData: (newValue: any) => void;
+    getLocalData: () => any;
+    clearLocalData: () => void;
+    localData: any;
+    cachedLocalData: React.RefObject<any>;
+};
+
 declare const useMediaQuery: (query: string | null) => boolean;
 
 declare const useMonochrome: (onChange?: (isMonochrome: boolean) => void) => boolean;
@@ -24,4 +34,4 @@ declare const useReducedMotion: (onChange?: (reducedMotion: boolean) => void) =>
 
 declare const useReducedTransparency: (onChange?: (reducedTransparency: boolean) => void) => boolean;
 
-export { useForcedColors, useFullscreen, useIsClient, useMediaQuery, useMonochrome, usePrevious, useReducedMotion, useReducedTransparency };
+export { useForcedColors, useFullscreen, useIsClient, useLocalStorage, useMediaQuery, useMonochrome, usePrevious, useReducedMotion, useReducedTransparency };

package/dist/core/Hooks/index.mjs

@@ -1,7 +1,6 @@
-export { useEpubNavigator, useFullscreen, useIsClient, usePrevious } from '../../chunk-JS5WI5D4.mjs';
+export { useEpubNavigator, useFullscreen, useIsClient, useLocalStorage, usePrevious, useTimeline } from '../../chunk-NA3KMUS4.mjs';
 export { useBreakpoints, useForcedColors, useMonochrome, useReducedMotion, useReducedTransparency } from '../../chunk-BNPR6V7V.mjs';
 export { ThColorScheme, ThContrast, useColorScheme, useContrast, useMediaQuery } from '../../chunk-NQ2ZSGCX.mjs';
-import '../../chunk-TWGRY5SW.mjs';
-import '../../chunk-3QS3WKRC.mjs';
+import '../../chunk-RQFPGXWN.mjs';
 //# sourceMappingURL=index.mjs.map
 //# sourceMappingURL=index.mjs.map

package/dist/{enums-DxbWWvn7.d.mts → enums-DqGQ66r1.d.mts}

@@ -26,11 +26,6 @@ declare enum ThDockingTypes {
     start = "start",
     end = "end"
 }
-declare enum ThScrollBackTo {
-    top = "top",
-    bottom = "bottom",
-    untouched = "untouched"
-}
 declare enum ThSettingsKeys {
     columns = "columns",
     fontFamily = "fontFamily",
@@ -57,18 +52,6 @@ declare enum ThTextSettingsKeys {
     textAlign = "textAlign",
     textNormalize = "textNormalize"
 }
-declare enum ThScrollAffordancePref {
-    none = "none",
-    prev = "previous",
-    next = "next",
-    both = "both"
-}
-interface ScrollAffordanceConfig {
-    pref: ThScrollAffordancePref;
-    placement: "top" | "bottom";
-    className?: string;
-    styleSheetContent?: string;
-}
 declare enum ThSpacingSettingsKeys {
     letterSpacing = "letterSpacing",
     lineHeight = "lineHeight",
@@ -110,11 +93,6 @@ declare enum ThLayoutDirection {
     rtl = "rtl",
     ltr = "ltr"
 }
-declare enum ThLayoutStrategy {
-    margin = "margin",
-    lineLength = "lineLength",
-    columns = "columns"
-}
 declare enum ThLayoutOptions {
     scroll = "scroll_option",
     paginated = "page_option"
@@ -131,4 +109,4 @@ declare enum ThLineHeightOptions {
     large = "large"
 }
 
-export { type ScrollAffordanceConfig as S, ThScrollAffordancePref as T, ThScrollBackTo as a, ThBreakpoints as b, ThDockingKeys as c, ThActionsKeys as d, ThThemeKeys as e, ThSettingsKeys as f, ThTextSettingsKeys as g, ThSpacingSettingsKeys as h, ThLayoutUI as i, ThDockingTypes as j, ThSettingsContainerKeys as k, ThSettingsRangeVariant as l, ThSheetTypes as m, ThSheetHeaderVariant as n, ThLayoutDirection as o, ThLayoutStrategy as p, ThLayoutOptions as q, ThTextAlignOptions as r, ThLineHeightOptions as s };
+export { ThBreakpoints as T, ThDockingKeys as a, ThActionsKeys as b, ThThemeKeys as c, ThSettingsKeys as d, ThTextSettingsKeys as e, ThSpacingSettingsKeys as f, ThLayoutUI as g, ThDockingTypes as h, ThSettingsContainerKeys as i, ThSettingsRangeVariant as j, ThSheetTypes as k, ThSheetHeaderVariant as l, ThLayoutDirection as m, ThLayoutOptions as n, ThTextAlignOptions as o, ThLineHeightOptions as p };