Askr documentation
Generated API snapshot

@askrjs/ui/dismissable-layer

Exports from the declarations published in @askrjs/ui. Signatures reflect the published artifact.

Exports

This entrypoint publishes 4 exports. Use the anchored symbol rows for direct links. Type-only exports are labeled separately from runtime values.

DismissableLayertype

DismissableLayer: { (props: DismissableLayerProps): JSX.Element; (props: DismissableLayerAsChildProps): JSX.Element; }

Renders a part of dismissable-layer. Supports polymorphic rendering via asChild.

DismissableLayerAsChildPropstype

DismissableLayerAsChildProps: DismissableLayerOwnProps & {
  asChild: true;
  children: JSXElement;
  ref?: Ref<Element>;
}

Props for the asChild (polymorphic) rendering of Dismissable Layer.

asChild
asChild: true;
children
children: JSXElement;
disabled
disabled?: boolean | undefined;
disableOutsidePointerEvents
disableOutsidePointerEvents?: boolean | undefined;
id
id?: string | undefined;
onDismiss
onDismiss?: (() => void) | undefined;
onEscapeKeyDown
onEscapeKeyDown?: ((event: KeyboardEvent) => void) | undefined;
onInteractOutside
onInteractOutside?: ((event: Event) => void) | undefined;
onPointerDownOutside
onPointerDownOutside?: ((event: PointerEvent) => void) | undefined;
ref
ref?: Ref<Element>;

DismissableLayerOwnPropstype

DismissableLayerOwnProps: {
  children?: unknown;
  id?: string;
  disabled?: boolean;
  disableOutsidePointerEvents?: boolean;
  onEscapeKeyDown?: (event: KeyboardEvent) => void;
  onPointerDownOutside?: (event: PointerEvent) => void;
  onInteractOutside?: (event: Event) => void;
  onDismiss?: () => void;
}

Own props for Dismissable Layer, before merging with native element attributes.

children
children?: unknown;
disabled
disabled?: boolean | undefined;
disableOutsidePointerEvents
disableOutsidePointerEvents?: boolean | undefined;
id
id?: string | undefined;
onDismiss
onDismiss?: (() => void) | undefined;
onEscapeKeyDown
onEscapeKeyDown?: ((event: KeyboardEvent) => void) | undefined;
onInteractOutside
onInteractOutside?: ((event: Event) => void) | undefined;
onPointerDownOutside
onPointerDownOutside?: ((event: PointerEvent) => void) | undefined;

DismissableLayerPropstype

DismissableLayerProps: Omit<JSX.IntrinsicElements['div'], 'children' | 'ref'> & DismissableLayerOwnProps & {
  asChild?: false;
  ref?: Ref<HTMLDivElement>;
}

Props for Dismissable Layer.

asChild
asChild?: false | undefined;
children
children?: unknown;
disabled
disabled?: boolean | undefined;
disableOutsidePointerEvents
disableOutsidePointerEvents?: boolean | undefined;
id
id?: string | undefined;
onDismiss
onDismiss?: (() => void) | undefined;
onEscapeKeyDown
onEscapeKeyDown?: ((event: KeyboardEvent) => void) | undefined;
onInteractOutside
onInteractOutside?: ((event: Event) => void) | undefined;
onPointerDownOutside
onPointerDownOutside?: ((event: PointerEvent) => void) | undefined;
ref
ref?: Ref<HTMLDivElement>;