usePortal | /runtime/react/mod.ts | aleph@1.0.0-beta.29

function usePortal

import { usePortal } from "https://dotland.deno.dev/x/aleph@1.0.0-beta.29/runtime/react/mod.ts";

usePortal(props?: { key?: string | null; className?: string; lockScroll?: boolean; type?: "div" | "dialog"; }): (children: ReactNode) => ReactPortal | null

The usePortal hook to create a portal node. Please ensure to pass the React.createPortal in Router props.

function Modal() {
  const portal = usePortal({ type: "dialog", preventScroll: true });
  return portal(<p>Hello portal!</p>);
}

Parameters

optional

props: { key?: string | null; className?: string; lockScroll?: boolean; type?: "div" | "dialog"; }

Returns

(children: ReactNode) => ReactPortal | null