DocsAPI referenceHeadlessalert-dialog

alert-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/alert-dialog

Core connector and vanilla API

23 exports
View source packages/ui-headless/core/src/alert-dialog/index.ts
DeclarationView source
activateAlertDialogManagersts
declare function activateAlertDialogManagers(service: AlertDialogService, scope: PartScope, doc: Document): () => void;
Name
Kind
Type
Requirement
service
parameter
AlertDialogService
required
scope
parameter
PartScope
required
doc
parameter
Document
required
return
return value
() => void
n/a
Name
service
Kind
parameter
Type
AlertDialogService
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
DeclarationView source
alertDialogAnatomyts
export declare const alertDialogAnatomy: {
readonly scope: "alert-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
"alert-dialog"
required
Name
parts
Kind
property
Type
readonly ["trigger", "backdrop", "positioner", "content", "title", "description", "close-trigger"]
Requirement
required
Name
scope
Kind
property
Type
"alert-dialog"
Requirement
required

AlertDialogApi

interface
DeclarationView source
AlertDialogApits
interface AlertDialogApi {
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
AlertDialogChangeReasonts
type AlertDialogChangeReason = AlertDialogOpenReason | AlertDialogCloseReason;
DeclarationView source
AlertDialogCloseReasonts
type AlertDialogCloseReason = "escape" | "outside-click" | "close-trigger" | "programmatic";
DeclarationView source
AlertDialogCommandts
type AlertDialogCommand = CommandObject & {
readonly type: "OPEN_CHANGE_REQUEST";
readonly open: boolean;
readonly reason: AlertDialogChangeReason;
};
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
AlertDialogChangeReason
required
type
property
string
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
AlertDialogChangeReason
Requirement
required
Name
type
Kind
property
Type
string
Requirement
required
DeclarationView source
AlertDialogConnectOptionsts
interface AlertDialogConnectOptions {}
DeclarationView source
AlertDialogContextts
type AlertDialogContext = {
readonly mode: "controlled" | "uncontrolled";
};
Name
Kind
Type
Requirement
mode
property
"controlled" | "uncontrolled"
required
Name
mode
Kind
property
Type
"controlled" | "uncontrolled"
Requirement
required
DeclarationView source
AlertDialogEventts
type AlertDialogEvent = {
readonly type: "OPEN";
readonly reason: AlertDialogOpenReason;
} | {
readonly type: "CLOSE";
readonly reason: AlertDialogCloseReason;
};
DeclarationView source
AlertDialogInputts
type AlertDialogInput = {
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
alertDialogMachinets
export declare const alertDialogMachine: AlertDialogMachine;

AlertDialogMount

interface
DeclarationView source
AlertDialogMountts
interface AlertDialogMount {
readonly service: AlertDialogService;
readonly connector: AlertDialogApi;
readonly root: HTMLElement;
readonly trigger: HTMLButtonElement;
destroy(): void;
}
Name
Kind
Type
Requirement
connector
property
AlertDialogApi
required
destroy
method
() => void
required
root
property
HTMLElement
required
service
property
AlertDialogService
required
trigger
property
HTMLButtonElement
required
Name
connector
Kind
property
Type
AlertDialogApi
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
root
Kind
property
Type
HTMLElement
Requirement
required
Name
service
Kind
property
Type
AlertDialogService
Requirement
required
Name
trigger
Kind
property
Type
HTMLButtonElement
Requirement
required
DeclarationView source
AlertDialogOpenChangeDetailts
interface AlertDialogOpenChangeDetail {
readonly open: boolean;
readonly reason: AlertDialogChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
AlertDialogChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
AlertDialogChangeReason
Requirement
required
DeclarationView source
AlertDialogOpenReasonts
type AlertDialogOpenReason = "trigger" | "programmatic";
DeclarationView source
AlertDialogPartts
type AlertDialogPart = (typeof alertDialogAnatomy.parts)[number];
DeclarationView source
alertDialogSelectorsts
export declare const alertDialogSelectors: {
open: (snapshot: AlertDialogSnapshot) => boolean;
};
Name
Kind
Type
Requirement
open
property
(snapshot: AlertDialogSnapshot) => boolean
required
Name
open
Kind
property
Type
(snapshot: AlertDialogSnapshot) => boolean
Requirement
required
DeclarationView source
AlertDialogServicets
type AlertDialogService = Service<AlertDialogInput, AlertDialogStateValue, AlertDialogContext, AlertDialogEvent, AlertDialogCommand>;
DeclarationView source
AlertDialogSnapshotts
type AlertDialogSnapshot = Snapshot<AlertDialogStateValue, AlertDialogContext>;
DeclarationView source
AlertDialogStateValuets
type AlertDialogStateValue = "open" | "closed";
DeclarationView source
connectAlertDialogts
declare function connectAlertDialog(service: AlertDialogService, scope: PartScope, _options?: AlertDialogConnectOptions): AlertDialogApi;
Name
Kind
Type
Requirement
service
parameter
AlertDialogService
required
scope
parameter
PartScope
required
_options
parameter
AlertDialogConnectOptions
optional
return
return value
AlertDialogApi
n/a
Name
service
Kind
parameter
Type
AlertDialogService
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
_options
Kind
parameter
Type
AlertDialogConnectOptions
Requirement
optional
Name
return
Kind
return value
Type
AlertDialogApi
Requirement
n/a

mountAlertDialog

function
DeclarationView source
mountAlertDialogts
declare function mountAlertDialog(container: HTMLElement, options?: MountAlertDialogOptions): AlertDialogMount;
Name
Kind
Type
Requirement
container
parameter
HTMLElement
required
options
parameter
MountAlertDialogOptions
optional
return
return value
AlertDialogMount
n/a
Name
container
Kind
parameter
Type
HTMLElement
Requirement
required
Name
options
Kind
parameter
Type
MountAlertDialogOptions
Requirement
optional
Name
return
Kind
return value
Type
AlertDialogMount
Requirement
n/a
DeclarationView source
MountAlertDialogOptionsts
interface MountAlertDialogOptions extends AlertDialogInput {
readonly onOpenChange?: (detail: AlertDialogOpenChangeDetail) => void;
readonly renderTrigger?: (button: HTMLButtonElement) => void;
readonly renderContent?: (panel: HTMLDivElement) => void;
readonly renderTitle?: (heading: HTMLHeadingElement) => void;
readonly renderDescription?: (paragraph: HTMLParagraphElement) => void;
readonly renderCloseTrigger?: (button: HTMLButtonElement) => void;
}
Name
Kind
Type
Requirement
onOpenChange
property
(detail: AlertDialogOpenChangeDetail) => void
optional
renderCloseTrigger
property
(button: HTMLButtonElement) => void
optional
renderContent
property
(panel: HTMLDivElement) => void
optional
renderDescription
property
(paragraph: HTMLParagraphElement) => void
optional
renderTitle
property
(heading: HTMLHeadingElement) => void
optional
renderTrigger
property
(button: HTMLButtonElement) => void
optional
Name
onOpenChange
Kind
property
Type
(detail: AlertDialogOpenChangeDetail) => void
Requirement
optional
Name
renderCloseTrigger
Kind
property
Type
(button: HTMLButtonElement) => void
Requirement
optional
Name
renderContent
Kind
property
Type
(panel: HTMLDivElement) => void
Requirement
optional
Name
renderDescription
Kind
property
Type
(paragraph: HTMLParagraphElement) => void
Requirement
optional
Name
renderTitle
Kind
property
Type
(heading: HTMLHeadingElement) => void
Requirement
optional
Name
renderTrigger
Kind
property
Type
(button: HTMLButtonElement) => void
Requirement
optional
DeclarationView source
runAlertDialogCommandts
declare function runAlertDialogCommand(command: AlertDialogCommand, _scope: PartScope, options?: {
readonly onOpenChange?: (detail: {
open: boolean;
reason: AlertDialogChangeReason;
}) => void;
}): void;
Name
Kind
Type
Requirement
command
parameter
AlertDialogCommand
required
_scope
parameter
PartScope
required
options
parameter
{ readonly onOpenChange?: (detail: { open: boolean; reason: AlertDialogChangeReason; }) => void; }
optional
return
return value
void
n/a
Name
command
Kind
parameter
Type
AlertDialogCommand
Requirement
required
Name
_scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
{ readonly onOpenChange?: (detail: { open: boolean; reason: AlertDialogChangeReason; }) => 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/alert-dialogts
import { AlertDialog, Backdrop, CloseTrigger, Content, Description, Positioner, Root, Title } from "@grassroot/ui-headless-react/alert-dialog"; // +1 more exports

Vue imports

@grassroot/ui-headless-vue/alert-dialogts
<script setup lang="ts">
import { AlertDialogBackdrop, AlertDialogCloseTrigger, AlertDialogContent, AlertDialogDescription, AlertDialogPositioner, AlertDialogRoot, AlertDialogTitle, AlertDialogTrigger } from "@grassroot/ui-headless-vue/alert-dialog";
</script>

Angular imports

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

Solid imports

@grassroot/ui-headless-solid/alert-dialogts
import { AlertDialogBackdrop, AlertDialogCloseTrigger, AlertDialogContent, AlertDialogDescription, AlertDialogPositioner, AlertDialogRoot, AlertDialogTitle, AlertDialogTrigger } from "@grassroot/ui-headless-solid/alert-dialog";

@grassroot/ui-headless-react/alert-dialog

React adapter

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

AlertDialog

value
DeclarationView source
AlertDialogts
export declare const AlertDialog: {
Root: typeof Root;
Trigger: import("react").ForwardRefExoticComponent<AlertDialogTriggerProps & import("react").RefAttributes<HTMLButtonElement>>;
Backdrop: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
readonly asChild?: boolean;
} & import("react").RefAttributes<HTMLDivElement>>;
Positioner: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
readonly asChild?: boolean;
} & import("react").RefAttributes<HTMLDivElement>>;
Content: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
readonly asChild?: boolean;
} & import("react").RefAttributes<HTMLDivElement>>;
Title: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement>, "ref"> & {
readonly asChild?: boolean;
} & import("react").RefAttributes<HTMLHeadingElement>>;
Description: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, "ref"> & {
readonly asChild?: boolean;
} & import("react").RefAttributes<HTMLParagraphElement>>;
CloseTrigger: import("react").ForwardRefExoticComponent<AlertDialogTriggerProps & import("react").RefAttributes<HTMLButtonElement>>;
};
Name
Kind
Type
Requirement
Backdrop
property
import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & { readonly asChild?: boolean; } & import("react").RefAttributes<HTMLDivElement>>
required
CloseTrigger
property
import("react").ForwardRefExoticComponent<AlertDialogTriggerProps & import("react").RefAttributes<HTMLButtonElement>>
required
Content
property
import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & { readonly asChild?: boolean; } & import("react").RefAttributes<HTMLDivElement>>
required
Description
property
import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, "ref"> & { readonly asChild?: boolean; } & import("react").RefAttributes<HTMLParagraphElement>>
required
Positioner
property
import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & { readonly asChild?: boolean; } & import("react").RefAttributes<HTMLDivElement>>
required
Root
property
typeof Root
required
Title
property
import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement>, "ref"> & { readonly asChild?: boolean; } & import("react").RefAttributes<HTMLHeadingElement>>
required
Trigger
property
import("react").ForwardRefExoticComponent<AlertDialogTriggerProps & import("react").RefAttributes<HTMLButtonElement>>
required
Name
Backdrop
Kind
property
Type
import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & { readonly asChild?: boolean; } & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
CloseTrigger
Kind
property
Type
import("react").ForwardRefExoticComponent<AlertDialogTriggerProps & import("react").RefAttributes<HTMLButtonElement>>
Requirement
required
Name
Content
Kind
property
Type
import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & { readonly asChild?: boolean; } & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
Description
Kind
property
Type
import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, "ref"> & { readonly asChild?: boolean; } & import("react").RefAttributes<HTMLParagraphElement>>
Requirement
required
Name
Positioner
Kind
property
Type
import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & { readonly asChild?: boolean; } & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
Root
Kind
property
Type
typeof Root
Requirement
required
Name
Title
Kind
property
Type
import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement>, "ref"> & { readonly asChild?: boolean; } & import("react").RefAttributes<HTMLHeadingElement>>
Requirement
required
Name
Trigger
Kind
property
Type
import("react").ForwardRefExoticComponent<AlertDialogTriggerProps & import("react").RefAttributes<HTMLButtonElement>>
Requirement
required
DeclarationView source
AlertDialogContextts
export declare const AlertDialogContext: import("react").Context<AlertDialogContextValue | 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
DeclarationView source
AlertDialogOpenChangeDetailts
interface AlertDialogOpenChangeDetail {
readonly open: boolean;
readonly reason: AlertDialogChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
AlertDialogChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
AlertDialogChangeReason
Requirement
required
DeclarationView source
AlertDialogRootPropsts
interface AlertDialogRootProps extends Pick<AlertDialogInput, "open" | "defaultOpen" | "dismissable"> {
readonly onOpenChange?: (detail: {
open: boolean;
reason: string;
}) => void;
readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
children
property
ReactNode
optional
onOpenChange
property
(detail: { open: boolean; reason: string; }) => void
optional
Name
children
Kind
property
Type
ReactNode
Requirement
optional
Name
onOpenChange
Kind
property
Type
(detail: { open: boolean; reason: string; }) => void
Requirement
optional
DeclarationView source
AlertDialogTriggerPropsts
interface AlertDialogTriggerProps extends Omit<ComponentPropsWithoutRef<"button">, "type"> {
readonly asChild?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional

Backdrop

value
DeclarationView source
Backdropts
export declare const Backdrop: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
readonly asChild?: boolean;
} & 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<AlertDialogTriggerProps & 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<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
readonly asChild?: boolean;
} & 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<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, "ref"> & {
readonly asChild?: boolean;
} & 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

Positioner

value
DeclarationView source
Positionerts
export declare const Positioner: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
readonly asChild?: boolean;
} & 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: AlertDialogRootProps): import("react").JSX.Element;
Name
Kind
Type
Requirement
props
parameter
AlertDialogRootProps
required
return
return value
import("react").JSX.Element
n/a
Name
props
Kind
parameter
Type
AlertDialogRootProps
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<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement>, "ref"> & {
readonly asChild?: boolean;
} & 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<AlertDialogTriggerProps & 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

useAlertDialog

function
DeclarationView source
useAlertDialogts
declare function useAlertDialog(input: AlertDialogInput, options?: UseAlertDialogOptions): UseAlertDialogResult;
Name
Kind
Type
Requirement
input
parameter
AlertDialogInput
required
options
parameter
UseAlertDialogOptions
optional
return
return value
UseAlertDialogResult
n/a
Name
input
Kind
parameter
Type
AlertDialogInput
Requirement
required
Name
options
Kind
parameter
Type
UseAlertDialogOptions
Requirement
optional
Name
return
Kind
return value
Type
UseAlertDialogResult
Requirement
n/a
DeclarationView source
useAlertDialogContextts
declare function useAlertDialogContext(part: string): AlertDialogContextValue;
Name
Kind
Type
Requirement
part
parameter
string
required
return
return value
AlertDialogContextValue
n/a
Name
part
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
AlertDialogContextValue
Requirement
n/a
DeclarationView source
UseAlertDialogOptionsts
interface UseAlertDialogOptions {
readonly onOpenChange?: (detail: AlertDialogOpenChangeDetail) => void;
}
Name
Kind
Type
Requirement
onOpenChange
property
(detail: AlertDialogOpenChangeDetail) => void
optional
Name
onOpenChange
Kind
property
Type
(detail: AlertDialogOpenChangeDetail) => void
Requirement
optional
DeclarationView source
UseAlertDialogResultts
interface UseAlertDialogResult {
readonly service: AlertDialogService;
readonly connector: AlertDialogApi;
readonly scope: PartScope;
readonly snapshot: AlertDialogSnapshot;
}
Name
Kind
Type
Requirement
connector
property
AlertDialogApi
required
scope
property
PartScope
required
service
property
AlertDialogService
required
snapshot
property
AlertDialogSnapshot
required
Name
connector
Kind
property
Type
AlertDialogApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
AlertDialogService
Requirement
required
Name
snapshot
Kind
property
Type
AlertDialogSnapshot
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/alert-dialog

Vue adapter

15 exports
View source packages/ui-headless/vue/src/alert-dialog/index.ts
DeclarationView source
AlertDialogBackdropts
export declare const AlertDialogBackdrop: 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
AlertDialogCloseTriggerts
export declare const AlertDialogCloseTrigger: 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
AlertDialogContentts
export declare const AlertDialogContent: 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
AlertDialogContextKeyts
export declare const AlertDialogContextKey: InjectionKey<AlertDialogContextValue>;
DeclarationView source
AlertDialogContextValuets
interface AlertDialogContextValue {
readonly service: AlertDialogService;
readonly connector: AlertDialogApi;
readonly scope: PartScope;
readonly snapshot: ShallowRef<AlertDialogSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
AlertDialogApi
required
scope
property
PartScope
required
service
property
AlertDialogService
required
snapshot
property
ShallowRef<AlertDialogSnapshot>
required
Name
connector
Kind
property
Type
AlertDialogApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
AlertDialogService
Requirement
required
Name
snapshot
Kind
property
Type
ShallowRef<AlertDialogSnapshot>
Requirement
required
DeclarationView source
AlertDialogDescriptionts
export declare const AlertDialogDescription: 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
AlertDialogOpenChangeDetailts
interface AlertDialogOpenChangeDetail {
readonly open: boolean;
readonly reason: AlertDialogChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
AlertDialogChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
AlertDialogChangeReason
Requirement
required
DeclarationView source
AlertDialogPositionerts
export declare const AlertDialogPositioner: 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
AlertDialogRootts
export declare const AlertDialogRoot: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
open: {
type: PropType<AlertDialogInput["open"]>;
default: undefined;
};
defaultOpen: {
type: PropType<AlertDialogInput["defaultOpen"]>;
default: undefined;
};
dismissable: {
type: PropType<AlertDialogInput["dismissable"]>;
default: undefined;
};
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}>[] | undefined, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
openChange: (_detail: AlertDialogOpenChangeDetail) => true;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
open: {
type: PropType<AlertDialogInput["open"]>;
default: undefined;
};
defaultOpen: {
type: PropType<AlertDialogInput["defaultOpen"]>;
default: undefined;
};
dismissable: {
type: PropType<AlertDialogInput["dismissable"]>;
default: undefined;
};
}>> & Readonly<{
onOpenChange?: ((_detail: AlertDialogOpenChangeDetail) => any) | undefined;
}>, {
open: boolean | undefined;
defaultOpen: boolean | undefined;
dismissable: boolean | undefined;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
DeclarationView source
AlertDialogTitlets
export declare const AlertDialogTitle: 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
AlertDialogTriggerts
export declare const AlertDialogTrigger: 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>;

useAlertDialog

function
DeclarationView source
useAlertDialogts
declare function useAlertDialog(input: AlertDialogInput | (() => AlertDialogInput), options?: UseAlertDialogOptions): UseAlertDialogResult;
Name
Kind
Type
Requirement
input
parameter
AlertDialogInput | (() => AlertDialogInput)
required
options
parameter
UseAlertDialogOptions
optional
return
return value
UseAlertDialogResult
n/a
Name
input
Kind
parameter
Type
AlertDialogInput | (() => AlertDialogInput)
Requirement
required
Name
options
Kind
parameter
Type
UseAlertDialogOptions
Requirement
optional
Name
return
Kind
return value
Type
UseAlertDialogResult
Requirement
n/a
DeclarationView source
useAlertDialogContextts
declare function useAlertDialogContext(partName: string): AlertDialogContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
AlertDialogContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
AlertDialogContextValue
Requirement
n/a
DeclarationView source
UseAlertDialogOptionsts
interface UseAlertDialogOptions {
readonly onOpenChange?: (detail: AlertDialogOpenChangeDetail) => void;
}
Name
Kind
Type
Requirement
onOpenChange
property
(detail: AlertDialogOpenChangeDetail) => void
optional
Name
onOpenChange
Kind
property
Type
(detail: AlertDialogOpenChangeDetail) => void
Requirement
optional
DeclarationView source
UseAlertDialogResultts
interface UseAlertDialogResult {
readonly service: AlertDialogService;
readonly connector: AlertDialogApi;
readonly scope: PartScope;
readonly snapshot: ShallowRef<AlertDialogSnapshot>;
readonly hasMounted: ShallowRef<boolean>;
}
Name
Kind
Type
Requirement
connector
property
AlertDialogApi
required
hasMounted
property
ShallowRef<boolean>
required
scope
property
PartScope
required
service
property
AlertDialogService
required
snapshot
property
ShallowRef<AlertDialogSnapshot>
required
Name
connector
Kind
property
Type
AlertDialogApi
Requirement
required
Name
hasMounted
Kind
property
Type
ShallowRef<boolean>
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
AlertDialogService
Requirement
required
Name
snapshot
Kind
property
Type
ShallowRef<AlertDialogSnapshot>
Requirement
required

@grassroot/ui-headless-angular/alert-dialog

Angular adapter

17 exports
View source packages/ui-headless/angular/src/alert-dialog/index.ts
DeclarationView source
ALERT_DIALOG_STOREts
export declare const ALERT_DIALOG_STORE: InjectionToken<AlertDialogStore>;
DeclarationView source
AlertDialogOpenChangeDetailts
export interface AlertDialogOpenChangeDetail {
readonly open: boolean;
readonly reason: AlertDialogChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
AlertDialogChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
AlertDialogChangeReason
Requirement
required

AlertDialogStore

interface
DeclarationView source
AlertDialogStorets
export interface AlertDialogStore {
readonly service: AlertDialogService;
readonly connector: AlertDialogApi;
readonly scope: PartScope;
readonly version: WritableSignal<number>;
start(): void;
stop(): void;
sync(input: AlertDialogInput): void;
bindOpenChange?(handler: (detail: {
open: boolean;
reason: AlertDialogChangeReason;
}) => void): void;
}
Name
Kind
Type
Requirement
bindOpenChange
method
((handler: (detail: { open: boolean; reason: AlertDialogChangeReason; }) => void) => void) | undefined
optional
connector
property
AlertDialogApi
required
scope
property
PartScope
required
service
property
AlertDialogService
required
start
method
() => void
required
stop
method
() => void
required
sync
method
(input: AlertDialogInput) => void
required
version
property
WritableSignal<number>
required
Name
bindOpenChange
Kind
method
Type
((handler: (detail: { open: boolean; reason: AlertDialogChangeReason; }) => void) => void) | undefined
Requirement
optional
Name
connector
Kind
property
Type
AlertDialogApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
AlertDialogService
Requirement
required
Name
start
Kind
method
Type
() => void
Requirement
required
Name
stop
Kind
method
Type
() => void
Requirement
required
Name
sync
Kind
method
Type
(input: AlertDialogInput) => void
Requirement
required
Name
version
Kind
property
Type
WritableSignal<number>
Requirement
required
DeclarationView source
createAlertDialogStorets
export declare function createAlertDialogStore(initialInput: AlertDialogInput, options?: CreateAlertDialogStoreOptions): AlertDialogStore;
Name
Kind
Type
Requirement
initialInput
parameter
AlertDialogInput
required
options
parameter
CreateAlertDialogStoreOptions
optional
return
return value
AlertDialogStore
n/a
Name
initialInput
Kind
parameter
Type
AlertDialogInput
Requirement
required
Name
options
Kind
parameter
Type
CreateAlertDialogStoreOptions
Requirement
optional
Name
return
Kind
return value
Type
AlertDialogStore
Requirement
n/a
DeclarationView source
CreateAlertDialogStoreOptionsts
export interface CreateAlertDialogStoreOptions {
readonly onOpenChange?: (detail: AlertDialogOpenChangeDetail) => void;
readonly onCommit?: () => void;
}
Name
Kind
Type
Requirement
onCommit
property
() => void
optional
onOpenChange
property
(detail: AlertDialogOpenChangeDetail) => void
optional
Name
onCommit
Kind
property
Type
() => void
Requirement
optional
Name
onOpenChange
Kind
property
Type
(detail: AlertDialogOpenChangeDetail) => void
Requirement
optional
DeclarationView source
DIALOG_PROJECTION_STOREts
export declare const DIALOG_PROJECTION_STORE: InjectionToken<DialogProjectionStore>;
DeclarationView source
GR_ALERT_DIALOG_DECLARATIONSts
export declare const GR_ALERT_DIALOG_DECLARATIONS: readonly [typeof GrAlertDialogRoot, typeof GrAlertDialogTrigger, typeof GrAlertDialogOpen, typeof GrAlertDialogBackdrop, typeof GrAlertDialogPositioner, typeof GrAlertDialogContent, typeof GrAlertDialogTitle, typeof GrAlertDialogDescription, typeof GrAlertDialogCloseTrigger];
DeclarationView source
GrAlertDialogBackdropts
export declare class GrAlertDialogBackdrop extends AlertDialogPartBase {
constructor();
static ɵfac: i0.ɵɵFactoryDeclaration<GrAlertDialogBackdrop, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrAlertDialogBackdrop, "[grAlertDialogBackdrop]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrAlertDialogBackdrop, "[grAlertDialogBackdrop]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrAlertDialogBackdrop, never>
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrAlertDialogBackdrop, "[grAlertDialogBackdrop]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrAlertDialogBackdrop, never>
Requirement
required
DeclarationView source
GrAlertDialogCloseTriggerts
export declare class GrAlertDialogCloseTrigger extends AlertDialogPartBase {
constructor();
static ɵfac: i0.ɵɵFactoryDeclaration<GrAlertDialogCloseTrigger, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrAlertDialogCloseTrigger, "[grAlertDialogCloseTrigger]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrAlertDialogCloseTrigger, "[grAlertDialogCloseTrigger]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrAlertDialogCloseTrigger, never>
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrAlertDialogCloseTrigger, "[grAlertDialogCloseTrigger]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrAlertDialogCloseTrigger, never>
Requirement
required
DeclarationView source
GrAlertDialogContentts
export declare class GrAlertDialogContent extends AlertDialogPartBase {
constructor();
static ɵfac: i0.ɵɵFactoryDeclaration<GrAlertDialogContent, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrAlertDialogContent, "[grAlertDialogContent]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrAlertDialogContent, "[grAlertDialogContent]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrAlertDialogContent, never>
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrAlertDialogContent, "[grAlertDialogContent]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrAlertDialogContent, never>
Requirement
required
DeclarationView source
GrAlertDialogDescriptionts
export declare class GrAlertDialogDescription extends AlertDialogPartBase {
constructor();
static ɵfac: i0.ɵɵFactoryDeclaration<GrAlertDialogDescription, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrAlertDialogDescription, "[grAlertDialogDescription], [grassrootDialogDescription]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrAlertDialogDescription, "[grAlertDialogDescription], [grassrootDialogDescription]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrAlertDialogDescription, never>
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrAlertDialogDescription, "[grAlertDialogDescription], [grassrootDialogDescription]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrAlertDialogDescription, never>
Requirement
required
DeclarationView source
GrAlertDialogOpents
export declare class GrAlertDialogOpen implements OnDestroy {
private readonly store;
private readonly template;
private readonly view;
private shown;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrAlertDialogOpen, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrAlertDialogOpen, "[grAlertDialogOpen]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrAlertDialogOpen, "[grAlertDialogOpen]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrAlertDialogOpen, never>
required
shown
property
any
required
store
property
any
required
template
property
any
required
view
property
any
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrAlertDialogOpen, "[grAlertDialogOpen]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrAlertDialogOpen, never>
Requirement
required
Name
shown
Kind
property
Type
any
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required
Name
template
Kind
property
Type
any
Requirement
required
Name
view
Kind
property
Type
any
Requirement
required
DeclarationView source
GrAlertDialogPositionerts
export declare class GrAlertDialogPositioner extends AlertDialogPartBase {
constructor();
static ɵfac: i0.ɵɵFactoryDeclaration<GrAlertDialogPositioner, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrAlertDialogPositioner, "[grAlertDialogPositioner]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrAlertDialogPositioner, "[grAlertDialogPositioner]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrAlertDialogPositioner, never>
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrAlertDialogPositioner, "[grAlertDialogPositioner]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrAlertDialogPositioner, never>
Requirement
required
DeclarationView source
GrAlertDialogRootts
export declare class GrAlertDialogRoot 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<AlertDialogOpenChangeDetail>;
private readonly injector;
private last;
private release?;
private registrationTicked;
readonly store: AlertDialogStore;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrAlertDialogRoot, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrAlertDialogRoot, "[grAlertDialogRoot]", 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
last
property
any
required
ngOnDestroy
method
() => void
required
open
property
import("@angular/core").InputSignal<boolean | undefined>
required
openChange
property
import("@angular/core").OutputEmitterRef<AlertDialogOpenChangeDetail>
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrAlertDialogRoot, "[grAlertDialogRoot]", 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<GrAlertDialogRoot, never>
required
registrationTicked
property
any
required
release
property
any
optional
store
property
AlertDialogStore
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
last
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<AlertDialogOpenChangeDetail>
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrAlertDialogRoot, "[grAlertDialogRoot]", 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<GrAlertDialogRoot, never>
Requirement
required
Name
registrationTicked
Kind
property
Type
any
Requirement
required
Name
release
Kind
property
Type
any
Requirement
optional
Name
store
Kind
property
Type
AlertDialogStore
Requirement
required
DeclarationView source
GrAlertDialogTitlets
export declare class GrAlertDialogTitle extends AlertDialogPartBase {
constructor();
static ɵfac: i0.ɵɵFactoryDeclaration<GrAlertDialogTitle, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrAlertDialogTitle, "[grAlertDialogTitle], [grassrootDialogTitle]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrAlertDialogTitle, "[grAlertDialogTitle], [grassrootDialogTitle]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrAlertDialogTitle, never>
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrAlertDialogTitle, "[grAlertDialogTitle], [grassrootDialogTitle]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrAlertDialogTitle, never>
Requirement
required
DeclarationView source
GrAlertDialogTriggerts
export declare class GrAlertDialogTrigger extends AlertDialogPartBase {
constructor();
static ɵfac: i0.ɵɵFactoryDeclaration<GrAlertDialogTrigger, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrAlertDialogTrigger, "[grAlertDialogTrigger]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrAlertDialogTrigger, "[grAlertDialogTrigger]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrAlertDialogTrigger, never>
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrAlertDialogTrigger, "[grAlertDialogTrigger]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrAlertDialogTrigger, never>
Requirement
required
DeclarationView source
provideAlertDialogStorets
export declare function provideAlertDialogStore(): Provider;
Name
Kind
Type
Requirement
return
return value
Provider
n/a
Name
return
Kind
return value
Type
Provider
Requirement
n/a

@grassroot/ui-headless-svelte/alert-dialog

Svelte adapter

14 exports
View source packages/ui-headless/svelte/src/alert-dialog/index.ts
DeclarationView source
AlertDialogBackdropts
export { default as AlertDialogBackdrop } from "./AlertDialogBackdrop.svelte"
DeclarationView source
AlertDialogCloseTriggerts
export { default as AlertDialogCloseTrigger } from "./AlertDialogCloseTrigger.svelte"

AlertDialogContent

component
DeclarationView source
AlertDialogContentts
export { default as AlertDialogContent } from "./AlertDialogContent.svelte"
DeclarationView source
AlertDialogContextValuets
export interface AlertDialogContextValue {
readonly service: AlertDialogService;
readonly connector: AlertDialogApi;
readonly scope: PartScope;
readonly version: () => number;
}
Name
Kind
Type
Requirement
connector
property
AlertDialogApi
required
scope
property
PartScope
required
service
property
AlertDialogService
required
version
property
() => number
required
Name
connector
Kind
property
Type
AlertDialogApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
AlertDialogService
Requirement
required
Name
version
Kind
property
Type
() => number
Requirement
required
DeclarationView source
AlertDialogDescriptionts
export { default as AlertDialogDescription } from "./AlertDialogDescription.svelte"
DeclarationView source
AlertDialogOpenChangeDetailts
export interface AlertDialogOpenChangeDetail {
readonly open: boolean;
readonly reason: AlertDialogChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
AlertDialogChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
AlertDialogChangeReason
Requirement
required
DeclarationView source
AlertDialogPositionerts
export { default as AlertDialogPositioner } from "./AlertDialogPositioner.svelte"

AlertDialogRoot

component
DeclarationView source
AlertDialogRootts
export { default as AlertDialogRoot } from "./AlertDialogRoot.svelte"

AlertDialogTitle

component
DeclarationView source
AlertDialogTitlets
export { default as AlertDialogTitle } from "./AlertDialogTitle.svelte"

AlertDialogTrigger

component
DeclarationView source
AlertDialogTriggerts
export { default as AlertDialogTrigger } from "./AlertDialogTrigger.svelte"
DeclarationView source
createAlertDialogts
export declare function createAlertDialog(inputGetter: () => AlertDialogInput, options?: UseAlertDialogOptions): UseAlertDialogResult;
Name
Kind
Type
Requirement
inputGetter
parameter
() => AlertDialogInput
required
options
parameter
UseAlertDialogOptions
optional
return
return value
UseAlertDialogResult
n/a
Name
inputGetter
Kind
parameter
Type
() => AlertDialogInput
Requirement
required
Name
options
Kind
parameter
Type
UseAlertDialogOptions
Requirement
optional
Name
return
Kind
return value
Type
UseAlertDialogResult
Requirement
n/a
DeclarationView source
useAlertDialogContextts
export declare function useAlertDialogContext(partName: string): AlertDialogContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
AlertDialogContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
AlertDialogContextValue
Requirement
n/a
DeclarationView source
UseAlertDialogOptionsts
export interface UseAlertDialogOptions {
readonly onOpenChange?: (detail: AlertDialogOpenChangeDetail) => void;
}
Name
Kind
Type
Requirement
onOpenChange
property
(detail: AlertDialogOpenChangeDetail) => void
optional
Name
onOpenChange
Kind
property
Type
(detail: AlertDialogOpenChangeDetail) => void
Requirement
optional
DeclarationView source
UseAlertDialogResultts
export interface UseAlertDialogResult {
readonly service: AlertDialogService;
readonly connector: AlertDialogApi;
readonly scope: PartScope;
readonly version: () => number;
}
Name
Kind
Type
Requirement
connector
property
AlertDialogApi
required
scope
property
PartScope
required
service
property
AlertDialogService
required
version
property
() => number
required
Name
connector
Kind
property
Type
AlertDialogApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
AlertDialogService
Requirement
required
Name
version
Kind
property
Type
() => number
Requirement
required

@grassroot/ui-headless-solid/alert-dialog

Solid adapter

23 exports
View source packages/ui-headless/solid/src/alert-dialog/index.ts
DeclarationView source
AlertDialogBackdropts
export declare function AlertDialogBackdrop(props: AlertDialogBackdropProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
AlertDialogBackdropProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
AlertDialogBackdropProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a
DeclarationView source
AlertDialogBackdropPropsts
export interface AlertDialogBackdropProps extends JSX.HTMLAttributes<HTMLDivElement>, Shared {
}
DeclarationView source
AlertDialogCloseTriggerts
export declare function AlertDialogCloseTrigger(props: AlertDialogCloseTriggerProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
AlertDialogCloseTriggerProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
AlertDialogCloseTriggerProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a
DeclarationView source
AlertDialogCloseTriggerPropsts
export interface AlertDialogCloseTriggerProps extends JSX.ButtonHTMLAttributes<HTMLButtonElement>, Shared {
}
DeclarationView source
AlertDialogContentts
export declare function AlertDialogContent(props: AlertDialogContentProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
AlertDialogContentProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
AlertDialogContentProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a
DeclarationView source
AlertDialogContentPropsts
export interface AlertDialogContentProps extends JSX.HTMLAttributes<HTMLDivElement>, Shared {
}
DeclarationView source
AlertDialogContextts
export declare const AlertDialogContext: import("solid-js").Context<AlertDialogContextValue | undefined>;
DeclarationView source
AlertDialogContextValuets
export interface AlertDialogContextValue {
readonly service: AlertDialogService;
readonly connector: AlertDialogApi;
readonly scope: PartScope;
readonly snapshot: Accessor<AlertDialogSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
AlertDialogApi
required
scope
property
PartScope
required
service
property
AlertDialogService
required
snapshot
property
Accessor<AlertDialogSnapshot>
required
Name
connector
Kind
property
Type
AlertDialogApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
AlertDialogService
Requirement
required
Name
snapshot
Kind
property
Type
Accessor<AlertDialogSnapshot>
Requirement
required
DeclarationView source
AlertDialogDescriptionts
export declare function AlertDialogDescription(props: AlertDialogDescriptionProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
AlertDialogDescriptionProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
AlertDialogDescriptionProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a
DeclarationView source
AlertDialogDescriptionPropsts
export interface AlertDialogDescriptionProps extends JSX.HTMLAttributes<HTMLParagraphElement>, Shared {
}
DeclarationView source
AlertDialogOpenChangeDetailts
export interface AlertDialogOpenChangeDetail {
readonly open: boolean;
readonly reason: AlertDialogChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
AlertDialogChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
AlertDialogChangeReason
Requirement
required
DeclarationView source
AlertDialogPositionerts
export declare function AlertDialogPositioner(props: AlertDialogPositionerProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
AlertDialogPositionerProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
AlertDialogPositionerProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a
DeclarationView source
AlertDialogPositionerPropsts
export interface AlertDialogPositionerProps extends JSX.HTMLAttributes<HTMLDivElement>, Shared {
}

AlertDialogRoot

function
DeclarationView source
AlertDialogRootts
export declare function AlertDialogRoot(props: AlertDialogRootProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
AlertDialogRootProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
AlertDialogRootProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a
DeclarationView source
AlertDialogRootPropsts
export interface AlertDialogRootProps {
readonly open?: AlertDialogInput["open"];
readonly defaultOpen?: AlertDialogInput["defaultOpen"];
readonly dismissable?: AlertDialogInput["dismissable"];
readonly onOpenChange?: (detail: AlertDialogOpenChangeDetail) => void;
readonly children?: JSX.Element;
}
Name
Kind
Type
Requirement
children
property
JSX.Element
optional
defaultOpen
property
AlertDialogInput["defaultOpen"]
optional
dismissable
property
AlertDialogInput["dismissable"]
optional
onOpenChange
property
(detail: AlertDialogOpenChangeDetail) => void
optional
open
property
AlertDialogInput["open"]
optional
Name
children
Kind
property
Type
JSX.Element
Requirement
optional
Name
defaultOpen
Kind
property
Type
AlertDialogInput["defaultOpen"]
Requirement
optional
Name
dismissable
Kind
property
Type
AlertDialogInput["dismissable"]
Requirement
optional
Name
onOpenChange
Kind
property
Type
(detail: AlertDialogOpenChangeDetail) => void
Requirement
optional
Name
open
Kind
property
Type
AlertDialogInput["open"]
Requirement
optional

AlertDialogTitle

function
DeclarationView source
AlertDialogTitlets
export declare function AlertDialogTitle(props: AlertDialogTitleProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
AlertDialogTitleProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
AlertDialogTitleProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a
DeclarationView source
AlertDialogTitlePropsts
export interface AlertDialogTitleProps extends JSX.HTMLAttributes<HTMLHeadingElement>, Shared {
}
DeclarationView source
AlertDialogTriggerts
export declare function AlertDialogTrigger(props: AlertDialogTriggerProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
AlertDialogTriggerProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
AlertDialogTriggerProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a
DeclarationView source
AlertDialogTriggerPropsts
export interface AlertDialogTriggerProps extends JSX.ButtonHTMLAttributes<HTMLButtonElement>, Shared {
}

useAlertDialog

function
DeclarationView source
useAlertDialogts
export declare function useAlertDialog(input: Accessor<AlertDialogInput>, options?: UseAlertDialogOptions): UseAlertDialogResult;
Name
Kind
Type
Requirement
input
parameter
Accessor<AlertDialogInput>
required
options
parameter
UseAlertDialogOptions
optional
return
return value
UseAlertDialogResult
n/a
Name
input
Kind
parameter
Type
Accessor<AlertDialogInput>
Requirement
required
Name
options
Kind
parameter
Type
UseAlertDialogOptions
Requirement
optional
Name
return
Kind
return value
Type
UseAlertDialogResult
Requirement
n/a
DeclarationView source
useAlertDialogContextts
export declare function useAlertDialogContext(partName: string): AlertDialogContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
AlertDialogContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
AlertDialogContextValue
Requirement
n/a
DeclarationView source
UseAlertDialogOptionsts
export interface UseAlertDialogOptions {
readonly onOpenChange?: (detail: AlertDialogOpenChangeDetail) => void;
}
Name
Kind
Type
Requirement
onOpenChange
property
(detail: AlertDialogOpenChangeDetail) => void
optional
Name
onOpenChange
Kind
property
Type
(detail: AlertDialogOpenChangeDetail) => void
Requirement
optional
DeclarationView source
UseAlertDialogResultts
export interface UseAlertDialogResult {
readonly service: AlertDialogService;
readonly connector: AlertDialogApi;
readonly scope: PartScope;
readonly snapshot: Accessor<AlertDialogSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
AlertDialogApi
required
scope
property
PartScope
required
service
property
AlertDialogService
required
snapshot
property
Accessor<AlertDialogSnapshot>
required
Name
connector
Kind
property
Type
AlertDialogApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
AlertDialogService
Requirement
required
Name
snapshot
Kind
property
Type
Accessor<AlertDialogSnapshot>
Requirement
required