drawer

Documentation

Index

• type ActionsProps
• type CloseButtonProps
• type ContentBodyProps
• type ContentProps
• type ContextProps
• type HeadProps
• type MainProps
• type PanelBodyProps
• type PanelContentProps
• type Props
• type SectionProps

Types

type ActionsProps

type ActionsProps struct {
	// ClassName - Additional classes added to the drawer actions button. Optional.
	ClassName string
	// Children - Actions to be rendered in the panel head. Optional.
	Children any //  // React.ReactNode
}

type CloseButtonProps

type CloseButtonProps struct {
	// ClassName - Additional classes added to the drawer close button outer <div>. Optional.
	ClassName string
	// OnClose - A callback for when the close button is clicked. Optional.
	OnClose func()
	// AriaLabel - Accessible label for the drawer close button. Optional.
	AriaLabel string
}

type ContentBodyProps

type ContentBodyProps struct {
	// ClassName - Additional classes added to the Drawer. Optional.
	ClassName string
	// Children - Content to be rendered in the drawer. Optional.
	Children any //  // React.ReactNode
	// HasPadding - Indicates if there should be padding around the drawer content body. Optional.
	HasPadding bool
}

type ContentProps

type ContentProps struct {
	// ClassName - Additional classes added to the Drawer. Optional.
	ClassName string
	// Children - Content to be rendered in the drawer. Optional.
	Children any //  // React.ReactNode
	// PanelContent - Content rendered in the drawer panel.
	PanelContent any //  // React.ReactNode
	// ColorVariant - Color variant of the background of the drawer panel. Optional.
	ColorVariant any //  /* any // DrawerColorVariant  | "light-200" | "default" */
}

type ContextProps

type ContextProps struct {
	// IsExpanded -
	IsExpanded bool
	// IsStatic -
	IsStatic bool
	// OnExpand - Optional.
	OnExpand func()
	// Position - Optional.
	Position string
	// DrawerRef - Optional.
	DrawerRef any //  // React.RefObject
	// IsInline -
	IsInline bool
}

type HeadProps

type HeadProps struct {
	// ClassName - Additional classes added to the drawer head. Optional.
	ClassName string
	// Children - Content to be rendered in the drawer head. Optional.
	Children any //  // React.ReactNode
	// HasNoPadding - Indicates if there should be no padding around the drawer panel body of the head. Optional.
	HasNoPadding bool
}

type MainProps

type MainProps struct {
	// ClassName - Additional classes added to the drawer main wrapper. Optional.
	ClassName string
	// Children - Content to be rendered in the drawer main wrapper. Optional.
	Children any //  // React.ReactNode
}

type PanelBodyProps

type PanelBodyProps struct {
	// ClassName - Additional classes added to the Drawer. Optional.
	ClassName string
	// Children - Content to be rendered in the drawer. Optional.
	Children any //  // React.ReactNode
	// HasNoPadding - Indicates if there should be no padding around the drawer panel body. Optional.
	HasNoPadding bool
}

type PanelContentProps

type PanelContentProps struct {
	// ClassName - Additional classes added to the drawer. Optional.
	ClassName string
	// Id - ID of the drawer panel. Optional.
	Id string
	// Children - Content to be rendered in the drawer panel. Optional.
	Children any //  // React.ReactNode
	// HasNoBorder - Flag indicating that the drawer panel should not have a border. Optional.
	HasNoBorder bool
	// IsResizable - Flag indicating that the drawer panel should be resizable. Optional.
	IsResizable bool
	// OnResize - Callback for resize end. Optional.
	OnResize func(width int, id string)
	// MinSize - The minimum size of a drawer, in either pixels or percentage. Optional.
	MinSize string
	// DefaultSize - The starting size of a resizable drawer, in either pixels or percentage. Optional.
	DefaultSize string
	// MaxSize - The maximum size of a drawer, in either pixels or percentage. Optional.
	MaxSize string
	// Increment - The increment amount for keyboard drawer resizing, in pixels. Optional.
	Increment int
	// ResizeAriaLabel - Aria label for the resizable drawer splitter. Optional.
	ResizeAriaLabel string
	// Widths - Width for drawer panel at various breakpoints. Overriden by resizable drawer minSize and defaultSize.
	// Optional.
	Widths map[string]string /* { default:{ width_25, width_33, width_50, width_66, width_75, width_100 }, lg:{ width_25, width_33, width_50, width_66, width_75, width_100 }, xl:{ width_25, width_33, width_50, width_66, width_75, width_100 }, 2xl:{ width_25, width_33, width_50, width_66, width_75, width_100 } } */
	// ColorVariant - Color variant of the background of the drawer panel. Optional.
	ColorVariant any //  /* any // DrawerColorVariant  | "light-200" | "default" */
	// DrawerContentRef - Optional.
	DrawerContentRef any //  // React.RefObject
}

type Props

type Props struct {
	// ClassName - Additional classes added to the Drawer. Optional.
	ClassName string
	// Children - Content rendered in the left hand panel. Optional.
	Children any //  // React.ReactNode
	// IsExpanded - Indicates if the drawer is expanded. Optional.
	IsExpanded bool
	// IsInline - Indicates if the content element and panel element are displayed side by side. Optional.
	IsInline bool
	// IsStatic - Indicates if the drawer will always show both content and panel. Optional.
	IsStatic bool
	// Position - Position of the drawer panel. Optional.
	Position any //  /* "left" | "right" | "bottom" */
	// OnExpand - Callback when drawer panel is expanded after waiting 250ms for animation to complete. Optional.
	OnExpand func()
}

type SectionProps

type SectionProps struct {
	// ClassName - Additional classes added to the drawer section. Optional.
	ClassName string
	// Children - Content to be rendered in the drawer section. Optional.
	Children any //  // React.ReactNode
	// ColorVariant - Color variant of the background of the drawer Section. Optional.
	ColorVariant any //  /* any // DrawerColorVariant  | "light-200" | "default" */
}