Type Alias FiveProviderPropTypes

type FiveProviderPropTypes = {
    children: React.ReactNode;
    initialOptions?: number | FiveLoadOptions;
    initialState?: "inherit" | "initial" | Partial<Omit<State, "offset">>;
    initialUserAction?: boolean;
    initialWork?: Work | Work[];
    onCurrentStateChange?: (state: State, userAction: boolean) => void;
    onError?: (error: Error) => void;
    onStateChange?: (state: State, userAction: boolean) => void;
    onWorksChange?: (works: Works) => void;
    work?: Work | Work[];
}

Index

Properties

children initialOptions? initialState? initialUserAction? initialWork? onCurrentStateChange? onError? onStateChange? onWorksChange? work?

Properties

children

children: React.ReactNode

`Optional`initialOptions

initialOptions?: number | FiveLoadOptions

`Optional`initialState

initialState?: "inherit" | "initial" | Partial<Omit<State, "offset">>

`Optional`initialUserAction

initialUserAction?: boolean

`Optional`initialWork

initialWork?: Work | Work[]

`Optional`onCurrentStateChange

onCurrentStateChange?: (state: State, userAction: boolean) => void

`Optional`onError

onError?: (error: Error) => void

`Optional`onStateChange

onStateChange?: (state: State, userAction: boolean) => void

`Optional`onWorksChange

onWorksChange?: (works: Works) => void

`Optional`work

work?: Work | Work[]