Toolmark

Appearance

toolmark-monorepo / @toolmark/tour/overlay / TourStrings

Interface: TourStrings ​

Defined in: packages/tour/src/overlay/index.ts:13

App-supplied overlay strings (spec §15: the app localizes; English defaults).

Properties ​

back ​

back: string

Defined in: packages/tour/src/overlay/index.ts:17

Back button. Default "Back".

busy ​

busy: string

Defined in: packages/tour/src/overlay/index.ts:25

Announced while a do step's call is in flight (Next/Back unavailable). Default "Working…".

close ​

close: string

Defined in: packages/tour/src/overlay/index.ts:19

Accessible name of the close button. Default "Close tour".

confirming ​

confirming: string

Defined in: packages/tour/src/overlay/index.ts:23

Announced while an inline confirmation is pending. Default "Waiting for your confirmation".

done ​

done: string

Defined in: packages/tour/src/overlay/index.ts:21

Next button on the last step. Default "Done".

next ​

next: string

Defined in: packages/tour/src/overlay/index.ts:15

Next button. Default "Next".

Methods ​

stepOf() ​

stepOf(i, n): string

Defined in: packages/tour/src/overlay/index.ts:31

Step counter. Default (i, n) => `Step ${i} of ${n}`.

Parameters ​

i ​

number

1-based step number.

n ​

number

Number of steps.

Returns ​

string