Skip to main content

Module components

Module components 

Source

Macros§

define_theme
get_theme

Structs§

Accordion
A container that expands/collapses vertically when pressed.
AccordionTheme
Theming properties for the Accordion component.
AccordionThemePartial
You can use this to change a theme for only one component, with the theme property.
AccordionThemePreference
Theming properties for the Accordion component.
ActivableRouterouter
ActivableRouteContext
AnimatedRouter
ArrowIcon
Attached
A container that attaches elements to the top, bottom, left, or right of an inner element.
Button
Simply a button.
ButtonColorsTheme
Theming properties for the ButtonColors component.
ButtonColorsThemePartial
You can use this to change a theme for only one component, with the theme property.
ButtonColorsThemePreference
Theming properties for the ButtonColors component.
ButtonLayoutTheme
Theming properties for the ButtonLayout component.
ButtonLayoutThemePartial
You can use this to change a theme for only one component, with the theme property.
ButtonLayoutThemePreference
Theming properties for the ButtonLayout component.
ButtonSegment
A segment button to be used within a SegmentedButton.
ButtonSegmentTheme
Theming properties for the ButtonSegment component.
ButtonSegmentThemePartial
You can use this to change a theme for only one component, with the theme property.
ButtonSegmentThemePreference
Theming properties for the ButtonSegment component.
Calendarcalendar
A calendar component for date selection.
CalendarDatecalendar
A simple date representation for the calendar.
CalendarThemecalendar
Theming properties for the Calendar component.
CalendarThemePartialcalendar
You can use this to change a theme for only one component, with the theme property.
CalendarThemePreferencecalendar
Theming properties for the Calendar component.
Canvas
CanvasElement
Card
A container component with styling variants.
CardColorsTheme
Theming properties for the CardColors component.
CardColorsThemePartial
You can use this to change a theme for only one component, with the theme property.
CardColorsThemePreference
Theming properties for the CardColors component.
CardLayoutTheme
Theming properties for the CardLayout component.
CardLayoutThemePartial
You can use this to change a theme for only one component, with the theme property.
CardLayoutThemePreference
Theming properties for the CardLayout component.
Checkbox
Checkbox component.
CheckboxTheme
Theming properties for the Checkbox component.
CheckboxThemePartial
You can use this to change a theme for only one component, with the theme property.
CheckboxThemePreference
Theming properties for the Checkbox component.
Chip
Chip component.
ChipTheme
Theming properties for the Chip component.
ChipThemePartial
You can use this to change a theme for only one component, with the theme property.
ChipThemePreference
Theming properties for the Chip component.
CircularLoader
Circular loader component.
CircularLoaderTheme
Theming properties for the CircularLoader component.
CircularLoaderThemePartial
You can use this to change a theme for only one component, with the theme property.
CircularLoaderThemePreference
Theming properties for the CircularLoader component.
ColorPicker
HSV-based gradient color picker.
ColorPickerTheme
Theming properties for the ColorPicker component.
ColorPickerThemePartial
You can use this to change a theme for only one component, with the theme property.
ColorPickerThemePreference
Theming properties for the ColorPicker component.
ColorsSheet
ContextMenu
Context for managing a global context menu.
CursorArea
A container that changes the cursor icon when hovered.
DragZone
Properties for the DragZone component.
Draggable
DraggableCanvas
A canvas container that allows draggable elements within it.
DropZone
FloatingTab
FloatingTabTheme
Theming properties for the FloatingTab component.
FloatingTabThemePartial
You can use this to change a theme for only one component, with the theme property.
FloatingTabThemePreference
Theming properties for the FloatingTab component.
Gifgif
GifElementgif
GifViewergif
GIF viewer component.
ImageViewer
Image viewer component.
Input
Small box to write some text.
InputColorsTheme
Theming properties for the InputColors component.
InputColorsThemePartial
You can use this to change a theme for only one component, with the theme property.
InputColorsThemePreference
Theming properties for the InputColors component.
InputLayoutTheme
Theming properties for the InputLayout component.
InputLayoutThemePartial
You can use this to change a theme for only one component, with the theme property.
InputLayoutThemePreference
Theming properties for the InputLayout component.
InputValidator
Link
LinkTheme
Theming properties for the Link component.
LinkThemePartial
You can use this to change a theme for only one component, with the theme property.
LinkThemePreference
Theming properties for the Link component.
MarkdownViewermarkdown
Markdown viewer component.
MarkdownViewerThememarkdown
Theming properties for the MarkdownViewer component.
MarkdownViewerThemePartialmarkdown
You can use this to change a theme for only one component, with the theme property.
MarkdownViewerThemePreferencemarkdown
Theming properties for the MarkdownViewer component.
Menu
Floating menu container.
MenuButton
Like a button, but for Menus.
MenuContainer
Container for menu items with proper spacing and layout.
MenuContainerTheme
Theming properties for the MenuContainer component.
MenuContainerThemePartial
You can use this to change a theme for only one component, with the theme property.
MenuContainerThemePreference
Theming properties for the MenuContainer component.
MenuGroup
MenuItem
A clickable menu item with hover and focus states.
MenuItemTheme
Theming properties for the MenuItem component.
MenuItemThemePartial
You can use this to change a theme for only one component, with the theme property.
MenuItemThemePreference
Theming properties for the MenuItem component.
NativeRouter
OverflowedContent
Animate the content of a container when the content overflows.
Panel
Popup
Floating popup / dialog.
PopupBackground
Popup background wrapper.
PopupButtons
Popup buttons container.
PopupContent
Popup content wrapper.
PopupTheme
Theming properties for the Popup component.
PopupThemePartial
You can use this to change a theme for only one component, with the theme property.
PopupThemePreference
Theming properties for the Popup component.
PopupTitle
Popup title.
Portal
PortalsMap
ProgressBar
ProgressBar component.
ProgressBarTheme
Theming properties for the ProgressBar component.
ProgressBarThemePartial
You can use this to change a theme for only one component, with the theme property.
ProgressBarThemePreference
Theming properties for the ProgressBar component.
RadioItem
Radio component.
RadioItemTheme
Theming properties for the RadioItem component.
RadioItemThemePartial
You can use this to change a theme for only one component, with the theme property.
RadioItemThemePreference
Theming properties for the RadioItem component.
RenderCallback
ResizableContainer
A container with resizable panels.
ResizableContext
ResizableDraggable
ResizableHandle
ResizableHandleTheme
Theming properties for the ResizableHandle component.
ResizableHandleThemePartial
You can use this to change a theme for only one component, with the theme property.
ResizableHandleThemePreference
Theming properties for the ResizableHandle component.
ResizablePanel
ScrollBar
ScrollBarTheme
Theming properties for the ScrollBar component.
ScrollBarThemePartial
You can use this to change a theme for only one component, with the theme property.
ScrollBarThemePreference
Theming properties for the ScrollBar component.
ScrollConfig
ScrollController
ScrollRequest
ScrollThumb
ScrollView
Scrollable area with bidirectional support and scrollbars.
SegmentedButton
A container for grouping ButtonSegments together.
SegmentedButtonTheme
Theming properties for the SegmentedButton component.
SegmentedButtonThemePartial
You can use this to change a theme for only one component, with the theme property.
SegmentedButtonThemePreference
Theming properties for the SegmentedButton component.
Select
Select between different items component.
SelectTheme
Theming properties for the Select component.
SelectThemePartial
You can use this to change a theme for only one component, with the theme property.
SelectThemePreference
Theming properties for the Select component.
SelectableText
SideBarItem
Button designed for sidebars.
SideBarItemTheme
Theming properties for the SideBarItem component.
SideBarItemThemePartial
You can use this to change a theme for only one component, with the theme property.
SideBarItemThemePreference
Theming properties for the SideBarItem component.
Slider
Slider component.
SliderTheme
Theming properties for the Slider component.
SliderThemePartial
You can use this to change a theme for only one component, with the theme property.
SliderThemePreference
Theming properties for the Slider component.
SubMenu
Create sub menus inside a Menu.
Switch
Toggle between true and false.
SwitchColorsTheme
Theming properties for the SwitchColors component.
SwitchColorsThemePartial
You can use this to change a theme for only one component, with the theme property.
SwitchColorsThemePreference
Theming properties for the SwitchColors component.
SwitchLayoutTheme
Theming properties for the SwitchLayout component.
SwitchLayoutThemePartial
You can use this to change a theme for only one component, with the theme property.
SwitchLayoutThemePreference
Theming properties for the SwitchLayout component.
Table
A table component with rows and columns.
TableArrow
TableBody
TableCell
TableConfig
TableHead
TableHead props (manual)
TableRow
TableTheme
Theming properties for the Table component.
TableThemePartial
You can use this to change a theme for only one component, with the theme property.
TableThemePreference
Theming properties for the Table component.
Theme
TickIcon
Tile
Example
TitlebarButtontitlebar
Titlebar button component.
TitlebarButtonThemetitlebar
Theming properties for the TitlebarButton component.
TitlebarButtonThemePartialtitlebar
You can use this to change a theme for only one component, with the theme property.
TitlebarButtonThemePreferencetitlebar
Theming properties for the TitlebarButton component.
Tooltip
Tooltip component.
TooltipContainer
TooltipTheme
Theming properties for the Tooltip component.
TooltipThemePartial
You can use this to change a theme for only one component, with the theme property.
TooltipThemePreference
Theming properties for the Tooltip component.
Uriremote-asset
The URI component of a request.
VirtualScrollView
One-direction scrollable area that dynamically builds and renders items based in their size and current available size, this is intended for apps using large sets of data that need good performance.

Enums§

AnimatedRouterContext
AttachedPosition
Position where the attached element will be placed relative to the inner element.
ButtonLayoutVariant
ButtonSegmentStatus
Identifies the current status of the ButtonSegments.
ButtonStyleVariant
CardLayoutVariant
Layout variants for the Card component.
CardStyleVariant
Style variants for the Card component.
ChipStatus
GifSourcegif
URI
HandleStatus
Describes the current status of the Handle.
ImageSource
Supported image sources for ImageViewer.
InputLayoutVariant
InputMode
InputStatus
InputStyleVariant
LinkTooltip
Tooltip configuration for the Link component.
OrderDirection
OverflowedContentDirection
The direction in which OverflowedContent scrolls.
OverflowedContentStart
Where the OverflowedContent animation starts from.
PanelSize
Sizing mode for a resizable panel.
Preference
ResizableError
ScrollEvent
ScrollPosition
SelectStatus
SelectableTextStatus
Current status of the SelectableText.
SideBarItemStatus
SurfaceThemeIndicator
Indicates what type of surface to use.
SwitchLayoutVariant
TabStatus
Current status of the Tab.
TileStatus
TitlebarActiontitlebar
WeekStartcalendar
Determines which day the week starts on.

Constants§

DARK_COLORS
LIGHT_COLORS

Traits§

AccordionThemePartialExt
ButtonColorsThemePartialExt
ButtonLayoutThemePartialExt
ButtonSegmentThemePartialExt
CalendarThemePartialExtcalendar
CardColorsThemePartialExt
CardLayoutThemePartialExt
CheckboxThemePartialExt
ChipThemePartialExt
CircularLoaderThemePartialExt
ColorPickerThemePartialExt
FloatingTabThemePartialExt
FromPreference
InputColorsThemePartialExt
InputLayoutThemePartialExt
LabelThemeExt
LinkThemePartialExt
MarkdownViewerThemePartialExtmarkdown
MenuContainerThemePartialExt
MenuItemThemePartialExt
ParagraphThemeExt
PopupThemePartialExt
ProgressBarThemePartialExt
RadioItemThemePartialExt
RectThemeExt
ResizableHandleThemePartialExt
ScrollBarThemePartialExt
SegmentedButtonThemePartialExt
SelectThemePartialExt
SideBarItemThemePartialExt
SliderThemePartialExt
SvgThemeExt
SwitchColorsThemePartialExt
SwitchLayoutThemePartialExt
TableThemePartialExt
TitlebarButtonThemePartialExttitlebar
TooltipThemePartialExt

Functions§

canvas
Create a new Canvas element.
dark_theme
Dark theme with all built-in component themes registered.
gallery
get_theme_or_default
Subscribe to Theme changes, default theme will be used if there is no provided Theme.
light_theme
Light theme with all built-in component themes registered.
radio
use_activable_route
use_animated_router
Shortcut to get access to the AnimatedRouterContext.
use_init_root_theme
Provides a custom Theme at the root scope. If a Theme context already exists at the root, it reuses it instead of creating a new one.
use_init_surface_theme_indicator
Provide a SurfaceThemeIndicator down to the components.
use_init_theme
Provides a custom Theme. If a Theme context already exists, it reuses it instead of creating a new one.
use_scroll_controller
use_surface_theme_indicator
Get the inherited SurfaceThemeIndicator.
use_theme
Subscribe to Theme changes.