Skip to main content

Interface: InstructionsOptions

Extends​

  • StoryOptions

Properties​

backButtonBackgroundColor?​

optional backButtonBackgroundColor: RgbaColor

Color of back button. Default is WebColors.Black. Can be overridden within a single instruction scene

Source​

addons/src/stories/instructions.ts:116

backButtonFontColor?​

optional backButtonFontColor: RgbaColor

Color of back button text. Default is WebColors.White. Can be overridden within a single instruction scene

Source​

addons/src/stories/instructions.ts:118

backButtonHeight?​

optional backButtonHeight: number

Height of back button. Default is 50. Can be overridden within a single instruction scene

Source​

addons/src/stories/instructions.ts:112

backButtonText?​

optional backButtonText: string

Button text for the back button. Default is "Back". Can be overridden within a single instruction scene

Source​

addons/src/stories/instructions.ts:100

backButtonTextInterpolation?​

optional backButtonTextInterpolation: StringInterpolationMap

Interpolation map for back button text

Source​

addons/src/stories/instructions.ts:102

backButtonWidth?​

optional backButtonWidth: number

Width of back button. Default is 125. Can be overridden within a single instruction scene

Source​

addons/src/stories/instructions.ts:108

backSceneTransition?​

optional backSceneTransition: Transition

Scene transition when returning to the previous instruction scene. Default is push transition, to the right, 500 milliseconds duration. Can be overridden within a single instruction scene

Source​

addons/src/stories/instructions.ts:98

backgroundColor?​

optional backgroundColor: RgbaColor

Background color for instruction scenes. Can be overridden within a single instruction scene

Source​

addons/src/stories/instructions.ts:94

instructionScenes​

instructionScenes: InstructionScene[]

Array of instruction scenes that form the instructions

Source​

addons/src/stories/instructions.ts:92

nextButtonBackgroundColor?​

optional nextButtonBackgroundColor: RgbaColor

Color of next button. Default is WebColors.Black. Can be overridden within a single instruction scene

Source​

addons/src/stories/instructions.ts:120

nextButtonFontColor?​

optional nextButtonFontColor: RgbaColor

Color of next button text. Default is WebColors.White. Can be overridden within a single instruction scene

Source​

addons/src/stories/instructions.ts:122

nextButtonHeight?​

optional nextButtonHeight: number

Height of next button. Default is 50. Can be overridden within a single instruction scene

Source​

addons/src/stories/instructions.ts:114

nextButtonText?​

optional nextButtonText: string

Button text for the next button. Default is "Next". Can be overridden within a single instruction scene

Source​

addons/src/stories/instructions.ts:104

nextButtonTextInterpolation?​

optional nextButtonTextInterpolation: StringInterpolationMap

Interpolation map for next button text

Source​

addons/src/stories/instructions.ts:106

nextButtonWidth?​

optional nextButtonWidth: number

Width of next button. Default is 125. Can be overridden within a single instruction scene

Source​

addons/src/stories/instructions.ts:110

nextSceneTransition?​

optional nextSceneTransition: Transition

Scene transition when advancing to the next instruction scene. Default is push transition, to the left, 500 milliseconds duration. Can be overridden within a single instruction scene

Source​

addons/src/stories/instructions.ts:96

postInstructionsScene?​

optional postInstructionsScene: string

Name of scene that follows the last instruction scene. Clicking the "next" button on the last instruction screen will advance to this screen

Source​

addons/src/stories/instructions.ts:90

sceneNamePrefix?​

optional sceneNamePrefix: string

Name to prefix to each instruction scene name. Default is "instructions." For example, if screenNamePrefix is "instructions", instruction scenes will be named "instructions-01", "instructions-02", etc.

Overrides​

StoryOptions.sceneNamePrefix

Source​

addons/src/stories/instructions.ts:88