saltfish
Version:
An interactive video-guided tour system for web applications
27 lines • 1.13 kB
TypeScript
import type { SaltfishStore, Step } from '../types';
/**
* Creates the Saltfish playlist Player store with Zustand and Immer
* Using vanilla store to avoid React hooks
*/
export declare const saltfishStore: Omit<import("zustand/vanilla").StoreApi<SaltfishStore>, "setState"> & {
setState(nextStateOrUpdater: SaltfishStore | Partial<SaltfishStore> | ((state: import("immer").WritableDraft<SaltfishStore>) => void), shouldReplace?: boolean | undefined): void;
};
type StoreAdapter = {
getState: () => SaltfishStore;
setState: typeof saltfishStore.setState;
subscribe: typeof saltfishStore.subscribe;
destroy: typeof saltfishStore.destroy;
};
export declare const useSaltfishStore: StoreAdapter;
/**
* Returns the current step from the store
* This is a React hook and should only be used in React components
*/
export declare const useCurrentStep: () => Step | null;
/**
* Gets the current step directly from the store state
* This is a regular function that can be used in non-React environments
*/
export declare const getCurrentStep: () => Step | null;
export {};
//# sourceMappingURL=store.d.ts.map