@vue-pdf-viewer/viewer 3.6.0-beta.4 → 3.6.0-beta.6

package/dist/types/composables/usePdfActualPages.d.ts

@@ -1,4 +1,4 @@
-import { UnwrapRef } from 'vue';
+import { Reactive } from 'vue';
 import { ViewerPdfPage, ViewerState } from '@/utils/types';
 /**
  * Composable for managing PDF pages at base scale (100%).
@@ -12,7 +12,7 @@ import { ViewerPdfPage, ViewerState } from '@/utils/types';
  * @param props - The viewer state containing PDF document and rotation settings
  * @returns Object containing pdfPages (all pages) and filteredPages (view-mode filtered)
  */
-declare function usePdfActualPages(props: UnwrapRef<ViewerState>): {
+declare function usePdfActualPages(props: Reactive<ViewerState>): {
     /** All pages at base scale (100%) */
     pdfPages: import("vue").ShallowRef<ViewerPdfPage[], ViewerPdfPage[]>;
     /** Pages filtered by view mode (for page scroll mode) */

package/dist/types/composables/useViewerState.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Composable for accessing the shared viewer state.
+ *
+ * This composable provides access to the reactive ViewerState that is
+ * provided by the VPdfViewer component. It centralizes the inject logic
+ * and ensures type safety.
+ *
+ * @example
+ * ```ts
+ * // In any component inside VPdfViewer
+ * const viewerState = useViewerState()
+ *
+ * // Access reactive properties directly (no .value needed)
+ * console.log(viewerState.scale)
+ *
+ * // Watch for changes
+ * watch(() => viewerState.scale, (newScale) => {
+ *   console.log('Scale changed:', newScale)
+ * })
+ *
+ * // Update values (watchers in other components will trigger)
+ * viewerState.scale = 1.5
+ *
+ * // Use toRefs for destructuring with reactivity
+ * const { scale, rotation } = toRefs(viewerState)
+ * console.log(scale.value) // refs need .value
+ * ```
+ */
+import { type Reactive } from 'vue';
+import type { ViewerState } from '@/utils/types';
+/**
+ * Access the shared ViewerState from the parent VPdfViewer component.
+ *
+ * @returns The reactive ViewerState object with plain value properties
+ * @throws Error if used outside of VPdfViewer component tree
+ */
+export declare function useViewerState(): Reactive<ViewerState>;
+/**
+ * Access the shared ViewerState, returning undefined if not available.
+ * Use this when the component may be used outside VPdfViewer context.
+ *
+ * @returns The reactive ViewerState object or undefined if not in VPdfViewer context
+ */
+export declare function useViewerStateOptional(): Reactive<ViewerState> | undefined;