PdfViewerLabels reference

Every user-visible string and accessible name. Defaults are English; override any subset through the labels prop.

Used by

Labels and locale

Import

import type { PdfViewerLabels } from '@kingtech/react-pdf-viewer';

Properties

Name	Type	Default	Required	Description
`viewer`	`string`	—	Yes	Accessible name of the viewer region.
`toolbar`	`string`	—	Yes	Accessible name of the toolbar.
`document`	`string`	—	Yes	Accessible name of the scrollable document area.
`zoomOut`	`string`	—	Yes	Button.
`zoomIn`	`string`	—	Yes	Button.
`zoomLevel`	`(percent: number, context: LabelContext) => string`	—	Yes	Zoom label text.
`resetZoom`	`string`	—	Yes	Reset-zoom button (with `zoomReset`) and menu item.
`previousPage`	`string`	—	Yes	Button.
`nextPage`	`string`	—	Yes	Button.
`pageIndicator`	`(page: number, total: number, context: LabelContext) => string`	—	Yes	Page label text.
`pageAriaLabel`	`(page: number, total: number, context: LabelContext) => string`	—	Yes	Accessible name of each page.
`pageInput`	`string`	—	Yes	Accessible name of the page-number input.
`enterFullscreen`	`string`	—	Yes	Fullscreen button outside fullscreen.
`exitFullscreen`	`string`	—	Yes	Fullscreen button in fullscreen.
`rotate`	`string`	—	Yes	Button.
`download`	`string`	—	Yes	Button.
`print`	`string`	—	Yes	Button.
`moreActions`	`string`	—	Yes	Overflow menu button shown when the toolbar is too narrow.
`loading`	`string`	—	Yes	Loading view text.
`retry`	`string`	—	Yes	Retry button of the error view.
`empty`	`string`	—	Yes	Announced when there is no document.
`printProgress`	`(done: number, total: number, context: LabelContext) => string`	—	Yes	Print preparation status.
`cancel`	`string`	—	Yes	Cancels print preparation.
`passwordPrompt`	`string`	—	Yes	Password form heading.
`passwordLabel`	`string`	—	Yes	Password field label.
`passwordSubmit`	`string`	—	Yes	Password submit button.
`passwordIncorrect`	`string`	—	Yes	Shown after a wrong password.
`thumbnails`	`string`	—	Yes	Accessible name of the thumbnails sidebar.
`search`	`string`	—	Yes	Accessible name of the search field.
`searchResults`	`(current: number, total: number, context: LabelContext) => string`	—	Yes	Search result status.
`searchPrevious`	`string`	—	Yes	Search button.
`searchNext`	`string`	—	Yes	Search button.
`searchNoResults`	`string`	—	Yes	Shown when nothing matches.

Source

packages/react-pdf-viewer/src/labels.ts

Generated from content/react-pdf-viewer/reference/pdf-viewer-labels.schema.json. Do not edit by hand.