Sanity Library Reference Docs
    Preparing search index...
    • Returns metadata for a given project.

      Type Parameters

      • IncludeMembers extends boolean = true
      • IncludeFeatures extends boolean = true

      Parameters

      Returns Project<IncludeMembers, IncludeFeatures>

      The metadata for the project. members is included only when includeMembers: true; features is included unless includeFeatures: false.

      function ProjectMetadata({projectId}: {projectId: string}) {
      const project = useProject({projectId})

      return (
      <figure style={{backgroundColor: project.metadata.color || 'lavender'}}>
      <h1>{project.displayName}</h1>
      </figure>
      )
      }
      const projectWithMembersAndFeatures = useProject({projectId})
      const projectWithMembers = useProject({projectId, includeMembers: true})
      const projectWithoutMembers = useProject({projectId, includeMembers: false})
      const projectWithoutFeatures = useProject({projectId, includeFeatures: false})