@nypl/web-reader 0.2.0-alpha.3 → 0.2.0-alpha.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/index.js +79 -79
- package/dist/cjs/index.js.map +2 -2
- package/dist/esm/index.js +80 -98
- package/dist/esm/index.js.map +2 -2
- package/dist/types/WebpubManifestTypes/ConformsTo.d.ts +1 -1
- package/dist/types/index.d.ts +2 -2
- package/dist/types/types.d.ts +12 -4
- package/dist/types/ui/Header.d.ts +2 -5
- package/dist/types/ui/manager.d.ts +2 -2
- package/package.json +2 -3
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
export declare const WebpubPdfConformsTo = "
|
|
1
|
+
export declare const WebpubPdfConformsTo = "http://librarysimplified.org/terms/profiles/pdf";
|
|
2
2
|
export declare const AxisNowEpubConformsTo = "stub/webpub+axisnow";
|
|
3
3
|
export declare type ConformsTo = typeof WebpubPdfConformsTo | typeof AxisNowEpubConformsTo;
|
package/dist/types/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { FC } from 'react';
|
|
2
|
-
import { UseWebReaderArguments } from './types';
|
|
2
|
+
import { ReaderManagerArguments, UseWebReaderArguments } from './types';
|
|
3
3
|
/**
|
|
4
4
|
* The main React component export.
|
|
5
5
|
*/
|
|
6
|
-
declare const WebReader: FC<UseWebReaderArguments>;
|
|
6
|
+
declare const WebReader: FC<UseWebReaderArguments & ReaderManagerArguments>;
|
|
7
7
|
export default WebReader;
|
package/dist/types/types.d.ts
CHANGED
|
@@ -8,15 +8,19 @@ export declare type FontFamily = 'publisher' | 'serif' | 'sans-serif' | 'open-dy
|
|
|
8
8
|
export declare type Navigator = {
|
|
9
9
|
goForward: () => void;
|
|
10
10
|
goBackward: () => void;
|
|
11
|
-
setColorMode: (mode: ColorMode) => Promise<void>;
|
|
12
11
|
setScroll: (val: 'scrolling' | 'paginated') => Promise<void>;
|
|
12
|
+
goToPage: (href: string) => void;
|
|
13
|
+
};
|
|
14
|
+
export declare type PdfNavigator = Navigator & {
|
|
15
|
+
zoomIn: () => Promise<void>;
|
|
16
|
+
zoomOut: () => Promise<void>;
|
|
17
|
+
};
|
|
18
|
+
export declare type HtmlNavigator = Navigator & {
|
|
13
19
|
increaseFontSize: () => Promise<void>;
|
|
14
20
|
decreaseFontSize: () => Promise<void>;
|
|
15
21
|
setFontFamily: (family: FontFamily) => Promise<void>;
|
|
16
|
-
|
|
22
|
+
setColorMode: (mode: ColorMode) => Promise<void>;
|
|
17
23
|
};
|
|
18
|
-
export declare type PdfNavigator = Navigator;
|
|
19
|
-
export declare type HtmlNavigator = Navigator;
|
|
20
24
|
export declare type ReaderState = {
|
|
21
25
|
colorMode: ColorMode;
|
|
22
26
|
isScrolling: boolean;
|
|
@@ -53,10 +57,14 @@ export declare type HTMLActiveReader = CommonReader & {
|
|
|
53
57
|
export declare type ActiveReader = PDFActiveReader | HTMLActiveReader;
|
|
54
58
|
export declare type ReaderReturn = InactiveReader | LoadingReader | ActiveReader;
|
|
55
59
|
export declare type GetContent = (href: string) => Promise<string>;
|
|
60
|
+
export declare type ReaderManagerArguments = {
|
|
61
|
+
headerLeft?: JSX.Element;
|
|
62
|
+
};
|
|
56
63
|
export declare type UseWebReaderArguments = {
|
|
57
64
|
webpubManifestUrl: string;
|
|
58
65
|
proxyUrl?: string;
|
|
59
66
|
getContent?: GetContent;
|
|
67
|
+
pdfWorkerSrc?: string;
|
|
60
68
|
};
|
|
61
69
|
export declare type ActiveReaderArguments = UseWebReaderArguments & {
|
|
62
70
|
manifest: WebpubManifest;
|
|
@@ -1,6 +1,3 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
|
-
import { ActiveReader } from '../types';
|
|
3
|
-
export
|
|
4
|
-
headerLeft?: React.ReactNode;
|
|
5
|
-
};
|
|
6
|
-
export default function Header(props: HeaderProps): React.ReactElement;
|
|
2
|
+
import { ActiveReader, ReaderManagerArguments } from '../types';
|
|
3
|
+
export default function Header(props: ActiveReader & ReaderManagerArguments): React.ReactElement;
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
|
-
import { ReaderReturn } from '../types';
|
|
2
|
+
import { ReaderManagerArguments, ReaderReturn } from '../types';
|
|
3
3
|
/**
|
|
4
4
|
* The default Manager UI. This will be broken into individual components
|
|
5
5
|
* that can be imported and used separately or in a customized setup.
|
|
6
6
|
* It takes the return value of useWebReader as props
|
|
7
7
|
*/
|
|
8
|
-
declare const ManagerUI: React.FC<ReaderReturn>;
|
|
8
|
+
declare const ManagerUI: React.FC<ReaderReturn & ReaderManagerArguments>;
|
|
9
9
|
export default ManagerUI;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nypl/web-reader",
|
|
3
|
-
"version": "0.2.0-alpha.
|
|
3
|
+
"version": "0.2.0-alpha.4",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"repository": "https://github.com/NYPL-Simplified/web-reader",
|
|
6
6
|
"homepage": "https://github.com/NYPL-Simplified/web-reader",
|
|
@@ -101,6 +101,7 @@
|
|
|
101
101
|
"eslint-config-react-app": "^6.0.0",
|
|
102
102
|
"eslint-plugin-flowtype": "^5.9.0",
|
|
103
103
|
"eslint-plugin-import": "^2.24.2",
|
|
104
|
+
"eslint-plugin-jsx-a11y": "^6.4.1",
|
|
104
105
|
"eslint-plugin-react-hooks": "^4.2.0",
|
|
105
106
|
"express": "^4.17.1",
|
|
106
107
|
"husky": "^7.0.2",
|
|
@@ -156,8 +157,6 @@
|
|
|
156
157
|
"hooks": {
|
|
157
158
|
"before:init": [
|
|
158
159
|
"npm run lint",
|
|
159
|
-
"npm run test:ci",
|
|
160
|
-
"npm run test:ci:integration",
|
|
161
160
|
"npm run build"
|
|
162
161
|
]
|
|
163
162
|
}
|