Function useAwareness

useAwareness<T, I extends JsonValue>(
    object: undefined | Unknown,
    kind: string,
    schema: Codec<T, I>,
    timing?: Timing,
): UseAwarenessResult<T>
Shares a value about object with the other clients in its space, tagged with this member's name and hue. Inert without a space or an identity.
Type Parameters
- T
- I extends JsonValue
Parameters
- object: undefined | Unknown
- kind: string
  Separates the kinds of awareness about one object (e.g. pointer, selection).
- schema: Codec<T, I>
  Must be stable across renders.
- Optionaltiming: Timing
  Must be stable across renders.
Returns UseAwarenessResult<T>
- Defined in packages/sdk/app-toolkit/src/ui/hooks/useAwareness.ts:48