Hierarchy
Properties
disabled
Whether the item is disabled or not.
The property can be used to force a default item to be
disabled by setting it to true.
dropdownGroup
icon
Icon for the item.
The icon should either be an URL, a base64 encoded image or the HTML for an inline SVG. This property can override the default items' ones.
id
Unique identifier for the item.
This is useful to identify items whose type is custom.
Note: It is not possible to override this option for built-in text comparison toolbar items.
Example
// In your JavaScript
const innerToolbarItems = NutrientViewer.defaultTextComparisonInnerToolbarItems
innerToolbarItems.push({
type: 'custom',
id: 'my-button',
// other properties...
})
NutrientViewer.loadTextComparison({
...otherOptions,
innerToolbarItems,
});
mediaQueries
node
Optionally custom tool items can define a DOM node.
NutrientViewer renders this node instead of a standard tool button.
In this case the tool item is rendered inside of a container
which gets the title and className attributes set.
The icon property is ignored.
The selected and disabled are used just to toggle the
PSPDFKit-Tool-Node-active and PSPDFKit-Tool-Node-disabled
class names but making the node effectively selected or disabled is up to
the implementation of the item.
The onPress event is registered and fires any time the item is either clicked
or selected with keyboard (if part of a dropdownGroup).
onPress
event: KeyboardEvent | MouseEvent,
documentEditorUIHandler: DocumentEditorUIHandler,
id: string,
) => void
Callback to invoke when the item is clicked or tapped (on touch devices). It gets the event as
first argument, a document editor UI handler object as the second, and the id of the tool item as the third.
responsiveGroup
selected
Whether a custom item is selected or not.
The selected status of default items cannot be altered.
Note: It is not possible to override this option for built-in text comparison instance toolbar items.
title
Title for the tool items.
It is shown on hover or when the item doesn't have an icon.
required
The type of a text comparison instance toolbar item.
It can either be custom for user defined items or one from the NutrientViewer.defaultTextComparisonInnerToolbarItems.
Note: It is not possible to override this option for built-in toolbar items.
Example
// In your JavaScript
const innerToolbarItems = NutrientViewer.defaultTextComparisonInnerToolbarItems
innerToolbarItems.push({
type: 'custom',
// other properties...
})
NutrientViewer.loadTextComparison({
...otherOptions,
innerToolbarItems,
});
Useful to set a custom CSS class name on the item.
For default text comparison instance toolbar items the
classNameis appended to the default item ones.