Sanity Library Reference Docs
    Preparing search index...

    Function useClient

    • React hook that returns a configured Sanity client instance based on the given configuration. Automatically uses the correct project and dataset based on the current active workspace.

      Parameters

      Returns SanityClient$1

      A configured Sanity client instance

      The client instance is automatically memoized based on API version

      function MyComponent() {
        const client = useClient({apiVersion: '2021-06-07'})
        // ... do something with client instance ...
      }

    • Returns SanityClient$1

      A configured Sanity client instance

      Calling useClient() without specifying an API version is deprecated - specify a date to prevent breaking changes, e.g. useClient({apiVersion: "2025-02-07"}).

      React hook that returns a configured Sanity client instance based on the given configuration. Automatically uses the correct project and dataset based on the current active workspace.

      The client instance is automatically memoized based on API version

      function MyComponent() {
        const client = useClient({apiVersion: '2021-06-07'})
        // ... do something with client instance ...
      }

    Settings

    Member Visibility