Fluent Commerce Logo
Docs

Print Button

UI Component

Changed on:

27 Sept 2024

Overview

The Print Button combines the page query with an HTML setting to generate a document that can be printed. A user can use this component to print pick lists, packing slips, order invoices, and more.
Plugin NameCore
The standard library of mystique components. 
0000-00-00

v1.0.0

Initial changelog entry.

Alias

fc.button.print fc.button.print.pick

Detailed technical description


Properties

NameTypeRequiredDefaultDescription
label`string`yes
Label text to be presented on the button. Accepts an i18n key.
setting`string`yes
Name of a setting containing an HTML document template.

This document can contain template strings referencing the data available in the page query.
behavior`string`no`print`Behaviour with which the HTML document is printed.
Three options are available:
`print`: Opens the browser's print preview
`preview`: Opens the modal preview with the print button that triggers the browser's print action
`newTab`: Opens the HTML document in a new tab of the browser
disabled`string`NononeMakes the button inactive.

Configuration example

1{
2  "component": "fc.button.print",
3  "props": {
4     "label": "i18n:fc.sf.ui.waves.detail.action.pickList.label",
5     "setting": "example.wave.pick.print",
6     "behavior": "print",
7     "disabled": "true"
8  }
9}

Version History

2023-08-01

v23.08.01

apart of the standard offering
2024-10-08

2024.10.8

The component extension with the `disabled`.

Recommended Placement

None