Type alias YDocProviderProps

YDocProviderProps: {
    authEndpoint: AuthEndpoint;
    children: ReactNode;
    docId: string;
    initialClientToken?: ClientToken;
    offlineSupport?: boolean;
    setQueryParam?: string;
    showDebuggerLink?: boolean;
    warnOnClose?: boolean;
}

Props to the YDocProvider component.

Type declaration

  • authEndpoint: AuthEndpoint

    The endpoint to use for authentication or an async function that returns a client token.

  • children: ReactNode

    The children to render.

  • docId: string

    The doc id to use for the Y.Doc.

  • Optional initialClientToken?: ClientToken

    An optional initial client token to use for the Y.Doc. This will be used initially, and if the client token expires, the authEndpoint will be called to get a new client token.

  • Optional offlineSupport?: boolean

    Whether to enable offline support. Document state will be stored on the client side for offline use and faster startup times.

    Defaults to true.

  • Optional setQueryParam?: string

    If set to a string, the URL query parameter with this name will be set to the doc id provided.

  • Optional showDebuggerLink?: boolean

    Whether to show the debugger link. Defaults to true.

  • Optional warnOnClose?: boolean

    Whether to warn when closing tab with unsynchronized changes.

    Defaults to false.

Settings

Member Visibility

Theme