@dxos/react-client
    Preparing search index...

    Variable useLabelConst

    useLabel: (
        entity: Entity.Unknown | Entity.Snapshot | undefined,
        options?: UseLabelOptions,
    ) => string | undefined

    The label of an ECHO entity, re-rendering only when the label string changes. A snapshot is read as is; a live entity subscribes through Entity.labelAtom.

    Type declaration

      • (
            entity: Entity.Unknown | Entity.Snapshot | undefined,
            options?: UseLabelOptions,
        ): string | undefined

      • Parameters

        • entity: Entity.Unknown | Entity.Snapshot | undefined
        • Optionaloptions: UseLabelOptions

        Returns string | undefined

    Settings

    Member Visibility