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

Function useRegisterHandle

  • useRegisterHandle<HandleType>(ID, cb, deps?): void
  • A React hook that registers a handle for manipulation on a foreign component.

    This hook will create a handle using the provided callback function and register it with the given ID. The handle will be unregistered when the component using the hook unmounts.

    Type Parameters

    • HandleType = any

      The type of the handle.

    Parameters

    • ID: Path

      The ID to register the handle with.

    • cb: (() => HandleType)

      The callback function to create the handle.

        • (): HandleType
        • Returns HandleType

    • Optional deps: never[] = []

      The list of dependencies for the effect that updates the handle.

    Returns void

    See

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

Settings

Member Visibility

Theme

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

Generated using TypeDoc