DocsAPI referenceHeadlessdialog

dialog headless API

The core connector and vanilla mount are always visible. Use the framework choice to inspect native composition, props, outputs, context and hooks for the selected adapter.

@grassroot/ui-headless-core/dialog

Core connector and vanilla API

23 exports
View source packages/ui-headless/core/src/dialog/index.ts

Manager lifecycle helper (spec's "Managers" section) — pushes a modal layer (which holds its own ref-counted `lockScroll` handle for its lifetime per the amendment) whose `onDismiss` forwards straight to `service.send({ type: "CLOSE", reason })` (dismissal never forks state — the machine's own `dismissable` guard decides whether it becomes a transition), with `getElements` covering the mounted Content *and* Trigger (so a trigger click while open is never treated as an outside click), and installs `trapFocus` on the mounted Content. Callers (adapters/`mountDialog`) invoke this once the overlay commits open, and call the returned `release()` on close-commit or unmount. Requires Content (and ideally Trigger) to already be registered in `scope` — this is a mount-time-only manager wire-up, never called at SSR or before the overlay's DOM exists (mirrors the shared layer's "pushing while unmounted is a development error" stance for its `document` argument).

DeclarationView source
activateDialogManagersts
declare function activateDialogManagers(service: DialogService, scope: PartScope, doc: Document): () => void;
Name
Kind
Type
Requirement
service
parameter
DialogService
required
scope
parameter
PartScope
required
doc
parameter
Document
required
return
return value
() => void
n/a
Name
service
Kind
parameter
Type
DialogService
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
doc
Kind
parameter
Type
Document
Requirement
required
Name
return
Kind
return value
Type
() => void
Requirement
n/a

connectDialog

function
DeclarationView source
connectDialogts
declare function connectDialog(service: DialogService, scope: PartScope, _options?: DialogConnectOptions): DialogApi;
Name
Kind
Type
Requirement
service
parameter
DialogService
required
scope
parameter
PartScope
required
_options
parameter
DialogConnectOptions
optional
return
return value
DialogApi
n/a
Name
service
Kind
parameter
Type
DialogService
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
_options
Kind
parameter
Type
DialogConnectOptions
Requirement
optional
Name
return
Kind
return value
Type
DialogApi
Requirement
n/a
DeclarationView source
dialogAnatomyts
export declare const dialogAnatomy: {
readonly scope: "dialog";
readonly parts: readonly ["trigger", "backdrop", "positioner", "content", "title", "description", "close-trigger"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["trigger", "backdrop", "positioner", "content", "title", "description", "close-trigger"]
required
scope
property
"dialog"
required
Name
parts
Kind
property
Type
readonly ["trigger", "backdrop", "positioner", "content", "title", "description", "close-trigger"]
Requirement
required
Name
scope
Kind
property
Type
"dialog"
Requirement
required

DialogApi

interface
DeclarationView source
DialogApits
interface DialogApi {
triggerProps(): PartProps;
backdropProps(): PartProps;
positionerProps(): PartProps;
contentProps(): PartProps;
titleProps(): PartProps;
descriptionProps(): PartProps;
closeTriggerProps(): PartProps;
readonly open: boolean;
}
Name
Kind
Type
Requirement
backdropProps
method
() => PartProps
required
closeTriggerProps
method
() => PartProps
required
contentProps
method
() => PartProps
required
descriptionProps
method
() => PartProps
required
open
property
boolean
required
positionerProps
method
() => PartProps
required
titleProps
method
() => PartProps
required
triggerProps
method
() => PartProps
required
Name
backdropProps
Kind
method
Type
() => PartProps
Requirement
required
Name
closeTriggerProps
Kind
method
Type
() => PartProps
Requirement
required
Name
contentProps
Kind
method
Type
() => PartProps
Requirement
required
Name
descriptionProps
Kind
method
Type
() => PartProps
Requirement
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
positionerProps
Kind
method
Type
() => PartProps
Requirement
required
Name
titleProps
Kind
method
Type
() => PartProps
Requirement
required
Name
triggerProps
Kind
method
Type
() => PartProps
Requirement
required
DeclarationView source
DialogChangeReasonts
type DialogChangeReason = DialogOpenReason | DialogCloseReason;
DeclarationView source
DialogCloseReasonts
type DialogCloseReason = "escape" | "outside-click" | "close-trigger" | "programmatic";
DeclarationView source
DialogCommandts
type DialogCommand = CommandObject & {
readonly type: "OPEN_CHANGE_REQUEST";
readonly open: boolean;
readonly reason: DialogChangeReason;
};
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
DialogChangeReason
required
type
property
string
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
DialogChangeReason
Requirement
required
Name
type
Kind
property
Type
string
Requirement
required
DeclarationView source
DialogConnectOptionsts
interface DialogConnectOptions {}
DeclarationView source
DialogContextts
type DialogContext = {
readonly mode: "controlled" | "uncontrolled";
};
Name
Kind
Type
Requirement
mode
property
"controlled" | "uncontrolled"
required
Name
mode
Kind
property
Type
"controlled" | "uncontrolled"
Requirement
required
DeclarationView source
DialogEventts
type DialogEvent = {
readonly type: "OPEN";
readonly reason: DialogOpenReason;
} | {
readonly type: "CLOSE";
readonly reason: DialogCloseReason;
};
DeclarationView source
DialogInputts
type DialogInput = {
readonly open?: boolean;
readonly defaultOpen?: boolean;
readonly dismissable?: boolean;
};
Name
Kind
Type
Requirement
defaultOpen
property
boolean
optional
dismissable
property
boolean
optional
open
property
boolean
optional
Name
defaultOpen
Kind
property
Type
boolean
Requirement
optional
Name
dismissable
Kind
property
Type
boolean
Requirement
optional
Name
open
Kind
property
Type
boolean
Requirement
optional
DeclarationView source
dialogMachinets
export declare const dialogMachine: DialogMachine;

DialogMount

interface
DeclarationView source
DialogMountts
interface DialogMount {
readonly service: DialogService;
readonly connector: DialogApi;
readonly root: HTMLElement;
readonly trigger: HTMLElement;
destroy(): void;
}
Name
Kind
Type
Requirement
connector
property
DialogApi
required
destroy
method
() => void
required
root
property
HTMLElement
required
service
property
DialogService
required
trigger
property
HTMLElement
required
Name
connector
Kind
property
Type
DialogApi
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
root
Kind
property
Type
HTMLElement
Requirement
required
Name
service
Kind
property
Type
DialogService
Requirement
required
Name
trigger
Kind
property
Type
HTMLElement
Requirement
required
DeclarationView source
DialogOpenChangeDetailts
interface DialogOpenChangeDetail {
readonly open: boolean;
readonly reason: DialogChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
DialogChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
DialogChangeReason
Requirement
required
DeclarationView source
DialogOpenReasonts
type DialogOpenReason = "trigger" | "programmatic";

DialogPart

type
DeclarationView source
DialogPartts
type DialogPart = (typeof dialogAnatomy.parts)[number];
DeclarationView source
dialogSelectorsts
export declare const dialogSelectors: {
open: (snapshot: DialogSnapshot) => boolean;
};
Name
Kind
Type
Requirement
open
property
(snapshot: DialogSnapshot) => boolean
required
Name
open
Kind
property
Type
(snapshot: DialogSnapshot) => boolean
Requirement
required
DeclarationView source
DialogServicets
type DialogService = Service<DialogInput, DialogStateValue, DialogContext, DialogEvent, DialogCommand>;
DeclarationView source
DialogSnapshotts
type DialogSnapshot = Snapshot<DialogStateValue, DialogContext>;
DeclarationView source
DialogStateValuets
type DialogStateValue = "open" | "closed";

mountDialog

function
DeclarationView source
mountDialogts
declare function mountDialog(container: HTMLElement, options?: MountDialogOptions): DialogMount;
Name
Kind
Type
Requirement
container
parameter
HTMLElement
required
options
parameter
MountDialogOptions
optional
return
return value
DialogMount
n/a
Name
container
Kind
parameter
Type
HTMLElement
Requirement
required
Name
options
Kind
parameter
Type
MountDialogOptions
Requirement
optional
Name
return
Kind
return value
Type
DialogMount
Requirement
n/a

MountDialogOptions

interface
DeclarationView source
MountDialogOptionsts
interface MountDialogOptions extends DialogInput {
readonly onOpenChange?: (detail: DialogOpenChangeDetail) => void;
/** Render callback for the trigger's content; default = "Open" as textContent. */
readonly renderTrigger?: (button: HTMLElement) => void;
/** Render callback for the content panel's own content (title/description/close-trigger are appended after it runs). */
readonly renderContent?: (panel: HTMLElement) => void;
/** Render callback for the title's content; default = "Dialog" as textContent. */
readonly renderTitle?: (heading: HTMLElement) => void;
/** Render callback for the description's content; default = untouched (empty). */
readonly renderDescription?: (paragraph: HTMLElement) => void;
/** Render callback for the close-trigger's content; default = "Close" as textContent. */
readonly renderCloseTrigger?: (button: HTMLElement) => void;
}
Name
Kind
Type
Requirement
Description
onOpenChange
property
(detail: DialogOpenChangeDetail) => void
optional
renderCloseTrigger
property
(button: HTMLElement) => void
optional
Render callback for the close-trigger's content; default = "Close" as textContent.
renderContent
property
(panel: HTMLElement) => void
optional
Render callback for the content panel's own content (title/description/close-trigger are appended after it runs).
renderDescription
property
(paragraph: HTMLElement) => void
optional
Render callback for the description's content; default = untouched (empty).
renderTitle
property
(heading: HTMLElement) => void
optional
Render callback for the title's content; default = "Dialog" as textContent.
renderTrigger
property
(button: HTMLElement) => void
optional
Render callback for the trigger's content; default = "Open" as textContent.
Name
onOpenChange
Kind
property
Type
(detail: DialogOpenChangeDetail) => void
Requirement
optional
Description
Name
renderCloseTrigger
Kind
property
Type
(button: HTMLElement) => void
Requirement
optional
Description
Render callback for the close-trigger's content; default = "Close" as textContent.
Name
renderContent
Kind
property
Type
(panel: HTMLElement) => void
Requirement
optional
Description
Render callback for the content panel's own content (title/description/close-trigger are appended after it runs).
Name
renderDescription
Kind
property
Type
(paragraph: HTMLElement) => void
Requirement
optional
Description
Render callback for the description's content; default = untouched (empty).
Name
renderTitle
Kind
property
Type
(heading: HTMLElement) => void
Requirement
optional
Description
Render callback for the title's content; default = "Dialog" as textContent.
Name
renderTrigger
Kind
property
Type
(button: HTMLElement) => void
Requirement
optional
Description
Render callback for the trigger's content; default = "Open" as textContent.

runDialogCommand

function

Dialog-shaped command runner — mirrors `runTooltipCommand`. Pass this as the `runCommand` option when constructing the Dialog `Service` (never called by `connectDialog` itself). Resolves `OPEN_CHANGE_REQUEST` against an optional `onOpenChange` callback.

DeclarationView source
runDialogCommandts
declare function runDialogCommand(command: DialogCommand, _scope: PartScope, options?: {
readonly onOpenChange?: (detail: {
open: boolean;
reason: DialogChangeReason;
}) => void;
}): void;
Name
Kind
Type
Requirement
command
parameter
DialogCommand
required
_scope
parameter
PartScope
required
options
parameter
{ readonly onOpenChange?: (detail: { open: boolean; reason: DialogChangeReason; }) => void; }
optional
return
return value
void
n/a
Name
command
Kind
parameter
Type
DialogCommand
Requirement
required
Name
_scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
{ readonly onOpenChange?: (detail: { open: boolean; reason: DialogChangeReason; }) => void; }
Requirement
optional
Name
return
Kind
return value
Type
void
Requirement
n/a

Framework adapters

Each panel keeps its adapter's public vocabulary. React compound exports, Vue composables, standalone Angular declarations, Svelte components, and Solid hooks stay native to their framework.

React example follows below.

React imports

@grassroot/ui-headless-react/dialogts
import { Backdrop, CloseTrigger, Content, Description, Dialog, Positioner, Root, Title } from "@grassroot/ui-headless-react/dialog"; // +1 more exports

Vue imports

@grassroot/ui-headless-vue/dialogts
<script setup lang="ts">
import { DialogBackdrop, DialogCloseTrigger, DialogContent, DialogDescription, DialogPositioner, DialogRoot, DialogTitle, DialogTrigger } from "@grassroot/ui-headless-vue/dialog";
</script>

Angular imports

@grassroot/ui-headless-angular/dialogts
import { Component } from "@angular/core";
import { GR_DIALOG_DECLARATIONS } from "@grassroot/ui-headless-angular/dialog";
@Component({ standalone: true, imports: [GR_DIALOG_DECLARATIONS], template: `<!-- compose the dialog parts here -->` })
export class Example {}

Svelte imports

@grassroot/ui-headless-svelte/dialogts
<script lang="ts">
import { DialogBackdrop, DialogCloseTrigger, DialogContent, DialogDescription, DialogPositioner, DialogRoot, DialogTitle, DialogTrigger } from "@grassroot/ui-headless-svelte/dialog";
</script>

Solid imports

@grassroot/ui-headless-solid/dialogts
import { DialogBackdrop, DialogCloseTrigger, DialogContent, DialogDescription, DialogPositioner, DialogRoot, DialogTitle, DialogTrigger } from "@grassroot/ui-headless-solid/dialog";

@grassroot/ui-headless-react/dialog

React adapter

25 exports
View source packages/ui-headless/react/src/dialog/index.ts

Backdrop

value
DeclarationView source
Backdropts
export declare const Backdrop: import("react").ForwardRefExoticComponent<DialogBackdropProps & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

CloseTrigger

value
DeclarationView source
CloseTriggerts
export declare const CloseTrigger: import("react").ForwardRefExoticComponent<DialogCloseTriggerProps & import("react").RefAttributes<HTMLButtonElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Content

value
DeclarationView source
Contentts
export declare const Content: import("react").ForwardRefExoticComponent<DialogContentProps & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Description

value
DeclarationView source
Descriptionts
export declare const Description: import("react").ForwardRefExoticComponent<DialogDescriptionProps & import("react").RefAttributes<HTMLParagraphElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Dialog

value
DeclarationView source
Dialogts
export declare const Dialog: {
Root: typeof Root;
Trigger: import("react").ForwardRefExoticComponent<DialogTriggerProps & import("react").RefAttributes<HTMLButtonElement>>;
Backdrop: import("react").ForwardRefExoticComponent<DialogBackdropProps & import("react").RefAttributes<HTMLDivElement>>;
Positioner: import("react").ForwardRefExoticComponent<DialogPositionerProps & import("react").RefAttributes<HTMLDivElement>>;
Content: import("react").ForwardRefExoticComponent<DialogContentProps & import("react").RefAttributes<HTMLDivElement>>;
Title: import("react").ForwardRefExoticComponent<DialogTitleProps & import("react").RefAttributes<HTMLHeadingElement>>;
Description: import("react").ForwardRefExoticComponent<DialogDescriptionProps & import("react").RefAttributes<HTMLParagraphElement>>;
CloseTrigger: import("react").ForwardRefExoticComponent<DialogCloseTriggerProps & import("react").RefAttributes<HTMLButtonElement>>;
};
Name
Kind
Type
Requirement
Backdrop
property
import("react").ForwardRefExoticComponent<DialogBackdropProps & import("react").RefAttributes<HTMLDivElement>>
required
CloseTrigger
property
import("react").ForwardRefExoticComponent<DialogCloseTriggerProps & import("react").RefAttributes<HTMLButtonElement>>
required
Content
property
import("react").ForwardRefExoticComponent<DialogContentProps & import("react").RefAttributes<HTMLDivElement>>
required
Description
property
import("react").ForwardRefExoticComponent<DialogDescriptionProps & import("react").RefAttributes<HTMLParagraphElement>>
required
Positioner
property
import("react").ForwardRefExoticComponent<DialogPositionerProps & import("react").RefAttributes<HTMLDivElement>>
required
Root
property
typeof Root
required
Title
property
import("react").ForwardRefExoticComponent<DialogTitleProps & import("react").RefAttributes<HTMLHeadingElement>>
required
Trigger
property
import("react").ForwardRefExoticComponent<DialogTriggerProps & import("react").RefAttributes<HTMLButtonElement>>
required
Name
Backdrop
Kind
property
Type
import("react").ForwardRefExoticComponent<DialogBackdropProps & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
CloseTrigger
Kind
property
Type
import("react").ForwardRefExoticComponent<DialogCloseTriggerProps & import("react").RefAttributes<HTMLButtonElement>>
Requirement
required
Name
Content
Kind
property
Type
import("react").ForwardRefExoticComponent<DialogContentProps & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
Description
Kind
property
Type
import("react").ForwardRefExoticComponent<DialogDescriptionProps & import("react").RefAttributes<HTMLParagraphElement>>
Requirement
required
Name
Positioner
Kind
property
Type
import("react").ForwardRefExoticComponent<DialogPositionerProps & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
Root
Kind
property
Type
typeof Root
Requirement
required
Name
Title
Kind
property
Type
import("react").ForwardRefExoticComponent<DialogTitleProps & import("react").RefAttributes<HTMLHeadingElement>>
Requirement
required
Name
Trigger
Kind
property
Type
import("react").ForwardRefExoticComponent<DialogTriggerProps & import("react").RefAttributes<HTMLButtonElement>>
Requirement
required
DeclarationView source
DialogBackdropPropsts
interface DialogBackdropProps extends ComponentPropsWithoutRef<"div"> {
readonly asChild?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional
DeclarationView source
DialogCloseTriggerPropsts
interface DialogCloseTriggerProps extends Omit<ComponentPropsWithoutRef<"button">, "type"> {
readonly asChild?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional

DialogContentProps

interface
DeclarationView source
DialogContentPropsts
interface DialogContentProps extends ComponentPropsWithoutRef<"div"> {
readonly asChild?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional
DeclarationView source
DialogContextts
export declare const DialogContext: import("react").Context<DialogContextValue | null>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

DialogContextValue

interface
DeclarationView source
DialogContextValuets
interface DialogContextValue {
readonly service: DialogService;
readonly connector: DialogApi;
readonly scope: PartScope;
}
Name
Kind
Type
Requirement
connector
property
DialogApi
required
scope
property
PartScope
required
service
property
DialogService
required
Name
connector
Kind
property
Type
DialogApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
DialogService
Requirement
required
DeclarationView source
DialogDescriptionPropsts
interface DialogDescriptionProps extends ComponentPropsWithoutRef<"p"> {
readonly asChild?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional
DeclarationView source
DialogOpenChangeDetailts
interface DialogOpenChangeDetail {
readonly open: boolean;
readonly reason: DialogChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
DialogChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
DialogChangeReason
Requirement
required
DeclarationView source
DialogPositionerPropsts
interface DialogPositionerProps extends ComponentPropsWithoutRef<"div"> {
readonly asChild?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional

DialogRootProps

interface
DeclarationView source
DialogRootPropsts
interface DialogRootProps {
readonly open?: DialogInput["open"];
readonly defaultOpen?: DialogInput["defaultOpen"];
readonly dismissable?: DialogInput["dismissable"];
readonly onOpenChange?: (detail: DialogOpenChangeDetail) => void;
readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
children
property
ReactNode
optional
defaultOpen
property
DialogInput["defaultOpen"]
optional
dismissable
property
DialogInput["dismissable"]
optional
onOpenChange
property
(detail: DialogOpenChangeDetail) => void
optional
open
property
DialogInput["open"]
optional
Name
children
Kind
property
Type
ReactNode
Requirement
optional
Name
defaultOpen
Kind
property
Type
DialogInput["defaultOpen"]
Requirement
optional
Name
dismissable
Kind
property
Type
DialogInput["dismissable"]
Requirement
optional
Name
onOpenChange
Kind
property
Type
(detail: DialogOpenChangeDetail) => void
Requirement
optional
Name
open
Kind
property
Type
DialogInput["open"]
Requirement
optional

DialogTitleProps

interface
DeclarationView source
DialogTitlePropsts
interface DialogTitleProps extends ComponentPropsWithoutRef<"h2"> {
readonly asChild?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional

DialogTriggerProps

interface
DeclarationView source
DialogTriggerPropsts
interface DialogTriggerProps extends Omit<ComponentPropsWithoutRef<"button">, "type"> {
readonly asChild?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional

Positioner

value
DeclarationView source
Positionerts
export declare const Positioner: import("react").ForwardRefExoticComponent<DialogPositionerProps & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Root

function
DeclarationView source
Rootts
declare function Root(props: DialogRootProps): import("react").JSX.Element;
Name
Kind
Type
Requirement
props
parameter
DialogRootProps
required
return
return value
import("react").JSX.Element
n/a
Name
props
Kind
parameter
Type
DialogRootProps
Requirement
required
Name
return
Kind
return value
Type
import("react").JSX.Element
Requirement
n/a

Title

value
DeclarationView source
Titlets
export declare const Title: import("react").ForwardRefExoticComponent<DialogTitleProps & import("react").RefAttributes<HTMLHeadingElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Trigger

value
DeclarationView source
Triggerts
export declare const Trigger: import("react").ForwardRefExoticComponent<DialogTriggerProps & import("react").RefAttributes<HTMLButtonElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

useDialog

function
DeclarationView source
useDialogts
declare function useDialog(input: DialogInput, options?: UseDialogOptions): UseDialogResult;
Name
Kind
Type
Requirement
input
parameter
DialogInput
required
options
parameter
UseDialogOptions
optional
return
return value
UseDialogResult
n/a
Name
input
Kind
parameter
Type
DialogInput
Requirement
required
Name
options
Kind
parameter
Type
UseDialogOptions
Requirement
optional
Name
return
Kind
return value
Type
UseDialogResult
Requirement
n/a

useDialogContext

function
DeclarationView source
useDialogContextts
declare function useDialogContext(partName: string): DialogContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
DialogContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
DialogContextValue
Requirement
n/a

UseDialogOptions

interface
DeclarationView source
UseDialogOptionsts
interface UseDialogOptions {
readonly onOpenChange?: (detail: DialogOpenChangeDetail) => void;
}
Name
Kind
Type
Requirement
onOpenChange
property
(detail: DialogOpenChangeDetail) => void
optional
Name
onOpenChange
Kind
property
Type
(detail: DialogOpenChangeDetail) => void
Requirement
optional

UseDialogResult

interface
DeclarationView source
UseDialogResultts
interface UseDialogResult {
readonly service: DialogService;
readonly connector: DialogApi;
readonly scope: PartScope;
readonly snapshot: DialogSnapshot;
}
Name
Kind
Type
Requirement
connector
property
DialogApi
required
scope
property
PartScope
required
service
property
DialogService
required
snapshot
property
DialogSnapshot
required
Name
connector
Kind
property
Type
DialogApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
DialogService
Requirement
required
Name
snapshot
Kind
property
Type
DialogSnapshot
Requirement
required

Subscribes a component to a service's committed-snapshot version.

DeclarationView source
useServiceVersionts
declare function useServiceVersion<S extends Service<any, any, any, any, any, any>>(service: S): ReturnType<S["getSnapshot"]>;
Name
Kind
Type
Requirement
service
parameter
S
required
return
return value
ReturnType<S["getSnapshot"]>
n/a
Name
service
Kind
parameter
Type
S
Requirement
required
Name
return
Kind
return value
Type
ReturnType<S["getSnapshot"]>
Requirement
n/a

@grassroot/ui-headless-vue/dialog

Vue adapter

15 exports
View source packages/ui-headless/vue/src/dialog/index.ts
DeclarationView source
DialogBackdropts
export declare const DialogBackdrop: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>, () => VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}> | null, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{}>, {
asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
DeclarationView source
DialogCloseTriggerts
export declare const DialogCloseTrigger: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>, () => VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}> | null, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{}>, {
asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
DeclarationView source
DialogContentts
export declare const DialogContent: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>, () => VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}> | null, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{}>, {
asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
DeclarationView source
DialogContextKeyts
export declare const DialogContextKey: InjectionKey<DialogContextValue>;

DialogContextValue

interface
DeclarationView source
DialogContextValuets
interface DialogContextValue {
readonly service: DialogService;
readonly connector: DialogApi;
readonly scope: PartScope;
/** Bumped on every committed machine update; parts read `.value` to establish a reactive dependency. */
readonly snapshot: ShallowRef<DialogSnapshot>;
}
Name
Kind
Type
Requirement
Description
connector
property
DialogApi
required
scope
property
PartScope
required
service
property
DialogService
required
snapshot
property
ShallowRef<DialogSnapshot>
required
Bumped on every committed machine update; parts read `.value` to establish a reactive dependency.
Name
connector
Kind
property
Type
DialogApi
Requirement
required
Description
Name
scope
Kind
property
Type
PartScope
Requirement
required
Description
Name
service
Kind
property
Type
DialogService
Requirement
required
Description
Name
snapshot
Kind
property
Type
ShallowRef<DialogSnapshot>
Requirement
required
Description
Bumped on every committed machine update; parts read `.value` to establish a reactive dependency.
DeclarationView source
DialogDescriptionts
export declare const DialogDescription: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>, () => VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}> | null, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{}>, {
asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
DeclarationView source
DialogOpenChangeDetailts
interface DialogOpenChangeDetail {
readonly open: boolean;
readonly reason: DialogChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
DialogChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
DialogChangeReason
Requirement
required
DeclarationView source
DialogPositionerts
export declare const DialogPositioner: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>, () => VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}> | null, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{}>, {
asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

DialogRoot

value
DeclarationView source
DialogRootts
export declare const DialogRoot: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
open: {
type: PropType<DialogInput["open"]>;
default: undefined;
};
defaultOpen: {
type: PropType<DialogInput["defaultOpen"]>;
default: undefined;
};
dismissable: {
type: PropType<DialogInput["dismissable"]>;
default: undefined;
};
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}>[] | undefined, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
openChange: (_detail: DialogOpenChangeDetail) => true;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
open: {
type: PropType<DialogInput["open"]>;
default: undefined;
};
defaultOpen: {
type: PropType<DialogInput["defaultOpen"]>;
default: undefined;
};
dismissable: {
type: PropType<DialogInput["dismissable"]>;
default: undefined;
};
}>> & Readonly<{
onOpenChange?: ((_detail: DialogOpenChangeDetail) => any) | undefined;
}>, {
open: boolean | undefined;
defaultOpen: boolean | undefined;
dismissable: boolean | undefined;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

DialogTitle

value
DeclarationView source
DialogTitlets
export declare const DialogTitle: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>, () => VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}> | null, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{}>, {
asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
DeclarationView source
DialogTriggerts
export declare const DialogTrigger: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>, () => VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{}>, {
asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

useDialog

function
DeclarationView source
useDialogts
declare function useDialog(input: DialogInput | (() => DialogInput), options?: UseDialogOptions): InternalUseDialogResult;
Name
Kind
Type
Requirement
input
parameter
DialogInput | (() => DialogInput)
required
options
parameter
UseDialogOptions
optional
return
return value
InternalUseDialogResult
n/a
Name
input
Kind
parameter
Type
DialogInput | (() => DialogInput)
Requirement
required
Name
options
Kind
parameter
Type
UseDialogOptions
Requirement
optional
Name
return
Kind
return value
Type
InternalUseDialogResult
Requirement
n/a

useDialogContext

function
DeclarationView source
useDialogContextts
declare function useDialogContext(partName: string): DialogContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
DialogContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
DialogContextValue
Requirement
n/a

UseDialogOptions

interface
DeclarationView source
UseDialogOptionsts
interface UseDialogOptions {
readonly onOpenChange?: (detail: DialogOpenChangeDetail) => void;
}
Name
Kind
Type
Requirement
onOpenChange
property
(detail: DialogOpenChangeDetail) => void
optional
Name
onOpenChange
Kind
property
Type
(detail: DialogOpenChangeDetail) => void
Requirement
optional

UseDialogResult

interface
DeclarationView source
UseDialogResultts
interface UseDialogResult {
readonly service: DialogService;
readonly connector: DialogApi;
readonly scope: PartScope;
readonly snapshot: ShallowRef<DialogSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
DialogApi
required
scope
property
PartScope
required
service
property
DialogService
required
snapshot
property
ShallowRef<DialogSnapshot>
required
Name
connector
Kind
property
Type
DialogApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
DialogService
Requirement
required
Name
snapshot
Kind
property
Type
ShallowRef<DialogSnapshot>
Requirement
required

@grassroot/ui-headless-angular/dialog

Angular adapter

17 exports
View source packages/ui-headless/angular/src/dialog/index.ts
DeclarationView source
createDialogStorets
export declare function createDialogStore(initialInput: DialogInput, options?: CreateDialogStoreOptions): DialogStore;
Name
Kind
Type
Requirement
initialInput
parameter
DialogInput
required
options
parameter
CreateDialogStoreOptions
optional
return
return value
DialogStore
n/a
Name
initialInput
Kind
parameter
Type
DialogInput
Requirement
required
Name
options
Kind
parameter
Type
CreateDialogStoreOptions
Requirement
optional
Name
return
Kind
return value
Type
DialogStore
Requirement
n/a
DeclarationView source
CreateDialogStoreOptionsts
export interface CreateDialogStoreOptions {
readonly onOpenChange?: (detail: DialogOpenChangeDetail) => void;
readonly onCommit?: () => void;
}
Name
Kind
Type
Requirement
onCommit
property
() => void
optional
onOpenChange
property
(detail: DialogOpenChangeDetail) => void
optional
Name
onCommit
Kind
property
Type
() => void
Requirement
optional
Name
onOpenChange
Kind
property
Type
(detail: DialogOpenChangeDetail) => void
Requirement
optional
DeclarationView source
DIALOG_PROJECTION_STOREts
export declare const DIALOG_PROJECTION_STORE: InjectionToken<DialogProjectionStore>;

DIALOG_STORE

value
DeclarationView source
DIALOG_STOREts
export declare const DIALOG_STORE: InjectionToken<DialogStore>;
DeclarationView source
DialogOpenChangeDetailts
export interface DialogOpenChangeDetail {
readonly open: boolean;
readonly reason: DialogChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
DialogChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
DialogChangeReason
Requirement
required

Narrow projection seam shared by styled Dialog and AlertDialog. Keeping this token in the already-shared Angular adapter module lets the styled Dialog markers register accessible-name parts without importing the AlertDialog implementation (and therefore its whole source closure).

DeclarationView source
DialogProjectionStorets
export interface DialogProjectionStore {
readonly scope: Pick<PartScope, "id" | "register">;
readonly version: () => number;
readonly connector: {
titleProps(): PartProps;
descriptionProps(): PartProps;
};
}
Name
Kind
Type
Requirement
connector
property
{ titleProps(): PartProps; descriptionProps(): PartProps; }
required
scope
property
Pick<PartScope, "id" | "register">
required
version
property
() => number
required
Name
connector
Kind
property
Type
{ titleProps(): PartProps; descriptionProps(): PartProps; }
Requirement
required
Name
scope
Kind
property
Type
Pick<PartScope, "id" | "register">
Requirement
required
Name
version
Kind
property
Type
() => number
Requirement
required

DialogStore

interface
DeclarationView source
DialogStorets
export interface DialogStore {
readonly service: DialogService;
readonly connector: DialogApi;
readonly scope: PartScope;
/**
* Bumped on every committed machine update. Effects that read the
* connector's prop bags must read this signal first — inside the same
* `effect()` — so Angular's reactivity re-runs the effect on every
* committed change (the staleness bug class called out across every
* other adapter).
*/
readonly version: WritableSignal<number>;
/** Starts the underlying service (idempotent) — call from the browser only. */
start(): void;
/** Stops the underlying service (idempotent). */
stop(): void;
/** Forwards a new committed input to the machine (no-op on the very first call). */
sync(input: DialogInput): void;
}
Name
Kind
Type
Requirement
Description
connector
property
DialogApi
required
scope
property
PartScope
required
service
property
DialogService
required
start
method
() => void
required
Starts the underlying service (idempotent) — call from the browser only.
stop
method
() => void
required
Stops the underlying service (idempotent).
sync
method
(input: DialogInput) => void
required
Forwards a new committed input to the machine (no-op on the very first call).
version
property
WritableSignal<number>
required
Bumped on every committed machine update. Effects that read the connector's prop bags must read this signal first — inside the same `effect()` — so Angular's reactivity re-runs the effect on every committed change (the staleness bug class called out across every other adapter).
Name
connector
Kind
property
Type
DialogApi
Requirement
required
Description
Name
scope
Kind
property
Type
PartScope
Requirement
required
Description
Name
service
Kind
property
Type
DialogService
Requirement
required
Description
Name
start
Kind
method
Type
() => void
Requirement
required
Description
Starts the underlying service (idempotent) — call from the browser only.
Name
stop
Kind
method
Type
() => void
Requirement
required
Description
Stops the underlying service (idempotent).
Name
sync
Kind
method
Type
(input: DialogInput) => void
Requirement
required
Description
Forwards a new committed input to the machine (no-op on the very first call).
Name
version
Kind
property
Type
WritableSignal<number>
Requirement
required
Description
Bumped on every committed machine update. Effects that read the connector's prop bags must read this signal first — inside the same `effect()` — so Angular's reactivity re-runs the effect on every committed change (the staleness bug class called out across every other adapter).
DeclarationView source
GR_DIALOG_DECLARATIONSts
export declare const GR_DIALOG_DECLARATIONS: readonly [typeof GrDialogRoot, typeof GrDialogTrigger, typeof GrDialogOpen, typeof GrDialogBackdrop, typeof GrDialogPositioner, typeof GrDialogContent, typeof GrDialogTitle, typeof GrDialogDescription, typeof GrDialogCloseTrigger];
DeclarationView source
GrDialogBackdropts
export declare class GrDialogBackdrop implements OnDestroy {
private readonly store;
private readonly elementRef;
private readonly listeners;
private readonly consumerProps;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrDialogBackdrop, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrDialogBackdrop, "[grDialogBackdrop]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrDialogBackdrop, "[grDialogBackdrop]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrDialogBackdrop, never>
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrDialogBackdrop, "[grDialogBackdrop]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrDialogBackdrop, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required
DeclarationView source
GrDialogCloseTriggerts
export declare class GrDialogCloseTrigger implements OnDestroy {
private readonly store;
private readonly elementRef;
private readonly listeners;
private readonly consumerProps;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrDialogCloseTrigger, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrDialogCloseTrigger, "[grDialogCloseTrigger]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrDialogCloseTrigger, "[grDialogCloseTrigger]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrDialogCloseTrigger, never>
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrDialogCloseTrigger, "[grDialogCloseTrigger]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrDialogCloseTrigger, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required
DeclarationView source
GrDialogContentts
export declare class GrDialogContent implements OnDestroy {
readonly ariaLabelledby: import("@angular/core").InputSignal<string | undefined>;
readonly ariaDescribedby: import("@angular/core").InputSignal<string | undefined>;
private readonly store;
private readonly elementRef;
private readonly listeners;
private readonly consumerProps;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrDialogContent, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrDialogContent, "[grDialogContent]", never, { "ariaLabelledby": { "alias": "ariaLabelledby"; "required": false; "isSignal": true; }; "ariaDescribedby": { "alias": "ariaDescribedby"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
ariaDescribedby
property
import("@angular/core").InputSignal<string | undefined>
required
ariaLabelledby
property
import("@angular/core").InputSignal<string | undefined>
required
consumerProps
property
any
required
elementRef
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrDialogContent, "[grDialogContent]", never, { "ariaLabelledby": { "alias": "ariaLabelledby"; "required": false; "isSignal": true; }; "ariaDescribedby": { "alias": "ariaDescribedby"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrDialogContent, never>
required
store
property
any
required
Name
ariaDescribedby
Kind
property
Type
import("@angular/core").InputSignal<string | undefined>
Requirement
required
Name
ariaLabelledby
Kind
property
Type
import("@angular/core").InputSignal<string | undefined>
Requirement
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrDialogContent, "[grDialogContent]", never, { "ariaLabelledby": { "alias": "ariaLabelledby"; "required": false; "isSignal": true; }; "ariaDescribedby": { "alias": "ariaDescribedby"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrDialogContent, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required
DeclarationView source
GrDialogDescriptionts
export declare class GrDialogDescription implements OnDestroy {
private readonly store;
private readonly elementRef;
private readonly listeners;
private readonly consumerProps;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrDialogDescription, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrDialogDescription, "[grDialogDescription]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrDialogDescription, "[grDialogDescription]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrDialogDescription, never>
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrDialogDescription, "[grDialogDescription]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrDialogDescription, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrDialogOpen

class
DeclarationView source
GrDialogOpents
export declare class GrDialogOpen implements OnDestroy {
private readonly store;
private readonly templateRef;
private readonly viewContainerRef;
private hasView;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrDialogOpen, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrDialogOpen, "[grDialogOpen]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
hasView
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrDialogOpen, "[grDialogOpen]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrDialogOpen, never>
required
store
property
any
required
templateRef
property
any
required
viewContainerRef
property
any
required
Name
hasView
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrDialogOpen, "[grDialogOpen]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrDialogOpen, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required
Name
templateRef
Kind
property
Type
any
Requirement
required
Name
viewContainerRef
Kind
property
Type
any
Requirement
required
DeclarationView source
GrDialogPositionerts
export declare class GrDialogPositioner implements OnDestroy {
private readonly store;
private readonly elementRef;
private readonly renderer;
private readonly listeners;
private readonly consumerProps;
constructor();
ngOnDestroy(): void;
private portalToBody;
static ɵfac: i0.ɵɵFactoryDeclaration<GrDialogPositioner, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrDialogPositioner, "[grDialogPositioner]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrDialogPositioner, "[grDialogPositioner]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrDialogPositioner, never>
required
portalToBody
property
any
required
renderer
property
any
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrDialogPositioner, "[grDialogPositioner]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrDialogPositioner, never>
Requirement
required
Name
portalToBody
Kind
property
Type
any
Requirement
required
Name
renderer
Kind
property
Type
any
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrDialogRoot

class
DeclarationView source
GrDialogRootts
export declare class GrDialogRoot implements OnDestroy {
readonly open: import("@angular/core").InputSignal<boolean | undefined>;
readonly defaultOpen: import("@angular/core").InputSignal<boolean | undefined>;
readonly dismissable: import("@angular/core").InputSignal<boolean | undefined>;
readonly openChange: import("@angular/core").OutputEmitterRef<DialogOpenChangeDetail>;
private readonly injector;
private lastSynced;
private releaseManagers;
readonly store: DialogStore;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrDialogRoot, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrDialogRoot, "[grDialogRoot]", never, { "open": { "alias": "open"; "required": false; "isSignal": true; }; "defaultOpen": { "alias": "defaultOpen"; "required": false; "isSignal": true; }; "dismissable": { "alias": "dismissable"; "required": false; "isSignal": true; }; }, { "openChange": "openChange"; }, never, never, true, never>;
}
Name
Kind
Type
Requirement
defaultOpen
property
import("@angular/core").InputSignal<boolean | undefined>
required
dismissable
property
import("@angular/core").InputSignal<boolean | undefined>
required
injector
property
any
required
lastSynced
property
any
required
ngOnDestroy
method
() => void
required
open
property
import("@angular/core").InputSignal<boolean | undefined>
required
openChange
property
import("@angular/core").OutputEmitterRef<DialogOpenChangeDetail>
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrDialogRoot, "[grDialogRoot]", never, { "open": { "alias": "open"; "required": false; "isSignal": true; }; "defaultOpen": { "alias": "defaultOpen"; "required": false; "isSignal": true; }; "dismissable": { "alias": "dismissable"; "required": false; "isSignal": true; }; }, { "openChange": "openChange"; }, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrDialogRoot, never>
required
releaseManagers
property
any
required
store
property
DialogStore
required
Name
defaultOpen
Kind
property
Type
import("@angular/core").InputSignal<boolean | undefined>
Requirement
required
Name
dismissable
Kind
property
Type
import("@angular/core").InputSignal<boolean | undefined>
Requirement
required
Name
injector
Kind
property
Type
any
Requirement
required
Name
lastSynced
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
open
Kind
property
Type
import("@angular/core").InputSignal<boolean | undefined>
Requirement
required
Name
openChange
Kind
property
Type
import("@angular/core").OutputEmitterRef<DialogOpenChangeDetail>
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrDialogRoot, "[grDialogRoot]", never, { "open": { "alias": "open"; "required": false; "isSignal": true; }; "defaultOpen": { "alias": "defaultOpen"; "required": false; "isSignal": true; }; "dismissable": { "alias": "dismissable"; "required": false; "isSignal": true; }; }, { "openChange": "openChange"; }, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrDialogRoot, never>
Requirement
required
Name
releaseManagers
Kind
property
Type
any
Requirement
required
Name
store
Kind
property
Type
DialogStore
Requirement
required
DeclarationView source
GrDialogTitlets
export declare class GrDialogTitle implements OnDestroy {
private readonly store;
private readonly elementRef;
private readonly listeners;
private readonly consumerProps;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrDialogTitle, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrDialogTitle, "[grDialogTitle]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrDialogTitle, "[grDialogTitle]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrDialogTitle, never>
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrDialogTitle, "[grDialogTitle]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrDialogTitle, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required
DeclarationView source
GrDialogTriggerts
export declare class GrDialogTrigger implements OnDestroy {
private readonly store;
private readonly elementRef;
private readonly listeners;
private readonly consumerProps;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrDialogTrigger, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrDialogTrigger, "[grDialogTrigger]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrDialogTrigger, "[grDialogTrigger]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrDialogTrigger, never>
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrDialogTrigger, "[grDialogTrigger]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrDialogTrigger, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

@grassroot/ui-headless-svelte/dialog

Svelte adapter

22 exports
View source packages/ui-headless/svelte/src/dialog/index.ts

createDialog

function
DeclarationView source
createDialogts
export declare function createDialog(inputGetter: () => DialogInput, options?: UseDialogOptions): UseDialogResult;
Name
Kind
Type
Requirement
inputGetter
parameter
() => DialogInput
required
options
parameter
UseDialogOptions
optional
return
return value
UseDialogResult
n/a
Name
inputGetter
Kind
parameter
Type
() => DialogInput
Requirement
required
Name
options
Kind
parameter
Type
UseDialogOptions
Requirement
optional
Name
return
Kind
return value
Type
UseDialogResult
Requirement
n/a
DeclarationView source
DialogBackdropts
export declare const DialogBackdrop: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a
DeclarationView source
DialogChangeReasonts
type DialogChangeReason = DialogOpenReason | DialogCloseReason;
DeclarationView source
DialogCloseTriggerts
export declare const DialogCloseTrigger: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a
DeclarationView source
DialogCommandts
type DialogCommand = CommandObject & {
readonly type: "OPEN_CHANGE_REQUEST";
readonly open: boolean;
readonly reason: DialogChangeReason;
};
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
DialogChangeReason
required
type
property
string
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
DialogChangeReason
Requirement
required
Name
type
Kind
property
Type
string
Requirement
required
DeclarationView source
DialogContentts
export declare const DialogContent: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a
DeclarationView source
DialogContextts
type DialogContext = {
readonly mode: "controlled" | "uncontrolled";
};
Name
Kind
Type
Requirement
mode
property
"controlled" | "uncontrolled"
required
Name
mode
Kind
property
Type
"controlled" | "uncontrolled"
Requirement
required
DeclarationView source
DialogContextValuets
export type DialogContextValue = UseDialogResult;
DeclarationView source
DialogDescriptionts
export declare const DialogDescription: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a
DeclarationView source
DialogEventts
type DialogEvent = {
readonly type: "OPEN";
readonly reason: DialogOpenReason;
} | {
readonly type: "CLOSE";
readonly reason: DialogCloseReason;
};
DeclarationView source
DialogInputts
type DialogInput = {
readonly open?: boolean;
readonly defaultOpen?: boolean;
readonly dismissable?: boolean;
};
Name
Kind
Type
Requirement
defaultOpen
property
boolean
optional
dismissable
property
boolean
optional
open
property
boolean
optional
Name
defaultOpen
Kind
property
Type
boolean
Requirement
optional
Name
dismissable
Kind
property
Type
boolean
Requirement
optional
Name
open
Kind
property
Type
boolean
Requirement
optional
DeclarationView source
DialogMachinets
type DialogMachine = Machine<DialogInput, DialogStateValue, DialogContext, DialogEvent, DialogCommand>;
DeclarationView source
DialogOpenChangeDetailts
export interface DialogOpenChangeDetail {
readonly open: boolean;
readonly reason: DialogChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
DialogChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
DialogChangeReason
Requirement
required
DeclarationView source
DialogPositionerts
export declare const DialogPositioner: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

DialogRoot

value
DeclarationView source
DialogRootts
export declare const DialogRoot: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a
DeclarationView source
DialogSnapshotts
type DialogSnapshot = Snapshot<DialogStateValue, DialogContext>;
DeclarationView source
DialogStateValuets
type DialogStateValue = "open" | "closed";

DialogTitle

value
DeclarationView source
DialogTitlets
export declare const DialogTitle: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a
DeclarationView source
DialogTriggerts
export declare const DialogTrigger: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

useDialogContext

function
DeclarationView source
useDialogContextts
export declare function useDialogContext(partName: string): DialogContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
DialogContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
DialogContextValue
Requirement
n/a

UseDialogOptions

interface
DeclarationView source
UseDialogOptionsts
export interface UseDialogOptions {
readonly onOpenChange?: (detail: DialogOpenChangeDetail) => void;
}
Name
Kind
Type
Requirement
onOpenChange
property
(detail: DialogOpenChangeDetail) => void
optional
Name
onOpenChange
Kind
property
Type
(detail: DialogOpenChangeDetail) => void
Requirement
optional

UseDialogResult

interface
DeclarationView source
UseDialogResultts
export interface UseDialogResult {
readonly service: DialogService;
readonly connector: DialogApi;
readonly scope: PartScope;
readonly version: () => number;
}
Name
Kind
Type
Requirement
connector
property
DialogApi
required
scope
property
PartScope
required
service
property
DialogService
required
version
property
() => number
required
Name
connector
Kind
property
Type
DialogApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
DialogService
Requirement
required
Name
version
Kind
property
Type
() => number
Requirement
required

@grassroot/ui-headless-solid/dialog

Solid adapter

23 exports
View source packages/ui-headless/solid/src/dialog/index.ts

DialogBackdrop

function
DeclarationView source
DialogBackdropts
export declare function DialogBackdrop(props: DialogBackdropProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
DialogBackdropProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
DialogBackdropProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a
DeclarationView source
DialogBackdropPropsts
export interface DialogBackdropProps extends JSX.HTMLAttributes<HTMLDivElement> {
readonly as?: AsProp;
}
Name
Kind
Type
Requirement
as
property
AsProp
optional
Name
as
Kind
property
Type
AsProp
Requirement
optional
DeclarationView source
DialogCloseTriggerts
export declare function DialogCloseTrigger(props: DialogCloseTriggerProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
DialogCloseTriggerProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
DialogCloseTriggerProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a
DeclarationView source
DialogCloseTriggerPropsts
export interface DialogCloseTriggerProps extends Omit<JSX.ButtonHTMLAttributes<HTMLButtonElement>, "type"> {
readonly as?: AsProp;
}
Name
Kind
Type
Requirement
as
property
AsProp
optional
Name
as
Kind
property
Type
AsProp
Requirement
optional

DialogContent

function
DeclarationView source
DialogContentts
export declare function DialogContent(props: DialogContentProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
DialogContentProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
DialogContentProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

DialogContentProps

interface
DeclarationView source
DialogContentPropsts
export interface DialogContentProps extends JSX.HTMLAttributes<HTMLDivElement> {
readonly as?: AsProp;
}
Name
Kind
Type
Requirement
as
property
AsProp
optional
Name
as
Kind
property
Type
AsProp
Requirement
optional
DeclarationView source
DialogContextts
export declare const DialogContext: import("solid-js").Context<DialogContextValue | undefined>;

DialogContextValue

interface
DeclarationView source
DialogContextValuets
export interface DialogContextValue {
readonly service: DialogService;
readonly connector: DialogApi;
readonly scope: PartScope;
/**
* Bumped on every committed machine update. Parts must call this
* accessor *inside* the JSX/spread thunk that reads the connector's prop
* bags — not once at setup — so Solid's fine-grained reactivity tracks
* the dependency and re-runs on every committed change.
*/
readonly snapshot: Accessor<DialogSnapshot>;
}
Name
Kind
Type
Requirement
Description
connector
property
DialogApi
required
scope
property
PartScope
required
service
property
DialogService
required
snapshot
property
Accessor<DialogSnapshot>
required
Bumped on every committed machine update. Parts must call this accessor *inside* the JSX/spread thunk that reads the connector's prop bags — not once at setup — so Solid's fine-grained reactivity tracks the dependency and re-runs on every committed change.
Name
connector
Kind
property
Type
DialogApi
Requirement
required
Description
Name
scope
Kind
property
Type
PartScope
Requirement
required
Description
Name
service
Kind
property
Type
DialogService
Requirement
required
Description
Name
snapshot
Kind
property
Type
Accessor<DialogSnapshot>
Requirement
required
Description
Bumped on every committed machine update. Parts must call this accessor *inside* the JSX/spread thunk that reads the connector's prop bags — not once at setup — so Solid's fine-grained reactivity tracks the dependency and re-runs on every committed change.
DeclarationView source
DialogDescriptionts
export declare function DialogDescription(props: DialogDescriptionProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
DialogDescriptionProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
DialogDescriptionProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a
DeclarationView source
DialogDescriptionPropsts
export interface DialogDescriptionProps extends JSX.HTMLAttributes<HTMLParagraphElement> {
readonly as?: AsProp;
}
Name
Kind
Type
Requirement
as
property
AsProp
optional
Name
as
Kind
property
Type
AsProp
Requirement
optional
DeclarationView source
DialogOpenChangeDetailts
export interface DialogOpenChangeDetail {
readonly open: boolean;
readonly reason: DialogChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
DialogChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
DialogChangeReason
Requirement
required

DialogPositioner

function
DeclarationView source
DialogPositionerts
export declare function DialogPositioner(props: DialogPositionerProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
DialogPositionerProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
DialogPositionerProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a
DeclarationView source
DialogPositionerPropsts
export interface DialogPositionerProps extends JSX.HTMLAttributes<HTMLDivElement> {
readonly as?: AsProp;
}
Name
Kind
Type
Requirement
as
property
AsProp
optional
Name
as
Kind
property
Type
AsProp
Requirement
optional

DialogRoot

function
DeclarationView source
DialogRootts
export declare function DialogRoot(props: DialogRootProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
DialogRootProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
DialogRootProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

DialogRootProps

interface
DeclarationView source
DialogRootPropsts
export interface DialogRootProps {
readonly open?: DialogInput["open"];
readonly defaultOpen?: DialogInput["defaultOpen"];
readonly dismissable?: DialogInput["dismissable"];
readonly onOpenChange?: (detail: DialogOpenChangeDetail) => void;
readonly children?: JSX.Element;
}
Name
Kind
Type
Requirement
children
property
JSX.Element
optional
defaultOpen
property
DialogInput["defaultOpen"]
optional
dismissable
property
DialogInput["dismissable"]
optional
onOpenChange
property
(detail: DialogOpenChangeDetail) => void
optional
open
property
DialogInput["open"]
optional
Name
children
Kind
property
Type
JSX.Element
Requirement
optional
Name
defaultOpen
Kind
property
Type
DialogInput["defaultOpen"]
Requirement
optional
Name
dismissable
Kind
property
Type
DialogInput["dismissable"]
Requirement
optional
Name
onOpenChange
Kind
property
Type
(detail: DialogOpenChangeDetail) => void
Requirement
optional
Name
open
Kind
property
Type
DialogInput["open"]
Requirement
optional

DialogTitle

function
DeclarationView source
DialogTitlets
export declare function DialogTitle(props: DialogTitleProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
DialogTitleProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
DialogTitleProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

DialogTitleProps

interface
DeclarationView source
DialogTitlePropsts
export interface DialogTitleProps extends JSX.HTMLAttributes<HTMLHeadingElement> {
readonly as?: AsProp;
}
Name
Kind
Type
Requirement
as
property
AsProp
optional
Name
as
Kind
property
Type
AsProp
Requirement
optional

DialogTrigger

function
DeclarationView source
DialogTriggerts
export declare function DialogTrigger(props: DialogTriggerProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
DialogTriggerProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
DialogTriggerProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

DialogTriggerProps

interface
DeclarationView source
DialogTriggerPropsts
export interface DialogTriggerProps extends Omit<JSX.ButtonHTMLAttributes<HTMLButtonElement>, "type"> {
readonly as?: AsProp;
}
Name
Kind
Type
Requirement
as
property
AsProp
optional
Name
as
Kind
property
Type
AsProp
Requirement
optional

useDialog

function
DeclarationView source
useDialogts
export declare function useDialog(input: Accessor<DialogInput>, options?: UseDialogOptions): UseDialogResult;
Name
Kind
Type
Requirement
input
parameter
Accessor<DialogInput>
required
options
parameter
UseDialogOptions
optional
return
return value
UseDialogResult
n/a
Name
input
Kind
parameter
Type
Accessor<DialogInput>
Requirement
required
Name
options
Kind
parameter
Type
UseDialogOptions
Requirement
optional
Name
return
Kind
return value
Type
UseDialogResult
Requirement
n/a

useDialogContext

function
DeclarationView source
useDialogContextts
export declare function useDialogContext(partName: string): DialogContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
DialogContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
DialogContextValue
Requirement
n/a

UseDialogOptions

interface
DeclarationView source
UseDialogOptionsts
export interface UseDialogOptions {
readonly onOpenChange?: (detail: DialogOpenChangeDetail) => void;
}
Name
Kind
Type
Requirement
onOpenChange
property
(detail: DialogOpenChangeDetail) => void
optional
Name
onOpenChange
Kind
property
Type
(detail: DialogOpenChangeDetail) => void
Requirement
optional

UseDialogResult

interface
DeclarationView source
UseDialogResultts
export interface UseDialogResult {
readonly service: DialogService;
readonly connector: DialogApi;
readonly scope: PartScope;
readonly snapshot: Accessor<DialogSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
DialogApi
required
scope
property
PartScope
required
service
property
DialogService
required
snapshot
property
Accessor<DialogSnapshot>
required
Name
connector
Kind
property
Type
DialogApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
DialogService
Requirement
required
Name
snapshot
Kind
property
Type
Accessor<DialogSnapshot>
Requirement
required