Skip to content

ModalCommandBuilder.build method

ModalCommandBuilder › build

Applies the accumulated commands to a modal. Always registers the essential navigation/action key handlers; only renders the control strip and registers the option-toggle shortcuts when ModalCommandBuilderBuildOptions.shouldShowInstructions is true.

Signature:

build(target: ModalCommandsTarget, options?: ModalCommandBuilderBuildOptions): ModalCommands

Parameters:

ParameterTypeDescription
targetModalCommandsTargetThe modal, or the bare element + scope, to apply the commands to.
options?ModalCommandBuilderBuildOptionsThe build options.

Returns: ModalCommandsA handle whose ModalCommands.refresh re-states every rendered control.