jazz-react
Context & Hooks
JazzProvider<Acc>(__namedParameters): ElementJazzProviderProps<Acc>Media
useProgressiveImg({ image, maxWidth? }): { src: undefined | string, res: "placeholder" | TODO type templateLiteral | undefined, originalSize: co<[number, number]> | undefined }{ image: ImageDefinition | null | undefined, maxWidth: number }ProgressiveImg({ children, image, maxWidth? }): ReactNode{ children: (result: { src: undefined | string, res: "placeholder" | TODO type templateLiteral | undefined, originalSize: TODO type typeOperator | undefined }) => ReactNode, image: ImageDefinition | null | undefined, maxWidth: number }Auth Providers
usePasskeyAuth({ appName, appHostname? }): { state: "anonymous" | "signedIn", logIn: () => Promise<void>, signUp: (username: string) => Promise<void> }{ appName: string, appHostname: string }useDemoAuth(): { state: "anonymous" | "signedIn", logIn: (username: string) => Promise<void>, signUp: (username: string) => Promise<void>, existingUsers: string[] }usePassphraseAuth({ wordlist }): { state: "anonymous" | "signedIn", logIn: (passphrase: string) => Promise<void>, signUp: (name: string) => Promise<string>, registerNewAccount: (passphrase: string, name: string) => Promise<ID>, generateRandomPassphrase: () => string, passphrase: string }{ wordlist: string[] }Invite Links
createInviteLink<C>(value, role, { baseURL?, valueHint? }): stringvalue: C,
role: "writeOnly" | "admin" | "writer" | "reader",
{ baseURL: string, valueHint: string }parseInviteLink<C>(inviteURL): { valueID: ID<C>, inviteSecret: InviteSecret, valueHint: string } | undefinedinviteURL: stringOther
type JazzProviderProps
type JazzProviderProps<Acc extends Account> = { children: React.ReactNode } & JazzContextManagerProps<Acc>
⚠️ undocumented
useAccount<A>(): { me: A, logOut: () => void }useAccount<A, D>(depth): { me: null | DeeplyLoaded<A, D> | undefined, logOut: () => void }depth: DuseAccountOrGuest<A>(): { me: AnonymousJazzAgent | A }useAccountOrGuest<A, D>(depth): { me: AnonymousJazzAgent | null | DeeplyLoaded<A, D> | undefined }depth: DuseCoState<V, D>(Schema, id, depth): null | DeeplyLoaded<V, D> | undefinedSchema: CoValueClass<V>,
id: ID<CoValue> | undefined,
depth: TODO type unknownuseAcceptInvite<V>({ invitedObjectSchema, onAccept, forValueHint? }): void{ invitedObjectSchema: CoValueClass<V>, onAccept: (projectID: ID<V>) => void, forValueHint: string }experimental_useInboxSender<I, O>(inboxOwnerID): (message: I) => Promise<TODO type conditional>inboxOwnerID: ID<Account> | undefineduseJazzContext<Acc>(): JazzContextType<Acc>useAuthSecretStorage(): AuthSecretStorageDemoAuthBasicUI(props): Element | Iterable<ReactNode> | null | string | number | booleanprops: { appName: string, children: ReactNode }PasskeyAuthBasicUI(props): Element | Iterable<ReactNode> | null | string | number | booleanprops: { appName: string, appHostname: string, children: ReactNode }PassphraseAuthBasicUI(props): Element | Iterable<ReactNode> | null | string | number | booleanprops: { appName: string, wordlist: string[], children: ReactNode }useIsAuthenticated(): boolean