BetaBeta pública — Consulta las notas de lanzamiento
Documentación

Drawer

Slide-in panel from any screen edge.

Paquete
@solidiom/drawer
Versión
0.0.1-next.0
Estado
stable

Generado a partir del código fuente público del paquete.

API

Backdropcomponente

@solidiom/drawer — Headless slide-in drawer primitive. Parts: Root, Trigger, Backdrop, Content, Close, Title, Description.

                        Backdrop(props: DrawerBackdropProps): Element
                      

Propiedades

class?
string
style?
string | CSSProperties

Ver código fuente

Closecomponente

@solidiom/drawer — Headless slide-in drawer primitive. Parts: Root, Trigger, Backdrop, Content, Close, Title, Description.

                        Close(props: DrawerCloseProps): Element
                      

Propiedades

aria-label?
string — Accessible label. Required when children are icon-only/non-text.
class?
string
ref?
(el: HTMLButtonElement) => void
style?
string | CSSProperties

hijos: Element

Ver código fuente

Contentcomponente

@solidiom/drawer — Headless slide-in drawer primitive. Parts: Root, Trigger, Backdrop, Content, Close, Title, Description.

                        Content(props: DrawerContentProps): Element
                      

Propiedades

class?
string
ref?
(el: HTMLDivElement) => void
style?
string | CSSProperties

hijos: Element

Ver código fuente

Descriptioncomponente

@solidiom/drawer — Headless slide-in drawer primitive. Parts: Root, Trigger, Backdrop, Content, Close, Title, Description.

                        Description(props: DrawerDescriptionProps): Element
                      

Propiedades

class?
string

hijos: Element

Ver código fuente

DrawerBackdropPropsinterfaz

@solidiom/drawer — Headless slide-in drawer primitive. Parts: Root, Trigger, Backdrop, Content, Close, Title, Description.

Propiedades

class?
string
style?
string | CSSProperties

Ver código fuente

DrawerClosePropsinterfaz

@solidiom/drawer — Headless slide-in drawer primitive. Parts: Root, Trigger, Backdrop, Content, Close, Title, Description.

Propiedades

aria-label?
string — Accessible label. Required when children are icon-only/non-text.
class?
string
ref?
(el: HTMLButtonElement) => void
style?
string | CSSProperties

hijos: Element

Ver código fuente

DrawerContentPropsinterfaz

@solidiom/drawer — Headless slide-in drawer primitive. Parts: Root, Trigger, Backdrop, Content, Close, Title, Description.

Propiedades

class?
string
ref?
(el: HTMLDivElement) => void
style?
string | CSSProperties

hijos: Element

Ver código fuente

DrawerContextValueinterfaz

Propiedades

contentId
string
descriptionId
string
dismissible
boolean
modal
boolean
open
Accessor<boolean>
phase
Accessor<PresencePhase>
present
Accessor<boolean>
requestOpenChange
(next: boolean, details: ChangeDetails<DisclosureReason>) => void
shouldScaleBackground
boolean
side
DrawerSide
snapPoints
number[] | undefined
titleId
string
triggerId
string

Ver código fuente

DrawerDescriptionPropsinterfaz

@solidiom/drawer — Headless slide-in drawer primitive. Parts: Root, Trigger, Backdrop, Content, Close, Title, Description.

Propiedades

class?
string

hijos: Element

Ver código fuente

DrawerRootPropsinterfaz

@solidiom/drawer — Headless slide-in drawer primitive. Parts: Root, Trigger, Backdrop, Content, Close, Title, Description.

Propiedades

defaultOpen?
boolean — Default open state (uncontrolled).
dismissible?
boolean — Whether the drawer can be dismissed by swipe/click-outside. Default: true.
modal?
boolean — Whether the drawer is modal. Default: true.
onOpenChange?
(open: boolean, details: ChangeDetails<DisclosureReason>) => void — Called when open state change is requested.
open?
Accessor<boolean> — Controlled open state.
shouldScaleBackground?
boolean — Whether the background should scale when drawer opens. Default: false.
side?
DrawerSide — Edge from which the drawer slides. Default: "right".
snapPoints?
number[] — Discrete snap point positions (as percentages 0–100).

hijos: Element

Ver código fuente

DrawerSidetipo

The edge from which the drawer slides in.

Ver código fuente

DrawerTitlePropsinterfaz

@solidiom/drawer — Headless slide-in drawer primitive. Parts: Root, Trigger, Backdrop, Content, Close, Title, Description.

Propiedades

class?
string

hijos: Element

Ver código fuente

DrawerTriggerPropsinterfaz

@solidiom/drawer — Headless slide-in drawer primitive. Parts: Root, Trigger, Backdrop, Content, Close, Title, Description.

Propiedades

aria-label?
string — Accessible label. Required when children are icon-only/non-text.
class?
string
ref?
(el: HTMLButtonElement) => void
style?
string | CSSProperties

hijos: Element

Ver código fuente

Rootcomponente

@solidiom/drawer — Headless slide-in drawer primitive. Parts: Root, Trigger, Backdrop, Content, Close, Title, Description.

                        Root(props: DrawerRootProps): Element
                      

Propiedades

defaultOpen?
boolean — Default open state (uncontrolled).
dismissible?
boolean — Whether the drawer can be dismissed by swipe/click-outside. Default: true.
modal?
boolean — Whether the drawer is modal. Default: true.
onOpenChange?
(open: boolean, details: ChangeDetails<DisclosureReason>) => void — Called when open state change is requested.
open?
Accessor<boolean> — Controlled open state.
shouldScaleBackground?
boolean — Whether the background should scale when drawer opens. Default: false.
side?
DrawerSide — Edge from which the drawer slides. Default: "right".
snapPoints?
number[] — Discrete snap point positions (as percentages 0–100).

hijos: Element

Ver código fuente

Titlecomponente

@solidiom/drawer — Headless slide-in drawer primitive. Parts: Root, Trigger, Backdrop, Content, Close, Title, Description.

                        Title(props: DrawerTitleProps): Element
                      

Propiedades

class?
string

hijos: Element

Ver código fuente

Triggercomponente

@solidiom/drawer — Headless slide-in drawer primitive. Parts: Root, Trigger, Backdrop, Content, Close, Title, Description.

                        Trigger(props: DrawerTriggerProps): Element
                      

Propiedades

aria-label?
string — Accessible label. Required when children are icon-only/non-text.
class?
string
ref?
(el: HTMLButtonElement) => void
style?
string | CSSProperties

hijos: Element

Ver código fuente