@xstate/react
- Version 4.0.1
- Published
- 36.2 kB
- 2 dependencies
- MIT license
Install
npm i @xstate/react
yarn add @xstate/react
pnpm add @xstate/react
Overview
XState tools for React
Index
Functions
function createActorContext
createActorContext: <TLogic extends AnyActorLogic>( actorLogic: TLogic, interpreterOptions?: ActorOptions<TLogic>) => { useSelector: <T>( selector: (snapshot: SnapshotFrom<TLogic>) => T, compare?: (a: T, b: T) => boolean ) => T; useActorRef: () => ActorRefFrom<TLogic>; Provider: ( props: { children: React.ReactNode; options?: ActorOptions<TLogic>; machine?: never; } & (TLogic extends AnyStateMachine ? AreAllImplementationsAssumedToBeProvided< TLogic['__TResolvedTypesMeta'] > extends true ? { logic?: TLogic } : { logic: ToMachinesWithProvidedImplementations<TLogic> } : { logic?: TLogic }) ) => React.ReactElement<any, any>;};
function shallowEqual
shallowEqual: (objA: any, objB: any) => boolean;
function useActor
useActor: <TLogic extends AnyActorLogic>( logic: TLogic, options?: ActorOptions<TLogic>) => [SnapshotFrom<TLogic>, ActorRefFrom<TLogic>['send'], ActorRefFrom<TLogic>];
function useActorRef
useActorRef: <TLogic extends AnyActorLogic>( machine: TLogic, options?: ActorOptions<TLogic>, observerOrListener?: any) => ActorRefFrom<TLogic>;
function useMachine
useMachine: <TMachine extends AnyStateMachine>( machine: AreAllImplementationsAssumedToBeProvided< TMachine['__TResolvedTypesMeta'] > extends true ? TMachine : MissingImplementationsError<TMachine['__TResolvedTypesMeta']>, options?: ActorOptions<TMachine>) => [StateFrom<TMachine>, ActorRefFrom<TMachine>['send'], ActorRefFrom<TMachine>];
useActor
function useSelector
useSelector: <TActor extends ActorRef<any, any>, T>( actor: TActor, selector: (emitted: SnapshotFrom<TActor>) => T, compare?: (a: T, b: T) => boolean) => T;
Package Files (7)
Dependencies (2)
Dev Dependencies (10)
Peer Dependencies (2)
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@xstate/react
.
- Markdown[](https://www.jsdocs.io/package/@xstate/react)
- HTML<a href="https://www.jsdocs.io/package/@xstate/react"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 2441 ms. - Missing or incorrect documentation? Open an issue for this package.