useWorkspace

useWorkspace returns the workspace identifier provided to WorkspaceProvider. If you pass a workspace identifier, the hook returns it instead, so a component can accept a workspace prop that wins over the context. useWorkspaceStrict does the same but throws when no workspace is available.

Basic usage

import { useWorkspace } from "@gooddata/sdk-ui";

function MyComponent({ workspace: workspaceProp }: { workspace?: string }) {
    // Uses workspaceProp if defined, otherwise falls back to the context value
    const workspace = useWorkspace(workspaceProp);

    if (!workspace) {
        return <div>No workspace configured</div>;
    }

    // Use the workspace identifier for data fetching
    // ...
}

Require a workspace

Use useWorkspaceStrict in components that can’t work without a workspace. It throws an invariant error when neither the parameter nor the context supplies one, so a misconfigured provider tree fails early:

import { useWorkspaceStrict } from "@gooddata/sdk-ui";

function MyComponent({ workspace: workspaceProp }: { workspace?: string }) {
    // Throws if no workspace is available
    const workspace = useWorkspaceStrict(workspaceProp);

    // workspace is always a string here
    // ...
}

Parameters

Return value

• useWorkspace: string | undefined
• useWorkspaceStrict: string (throws if unavailable)

Notes

• The override wins only when it’s defined. Passing undefined is the same as passing nothing.
• Components re-render when WorkspaceProvider receives a new workspace value, so hooks that key cached data on the workspace pick up the change.
• When no workspace is available, useWorkspaceStrict throws with this message: <context>: workspace must be defined. Either pass it as a parameter or make sure there is a WorkspaceProvider up the component tree.