Composables

usePdfKitZoom

Zoom controls and scale management.

Manages zoom controls and scale for the PDF viewer.

Usage

const {
  scale,
  zoomMode,
  zoomIn,
  zoomOut,
  setZoom,
  zoomPercentage,
  zoomPresets,
} = usePdfKitZoom()

Options

usePdfKitZoom({
  initialScale: 1.0,
  minScale: 0.25,
  maxScale: 10.0,
  scaleDelta: 1.1,
})
OptionTypeDefaultDescription
initialScalenumber | ZoomLevel1.0Initial zoom scale or mode
minScalenumber0.25Minimum allowed zoom scale
maxScalenumber10.0Maximum allowed zoom scale
scaleDeltanumber1.1Multiplier for zoom in/out

Return Values

PropertyTypeDescription
scaleRef<number>Current zoom scale
zoomModeRef<ZoomLevel>Current zoom mode
zoomIn() => voidIncrease zoom level
zoomOut() => voidDecrease zoom level
setZoom(value: number | ZoomLevel) => voidSet specific zoom
zoomPercentageComputedRef<number>Zoom as percentage
zoomPresetsnumber[]Available zoom presets

ZoomLevel Type

type ZoomLevel = 'auto' | 'page-fit' | 'page-width' | number

Example

<template>
  <div class="flex items-center gap-2">
    <UButton @click="zoomOut">-</UButton>
    <span>{{ zoomPercentage }}%</span>
    <UButton @click="zoomIn">+</UButton>
    <UButton @click="setZoom('page-fit')">Fit Page</UButton>
    <UButton @click="setZoom('page-width')">Fit Width</UButton>
  </div>
</template>

<script setup>
const { 
  zoomIn, 
  zoomOut, 
  setZoom, 
  zoomPercentage 
} = usePdfKitZoom()
</script>
Copyright © 2026