@pdfslick/react 1.1.0 → 1.1.2

package/dist/README.md

@@ -0,0 +1,119 @@
+<br><br>
+
+![readme-header](https://pdfslick.dev/pdfslick_logo.svg)
+
+<br><br>
+<div align="center">
+View and Interact with PDFs in React and SolidJS apps
+<br><br>
+
+[Getting Started](https://pdfslick.dev/docs) | [Examples](https://pdfslick.dev/examples)
+
+<br><br>
+</div>
+
+---
+<br>
+
+PDFSlick is a library that enables viewing of and interaction with PDF documents in React and SolidJS apps.
+It's build on top of Mozilla's [PDF.js](https://github.com/mozilla/pdf.js), and utilises [Zustand](https://github.com/pmndrs/zustand) to provide a reactive store for the loaded documents.
+
+## Motivation
+
+[PDF.js](https://github.com/mozilla/pdf.js) is an amazing piece of software. It is also a very stable and mature one — it powers the PDF viewer in Mozilla Firefox and it's been around since 2011. However, it's all Vanilla JavaScript, and when it comes to using it with libraries like React and SolidJS (although possible) it's a litte bit hard in terms of integrating it in these Component- and reactive-like environments. PDFSlick attempts to wrap all of that fascinating functionality into one that is easier to fit in React and SolidJS worlds — as components and a reactive store.
+
+## Core Concepts
+
+The core of PDFSlick is within the `@pdfslick/core` package. It wraps `PDF.js`'s functionality and links it to the store. This `@pdfslick/core` package is the basis for the React and SolidJS packages, which additionally transform the store and make it suitable for the adequate library, as well as providing components for the PDF viewer and thumbnails.
+
+Depending on your needs, at this you might find it useful to continue with learning more about using PDFSlick with React and SolidJS respsectivelly. However, if really interested you can learn more about using PDFSlick's `@pdfslick/core` package with Vanilla JS apps and with libraries other than React and SolidJS in the sections below.
+
+## Getting Started with React
+
+To get started with React run:
+```shell
+npm install @pdfslick/react
+# yarn add @pdfslick/react
+# pnpm add @pdfslick/react
+```
+
+You can start using PDFSlick with the `usePDFSlick()` hook, like with the following basic example:
+```jsx
+import { usePDFSlick } from "@pdfslick/react";
+import PDFNavigation from "./PDFNavigation";
+
+import "@pdfslick/react/dist/pdf_viewer.css";
+
+type PDFViewerAppProps = {
+  pdfFilePath: string;
+};
+
+const SimplePDFViewer = ({ pdfFilePath }: PDFViewerAppProps) => {
+  const { viewerRef, usePDFSlickStore, PDFSlickViewer } = usePDFSlick(pdfFilePath, {
+    singlePageViewer: true,
+    scaleValue: "page-fit"
+  });
+
+  return (
+    <div className="absolute inset-0 bg-slate-200/70 pdfSlick">
+      <div className="flex-1 relative h-full">
+        <PDFSlickViewer {...{ viewerRef, usePDFSlickStore }} />
+        <PDFNavigation {...{ usePDFSlickStore }} />
+      </div>
+    </div>
+  );
+};
+
+export default SimplePDFViewer;
+```
+
+Provided with the PDF Document path and options object, the `usePDFSlick()` hook returns an object consisting (among the other things) of:
+- `PDFSlickViewer` — the PDF Viewer component used for viewing the PDF document
+- `viewerRef` — a `RefCallback` that is provided as a prop to the `<PDFSlickViewer />` component
+- `usePDFSlickStore` — a hook to the PDFSlick store
+
+<br><br>
+[Read more about using PDFSlick with React](https://pdfslick.dev/docs/react) | [Checkout the React Examples](./apps/web/examples)
+
+## SolidJS
+
+To get started with PDFSlick for SolidJS React run:
+```shell
+npm install @pdfslick/solid
+# yarn add @pdfslick/solid
+# pnpm add @pdfslick/solid
+```
+
+You can start using PDFSlick with the `usePDFSlick()` hook, like with the following basic example:
+```jsx
+import { Component, createSignal } from "solid-js";
+import { usePDFSlick } from "@pdfslick/solid";
+
+type PDFViewerAppProps = {
+  pdfFilePath: string;
+};
+
+const PDFViewerApp: Component<PDFViewerAppProps> = ({ pdfFilePath }) => {
+  const { viewerRef, pdfSlickStore: store, PDFSlickViewer } =
+    usePDFSlick(pdfFilePath);
+
+  return (
+    <div class="absolute inset-0 bg-slate-200/70 flex flex-col pdfSlick">
+      <div class="flex-1 relative h-full">
+        <PDFSlickViewer {...{ store, viewerRef }} />
+      </div>
+    </div>
+  );
+};
+
+export default PDFViewerApp;
+```
+
+Provided with the PDF Document path and options object, the `usePDFSlick()` hook returns an object consisting (among the other things) of:
+- `PDFSlickViewer` — the PDF Viewer component used for viewing the PDF document
+- `viewerRef` — a `RefCallback` that is provided as a prop to the `<PDFSlickViewer />` component
+- `pdfSlickStore` — the PDFSlick store
+
+<br><br>
+[Read more about using PDFSlick with SolidJS](https://pdfslick.dev/docs/solid) | [Checkout the SolidJS Examples](./apps/solidweb/src/examples)
+

package/dist/esm/PDFSlickThumbnails.d.ts

@@ -0,0 +1,20 @@
+import { ReactNode } from "react";
+import type { TUsePDFSlickStore } from "./";
+export type PDFSlickThumbProps = {
+    pageNumber: number;
+    width: number;
+    height: number;
+    scale: number;
+    rotation: number;
+    loaded: boolean;
+    pageLabel: string | null;
+    src: string | null;
+};
+export type PDFSlickThumbnailsContainerProps = {
+    children: ({ pageNumber, src, width, height, scale, rotation, pageLabel, loaded, }: PDFSlickThumbProps) => ReactNode;
+    thumbsRef: (instance: HTMLElement | null) => void;
+    usePDFSlickStore: TUsePDFSlickStore;
+    className?: string;
+};
+export declare function PDFSlickThumbnails({ children: renderChild, thumbsRef, usePDFSlickStore, className, }: PDFSlickThumbnailsContainerProps): JSX.Element;
+//# sourceMappingURL=PDFSlickThumbnails.d.ts.map

package/dist/esm/PDFSlickThumbnails.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PDFSlickThumbnails.d.ts","sourceRoot":"","sources":["../PDFSlickThumbnails.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAGlC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,IAAI,CAAC;AAE5C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,QAAQ,EAAE,CAAC,EACT,UAAU,EACV,GAAG,EACH,KAAK,EACL,MAAM,EACN,KAAK,EACL,QAAQ,EACR,SAAS,EACT,MAAM,GACP,EAAE,kBAAkB,KAAK,SAAS,CAAC;IACpC,SAAS,EAAE,CAAC,QAAQ,EAAE,WAAW,GAAG,IAAI,KAAK,IAAI,CAAC;IAClD,gBAAgB,EAAE,iBAAiB,CAAC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,wBAAgB,kBAAkB,CAAC,EACjC,QAAQ,EAAE,WAAW,EACrB,SAAS,EACT,gBAAgB,EAChB,SAAS,GACV,EAAE,gCAAgC,eA8ClC"}

package/dist/esm/PDFSlickViewer.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+/// <reference types="react" />
+import type { TUsePDFSlickStore } from "@pdfslick/react";
+export type PDFSlickViewerProps = {
+    viewerRef: (instance: HTMLElement) => void;
+    usePDFSlickStore: TUsePDFSlickStore;
+    className?: string;
+};
+export default function PDFSlickViewer({ usePDFSlickStore, viewerRef, className, }: PDFSlickViewerProps): JSX.Element;
+//# sourceMappingURL=PDFSlickViewer.d.ts.map

package/dist/esm/PDFSlickViewer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PDFSlickViewer.d.ts","sourceRoot":"","sources":["../PDFSlickViewer.tsx"],"names":[],"mappings":";;AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEzD,MAAM,MAAM,mBAAmB,GAAG;IAChC,SAAS,EAAE,CAAC,QAAQ,EAAE,WAAW,KAAK,IAAI,CAAC;IAC3C,gBAAgB,EAAE,iBAAiB,CAAC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,EACrC,gBAAgB,EAChB,SAAS,EACT,SAAS,GACV,EAAE,mBAAmB,eAwCrB"}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./usePDFSlick";
+export * from "./PDFSlickThumbnails";
+export * from "@pdfslick/core";
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.tsx"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAA;AACpC,cAAc,gBAAgB,CAAA"}

package/dist/esm/index.js

@@ -0,0 +1,116 @@
+import { useState, useMemo, useCallback, useEffect } from 'react';
+import { useStore } from 'zustand';
+import { create, PDFSlick } from '@pdfslick/core';
+export * from '@pdfslick/core';
+import { jsx } from 'react/jsx-runtime';
+import { useMeasure, useDebounce } from 'react-use';
+import { createPortal } from 'react-dom';
+
+function PDFSlickViewer({ usePDFSlickStore, viewerRef, className, }) {
+    const pdfSlick = usePDFSlickStore((s) => s.pdfSlick);
+    const scaleValue = usePDFSlickStore((s) => s.scaleValue);
+    const [resizeRef, { width }] = useMeasure();
+    useDebounce(() => {
+        if (width) {
+            if (pdfSlick &&
+                (scaleValue === "auto" ||
+                    scaleValue === "page-fit" ||
+                    scaleValue === "page-width")) {
+                pdfSlick.viewer.currentScaleValue = scaleValue;
+            }
+            pdfSlick === null || pdfSlick === void 0 ? void 0 : pdfSlick.viewer.update();
+        }
+    }, 0, [width]);
+    return (jsx("div", Object.assign({ ref: (el) => {
+            viewerRef(el);
+            resizeRef(el);
+        }, id: "viewerContainer", className: `pdfSlickContainer ${className !== null && className !== void 0 ? className : ""}`, style: {
+            position: "absolute",
+            inset: 0,
+        } }, { children: jsx("div", { id: "viewer", className: "pdfSlickViewer pdfViewer" }) })));
+}
+
+function PDFSlickThumbnails({ children: renderChild, thumbsRef, usePDFSlickStore, className, }) {
+    const thumbnailViews = usePDFSlickStore((s) => s.thumbnailViews);
+    const pdfSlick = usePDFSlickStore((s) => s.pdfSlick);
+    const [resizeRef, { width }] = useMeasure();
+    useDebounce(() => {
+        if (width) {
+            pdfSlick === null || pdfSlick === void 0 ? void 0 : pdfSlick.forceRendering();
+        }
+    }, 0, [width]);
+    return (jsx("div", Object.assign({ ref: (el) => {
+            thumbsRef(el);
+            resizeRef(el);
+        } }, { className }, { style: {
+            position: "absolute",
+            overflow: "auto",
+            inset: 0
+        } }, { children: Array.from(thumbnailViews).map(([pageNumber, view]) => {
+            var _a;
+            return createPortal(renderChild({
+                pageNumber,
+                width: view.canvasWidth,
+                height: view.canvasHeight,
+                scale: view.scale,
+                src: (_a = view === null || view === void 0 ? void 0 : view.src) !== null && _a !== void 0 ? _a : null,
+                rotation: view.rotation,
+                pageLabel: view.pageLabel,
+                loaded: view.loaded,
+            }), view.div);
+        }) })));
+}
+
+function createStore(store) {
+    function usePDFSlickStore(selector, equals) {
+        return useStore(store, selector, equals);
+    }
+    return usePDFSlickStore;
+}
+/**
+ *
+ * @param url PDF Document path
+ * @param options PDFSlick Options
+ * @returns
+ */
+const usePDFSlick = (url, options) => {
+    const [isDocumentLoaded, setIsDocumentLoaded] = useState(false);
+    const [container, setContainer] = useState(null);
+    const [thumbs, setThumbs] = useState(null);
+    const store = useMemo(() => create(), []);
+    const usePDFSlickStore = useMemo(() => createStore(store), []);
+    const viewerRef = useCallback((node) => {
+        if (node !== null) {
+            setContainer(node);
+        }
+    }, []);
+    const thumbsRef = useCallback((node) => {
+        if (node !== null) {
+            setThumbs(node);
+        }
+    }, []);
+    useEffect(() => {
+        if (url && container) {
+            const pdfSlick = new PDFSlick({
+                container,
+                thumbs: thumbs,
+                store,
+                options,
+            });
+            pdfSlick.loadDocument(url, options).then(() => setIsDocumentLoaded(true));
+            store.setState({ pdfSlick });
+        }
+        return () => { };
+    }, [url, container]);
+    return {
+        isDocumentLoaded,
+        viewerRef,
+        thumbsRef,
+        usePDFSlickStore,
+        store,
+        PDFSlickViewer,
+        PDFSlickThumbnails,
+    };
+};
+
+export { PDFSlickThumbnails, createStore, usePDFSlick };

package/dist/esm/usePDFSlick.d.ts

@@ -0,0 +1,32 @@
+/// <reference types="node" />
+import { RefCallback } from "react";
+import { StoreApi } from "zustand";
+import type { PDFSlickState, PDFSlickOptions } from "@pdfslick/core";
+import PDFSlickViewer from "./PDFSlickViewer";
+import { PDFSlickThumbnails } from "./PDFSlickThumbnails";
+export type TUsePDFSlickStore = {
+    (): PDFSlickState;
+    <T>(selector: (state: PDFSlickState) => T, equals?: ((a: T, b: T) => boolean) | undefined): T;
+};
+type TUsePDFSlick = (url: string | URL | undefined, options?: PDFSlickOptions) => {
+    isDocumentLoaded: boolean;
+    viewerRef: RefCallback<HTMLElement>;
+    thumbsRef: RefCallback<HTMLElement>;
+    store: StoreApi<PDFSlickState>;
+    usePDFSlickStore: TUsePDFSlickStore;
+    PDFSlickViewer: typeof PDFSlickViewer;
+    PDFSlickThumbnails: typeof PDFSlickThumbnails;
+};
+export declare function createStore(store: StoreApi<PDFSlickState>): {
+    (): PDFSlickState;
+    <T>(selector: (state: PDFSlickState) => T, equals?: ((a: T, b: T) => boolean) | undefined): T;
+};
+/**
+ *
+ * @param url PDF Document path
+ * @param options PDFSlick Options
+ * @returns
+ */
+export declare const usePDFSlick: TUsePDFSlick;
+export {};
+//# sourceMappingURL=usePDFSlick.d.ts.map

package/dist/esm/usePDFSlick.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usePDFSlick.d.ts","sourceRoot":"","sources":["../usePDFSlick.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAoC,WAAW,EAAW,MAAM,OAAO,CAAC;AAC/E,OAAO,EAAE,QAAQ,EAAY,MAAM,SAAS,CAAC;AAE7C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACrE,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,aAAa,CAAC;IAClB,CAAC,CAAC,EACA,QAAQ,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,CAAC,EACrC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC,GAAG,SAAS,GAC7C,CAAC,CAAC;CACN,CAAC;AAEF,KAAK,YAAY,GAAG,CAClB,GAAG,EAAE,MAAM,GAAG,GAAG,GAAG,SAAS,EAE7B,OAAO,CAAC,EAAE,eAAe,KACtB;IACH,gBAAgB,EAAE,OAAO,CAAC;IAC1B,SAAS,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;IACpC,SAAS,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;IACpC,KAAK,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;IAC/B,gBAAgB,EAAE,iBAAiB,CAAC;IACpC,cAAc,EAAE,OAAO,cAAc,CAAC;IACtC,kBAAkB,EAAE,OAAO,kBAAkB,CAAC;CAC/C,CAAC;AAEF,wBAAgB,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,aAAa,CAAC;QAC3B,aAAa;0BAEtB,aAAa,kCACN,OAAO;EAUnC;AAED;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE,YA+CzB,CAAC"}