sdk.choice

Choice namespace

Functions

Function Description

Function	Description
showChoice(ctx, options)	Renders a form dialog with one or more sets of obligatory single choices. It displays a bubble with a text, one or more groups of radio buttons, header and navigation buttons, and waits until the user clicks one of the buttons. Common uses for this dialog are: - Asking how to proceed after an unexpected condition; - Asking whether to perform or skip a next step; - Asking for a decision to disambiguate a result. The `text` of the message is parsed as Markdown, but it's also possible to pass ReactNodes. All the choice groups in the form are required, and the main action will only be enabled when every choice has a value. One or more buttons can be specified, of which the "main" action should be the last. By default, the dialog presents a single `Submit` button with value `ok`. Resolves when the user clicks one of the buttons, with the `value` of the button that was clicked.
showMultipleChoice(ctx, options)	Renders a form dialog with one or more sets of multiple optional choices. It displays a bubble with a text, one or more groups of checkboxes, header and navigation buttons, and waits until the user clicks one of the buttons. Common uses for this dialog are: - Asking which optional tasks should be done next; - Asking which products should be removed from an order; - Asking which cost centers should be assigned to an invoice. The `text` of the message is parsed as Markdown, but it's also possible to pass ReactNodes. Any number of buttons can be specified, of which the "main" action should be the last. By default, the dialog presents a single `Submit` button with value `ok`. Resolves when the user clicks one of the buttons, with the `value` of the button that was clicked.

Renders a form dialog with one or more sets of obligatory single choices.

It displays a bubble with a text, one or more groups of radio buttons, header and navigation buttons, and waits until the user clicks one of the buttons.

Common uses for this dialog are: - Asking how to proceed after an unexpected condition; - Asking whether to perform or skip a next step; - Asking for a decision to disambiguate a result.

The text of the message is parsed as Markdown, but it's also possible to pass ReactNodes.

All the choice groups in the form are required, and the main action will only be enabled when every choice has a value.

One or more buttons can be specified, of which the "main" action should be the last. By default, the dialog presents a single Submit button with value ok.

Resolves when the user clicks one of the buttons, with the value of the button that was clicked.

showMultipleChoice(ctx, options)

Renders a form dialog with one or more sets of multiple optional choices.

It displays a bubble with a text, one or more groups of checkboxes, header and navigation buttons, and waits until the user clicks one of the buttons.

Common uses for this dialog are: - Asking which optional tasks should be done next; - Asking which products should be removed from an order; - Asking which cost centers should be assigned to an invoice.

The text of the message is parsed as Markdown, but it's also possible to pass ReactNodes.

Any number of buttons can be specified, of which the "main" action should be the last. By default, the dialog presents a single Submit button with value ok.

Resolves when the user clicks one of the buttons, with the value of the button that was clicked.

Variables

Variable	Description
DEFAULT_SHOW_CHOICE_OPTIONS
DEFAULT_SHOW_MULTIPLE_CHOICE_OPTIONS

Choice namespace​

Functions​

Variables​

Choice namespace

Functions

Variables