deepyr library

Classes

Accordion<T>
A "smart container" that manages a group of AccordionItems, ensuring only one can be open at a time.
AccordionItem<T>
Represents a single collapsible item within an Accordion.
AccordionStyling
A marker interface for any utility that can be passed to an AccordionItem's style list.
Alert
A component to inform users about important events, rendering a <div> with role="alert".
AlertStyling
A marker interface for any utility that can be passed to an Alert's style list.
Alignment
A utility class for applying alignment styles to flexbox and grid layouts.
Animation
A utility class for applying animation styles.
AnimationStyling
A marker interface for any utility that can be passed to a component's style list.
Avatar
A component for displaying a user's profile image or a placeholder.
AvatarGroup
A container for grouping multiple Avatar components.
AvatarStyling
A marker interface for any utility that can be passed to an Avatar's style list.
Badge
A small visual indicator or label, often used for counts, statuses, or categories. It typically renders as an HTML <span> with the 'badge' base class.
BadgeHelper
Helper methods for creating common badge patterns.
BadgeStyling
Marker interface for any utility that can be passed to a Badge's styles list.
BaseStyle<T extends BaseStyle<T>>
An abstract generic class representing a UI utility class (modifier).
BgUtil
A utility class for applying background styles, including colors and opacity.
BorderUtil
A utility class for applying border styles.
A component for showing the hierarchy of the current page in a navigation path.
A marker interface for any utility that can be passed to a Breadcrumbs' style list.
BrowserMockup
A component that renders a box styled to look like a browser window.
BrowserToolbar
A component representing the toolbar of a BrowserMockup.
Button
A clickable button component, used for actions in forms, dialogs, and more.
ButtonStyling
Marker interface for any utility that can be passed to a Button's modifiers list.
Card
A content container, often used to display information in a structured layout. It typically renders as an HTML <div> element with the 'card' base class. The modifiers list accepts instances of CardStyling (the interface), which includes specific card styles and general utility classes.
CardActions
A container for action elements (like buttons) within a Card. Typically renders as an HTML <div> element with the 'card-actions' class.
CardBody
The main content area of a Card. Typically renders as an HTML <div> element with the 'card-body' class.
CardHelper
Helper methods for creating common card patterns.
CardStyling
Marker interface for any utility that can be passed to a Card's modifiers list.
CardTitle
The title section of a Card. Typically renders as an HTML <h2> element with the 'card-title' class.
A "smart" container for displaying a scrollable list of items, such as images or cards.
CarouselStyling
A marker interface for any utility that can be passed to a Carousel's style list.
Chat
The main container for a single line of conversation.
ChatBubble
The main message container in a Chat component.
ChatBubbleStyling
A marker interface for utilities applicable to the ChatBubble component.
ChatFooter
A container for the footer of a chat bubble, typically containing delivery status.
ChatFooterStyling
A marker interface for utilities applicable to the ChatFooter component.
ChatHeader
A container for the header of a chat bubble, typically containing the author's name and a timestamp.
ChatHeaderStyling
A marker interface for utilities applicable to the ChatHeader component.
ChatImage
A container for the author's image in a Chat component.
ChatImageStyling
A marker interface for utilities applicable to the ChatImage component.
ChatStyling
A marker interface for utilities applicable to the main Chat container.
Checkbox
A checkbox component that allows users to select or deselect a value. It renders an <input type="checkbox">.
CheckboxStyling
A marker interface for any utility that can be passed to a Checkbox's style list.
CodeLine
A data class representing a single line of code within a MockupCode component.
Collapse
A component for showing and hiding content in a collapsible panel.
CollapseStyling
A marker interface for any utility that can be passed to a Collapse's style list.
Colors
A utility class for applying theme-based color styles.
CommonStyle<T extends CommonStyle<T>>
Base class for groups of general utility classes (e.g., Typography, Spacing, Effects).
Container
A generic container component, typically rendering as an HTML <div>.
Countdown
A component that displays a numerical value with a countdown transition effect.
CountdownStyling
A marker interface for any utility that can be passed to a Countdown's style list.
DaisyTheme
Represents a theme that can be used with DaisyUI.
Datalist
A component that renders an HTML <datalist> element.
Diff
A component for visually comparing two pieces of content ("before" and "after") side-by-side.
DiffItem1
Represents the first item (typically "before" or "left") in a Diff comparison.
DiffItem2
Represents the second item (typically "after" or "right") in a Diff comparison.
DiffResizer
Represents the draggable resizer handle within a Diff component.
DiffStyling
Marker interface for any utility that can be passed to a Diff's modifiers list.
Divider
A component used to separate content vertically or horizontally.
DividerStyling
A marker interface for any utility that can be passed to a Divider's style list.
Dock
A container for a bottom navigation bar that sticks to the bottom of the screen.
DockItem
A single interactive item within a Dock, typically a button.
DockItemStyling
A marker interface for any utility that can be passed to a DockItem's style list.
DockLabel
The text label for a DockItem.
DockLabelStyling
A marker interface for any utility that can be passed to a DockLabel's style list.
DockStyling
A marker interface for any utility that can be passed to a Dock's style list.
Drawer
A responsive slide-out panel that follows the controlled component pattern.
DrawerContent
The main content area of a Drawer.
DrawerSide
Represents the slide-out panel (sidebar) of a Drawer.
DrawerStyling
A marker interface for any utility that can be passed to a Drawer's style list.
A generic container that displays content when a trigger element is activated.
The content area of a Dropdown that appears when the dropdown is triggered.
Marker interface for any utility that can be passed to a DropdownContent's modifiers list.
Marker interface for any utility that can be passed to a Dropdown's modifiers list.
Effects
A utility class for applying visual effects like shadows, opacity, and border-radius.
Fab
A "smart container" for creating a Floating Action Button (FAB) with an optional "Speed Dial" menu that appears on focus or click.
FabAction
A structural component that wraps a single speed dial action, optionally with a label.
FabActionStyling
A marker interface for utilities that can be passed to a FabAction's style list. This exists for architectural consistency, as these components are styled via their children.
FabClose
A specialized component that provides a close button to replace the trigger when the FAB is open.
FabMainAction
A specialized component that provides a primary action to replace the trigger when the FAB is open.
FabStyling
A marker interface for any utility that can be passed to a Fab's style list.
Fieldset
A component that renders an HTML <fieldset> element, used as a container for grouping related form controls and labels.
FieldsetStyling
A marker interface for any utility that can be passed to a Fieldset's style list.
Figure
Represents an HTML <figure> element, typically used to encapsulate media like images, diagrams, or code snippets, optionally with a caption.
FileInput
A component for user file selection, rendering an HTML <input type="file">.
FileInputStyling
A marker interface for any utility that can be passed to a FileInput's style list.
Filter<T>
A "smart container" that groups FilterItem components to create a visually connected set of filter buttons.
FilterItem<T>
Represents a single selectable option within a Filter container.
FilterStyling
A marker interface for any utility that can be passed to a Filter's style list.
Flex
A utility class for controlling flexbox item behavior, including grow, shrink, and basis.
FontUtil
A utility class for applying font-specific styles.
A component for the bottom section of a site, typically containing links, copyright notices, and other information.
FooterAside
A semantic container for the branding section of a Footer.
FooterNav
A semantic container for a navigation column within a Footer.
FooterStyling
A marker interface for any utility that can be passed to a Footer's style list.
FooterTitle
A title component for a section or column within a Footer.
FormLabel
A component that renders an HTML <p> or <span> element with the 'label' base class, used for descriptive text within form containers.
FormLabelStyling
A marker interface for any utility that can be passed to a FormLabel's style list.
Grid
A utility class for applying CSS Grid layout styles.
Hero
A component for displaying a large box, often with a background image and text content.
HeroContent
The content container within a Hero component.
HeroOverlay
An overlay component used within a Hero to add a colored layer over the background, typically to improve text readability on a background image.
HeroStyling
A marker interface for any utility that can be passed to a Hero's style list.
HoverGallery
A container of images where the first is visible by default, and others are revealed sequentially as the user hovers horizontally across the component.
HoverGalleryStyling
A marker interface for any utility that can be passed to a HoverGallery's style list.
Icon
A component for displaying icons, typically from an icon font like Material Symbols.
IconStyling
Marker interface for any utility that can be passed to an Icon's modifiers list.
Indicator
A component to place a badge or item on the corner of another element.
IndicatorItem
An item, such as a Badge, to be placed on the corner of an element within an Indicator container.
IndicatorItemStyling
A marker interface for any utility that can be passed to an IndicatorItem's style list.
IndicatorStyling
A marker interface for any utility that can be passed to an Indicator's style list.
Input
A component for user text input, rendering an HTML <input> element.
InputStyling
A marker interface for any utility that can be passed to an Input's style list.
Interactivity
A utility class for applying interactivity styles.
InteractivityStyling
A marker interface for any utility that can be passed to a component's style list.
Join
A "smart" container for grouping multiple items like buttons or inputs.
JoinStyling
A marker interface for any utility that can be passed to a Join's style list.
Kbd
A component used to display keyboard shortcuts or key presses.
KbdStyling
A marker interface for any utility that can be passed to a Kbd's style list.
Label
A component that renders an HTML <label> element, specifically designed to act as a styled container for form elements as per DaisyUI patterns.
LabelStyling
A marker interface for any utility that can be passed to a Label's style list.
Layout
A comprehensive utility class for applying layout styles.
Legend
A component that renders an HTML <legend> element to provide a caption or title for its parent Fieldset.
LegendStyling
A marker interface for any utility that can be passed to a Legend's style list.
A component that styles an element to look like a hyperlink, typically adding an underline.
LinkStyling
A marker interface for any utility that can be passed to a Link's style list.
ListCol
A wrapper for content within a ListRow to define a column. This component supports layout modifiers to control its behavior within the row.
ListColStyling
A marker interface for any utility that can be passed to a ListCol's style list.
Listing
The main container for a list, typically rendering as a <ul> or <div>. It should contain one or more ListRow components.
ListingStyling
A marker interface for any utility that can be passed to a Listing's style list.
ListRow
Represents a single row within a Listing, typically rendering as an <li>. It acts as a "smart container" for ListCol components, automatically applying DaisyUI's default layout behavior.
ListRowStyling
A marker interface for any utility that can be passed to a ListRow's style list.
Loading
A component that shows an animation to indicate that something is loading.
LoadingStyling
A marker interface for any utility that can be passed to a Loading's style list.
Mask
A component that crops its content to a specific shape.
MaskStyling
A marker interface for any utility that can be passed to a Mask's style list.
A container for a list of navigation links, which can be arranged vertically or horizontally.
The content element for a JavaScript-controlled collapsible submenu.
The trigger element for a JavaScript-controlled collapsible submenu.
A hoverable submenu that expands on mouseover, used in horizontal menus.
An interactive item within a Menu.
Marker interface for any utility that can be passed to a menu item's (like MenuItem, MenuTitle) modifiers list.
Marker interface for any utility that can be passed to a Menu's modifiers list.
A collapsible submenu using <details> and <summary>.
A non-interactive title or heading within a Menu.
MockupBrowserStyling
A marker interface for any utility that can be passed to a BrowserMockup's style list.
MockupCode
A component that shows a block of code in a box styled like a code editor.
MockupCodeStyling
A marker interface for any utility that can be passed to a MockupCode's style list.
MockupPhone
A component that renders a box styled to look like an Phone mockup.
MockupPhoneStyling
A marker interface for any utility that can be passed to a MockupPhone's style list.
MockupWindow
A component that renders a box styled to look like an operating system window, complete with a title bar and window controls generated via CSS.
MockupWindowStyling
A marker interface for any utility that can be passed to a MockupWindow's style list.
A modal component that shows a dialog or box when triggered.
ModalAction
The action area of a modal, typically containing buttons.
ModalBackdrop
A backdrop that covers the screen when the modal is open.
The content container of a modal.
ModalStyling
Marker interface for any utility that can be passed to a Modal's modifiers list.
ModalToggle
A hidden checkbox that controls the modal state (legacy method).
MultiUsedStyle
A navigation bar component, typically placed at the top of a page or section. It provides a container for branding, navigation links, and actions.
Represents the center section of a Navbar. Used for primary navigation links or titles. Renders as an HTML <div> with the 'navbar-center' class.
Represents the ending section (typically right-aligned or bottom for vertical) of a Navbar. Used for action items, user profile, or secondary navigation. Renders as an HTML <div> with the 'navbar-end' class.
Represents the starting section (typically left-aligned or top for vertical) of a Navbar. Used for branding, logos, or hamburger menus. Renders as an HTML <div> with the 'navbar-start' class.
Marker interface for any utility that can be passed to a Navbar's modifiers list.
Placement
A utility class for applying positioning coordinate styles (top, right, bottom, left).
Position
A utility class for controlling the CSS position property.
PrefixModifier
Representing the Tailwind CSS prefix modifiers.
Progress
A component to show the progress of a task or the passing of time.
ProgressStyling
A marker interface for any utility that can be passed to a Progress's style list.
RadialProgress
A component to show the progress of a task in a circular "pie chart" style.
RadialProgressStyling
A marker interface for any utility that can be passed to a RadialProgress's style list.
Radio<T>
A radio button component that allows users to select one option from a group. It renders an <input type="radio">.
RadioStyling
A marker interface for any utility that can be passed to a Radio's style list.
Range
A range slider component used to select a value by sliding a handle. It renders an <input type="range">.
RangeStyling
A marker interface for any utility that can be passed to a Range's style list.
Rating
A high-level, controlled component for creating a uniform rating scale.
RatingContainer
A "smart" container for RatingItem components that renders <div class="rating">.
RatingItem
A single, stylable item within a RatingContainer, rendering an <input type="radio">.
RatingStyling
A marker interface for any utility that can be passed to a Rating's style list.
Select
A dropdown select component, rendering an HTML <select> element.
SelectStyling
A marker interface for any utility that can be passed to a Select's style list.
Size
Utilities for setting the width of an element.
Skeleton
A component that displays a placeholder preview of your content before it loads.
SkeletonStyling
A marker interface for any utility that can be passed to a Skeleton's style list.
Spacing
Utilities for controlling spacing (margin and padding).
Stack
A layout component that visually places its children on top of each other.
StackStyling
A marker interface for any utility that can be passed to a Stack's style list.
Stat
A single block to display statistical data about a topic.
StatActions
The actions part of a Stat component, for buttons or other interactive elements.
StatActionsStyling
A marker interface for any utility that can be passed to a StatActions's style list.
StatDesc
The description part of a Stat component (e.g., "21% more than last month").
StatDescStyling
A marker interface for any utility that can be passed to a StatDesc's style list.
StatFigure
The figure/icon part of a Stat component.
StatFigureStyling
A marker interface for any utility that can be passed to a StatFigure's style list.
Stats
A container for showing numbers and data in a block. It groups multiple Stat components.
StatsStyling
A marker interface for any utility that can be passed to a Stats's style list.
StatStyling
A marker interface for any utility that can be passed to a Stat's style list.
StatTitle
The title part of a Stat component (e.g., "Total Likes").
StatTitleStyling
A marker interface for any utility that can be passed to a StatTitle's style list.
Status
A small visual icon to show the current status of an element, like online, offline, or an error state.
StatusStyling
A marker interface for any utility that can be passed to a Status's style list.
StatValue
The main value part of a Stat component (e.g., "25.6K").
StatValueStyling
A marker interface for any utility that can be passed to a StatValue's style list.
Step
Represents a single step within a Steps container.
StepIcon
A wrapper for a custom icon or element to be placed inside a Step.
StepIconStyling
A marker interface for any utility that can be passed to a StepIcon's style list.
Steps
A container for a list of Step components to show progress in a process.
StepsStyling
A marker interface for any utility that can be passed to a Steps's style list.
StepStyling
A marker interface for any utility that can be passed to a Step's style list.
Styling
A base interface for all UI utility classes (modifiers).
Swap
A component that toggles between two visual states ("on" and "off") when clicked. It can also represent a third, indeterminate state.
SwapStyling
Marker interface for any utility that can be passed to a Swap's modifiers list.
Tab
Represents a single tab item within a Tabs container.
TabContent
Represents the content area associated with a Tab when using the radio input pattern.
Table
A component for displaying tabular data, rendering a <table> element.
TableStyling
A marker interface for any utility that can be passed to a Table's style list.
Tabs
A container for a set of Tab components, allowing users to switch between different views or sections of content.
TabsStyling
Marker interface for utilities passed to Tabs.
TabStyling
Marker interface for any utility that can be passed to an individual Tab's modifiers list.
Textarea
A component for multi-line text input, rendering an HTML <textarea> element.
TextareaStyling
A marker interface for any utility that can be passed to a Textarea's style list.
TextUtil
A utility class for applying text-specific styles, focusing on appearance and layout.
ThemeController
Abstract base class for DaisyUI theme controller input elements.
ThemeControllerCheckbox
A ThemeController rendered as an HTML <input type="checkbox">. Can be styled as a standard checkbox or a toggle switch.
ThemeControllerRadio
A ThemeController rendered as an HTML <input type="radio">.
ThemeControllerStyling
Marker interface for any utility that can be passed to a ThemeController's modifiers list.
ThemeService
A singleton service to manage theme switching and persistence for DaisyUI themes.
Timeline
A "smart container" that displays a list of events in chronological order.
TimelineContentStyling
A marker interface for any utility that can be passed to a TimelineStart or TimelineEnd component's style list.
TimelineEnd
The content on the "end" side of a TimelineItem (right in vertical, bottom in horizontal).
TimelineItem
A structural component representing a single event or item within a Timeline.
TimelineMiddle
The central icon or marker in a TimelineItem.
TimelineStart
The content on the "start" side of a TimelineItem (left in vertical, top in horizontal).
TimelineStyling
A marker interface for any utility that can be passed to a Timeline's style list.
Toast
A container for stacking notification elements, positioned on a corner of the page.
ToastStyling
A marker interface for any utility that can be passed to a Toast's style list.
Toggle
A checkbox styled to look like a switch button. It renders an <input type="checkbox">.
ToggleStyling
A marker interface for any utility that can be passed to a Toggle's style list.
Tooltip
A component that shows a message when hovering over an element.
TooltipContent
A container for rich HTML content to be used within a Tooltip.
TooltipStyling
A marker interface for any utility that can be passed to a Tooltip's style list. This allows for type-safe application of styles for color, placement, and behavior.
Transform
A utility class for applying CSS transform properties.
Transition
A utility class for applying CSS transition and animation properties.
UiComponent
The abstract base class for all stateless UI components in the deepyr library.
UiComponentAttributes
A builder class for creating a map of HTML attributes.
UiEventData
Base class for event data
UiKeyboardEventData
UiMouseEventData
ValidatorHint
A component that displays a validation message for a form field.
ValidatorHintStyling
A marker interface for any utility that can be passed to a ValidatorHint's style list.

Enums

Breakpoint
ButtonHtmlType
Defines the valid HTML type attributes for a button element.
CollapseMethod
Defines the activation mechanism for a Collapse component.
DrawerIs
A type-safe representation of DaisyUI's custom is-drawer-open: and is-drawer-close: variants. This allows for conditional styling of elements within a DrawerSide based on the drawer's state, using pure CSS.
Defines the underlying HTML/CSS mechanism for a Dropdown component.
FilterMethod
Defines the underlying HTML structure and reset mechanism for a Filter component.
Group
A prefix modifier for styling an element based on the state of a parent marked with the Layout.group utility.
Is
LabelContainerType
An enum defining the contextual container roles a Label can adopt based on DaisyUI patterns.
Media
PrefixModifierType
An enum representing the semantic category of a PrefixModifier.

Mixins

Breakpoints<T extends BaseStyle<T>>
A mixin that provides convenience getters for applying responsive breakpoints to a BaseStyle instance.

Extensions

DeepyrNullableUtilityGroupIterableExtensions on Iterable<Styling>?
DeepyrStylingExtensions on Styling
Extension methods for a single Deepyr UI utility class.
DeepyrUtilityGroupIterableExtensions on Iterable<Styling>
Extension methods for working with Deepyr UI utility groups.

Functions

blurActiveElement() → void
A safe Dart wrapper for the JS interop function. It ensures the code only runs on the client-side, preventing errors during server-side rendering (SSR).
createEventHandler(void handler(Event event)) → EventCallback
createMouseEventHandler(void handler(MouseEvent event)) → EventCallback

Typedefs

UiEventHandler = void Function(Event event)
UiInputEventHandler = void Function(String value)
UiKeyboardEventHandler = void Function(KeyboardEvent event)
UiMouseEventHandler = void Function(MouseEvent event)