• Preparing search index...
  • The search index is not available
@atomic-reactor/reactium-sdk-core
  • @atomic-reactor/reactium-sdk-core
  • useHandle

Function useHandle

  • useHandle<HandleType>(ID): undefined | HandleType
  • A React hook that consumes a handle registered with a given ID.

    This hook will consume a handle registered with the given ID. It will then set up an effect that updates the handle when the handle changes.

    Type Parameters

    • HandleType = any

      The type of the handle.

    Parameters

    • ID: Path

      The ID of the handle to consume.

    Returns undefined | HandleType

    The consumed handle, or undefined if no handle is registered with the given ID.

    See

    • useRegisterHandle for how the handle is registered.
    • Path
    • https://www.npmjs.com/package/object-path|object-path
    • Defined in dev/Reactium/reactium-sdk-core/src/browser/useHandle.ts:20

Settings

Member Visibility

Theme

@atomic-reactor/reactium-sdk-core
  • Loading...

Generated using TypeDoc