jazz-react - jazz

`jazz-react`

Context & Hooks

JazzProvider<Acc>(__namedParameters): Element

JazzProviderProps<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

useOnboardingAuth({ defaultUserName }): TODO type typeOperator

{ defaultUserName: string }

useDemoAuth({ seedAccounts? }): TODO type typeOperator

{ seedAccounts: { undefined } }

usePasskeyAuth({ appName, appHostname? }): TODO type typeOperator

{ appName: string, appHostname: string }

usePassphraseAuth({ appName, wordlist, appHostname? }): TODO type typeOperator

{ appName: string, wordlist: string[], appHostname: string }

Invite Links

createInviteLink<C>(value, role, { baseURL?, valueHint? }): string

value: C,
role: "writeOnly" | "admin" | "writer" | "reader",
{ baseURL: string, valueHint: string }

parseInviteLink<C>(inviteURL): { valueID: ID<C>, inviteSecret: InviteSecret, valueHint: string } | undefined

inviteURL: string

Other

`interface Register`

useAccount(): { me: Acc, logOut: () => void }

useAccount<D>(depth): { me: DeeplyLoaded<Acc, D> | undefined, logOut: () => void }

depth: D

useAccountOrGuest(): { me: AnonymousJazzAgent | Acc }

useAccountOrGuest<D>(depth): { me: AnonymousJazzAgent | DeeplyLoaded<Acc, D> | undefined }

depth: D

useCoState<V, D>(Schema, id, depth?): DeeplyLoaded<V, D> | undefined

Schema: CoValueClass<V>,
id: ID<V> | undefined,
depth?: D & DepthsIn<V>

useAcceptInvite<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> | undefined

DemoAuthBasicUI({ appName, state }): Element

{ appName: string, state: DemoAuthState }

PasskeyAuthBasicUI({ state }): Element | null

{ state: PasskeyAuthState }

PassphraseAuthBasicUI(state): Element

state: PassphraseAuthState