Inline Print Button (legacy)

Home
Essential Knowledge
By Type
Building Blocks
APIs
Releases

UI Component

Changed on:

18 Oct 2023

Overview

The Print Button combines the page query with an HTML setting to generate a document that can be printed.

On click, a modal preview is presented with a print button that triggers the browser's print action. From there the document may be printed directly or saved out to PDF using a print-to-pdf tool.

This can be used to produce things like pick lists, packing slips, and order invoices.

Note that this feature is a legacy design. The new print component can be found here: New Print Component.

Plugin Name	Core

The standard library of mystique components.

0000-00-00

v1.0.0

Initial changelog entry.

Alias

fc.button.print.inline fc.button.print.inline.compatibility

Detailed technical description

Note

The "compatibility" version is designed for use with pre-existing custom pick list templates (saved under setting name

`PICK_N_PACK_CUSTOM_PICK_LIST`

)`.

That version required a specific data format that isn't easy to generate directly from GraphQL, so some data transformation is performed before rendering.

Properties

Name

Type

Required

Default

Description

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.

Configuration example

1{
2  "component": "fc.button.print.inline.compatibility",
3  "props": {
4     "label": "i18n:fc.sf.ui.waves.detail.action.pickList.download.label",
5     "setting": "example.wave.pick.print"
6  }
7}

Language: json

Version History

2023-08-01

v23.8.1

N/A

Recommended Placement

None