BetaPublic beta — Read the release notes
Solidiom
Get Started
Documentation

Dialog

Modal or non-modal overlay window.

Package
@solidiom/dialog
Version
0.0.1-next.0
Status
stable

Generated from the package's public source.

API

Backdropcomponent

@solidiom/dialog — Headless modal dialog primitive. Parts: Root, Trigger, Portal, Backdrop, Content, Title, Description, Close.

                        Backdrop(props: DialogBackdropProps): Element

Props

class?
string
style?
string | CSSProperties

View source

Closecomponent

@solidiom/dialog — Headless modal dialog primitive. Parts: Root, Trigger, Portal, Backdrop, Content, Title, Description, Close.

                        Close(props: DialogCloseProps): Element

Props

ref?
(el: HTMLButtonElement) => void

children: Element

View source

Contentcomponent

@solidiom/dialog — Headless modal dialog primitive. Parts: Root, Trigger, Portal, Backdrop, Content, Title, Description, Close.

                        Content(props: DialogContentProps): Element

Props

class?
string
ref?
(el: HTMLDivElement) => void
style?
string | CSSProperties
trapFocus?
boolean — Disable focus trapping. Default: true (trapping enabled).

children: Element

View source

Descriptioncomponent

@solidiom/dialog — Headless modal dialog primitive. Parts: Root, Trigger, Portal, Backdrop, Content, Title, Description, Close.

                        Description(props: DialogDescriptionProps): Element

Props

class?
string

children: Element

View source

DialogBackdropPropsinterface

@solidiom/dialog — Headless modal dialog primitive. Parts: Root, Trigger, Portal, Backdrop, Content, Title, Description, Close.

Props

class?
string
style?
string | CSSProperties

View source

DialogClosePropsinterface

@solidiom/dialog — Headless modal dialog primitive. Parts: Root, Trigger, Portal, Backdrop, Content, Title, Description, Close.

Props

ref?
(el: HTMLButtonElement) => void

children: Element

View source

DialogContentPropsinterface

@solidiom/dialog — Headless modal dialog primitive. Parts: Root, Trigger, Portal, Backdrop, Content, Title, Description, Close.

Props

class?
string
ref?
(el: HTMLDivElement) => void
style?
string | CSSProperties
trapFocus?
boolean — Disable focus trapping. Default: true (trapping enabled).

children: Element

View source

DialogDescriptionPropsinterface

@solidiom/dialog — Headless modal dialog primitive. Parts: Root, Trigger, Portal, Backdrop, Content, Title, Description, Close.

Props

class?
string

children: Element

View source

DialogPortalPropsinterface

@solidiom/dialog — Headless modal dialog primitive. Parts: Root, Trigger, Portal, Backdrop, Content, Title, Description, Close.

children: Element

View source

DialogRootPropsinterface

@solidiom/dialog — Headless modal dialog primitive. Parts: Root, Trigger, Portal, Backdrop, Content, Title, Description, Close.

Props

defaultOpen?
boolean — Default open state (uncontrolled).
modal?
boolean — Whether the dialog is modal. Default: true.
onOpenChange?
(open: boolean, details: ChangeDetails<DisclosureReason>) => void — Called when open state change is requested.
open?
Accessor<boolean> — Controlled open state.

children: Element

View source

DialogTitlePropsinterface

@solidiom/dialog — Headless modal dialog primitive. Parts: Root, Trigger, Portal, Backdrop, Content, Title, Description, Close.

Props

class?
string

children: Element

View source

DialogTriggerPropsinterface

@solidiom/dialog — Headless modal dialog primitive. Parts: Root, Trigger, Portal, Backdrop, Content, Title, Description, Close.

Props

ref?
(el: HTMLButtonElement) => void

children: Element

View source

Portalcomponent

@solidiom/dialog — Headless modal dialog primitive. Parts: Root, Trigger, Portal, Backdrop, Content, Title, Description, Close.

                        Portal(props: DialogPortalProps): Element

children: Element

View source

Rootcomponent

@solidiom/dialog — Headless modal dialog primitive. Parts: Root, Trigger, Portal, Backdrop, Content, Title, Description, Close.

                        Root(props: DialogRootProps): Element

Props

defaultOpen?
boolean — Default open state (uncontrolled).
modal?
boolean — Whether the dialog is modal. Default: true.
onOpenChange?
(open: boolean, details: ChangeDetails<DisclosureReason>) => void — Called when open state change is requested.
open?
Accessor<boolean> — Controlled open state.

children: Element

View source

Titlecomponent

@solidiom/dialog — Headless modal dialog primitive. Parts: Root, Trigger, Portal, Backdrop, Content, Title, Description, Close.

                        Title(props: DialogTitleProps): Element

Props

class?
string

children: Element

View source

Triggercomponent

@solidiom/dialog — Headless modal dialog primitive. Parts: Root, Trigger, Portal, Backdrop, Content, Title, Description, Close.

                        Trigger(props: DialogTriggerProps): Element

Props

ref?
(el: HTMLButtonElement) => void

children: Element

View source