Customizing the Document Editor Toolbar and Footer

In PSPDFKit for Web 2021.4, we added support for customizing the Document Editor toolbar and footer. It’s now possible to customize the look and feel of built-in items in the toolbar and footer, as well as alter the entire list of items or add custom ones.

Customizing the Toolbar

Customized document editor toolbar

PSPDFKit.defaultDocumentEditorToolbarItems

The toolbar already includes a number of predefined items. You can retrieve all the predefined items using PSPDFKit.defaultDocumentEditorToolbarItems:

const defaultToolbarItems = PSPDFKit.defaultDocumentEditorToolbarItems;
console.log(defaultToolbarItems);

Items in the toolbar are plain JavaScript objects with the shape of a PSPDFKit.DocumentEditorToolbarItem.

Loading the Custom Toolbar

You can use the list of default toolbar items to customize the toolbar while loading PSPDFKit by using the PSPDFKit.Configuration#documentEditorToolbarItems option:

// Get the default toolbar items.
const defaultToolbarItems = PSPDFKit.defaultDocumentEditorToolbarItems;

// Reverse the list.
defaultToolbarItems.reverse();

// Add a custom item to the list.
defaultToolbarItems.push(customItem);

// Finally, use the desired set of toolbar items in the PSPDFKit configuration.
PSPDFKit.load({
	...otherOptions,
	documentEditorToolbarItems: defaultToolbarItems,
});

At any time, you can retrieve the current list of PSPDFKit.DocumentEditorToolbarItems with instance.documentEditorToolbarItems:

PSPDFKit.load(config).then((instance) => {
	console.log(instance.documentEditorToolbarItems);
});

Updating the Toolbar

Once the PSPDFKit instance has loaded, you can use instance.setDocumentEditorToolbarItems to update the Document Editor toolbar:

instance.setDocumentEditorToolbarItems((items) => {
	items.reverse();
	return items;
});

console.log(instance.documentEditorToolbarItems); // This will set the reversed items array as visible in the UI.

You can also pass an array of PSPDFKit.DocumentEditorToolbarItems directly instead of using a callback:

instance.setDocumentEditorToolbarItems(newItems);

Custom Toolbar Items

As mentioned before, items in the toolbar are plain JavaScript objects with the shape of a PSPDFKit.DocumentEditorToolbarItem. Most of the time, they’re buttons that perform an action upon being clicked.

The main differentiator between built-in toolbar items and user-defined ones is the type. For the former, it’s one of the PSPDFKit.defaultDocumentEditorToolbarItems, and for the latter, it’s custom:

const item = {
	type: 'custom',
	id: 'my-button',
	title: 'Custom Button',
	onPress: (event) => {
		alert('I was clicked');
	},
};

When the icon for an item is missing, the title will be displayed instead. This is useful if you want to create text-only buttons.

onPress is a function that’s invoked when an item is either clicked or tapped (on touch devices).

You can also add a custom node to the toolbar:

const node = instance.contentDocument.createElement('button');
button.innerText = 'Hello';

const item = {
	type: 'custom',
	id: 'my-button',
	node: node,
	onPress: (event) => {
		alert('I was clicked');
	},
};

Once the custom button is ready, it’s possible to insert it into the current list:

instance.setDocumentEditorToolbarItems((items) => {
	items.push(item);
	return items;
});

Customizing Built-In Toolbar Items

It’s possible to customize the following properties of built-in toolbar items:

  • title

  • onPress

  • icon

  • className

Please refer to the Document Editor Toolbar API documentation to learn more about each individual property:

instance.setDocumentEditorToolbarItems((items) =>
	items.map((item) => {
		if (item.type === 'add') {
			item.className = 'Custom-ClassName';
		}
		return item;
	}),
);

Customized document editor footer

PSPDFKit.defaultDocumentEditorFooterItems

Just like the toolbar, the footer includes a number of predefined items. You can retrieve all the predefined items using PSPDFKit.defaultDocumentEditorFooterItems:

const defaultFooterItems = PSPDFKit.defaultDocumentEditorFooterItems;
console.log(defaultFooterItems);

Items in the toolbar are plain JavaScript objects with the shape of a PSPDFKit.DocumentEditorFooterItem.

You can use the list of default footer items to customize the footer while loading PSPDFKit by using the PSPDFKit.Configuration#documentEditorFooterItems option:

const defaultFooterItems = PSPDFKit.defaultDocumentEditorFooterItems;

defaultFooterItems.reverse();

defaultFooterItems.push(customItem);

PSPDFKit.load({
	...otherOptions,
	documentEditorToolbarItems: defaultFooterItems,
});

At any time, you can retrieve the current list of PSPDFKit.DocumentEditorFooterItems with instance.documentEditorFooterItems:

PSPDFKit.load(config).then((instance) => {
	console.log(instance.documentEditorFooterItems);
});

Once the PSPDFKit instance has loaded, you can use instance.setDocumentEditorFooterItems to update the document editor footer:

instance.setDocumentEditorFooterItems((items) => {
	items.reverse();
	return items;
});

console.log(instance.documentEditorFooterItems); // This will set the reversed items array as visible on the UI.

You can also pass an array of PSPDFKit.DocumentEditorFooterItems directly instead of a callback:

instance.setDocumentEditorFooterItems(newItems);

Items in the footer are plain JavaScript objects with the shape of a PSPDFKit.DocumentEditorFooterItem. Most of the time, they’re buttons that perform an action upon being clicked. But in this case, the buttons are different from each other.

The main differentiator between built-in footer items and user-defined ones is the type. For the former, it’s one of the PSPDFKit.defaultDocumentEditorFooterItems, and for the latter, it’s custom. A custom item should always have the node property:

const node = instance.contentDocument.createElement('button');
button.innerText = 'Footer';

const item = {
	type: 'custom',
	id: 'my-button',
	node: node,
	onPress: (event) => {
		alert('I was clicked');
	},
};

Once the custom button is ready, it’s possible to insert it into the current list:

instance.setDocumentEditorFooterItems((items) => {
	items.push(item);
	return items;
});

It’s possible to customize the following properties of built-in footer items:

  • onPress

  • className

Please refer to the Document Editor Footer API documentation to learn more about each individual property.