/** * @embedpdf/vue/render: the Vue view of `@embedpdf/plugin-render`. * `` draws a page and `` the snapshot tool's box * on it, with `` beside it; `useRender()` renders pages yourself, for previews and exports; * `useRenderSettings()` and `useRenderEvent()` read and follow the plugin; * `usePictureState()` tells a layer whether its page's picture is on screen; * `useSnapshot()` is the snapshot the tool holds. */ // One line per feature: registration travels with the UI. export * from '@embedpdf/plugin-render'; // The snapshot's commands, made with the browser's clipboard and file download. export { renderCommands } from './command-lists'; import { RenderToken } from '@embedpdf/plugin-render'; import type { PictureState, RenderCapability, Snapshot } from '@embedpdf/plugin-render'; import type { EventHook } from '@embedpdf/core'; import type { Ref } from 'vue'; import { useCapability, useCapabilityEvent, useOptionalSelector } from './runtime/capabilities'; import { usePage } from './runtime/page'; import { settingsComposable } from './state'; export { default as RenderLayer } from './render/RenderLayer.vue'; export { default as SnapshotLayer } from './render/SnapshotLayer.vue'; export { default as SnapshotMenu } from './render/SnapshotMenu.vue'; /** The render API (renderPage, renderThumbnail, invalidation, settings) for app code. The object never changes. */ export function useRender(): RenderCapability { return useCapability(RenderToken); } /** The render settings (`fullPage`, `tiles`, `format`, …), with or without a document, as refs. Takes a selector. */ export const useRenderSettings = settingsComposable(RenderToken); /** Subscribe to one render event while the component lives: `useRenderEvent((render) => render.onInvalidated, handler)`. */ export function useRenderEvent( select: (render: RenderCapability) => EventHook, handler: (event: Event) => void, ): void { useCapabilityEvent(RenderToken, select, handler); } const NO_PICTURE: PictureState = Object.freeze({ status: 'idle', slow: false }); /** * Whether the picture of the page this component is drawn on is on screen in its view, as a ref: * `{ status, slow }`. `status` is `'loading'` until it is, and `slow` turns on once it waited * `slowAfterMs` (400 ms): the moment to show a loading indicator. Use it in a layer of the page. */ export function usePictureState(): Readonly> { const page = usePage(); return useOptionalSelector( RenderToken, (render) => render.getPictureState(page.value.ref, page.value.view), NO_PICTURE, ); } /** * The snapshot the `snapshot` tool holds, or `null`, as a ref: `{ page, rect, image }`, the same * object while it's held. Copy it with `copyImage(snapshot.image)`, in the click itself. */ export function useSnapshot(): Readonly> { return useOptionalSelector(RenderToken, (render) => render.getSnapshot(), null); }