modules.md

@guestbell/onboarder / Exports

@guestbell/onboarder

Table of contents

References

• default

Type Aliases

• HookConfig
• HookType
• NextStepFunc
• OnboarderProps
• ResetAction
• SetState
• Step
• StepComponent
• StepComponentProps
• StepContainerComponent
• StepContainerComponentProps
• Steps
• Structure

Variables

• StateContext

Functions

• Onboarder
• StateContextConsumer
• StateContextProvider
• useGlobalState

References

default

Renames and re-exports Onboarder

Type Aliases

HookConfig

Ƭ HookConfig<TState, TStepState>: Object

Type parameters

Name	Type
TState	extends Object
TStepState	TStepState

Type declaration

Name	Type
setState	SetState<TStepState>
state	TStepState

Defined in

src/types/Step.ts:25

---

HookType

Ƭ HookType<TState, TStepState, TRet>: (config: HookConfig<TState, TStepState>) => TRet | Promise<TRet>

Type parameters

Name	Type
TState	extends Object
TStepState	TStepState
TRet	TRet

Type declaration

▸ (config): TRet | Promise<TRet>

Parameters

Name	Type
config	HookConfig<TState, TStepState>

Returns

TRet | Promise<TRet>

Defined in

src/types/Step.ts:30

---

NextStepFunc

Ƭ NextStepFunc<TState, TKey>: (state: TState) => { [key in keyof Exclude<TState, TKey>]?: number }

Type parameters

Name	Type
TState	extends Object
TKey	TKey

Type declaration

▸ (state): { [key in keyof Exclude<TState, TKey>]?: number }

Parameters

Name	Type
state	TState

Returns

{ [key in keyof Exclude<TState, TKey>]?: number }

Defined in

src/types/Structure.ts:1

---

OnboarderProps

Ƭ OnboarderProps<TState, TExtraStepProps, TExtraStepContainerProps>: Object

Type parameters

Name	Type
TState	extends Object
TExtraStepProps	extends Object = {}
TExtraStepContainerProps	extends Object = {}

Type declaration

Name	Type
StepContainer?	StepContainerComponent<TState, TExtraStepProps, TExtraStepContainerProps>
debug?	boolean
finalSteps	keyof TState[]
initialStep	keyof TState
steps	Steps<TState, TExtraStepProps>
structure?	Structure<TState>

Defined in

src/components/onboarder/Onboarder.tsx:12

---

ResetAction

Ƭ ResetAction: Object

Type declaration

Name	Type
type	"reset"
value?	never

Defined in

src/components/onboarder/Onboarder.tsx:30

---

SetState

Ƭ SetState<TStepState>: (state: TStepState | (state: TStepState) => TStepState) => void

Type parameters

Name
TStepState

Type declaration

▸ (state): void

Parameters

Name	Type
state	TStepState | (state: TStepState) => TStepState

Returns

void

Defined in

src/types/Step.ts:4

---

Step

Ƭ Step<TState, TStepState, TExtraStepProps>: { Component: StepComponent<TState, TStepState> ; afterNext?: HookType<TState, TStepState, void> ; beforeNext?: HookType<TState, TStepState, boolean> ; initialState?: TStepState ; timeRequiredSec?: number } & TExtraStepProps

Type parameters

Name	Type
TState	extends Object
TStepState	TStepState
TExtraStepProps	extends Object

Defined in

src/types/Step.ts:34

---

StepComponent

Ƭ StepComponent<TState, TStepState, TExtraStepProps>: React.ComponentType<StepComponentProps<TState, TStepState, TExtraStepProps>>

Type parameters

Name	Type
TState	extends Object
TStepState	TStepState
TExtraStepProps	extends Object = {}

Defined in

src/types/Step.ts:17

---

StepComponentProps

Ƭ StepComponentProps<TState, TStepState, TExtraStepProps>: StepContainerComponentProps<TState, TExtraStepProps> & { setState: SetState<TStepState> ; state: TStepState }

Type parameters

Name	Type
TState	extends Object
TStepState	TStepState
TExtraStepProps	extends Object = {}

Defined in

src/types/Step.ts:8

---

StepContainerComponent

Ƭ StepContainerComponent<TState, TExtraStepProps, TExtraStepContainerProps>: React.ComponentType<StepContainerComponentProps<TState, TExtraStepProps, TExtraStepContainerProps>>

Type parameters

Name	Type
TState	extends Object
TExtraStepProps	extends Object = {}
TExtraStepContainerProps	extends Object = {}

Defined in

src/types/StepContainer.ts:29

---

StepContainerComponentProps

Ƭ StepContainerComponentProps<TState, TExtraStepProps, TExtraStepContainerProps>: TExtraStepContainerProps & { currentStep: keyof TState ; finalSteps: keyof TState[] ; getState: () => TState ; goToNextStep: () => void ; goToRedoStep: () => void ; goToStep: (step: keyof TState) => void ; goToUndoStep: () => void ; hasNextStep: boolean ; hasRedoStep: boolean ; hasUndoStep: boolean ; initialStep: keyof TState ; journey: keyof TState[] ; journeyPosition: number ; nextStep: keyof TState | undefined ; remainingTimeSec: number ; reset: () => void ; shortestRemainingJourney: keyof TState[] ; shortestStepsRemaining: number ; steps: Steps<TState, TExtraStepProps> }

Type parameters

Name	Type
TState	extends Object
TExtraStepProps	extends Object = {}
TExtraStepContainerProps	extends Object = {}

Defined in

src/types/StepContainer.ts:3

---

Steps

Ƭ Steps<TState, TExtraStepProps>: { [key in keyof TState]: Step<TState, TState[key], TExtraStepProps> }

Type parameters

Name	Type
TState	extends Object
TExtraStepProps	extends Object = {}

Defined in

src/types/Step.ts:42

---

Structure

Ƭ Structure<TState>: { [key in keyof TState]?: NextStepFunc<TState, key> }

Type parameters

Name	Type
TState	extends Object

Defined in

src/types/Structure.ts:5

Variables

StateContext

• Const StateContext: Context<{}>

Defined in

src/context/StateContext.ts:4

Functions

Onboarder

▸ Onboarder<TState, TExtraStepProps, TExtraStepContainerProps>(props): Element

Type parameters

Name	Type
TState	extends Object = {}
TExtraStepProps	extends Object = {}
TExtraStepContainerProps	extends Object = {}

Parameters

Name	Type
props	OnboarderProps<TState, TExtraStepProps, TExtraStepContainerProps> & TExtraStepContainerProps

Returns

Element

Defined in

src/components/onboarder/Onboarder.tsx:36

---

StateContextConsumer

▸ StateContextConsumer(props): null | ReactElement<any, string | JSXElementConstructor<any>>

NOTE: Exotic components are not callable.

Parameters

Name	Type
props	ConsumerProps<{}>

Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Defined in

node_modules/@types/react/index.d.ts:351

---

StateContextProvider

▸ StateContextProvider(props): null | ReactElement<any, string | JSXElementConstructor<any>>

NOTE: Exotic components are not callable.

Parameters

Name	Type
props	ProviderProps<{}>

Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Defined in

node_modules/@types/react/index.d.ts:351

---

useGlobalState

▸ useGlobalState<TState>(): TState

Type parameters

Name	Type
TState	extends Object

Returns

TState

Defined in

src/context/StateContext.ts:9