chore: add comment to usePerspective

sanity-io · Feb 12, 2025 · d852d90 · d852d90
1 parent c725f09
commit d852d90
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/packages/sanity/src/core/perspective/usePerspective.ts b/packages/sanity/src/core/perspective/usePerspective.ts
@@ -5,6 +5,17 @@ import {type PerspectiveContextValue} from './types'
 
 /**
  * @beta
+ *
+ * React hook that returns the current studio perspective and perspective stack.
+ *
+ * @returns See {@link PerspectiveContextValue}
+ * @example Reading the current perspective stack
+ * ```ts
+ * function MyComponent() {
+ *  const {perspectiveStack} = usePerspective()
+ *  // ... do something with the perspective stack ...
+ * }
+ * ```
  */
 export function usePerspective(): PerspectiveContextValue {
   const context = useContext(PerspectiveContext)