Properties plugin

The properties plugin provides a button to list the properties of the PDF document.

Install

> npm install '@sse-ui/pdf-properties';

OR

> yarn add '@sse-ui/pdf-properties';

The properties plugin is included in the toolbar and default-layout plugins

Usage

1. Import the plugin

import { propertiesPlugin } from "@sse-ui/pdf-properties";

// Import styles
import "@sse-ui/pdf-properties/lib/styles/index.css";

2. Create the plugin instance

const propertiesPluginInstance = propertiesPlugin();

The plugin instance propertiesPluginInstance provides the following properties:

PROPERTY	TYPE	DESCRIPTION	FROM
ShowProperties	ReactElement	Customizable button to list the properties	1.0.0
ShowPropertiesButton	ReactElement	The default button to list the properties	1.0.0
ShowPropertiesMenuItem	ReactElement	The default menu item to list the properties	1.0.0

3. Register the plugin

Register the properties plugin instance:

<Viewer plugins={[propertiesPluginInstance]} />