@nypl/web-reader 1.1.0 → 1.2.0

package/dist/types/HtmlReader/effects.d.ts

@@ -1,4 +1,4 @@
-import { CSSState } from './types';
+import { ReaderSettings } from '../types';
 /**
  * These are effects that reach in to the iframe element and modify it.
  * They are not part of the reducer, and should only be called from within a
@@ -14,4 +14,4 @@ export declare function navigateToHash(fragment: string, iframe: HTMLIFrameEleme
  * Takes the HTML element and sets CSS variables on it based on the
  * reader's state
  */
-export declare function setCss(html: HTMLElement, state: CSSState): void;
+export declare function setCss(html: HTMLElement, settings: ReaderSettings): void;

package/dist/types/HtmlReader/types.d.ts

@@ -1,5 +1,5 @@
 import { Locator } from '../Readium/Locator';
-import { ColorMode, FontFamily, HtmlReaderState, ReaderArguments, ReaderState } from '../types';
+import { ColorMode, FontFamily, ReaderArguments, ReaderSettings, ReaderState } from '../types';
 /**
  * Html Reader States
  *  - Can be broken into distinct states that we create a union from.
@@ -16,49 +16,54 @@ export declare type InactiveState = ReaderState & {
     resource: undefined;
     resourceFetchError: undefined;
 };
-export declare type FetchingResourceState = HtmlReaderState & {
+export declare type FetchingResourceState = ReaderState & {
     state: 'FETCHING_RESOURCE';
     location: Locator;
     iframe: null;
     resource: undefined;
     resourceFetchError: undefined;
+    settings: ReaderSettings;
 };
-export declare type ResourceFetchErrorState = HtmlReaderState & {
+export declare type ResourceFetchErrorState = ReaderState & {
     state: 'RESOURCE_FETCH_ERROR';
     location: Locator;
     iframe: null;
     resource: undefined;
     resourceFetchError: Error;
+    settings: ReaderSettings;
 };
-export declare type RenderingIframeState = HtmlReaderState & {
+export declare type RenderingIframeState = ReaderState & {
     state: 'RENDERING_IFRAME';
     location: Locator;
     iframe: null;
     resource: string;
     resourceFetchError: undefined;
+    settings: ReaderSettings;
 };
-export declare type LoadingIframeState = HtmlReaderState & {
+export declare type LoadingIframeState = ReaderState & {
     state: 'LOADING_IFRAME';
     location: Locator;
     iframe: HTMLIFrameElement;
     resource: string;
     resourceFetchError: undefined;
+    settings: ReaderSettings;
 };
-export declare type NavigatingState = HtmlReaderState & {
+export declare type NavigatingState = ReaderState & {
     state: 'NAVIGATING';
     location: Locator;
     iframe: HTMLIFrameElement;
     resource: string;
     resourceFetchError: undefined;
+    settings: ReaderSettings;
 };
-export declare type ReadyState = HtmlReaderState & {
+export declare type ReadyState = ReaderState & {
     state: 'READY';
     location: Locator;
     iframe: HTMLIFrameElement;
     resource: string;
     resourceFetchError: undefined;
+    settings: ReaderSettings;
 };
-export declare type CSSState = Pick<HtmlState, 'isScrolling' | 'colorMode' | 'fontFamily' | 'fontSize'>;
 export declare type HtmlAction = {
     type: 'ARGS_CHANGED';
     args: ReaderArguments;

package/dist/types/constants.d.ts

@@ -1,3 +1,4 @@
+import { ReaderSettings } from './types';
 export declare const ReadiumWebpubContext = "http://readium.org/webpub/default.jsonld";
 export declare const IS_DEV: boolean;
 export declare const HEADER_HEIGHT = 48;
@@ -5,3 +6,4 @@ export declare const FOOTER_HEIGHT = 48;
 export declare const CHROME_HEIGHT: number;
 export declare const DEFAULT_HEIGHT: string;
 export declare const DEFAULT_SHOULD_GROW_WHEN_SCROLLING = true;
+export declare const DEFAULT_SETTINGS: ReaderSettings;

package/dist/types/index.d.ts

@@ -12,4 +12,5 @@ export { default as useWebReader } from './useWebReader';
 export { default as useHtmlReader } from './HtmlReader';
 export { default as usePdfReader } from './PdfReader';
 export { getTheme } from './ui/theme';
+export { default as useColorModeValue } from './ui/hooks/useColorModeValue';
 export * from './constants';

package/dist/types/types.d.ts

@@ -24,20 +24,23 @@ export declare type HtmlNavigator = Navigator & {
     setColorMode: (mode: ColorMode) => Promise<void>;
 };
 export declare type ReaderSettings = {
-    isScrolling?: boolean;
-};
-export declare type ReaderState = {
     colorMode: ColorMode;
     isScrolling: boolean;
     fontSize: number;
     fontFamily: FontFamily;
-    currentTocUrl: string | null;
+};
+/**
+ * This is the "public" state of the reader that
+ * is returned to consumers of useWebReader. Each
+ * reader (pdf/html) has its own internal state with
+ * more details necessary for rendering
+ */
+export declare type ReaderState = {
     atStart: boolean;
     atEnd: boolean;
     location?: Locator;
+    settings: ReaderSettings | undefined;
 };
-export declare type PdfReaderState = ReaderState;
-export declare type HtmlReaderState = ReaderState;
 export declare type InactiveReader = null;
 export declare type LoadingReader = {
     isLoading: true;
@@ -53,12 +56,12 @@ declare type CommonReader = {
     manifest: WebpubManifest;
 };
 export declare type PDFActiveReader = CommonReader & {
-    state: PdfReaderState;
+    state: ReaderState;
     navigator: PdfNavigator;
     type: 'PDF';
 };
 export declare type HTMLActiveReader = CommonReader & {
-    state: HtmlReaderState;
+    state: ReaderState;
     navigator: HtmlNavigator;
     type: 'HTML';
 };
@@ -95,7 +98,7 @@ export declare type UseWebReaderArguments = {
     /**
      * Initial user settings for the reader
      */
-    readerSettings?: ReaderSettings;
+    readerSettings?: Partial<ReaderSettings>;
 };
 export declare type ActiveReaderArguments = UseWebReaderArguments & {
     manifest: WebpubManifest;

package/dist/types/ui/Button.d.ts

@@ -1,8 +1,8 @@
 import React from 'react';
 import { Button as ChakraButton } from '@chakra-ui/react';
 export declare type ButtonProps = React.ComponentPropsWithRef<typeof ChakraButton>;
-declare const Button: React.ForwardRefExoticComponent<Pick<Pick<import("@chakra-ui/system").OmitCommonProps<React.DetailedHTMLProps<React.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, keyof import("@chakra-ui/react").ButtonProps> & import("@chakra-ui/react").ButtonProps & import("@chakra-ui/system").OmitCommonProps<any, keyof import("@chakra-ui/react").ButtonProps> & {
-    as?: import("@chakra-ui/system").As<any> | undefined;
+declare const Button: React.ForwardRefExoticComponent<Pick<Pick<import("@chakra-ui/react").OmitCommonProps<React.DetailedHTMLProps<React.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, keyof import("@chakra-ui/react").ButtonProps> & import("@chakra-ui/react").ButtonProps & import("@chakra-ui/react").OmitCommonProps<any, keyof import("@chakra-ui/react").ButtonProps> & {
+    as?: import("@chakra-ui/react").As<any> | undefined;
 }, string | number | symbol> & {
     ref?: ((instance: HTMLButtonElement | null) => void) | React.RefObject<HTMLButtonElement> | null | undefined;
 }, string | number | symbol> & React.RefAttributes<HTMLButtonElement>>;

package/dist/types/ui/Header.d.ts

@@ -4,6 +4,6 @@ export declare const DefaultHeaderLeft: () => React.ReactElement;
 export default function Header(props: ActiveReader & ReaderManagerArguments & {
     containerRef: React.MutableRefObject<null | HTMLDivElement>;
 }): React.ReactElement;
-export declare const HeaderWrapper: React.ForwardRefExoticComponent<Pick<import("@chakra-ui/system").OmitCommonProps<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, keyof import("@chakra-ui/react").FlexProps> & import("@chakra-ui/react").FlexProps & import("@chakra-ui/system").OmitCommonProps<any, keyof import("@chakra-ui/react").FlexProps> & {
-    as?: import("@chakra-ui/system").As<any> | undefined;
+export declare const HeaderWrapper: React.ForwardRefExoticComponent<Pick<import("@chakra-ui/react").OmitCommonProps<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, keyof import("@chakra-ui/react").FlexProps> & import("@chakra-ui/react").FlexProps & import("@chakra-ui/react").OmitCommonProps<any, keyof import("@chakra-ui/react").FlexProps> & {
+    as?: import("@chakra-ui/react").As<any> | undefined;
 }, string | number | symbol> & React.RefAttributes<HTMLDivElement>>;

package/dist/types/ui/HtmlSettings.d.ts

@@ -1,8 +1,8 @@
 import * as React from 'react';
-import { HtmlNavigator, HtmlReaderState } from '../types';
+import { HtmlNavigator, ReaderState } from '../types';
 export declare type HtmlSettingsProps = {
     navigator: HtmlNavigator;
-    readerState: HtmlReaderState;
+    readerState: ReaderState;
     paginationValue: string;
 };
-export default function HtmlSettings(props: HtmlSettingsProps): React.ReactElement;
+export default function HtmlSettings(props: HtmlSettingsProps): React.ReactElement | null;

package/dist/types/ui/PdfSettings.d.ts

@@ -1,8 +1,8 @@
 import * as React from 'react';
-import { PdfNavigator, PdfReaderState } from '../types';
+import { PdfNavigator, ReaderState } from '../types';
 export declare type PdfSettingsProps = {
     navigator: PdfNavigator;
-    readerState: PdfReaderState;
+    readerState: ReaderState;
     paginationValue: string;
 };
 export default function PdfSettings(props: PdfSettingsProps): React.ReactElement;