Nutrient Web SDK

ReferenceDocumentEditorFooterItem

Interface DocumentEditorFooterItem

Describes the properties of a Document Editor Footer Item.

Check out our guides for more examples.

Interface

See Also

Hierarchy

DocumentEditorBuiltinFooterItemDocumentEditorCustomFooterItemDocumentEditorFooterItem

Properties

className

Optional
string

Useful to set a custom CSS class name on the item.

For default document editor footer items the className is appended to the default item ones.

disabled

Optional
boolean

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.

icon

Optional
string

Icon for the item.

The icon should either be an URL, a base64 encoded image or the HTML for an inline SVG.

id

Optional
string

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 document editor footer items.

Example

// In your JavaScript
const documentEditorFooterItems = NutrientViewer.defaultDocumentEditorFooterItems
documentEditorFooterItems.push({
type: 'custom',
id: 'my-button',
// other properties...
})
NutrientViewer.load({
...otherOptions,
documentEditorFooterItems
});

required

custom tool items have to define a DOM node which NutrientViewer will render.

In this case the tool item is rendered inside of a container div. The className which you pass is set to this container div and not to the node that you passed.

The onPress event is registered and fires any time the item is clicked.

onPress

Optional
(e: Event) => void

title

Optional
string

Title for the tool items.

It is shown on hover or when the item doesn't have an icon.


    | "custom"
    | "cancel"
    | "save"
    | "spacer"
    | "save-as"
    | "selected-pages"
    | "loading-indicator"