ActorProvider is a React functional component that serves as a context provider for IC actor interactions within a React application.
It wraps child components, providing them access to actor-specific hooks and functionalities based on the provided canister ID and configuration.
Props:
canisterId (optional): string - The Canister ID for actor interactions. If not provided, the default from createActorContext is used.
idlFactory (optional): IDL.InterfaceFactory - The IDL factory for the actor interface. If not provided, the default from createActorContext is used.
didjsId (optional): string - The DID.js ID for authentication. If not provided, the default from createActorContext is used.
loadingComponent (optional): React Node - A component displayed during the loading/fetching state. Defaults to a simple message.
authenticatingComponent (optional): React Node - A component displayed during the authentication state. Defaults to a simple message.
children: React Node - The child components that will have access to the actor context.
Behavior:
Validates the presence of a canisterId. Throws an error if it is missing, ensuring that a valid canister ID is always used for actor operations.
Utilizes useMemo to combine the default configuration with the props provided to the ActorProvider, optimizing for performance by avoiding unnecessary recalculations.
Employs the useActor hook to initiate actor interactions based on the combined configuration, managing states such as fetching, fetchError, and the actor hooks.
Conditionally renders the loadingComponent or fetchError based on the actor fetching state. Once the actor is ready and no errors are present, it renders the child components, effectively providing them access to the actor context.
Example
This setup ensures that YourComponent and any of its children can interact with the specified IC actor through the context provided by ActorProvider.
ActorProvideris a React functional component that serves as a context provider for IC actor interactions within a React application. It wraps child components, providing them access to actor-specific hooks and functionalities based on the provided canister ID and configuration.Props:
canisterId(optional): string - The Canister ID for actor interactions. If not provided, the default fromcreateActorContextis used.idlFactory(optional): IDL.InterfaceFactory - The IDL factory for the actor interface. If not provided, the default fromcreateActorContextis used.didjsId(optional): string - The DID.js ID for authentication. If not provided, the default fromcreateActorContextis used.loadingComponent(optional): React Node - A component displayed during the loading/fetching state. Defaults to a simple message.authenticatingComponent(optional): React Node - A component displayed during the authentication state. Defaults to a simple message.children: React Node - The child components that will have access to the actor context.Behavior:
canisterId. Throws an error if it is missing, ensuring that a valid canister ID is always used for actor operations.useMemoto combine the default configuration with the props provided to theActorProvider, optimizing for performance by avoiding unnecessary recalculations.useActorhook to initiate actor interactions based on the combined configuration, managing states such asfetching,fetchError, and the actorhooks.loadingComponentorfetchErrorbased on the actor fetching state. Once the actor is ready and no errors are present, it renders the child components, effectively providing them access to the actor context.