useDndObserverContext

A Solid hook that retrieves the DndObserver accessor from the closest DndObserverContext.

Usage

/** @jsxImportSource solid-js */
import { Show } from 'solid-js';
import { render } from 'solid-js/web';
import { DndObserverContext, useDndObserver, useDndObserverContext } from 'dragdoll-solid';

function SomeComponent() {
  const observer = useDndObserverContext();

  return (
    <Show when={observer()} fallback={<div>No dnd observer in context</div>}>
      <div>Dnd observer ready!</div>
    </Show>
  );
}

function App() {
  const observer = useDndObserver();

  return (
    <DndObserverContext.Provider value={observer}>
      <SomeComponent />
    </DndObserverContext.Provider>
  );
}

render(() => <App />, document.getElementById('root')!);

Signature

function useDndObserverContext<
  T extends CollisionData = CollisionData,
>(): Accessor<DndObserver<T> | null>;

Return Value

type returnValue = Accessor<DndObserver<T> | null>;

Returns an accessor to the DndObserver instance from context. The accessor resolves to null if no observer is provided in context. Access with observer().

Notes

• Returns whatever the provider stores -- typically the accessor from useDndObserver.
• If you have multiple observers, create nested providers to scope hooks to the desired instance.