aliases library

Classes

a
The <a> HTML element (or anchor element), with its href attribute, creates a hyperlink to web pages, files, email addresses, locations in the same page, or anything else a URL can address.
AccordionItemProps
Accordion item data.
AccordionProps
Accordion component properties.
ActionSheetItem
An action item for ArcaneActionSheet.
AlertDialogProps
Alert dialog component properties.
AlertProps
Alert component properties.
Angle
The <angle> CSS data type represents an angle value expressed in degrees, gradians, radians, or turns. It is used by CSS functions like rotate() and in gradient angles.
Animation
The animation CSS property applies an animation between styles.
AppBinding
Main class that provide services (also known as "bindings").
ArcaneAccordion
Collapsible accordion component.
ArcaneAccordionItem
Accordion item data model.
ArcaneActionSheet
Action sheet with a list of actions (mobile-style).
ArcaneAlert
Inline alert component for important messages that need user attention.
ArcaneAlertDialog
Simple alert dialog with single dismiss action.
ArcaneApp
Root application component for Arcane Jaspr apps.
ArcaneAspectRatio
A container that maintains a specific aspect ratio.
ArcaneAuthProvider
Stub auth provider for non-web platforms.
ArcaneAvatar
Avatar component for displaying user images or initials.
ArcaneAvatarBadge
Badge displayed on an avatar.
ArcaneAvatarGroup
Avatar group for stacking multiple avatars with overlap.
ArcaneBodyText
Body text component.
ArcaneBorder
Border for ArcaneBoxDecoration.
ArcaneBottomFloatingBanner
Bottom floating banner that slides up with optional countdown timer.
ArcaneBox
A container component with enum-based styling.
ArcaneBoxDecoration
Box decoration for ArcaneContainer.
ArcaneBreadcrumbs
Navigation breadcrumbs component.
ArcaneBulletList
Styled unordered list wrapper.
ArcaneButton
A styled button component.
ArcaneButtonGroup
A group of related buttons or controls.
ArcaneButtonPanel
A panel component for action buttons, typically used in dialogs or footers.
ArcaneCalendar
A calendar component for date selection.
ArcaneCard
Card component with consistent styling and multiple variants.
ArcaneCardCarousel
Horizontally scrollable widget container with edge fading.
ArcaneCardCarouselTheme
Theme configuration for CardCarousel widgets.
ArcaneCarouselSection
Marketing section with an infinite carousel.
ArcaneCatImage
A random cat image from cataas.com.
ArcaneCenter
A center alignment component.
ArcaneChart
ArcaneChartPoint
ArcaneCheckbox
Checkbox input component.
ArcaneCircularProgress
Circular progress indicator.
ArcaneCodeBlock
Styled preformatted text wrapper with style presets.
ArcaneColors
Color design tokens as CSS variable references.
ArcaneColumn
A column layout component (vertical flex).
ArcaneCombobox<T>
An autocomplete combobox with search filtering.
ArcaneCommand
Command palette for quick actions and navigation.
ArcaneCommonStyles
Common style patterns.
ArcaneConfirmDialog
Confirmation dialog with confirm/cancel actions.
ArcaneContainer
A container component with styling options.
ArcaneContextMenu
Context menu that appears on right-click.
ArcaneCornerPromoToast
A corner toast-style promo notification that slides in from a corner.
ArcaneCycleButton<T>
A button that cycles through a list of values on each click.
ArcaneDataColumn<T>
Column definition for ArcaneDataTable.
ArcaneDataTable<T>
Data table component for displaying tabular data.
ArcaneDatePicker
A date picker input with calendar dropdown.
ArcaneDialog
Modal dialog component with title, content, and actions.
ArcaneDirection
ArcaneDisclosure
Disclosure widget using native HTML details/summary elements.
ArcaneDisclosureGroup
Group of disclosure widgets.
ArcaneDisclosureItem
Item in an ArcaneDisclosureGroup.
ArcaneDiv
Styled div wrapper.
ArcaneDrawer
Slide-in drawer/sheet panel.
ArcaneDropdownDivider
Divider for dropdown menus - subtle horizontal line.
ArcaneDropdownItem
Dropdown item component with multiple style variants.
ArcaneDropdownMenu
Dropdown menu component.
ArcaneDropdownSectionHeader
Section header for dropdown menus - compact uppercase label.
ArcaneEffects
Effects design tokens.
ArcaneEmptyState
Empty state placeholder component displaying a message when there's no content.
ArcaneExpanded
An expanded component that fills available space.
ArcaneExpandingFabPromo
A floating action button that expands to reveal a promo.
ArcaneFaqAccordion
FAQ accordion with question/answer pairs.
ArcaneField<T>
Generic form field component with provider-based state management.
ArcaneFieldMetadata
Metadata for an ArcaneField.
ArcaneFieldStyles
ArcaneFieldWrapper
Wrapper for form fields providing consistent styling and layout.
ArcaneFlow
A flexible flow layout component that wraps children.
ArcaneForm
Complete form component with built-in state management.
ArcaneFormSection
Form section that groups multiple fields together.
ArcaneFullscreenTakeover
A dramatic full-screen takeover for major promotions.
ArcaneGap
A flexible gap component.
ArcaneGutter
A spacing component that provides consistent gaps between elements.
ArcaneHeading
Styled heading wrapper for h1-h6 elements.
ArcaneHeadline
Styled headline component.
ArcaneHeroCarousel
Hero carousel with full-width slides.
ArcaneHoverCard
A unified floating content component.
ArcaneHtmlFooter
Styled footer element wrapper.
ArcaneHtmlSection
Styled section element wrapper.
ArcaneIcon
Wrapper class providing access to all 1666 Lucide icons.
ArcaneImage
Styled image wrapper.
ArcaneImageCard
Image card with overlay text.
ArcaneInfiniteCarousel
Infinite scrolling carousel that auto-scrolls horizontally.
ArcaneInlineHeroBanner
An inline promotional banner that integrates with the hero section.
ArcaneInput
Factory class for creating common field types.
ArcaneInputGroup
Input group that combines multiple inputs in a row.
ArcaneItem
ArcaneKbd
Keyboard shortcut display component.
ArcaneKeyValueRow
Row data for KeyValueTable.
ArcaneKeyValueTable
Simple key-value table with two columns.
ArcaneLabel
Styled label element wrapper.
ArcaneLayout
Layout design tokens.
Styled anchor link wrapper.
ArcaneListItem
Styled list item wrapper.
ArcaneLoadingSpinner
Indeterminate loading spinner.
ArcaneMain
Styled main element wrapper.
ArcaneMarqueeTickerBar
A scrolling marquee-style announcement bar.
ArcaneMegaMenu
Navigation dropdown with mega-menu style.
ArcaneMegaMenuSection
Section in a mega menu.
ArcaneMenubar
Horizontal menu bar component.
ArcaneMenubarMenu
Top-level menu in the menubar.
ArcaneMenuItem
Sealed class hierarchy for menu items. Use pattern matching to handle different item types in renderers.
ArcaneMinimizablePromo
A promo drawer that slides in from the right edge.
ArcaneNav
Styled nav element wrapper.
ArcaneNavDropdown
Hover-based navigation dropdown for header menus.
ArcaneNavigableCarousel
Carousel with navigation arrows.
ArcaneNumberedList
Styled ordered list wrapper.
ArcaneOtpInput
One-time password input with separate digit fields.
ArcanePadding
A padding wrapper component.
ArcanePagination
Page navigation component.
ArcaneParagraph
Styled paragraph wrapper.
ArcanePopover
ArcanePositioned
A positioned child for use within an ArcaneStack.
ArcaneProgressBar
Progress bar component with various styles.
ArcaneProgressClaimBanner
A banner showing how many people have claimed an offer.
ArcanePromoModal
Full-screen modal popup for high-priority promotions.
ArcaneQuote
Styled blockquote wrapper.
ArcaneRadio
Radio button component.
ArcaneRadioGroup<T>
A radio button group component.
ArcaneRadius
Border radius design tokens.
ArcaneRawButton
Raw button element wrapper.
ArcaneRawInput
Raw input element wrapper.
ArcaneResizable
A resizable panel group with draggable dividers.
ArcaneRichText
Rich text component supporting mixed styling.
ArcaneRow
A row layout component (horizontal flex).
ArcaneScripts
Fallback JavaScript for Arcane components on static sites.
ArcaneScriptsComponent
Component that injects Arcane fallback scripts into the page.
ArcaneScrollArea
A scrollable area with custom styled scrollbars.
ArcaneScrollRail
A scrollable sidebar rail that maintains position independently of page scroll.
ArcaneScrollRailLayout
A layout component that combines a scroll rail with main content.
ArcaneSelect
A select/dropdown input component.
ArcaneSelectOption
Select option model.
ArcaneSeparator
A visual separator/divider component.
ArcaneSheet
A modal sheet that slides in from screen edges.
ArcaneSidebar
Sidebar navigation component.
ArcaneSidebarCollapsed
Content that only displays when sidebar is collapsed.
ArcaneSidebarExpanded
Content that only displays when sidebar is expanded.
ArcaneSidebarGroup
Sidebar item group with optional label.
ArcaneSidebarItem
Sidebar navigation item.
ArcaneSidebarSection
Fixed sidebar section that is always expanded.
ArcaneSidebarSeparator
Visual separator between sidebar groups or items.
ArcaneSidebarSubMenu
Collapsible submenu section using native <details>/<summary>.
ArcaneSideContent
Styled aside element wrapper for supplementary content.
ArcaneSizedBox
A sized box component.
ArcaneSkeleton
Skeleton loading placeholder component.
ArcaneSkeletonCard
Skeleton card placeholder.
ArcaneSkeletonText
Skeleton text block with multiple lines.
ArcaneSlider
Slider input component with single value or range mode.
ArcaneSlidingSidebarBanner
A vertical sidebar banner that slides in from the edge of the screen.
ArcaneSonner
ArcaneSpacer
A flexible spacer component.
ArcaneSpacing
Spacing design tokens as CSS value strings.
ArcaneSpan
Styled inline span wrapper.
ArcaneSpinner
ArcaneStack
An ArcaneStack component for positioning children on top of each other.
ArcaneStaticTable
Static table component for displaying simple tabular data.
ArcaneStatusBadge
Unified badge component for status indicators and card overlays.
ArcaneStructuredCard
Card with header, body, and footer sections.
ArcaneStyleData
Immutable style configuration with type-safe enum properties.
ArcaneStylesheet
Base class for stylesheets.
ArcaneSubheadline
Subheadline/lead paragraph text.
ArcaneSvg
SVG container wrapper.
ArcaneSvgCircle
SVG circle element wrapper.
ArcaneSvgGroup
SVG group element wrapper.
ArcaneSvgLine
SVG line element wrapper.
ArcaneSvgPath
SVG path element wrapper.
ArcaneSvgPolygon
SVG polygon element wrapper.
ArcaneSvgPolyline
SVG polyline element wrapper.
ArcaneSvgRect
SVG rect element wrapper.
ArcaneTabBar
A simple tab bar without content for custom tab handling.
ArcaneTabBarItem
A tab bar item.
ArcaneTabItem
A tab item for ArcaneTabs.
ArcaneTable
Styled table wrapper.
ArcaneTableBody
Styled tbody wrapper.
ArcaneTableCell
Styled table data cell wrapper.
ArcaneTableHead
Styled thead wrapper.
ArcaneTableHeader
Styled table header cell wrapper.
ArcaneTableRow
Styled table row wrapper.
ArcaneTabs
A tab component for switching between views.
ArcaneText
Text component with enum-based styling.
ArcaneTextArea
A textarea component.
ArcaneTextInput
A styled text input component.
ArcaneTextSpan
Text span for use within ArcaneRichText.
ArcaneThemeProvider
Provides the current stylesheet and brightness to the component tree.
ArcaneToc
A table of contents component for documentation pages.
ArcaneToggleButton
A toggle button (on/off state).
ArcaneToggleButtonGroup
A toggle button group for switching between options.
ArcaneToggleGroup
A toggle group component for selecting one or multiple options.
ArcaneToggleSwitch
A toggle switch component.
ArcaneToolbar
A toolbar component for a horizontal bar of actions.
ArcaneTooltip
ArcaneTopAnnouncementBar
A thin sticky announcement bar at the top of the page.
ArcaneTypography
Typography design tokens.
ArcaneVirtualScroll<T>
A virtualized scroll list for large datasets.
ArcaneWindow
Web wrapper for ArcaneApp with optional background styling.
ArcaneZIndex
Z-index design tokens.
article
The <article> HTML element represents a self-contained composition in a document, page, application, or site, which is intended to be independently distributable or reusable (e.g., in syndication). Examples include: a forum post, a magazine or newspaper article, or a blog entry, a product card, a user-submitted comment, an interactive widget or gadget, or any other independent item of content.
aside
The <aside> HTML element represents a portion of a document whose content is only indirectly related to the document's main content. Asides are frequently presented as sidebars or call-out boxes.
AspectRatio
The aspect-ratio CSS property allows you to define the desired width-to-height ratio of an element's box. This means that even if the parent container or viewport size changes, the browser will adjust the element's dimensions to maintain the specified width-to-height ratio.
AspectRatioProps
Aspect ratio container component properties.
AsyncSnapshot<T>
Immutable representation of the most recent interaction with an asynchronous computation.
AttrCheck
audio
The <audio> HTML element is used to embed sound content in documents. It may contain one or more audio sources, represented using the src attribute or the <source> element: the browser will choose the most suitable one. It can also be the destination for streamed media, using a MediaStream.
AuthGuard
Stub route protection for non-web platforms.
AuthState
Authentication state container.
AuthUser
Represents an authenticated user.
AvatarProps
Avatar component properties.
b
The <b> HTML element is used to draw the reader's attention to the element's contents, which are not otherwise granted special importance. This was formerly known as the Boldface element, and most browsers still draw the text in boldface. However, you should not use <b> for styling text; instead, you should use the CSS font-weight property to create boldface text, or the <strong> element to indicate that text is of special importance.
BackgroundImage
The background-image CSS property sets one or more background images on an element. It accepts images (url()), gradients, and the keyword none.
BackgroundPosition
The background-position CSS property sets the initial position for each background image. The position is relative to the box established by background-origin.
BackgroundRepeat
The background-repeat CSS property sets how background images are repeated. A background image can be repeated along the horizontal and vertical axes, or not repeated at all.
BackgroundSize
The background-size CSS property sets the size of the element's background image. The image can be left to its natural size, stretched, or constrained to fit the available space.
BadgePosition
Position configuration for absolutely positioned badges.
BadgePresets
Common badge style presets
blockquote
The <blockquote> HTML element indicates that the enclosed text is an extended quotation. Usually, this is rendered visually by indentation. A URL for the source of the quotation may be given using the cite attribute, while a text representation of the source can be given using the <cite> element.
body
The <body> HTML element represents the content of an HTML document. There can be only one <body> element in a document.
BorderRadius
Border radius for rounded corners.
BorderSide
Represents one side of a CSS Border.
BottomFloatingBannerProps
Props for the bottom floating banner.
BoxConstraints
Flutter-like box constraints.
BoxShadow
Box shadow for elevation effects.
br
The <br> HTML element produces a line break in text (carriage-return). It is useful for writing a poem or an address, where the division of lines is significant.
Breadcrumb item in the navigation trail.
Breadcrumb item data.
Breadcrumbs component properties.
BuildableElement
An Element that has a build method.
BuildContext
The BuildContext supplied to a Components build() method.
Builder
A stateless utility component whose build method uses its builder callback to create the component's child.
BuildOwner
button
The <button> HTML element is an interactive element activated by a user with a mouse, keyboard, finger, voice command, or other assistive technology. Once activated, it then performs a programmable action, such as submitting a form or opening a dialog.
ButtonGroupProps
Button group component properties.
ButtonPanelProps
Button panel component properties.
ButtonPresets
Common button style presets
ButtonProps
Button component properties.
CachingIterable<E>
A lazy caching version of Iterable.
CalendarProps
Calendar component properties.
caption
The <caption> HTML element specifies the caption (or title) of a table, providing the table an accessible description.
CardPresets
Common card/surface style presets
CardProps
Card component properties.
CenterProps
Center alignment component properties.
ChangeNotifier
A class that can be extended or mixed in that provides a change notification API using VoidCallback for notifications.
ChartPointProps
ChartProps
CheckboxProps
Checkbox component properties.
CheckItemProps
Check item component properties.
CheckListProps
Check list component properties.
circle
The <circle> SVG element is an SVG basic shape, used to draw circles based on a center point and a radius.
CircularProgressProps
Circular progress component properties.
ClientAnnotation
Use with client to annotate a client component.
code
The <code> HTML element displays its contents styled in a fashion intended to indicate that the text is a short fragment of computer code. By default, the content text is displayed using the user agent's default monospace font.
CodexStylesheet
Codex stylesheet - premium dark design language.
col
The <col> HTML element defines one or more columns in a column group represented by its parent <colgroup> element. The <col> element is only valid as a child of a <colgroup> element that has no span attribute defined.
colgroup
The <colgroup> HTML element defines a group of columns within a table.
Color
ARGB color representation with CSS output.
Colors
Common color constants.
ColumnProps
Column layout component properties.
ComboboxOption<T>
A combobox option.
CommandGroup
A group of related commands.
CommandGroupProps
Command group data.
CommandItem
A single command item.
CommandItemProps
Command item data.
CommandProps
Command palette component properties.
Component
Describes the configuration for an Element.
ComponentRenderers
ConfirmDialogProps
Confirm dialog component properties.
ContextMenuProps
Context menu component properties.
CornerPromoToastProps
Props for the corner promo toast.
CssGenerator
Generates CSS variable blocks from ThemePalette.
Curve
Describes the timing function of a transition.
CycleButtonProps<T>
Cycle button component properties.
CycleOption<T>
Cycle option data.
DataColumnProps<T>
Data column definition.
datalist
The <datalist> HTML element contains a set of <option> elements that represent the permissible or recommended options available to choose from within other controls.
DataTableProps<T>
Data table component properties.
DatePickerProps
Date picker component properties.
DateRange
A date range.
DateRangeValue
Date range value.
dd
The <dd> HTML element provides the description, definition, or value for the preceding term (<dt>) in a description list (<dl>).
DecoderAnnotation
Use with decoder to annotate an decoder function for a custom model.
details
The <details> HTML element creates a disclosure widget in which information is visible only when the widget is toggled into an "open" state. A summary or label must be provided using the <summary> element.
dialog
The <dialog> HTML element represents a dialog box or other interactive component, such as a dismissible alert, inspector, or subwindow.
DialogProps
Dialog component properties.
DirectionProps
DisclosureGroupProps
Disclosure group component properties.
DisclosureItemProps
Disclosure item data.
DisclosureProps
Disclosure component properties.
div
The <div> HTML element is the generic container for flow content. It has no effect on the content or layout until styled in some way using CSS (e.g. styling is directly applied to it, or some kind of layout model like Flexbox is applied to its parent element).
dl
The <dl> HTML element represents a description list. The element encloses a list of groups of terms (specified using the <dt> element) and descriptions (provided by <dd> elements). Common uses for this element are to implement a glossary or to display metadata (a list of key-value pairs).
Document
DomComponent
Represents a html element in the DOM
DomElement
DrawerProps
Drawer component properties.
Dropdown menu component properties.
dt
The <dt> HTML element specifies a term in a description or definition list, and as such must be used inside a <dl> element. It is usually followed by a <dd> element; however, multiple <dt> elements in a row indicate several terms that are all defined by the immediate next <dd> element.
EdgeInsets
Flutter-like edge insets for padding and margin.
Element
An instantiation of a Component at a particular location in the tree.
ElementSlot
ellipse
The <ellipse> element is an SVG basic shape, used to create ellipses based on a center coordinate, and both their x and y radius.
em
The <em> HTML element marks text that has stress emphasis. The <em> element can be nested, with each level of nesting indicating a greater degree of emphasis.
embed
The <embed> HTML element embeds external content at the specified point in the document. This content is provided by an external application or other source of interactive content such as a browser plug-in.
EmptyStateProps
Empty state component properties.
EncoderAnnotation
Use with encoder to annotate an encoder function for a custom model.
ExpandedProps
Expanded component properties.
ExpandingFabPromoProps
Props for the expanding FAB promo.
Factory<T>
A factory interface that also reports the type of the created objects.
FadeEdgeProps
Fade edge component properties.
FeatureRowProps
Feature row component properties.
fieldset
The <fieldset> HTML element is used to group several controls as well as labels (<label>) within a web form.
FieldWrapperProps
Field wrapper component properties.
figcaption
The <figcaption> HTML element represents a caption or legend describing the rest of the contents of its parent <figure> element, providing the <figure>> an accessible description.
figure
The <figure> HTML element represents self-contained content, potentially with an optional caption, which is specified using the <figcaption> element. The figure, its caption, and its contents are referenced as a single unit.
Filter
CSS filter effects let you define a way of processing an element's rendering before the element is displayed in the document. Examples of such effects include blurring and changing the intensity of the color of an element.
Flex
Controls how a flex item consumes available space inside a flex container.
FlexiCardItem
Flexi card item data.
FlexiCardsProps
FlexiCards component properties.
FlexiCardsSimpleProps
FlexiCards simple component properties.
FloatingProps
Unified floating component properties.
FlowProps
Flow layout component properties.
FontConfig
Font family configuration for a theme.
FontFamilies
A collection of generic and common font families.
The <footer> HTML element represents a footer for its nearest ancestor sectioning content or sectioning root element. A <footer> typically contains information about the author of the section, copyright data or links to related documents.
form
The <form> HTML element represents a document section containing interactive controls for submitting information.
FormProps
Form component properties.
FormSectionProps
Form section component properties.
Fragment
A utility component that renders its children without any wrapper element.
FullscreenTakeoverProps
Props for the fullscreen takeover.
FutureBuilder<T>
Component that builds itself based on the latest snapshot of interaction with a Future.
GapProps
Gap component properties.
GlobalKey
A key that is unique across the entire app.
GlobalNodeKey<T extends Node>
A global key that provides access to the dom web.Node that is associated with its element.
GlobalObjectKey
A global key that takes its identity from the object used as its value.
GlobalObjectNodeKey<T extends Node>
A global node key that takes its identity from the object used as its value.
GlobalObjectStateKey<T extends State<StatefulComponent>>
A global state key that takes its identity from the object used as its value.
GlobalStateKey<T extends State<StatefulComponent>>
A global key that provides access to the State that is associated with its element.
GradientBuilder
Builds a CSS linear-gradient from a list of colors.
GradientStop
A color stop in a gradient, supporting both ArcaneColor and raw CSS values.
GridAreas
Represents the grid areas defined in a grid layout.
GridPlacement
Describes where a grid item should be placed within a grid. It can place an item by naming a grid area, or by describing start/end lines for the item's row and column tracks. Use this to control the item's location and span inside its grid.
GridTemplate
The grid-template CSS property defines grid columns, grid rows, and grid areas.
GridTrack
Represents a single track in a grid layout, which can be a line, a size, or a repeated set of tracks.
GridTracks
Represents a list of grid tracks for rows or columns.
GuestGuard
Stub guest route protection for non-web platforms.
GutterProps
Gutter/spacing component properties.
h1
The <h1> to <h6> HTML elements represent six levels of section headings. <h1> is the highest section level and <h6> is the lowest.
h2
The <h1> to <h6> HTML elements represent six levels of section headings. <h1> is the highest section level and <h6> is the lowest.
h3
The <h1> to <h6> HTML elements represent six levels of section headings. <h1> is the highest section level and <h6> is the lowest.
h4
The <h1> to <h6> HTML elements represent six levels of section headings. <h1> is the highest section level and <h6> is the lowest.
h5
The <h1> to <h6> HTML elements represent six levels of section headings. <h1> is the highest section level and <h6> is the lowest.
h6
The <h1> to <h6> HTML elements represent six levels of section headings. <h1> is the highest section level and <h6> is the lowest.
The <head> HTML element contains machine-readable information (metadata) about the document, like its title, scripts, and style sheets.
The <header> HTML element represents introductory content, typically a group of introductory or navigational aids. It may contain some heading elements but also a logo, a search form, an author name, and other elements.
hr
The <hr> HTML element represents a thematic break between paragraph-level elements: for example, a change of scene in a story, or a shift of topic within a section.
html
The <html> HTML element represents the root (top-level element) of an HTML document, so it is also referred to as the root element. All other elements must be descendants of this element.
i
The <i> HTML element represents a range of text that is set off from the normal text for some reason, such as idiomatic text, technical terms, taxonomical designations, among others. Historically, these have been presented using italicized type, which is the original source of the <i> naming of this element.
iframe
The <iframe> HTML element represents a nested browsing context, embedding another HTML page into the current one.
ImageStyle
Helper representing an image style value such as url(...) or gradients.
img
The <img> HTML element embeds an image into the document.
Import
Define a platform specific import with auto-generated stubbing.
InheritedComponent
Base class for components that efficiently propagate information down the tree.
InheritedElement
An Element that uses an InheritedComponent as its configuration.
InheritedModel<T>
InheritedModelElement<T>
InlineHeroBannerProps
Props for the inline hero banner.
input<T>
The <input> HTML element is used to create interactive controls for web-based forms in order to accept data from the user; a wide variety of types of input data and control widgets are available, depending on the device and user agent. The <input> element is one of the most powerful and complex in all of HTML due to the sheer number of combinations of input types and attributes.
InputGroupProps
Input group component properties.
InputPresets
Common input style presets
ItemProps
JasprAuthService
Stub implementation of JasprAuthService for non-web platforms.
JasprBadge
A "Built with Jaspr" badge component.
KbdProps
Keyboard shortcut display component properties.
Key
A Key is an identifier for Components and Elements.
KeyValueRowData
Key-value row data.
KeyValueTableProps
Key-value table component properties.
label
The <label> HTML element represents a caption for an item in a user interface.
LabeledGlobalKey
A global key with a debugging label.
LabeledGlobalNodeKey<T extends Node>
A global node key with a debugging label.
LabeledGlobalStateKey<T extends State<StatefulComponent>>
A global state key with a debugging label.
LayoutPresets
Common layout style presets
LeafElement
LeafRenderObjectElement
legend
The <legend> HTML element represents a caption for the content of its parent <fieldset>.
li
The <li> HTML element is used to represent an item in a list. It must be contained in a parent element: an ordered list (<ol>), an unordered list (<ul>), or a menu (<menu>). In menus and unordered lists, list items are usually displayed using bullet points. In ordered lists, they are usually displayed with an ascending counter on the left, such as a number or letter.
line
The <line> element is an SVG basic shape used to create a line connecting two points.
Linear
Tuple used with Curve.linear. The optional arguments are percentages between 0-100.
LinePlacement
Places an item by specifying grid lines or spans.
The <link> HTML element specifies relationships between the current document and an external resource. This element is most commonly used to link to stylesheets, but is also used to establish site icons (both "favicon" style icons and icons for the home screen and apps on mobile devices) among other things.
Listenable
An object that maintains a list of listeners.
ListenableBuilder
LoadingSpinnerProps
Loading spinner component properties.
LocalKey
A key that is not a GlobalKey.
main_
The <main> HTML element represents the primary content of a document, distinct from content that is repeated across multiple pages such as site headers, footers, and navigation bars.
MarqueeTickerBarProps
Props for the marquee ticker bar.
MediaQuery
Media queries allow you to apply CSS styles depending on a device's media type (such as print vs. screen) or other features or characteristics such as screen resolution or orientation, aspect ratio, browser viewport width or height, user preferences such as preferring reduced motion, data usage, or transparency.
Menubar menu data.
Menubar component properties.
Standard clickable menu item.
Checkbox menu item.
Label/header for grouping items (non-interactive).
Radio menu item (part of a group).
Visual separator between menu items.
Submenu with nested items.
meta
The <meta> HTML element represents metadata that cannot be represented by other HTML meta-related elements, like <base >, <link >, <script >, <style > or <title >.
meter
The <meter> HTML element represents either a scalar value within a known range or a fractional value.
MinimizablePromoProps
Props for the minimizable promo.
MultiChildElement
An Element that has multiple children based on a proxy list.
MultiChildRenderObjectElement
NativeSelectOptionProps
NativeSelectProps
The <nav> HTML element represents a section of a page whose purpose is to provide navigation links, either within the current document or to other documents. Common examples of navigation sections are menus, tables of contents, and indexes.
Notification
A notification that can bubble up the component tree.
object
The <object> HTML element represents an external resource, which can be treated as an image, a nested browsing context, or a resource to be handled by a plugin.
ObserverComponent
Base class for components that observes the build execution of it's descendants in the Component tree.
ObserverElement
An Element that uses an ObserverComponent as its configuration. You can override willRebuildElement, didRebuildElement and didUnmountElement to execute the required logic.
ol
The <ol> HTML element represents an ordered list of items — typically rendered as a numbered list.
optgroup
The <optgroup> HTML element creates a grouping of options within a <select> element.
option
The <option> HTML element is used to define an item contained in a <select>, an <optgroup>, or a <datalist> element. As such, <option> can represent menu items in popups and other lists of items in an HTML document.
OtpInputProps
OTP input component properties.
Outline
Represents the CSS outline property.
OutlineWidth
The CSS outline-width property sets the thickness of an element's outline. An outline is a line that is drawn around an element, outside the border.
OverflowValue
The overflow CSS property sets the desired behavior when content does not fit in the element's padding box (overflows) in the horizontal and/or vertical direction.
OverlayPresets
Overlay/modal presets
p
The <p> HTML element represents a paragraph. Paragraphs are usually represented in visual media as blocks of text separated from adjacent blocks by blank lines and/or first-line indentation, but HTML paragraphs can be any structural grouping of related content, such as images or form fields.
PaddingWrapperProps
Padding wrapper component properties.
PaginationProps
Pagination component properties.
PaletteGenerator
Generates a complete ThemePalette from a ThemeSeed.
PasswordPolicy
Password validation policy with configurable requirements.
path
The <path> SVG element is the generic element to define a shape. All the basic shapes can be created with a path element.
polygon
The <polygon> element defines a closed shape consisting of a set of connected straight line segments. The last point is connected to the first point.
polyline
The <polyline> SVG element is an SVG basic shape that creates straight lines connecting several points. Typically a polyline is used to create open shapes as the last point doesn't have to be connected to the first point.
pre
The <pre> HTML element represents preformatted text which is to be presented exactly as written in the HTML file. The text is typically rendered using a non-proportional, or monospaced, font. Whitespace inside this element is displayed as written.
progress
The <progress> HTML element displays an indicator showing the completion progress of a task, typically displayed as a progress bar.
ProgressClaimBannerProps
Props for the progress claim banner.
ProgressProps
Progress bar component properties.
PromoModalProps
Props for the promo modal.
Quotes
The CSS quotes property sets how the browser should render quotation marks that are automatically added to the HTML <q> element or added using the open-quotes or close-quotes (or omitted using the no-open-quote and no-close-quote) values of the of the CSS content property.
RadioGroupProps<T>
Radio group component properties.
RadioOption<T>
Radio button option model.
RadioOptionProps<T>
Radio option data.
RadiusConfig
Border radius configuration for a theme.
RawableRenderObject
RawableRenderText
RawText
Renders its text input as raw HTML.
ReadingTimeResult
Result of reading time calculation.
rect
The <rect> element is a basic SVG shape that draws rectangles, defined by their position, width, and height. The rectangles may have their corners rounded.
RenderElement
RenderFragment
RenderObject
RenderText
ResizablePanelData
Resizable panel data.
ResizableProps
Resizable panel group component properties.
RowProps
Row layout component properties.
s
The <s> HTML element renders text with a strikethrough, or a line through it. Use the <s> element to represent things that are no longer relevant or no longer accurate. However, <s> is not appropriate when indicating document edits; for that, use the <del> and <ins> elements, as appropriate.
script
The <script> HTML element is used to embed executable code or data; this is typically used to embed or refer to JavaScript code. The <script> element can also be used with other languages, such as WebGL's GLSL shader programming language and JSON.
ScrollAreaProps
Scroll area component properties.
ScrollRailLayoutProps
Scroll rail layout component properties.
ScrollRailProps
Scroll rail component properties.
section
The <section> HTML element represents a generic standalone section of a document, which doesn't have a more specific semantic element to represent it. Sections should always have a heading, with very few exceptions.
SectionPresets
Common section/page style presets
select
The <select> HTML element represents a control that provides a menu of options.
SelectOptionProps<T>
Select option data.
SelectProps<T>
Select component properties.
SeparatorProps
Unified separator component properties.
ShadcnStylesheet
ShadCN UI stylesheet.
SheetProps
Sheet/drawer component properties.
SidebarGroupProps
Sidebar group component properties.
SidebarItemProps
Sidebar item component properties.
SidebarProps
Sidebar component properties.
SidebarSectionProps
Sidebar section component properties (fixed, non-collapsible section).
SidebarSubMenuProps
Sidebar submenu component properties (collapsible section).
SizedBoxProps
SizedBox component properties.
SkeletonProps
Skeleton component properties.
SliderProps
Slider component properties.
SlidingSidebarBannerProps
Props for the sliding sidebar banner.
SlotCounterCardProps
Slot counter card component properties.
SlotCounterProps
Slot counter component properties.
SlotCounterRowProps
Slot counter row component properties.
small
The <small> HTML element represents side-comments and small print, like copyright and legal text, independent of its styled presentation. By default, it renders text within it one font-size smaller, such as from small to x-small.
source
The <source> HTML element specifies multiple media resources for the <picture>, the <audio> element, or the <video> element. It is an empty element, meaning that it has no content and does not have a closing tag. It is commonly used to offer the same media content in multiple file formats in order to provide compatibility with a broad range of browsers given their differing support for image file formats and media file formats.
SpacerProps
Spacer component properties.
span
The <span> HTML element is a generic inline container for phrasing content, which does not inherently represent anything. It can be used to group elements for styling purposes (using the class or id attributes), or because they share attribute values, such as lang. It should be used only when no other semantic element is appropriate. <span> is very much like a <div> element, but <div> is a block-level element whereas a <span> is an inline element.
SpecRowProps
Spec row component properties.
State<T extends StatefulComponent>
The logic and internal state for a StatefulComponent.
StatefulBuilder
A platonic component that both has state and calls a closure to obtain its child component.
StatefulComponent
A component that has mutable state.
StatefulElement
An Element that uses a StatefulComponent as its configuration.
StatelessComponent
A component that does not require mutable state.
StatelessElement
An Element that uses a StatelessComponent as its configuration.
StaticTableProps
Static table component properties.
StatusBadgeProps
Unified badge component properties.
StreamBuilder<T>
Component that builds itself based on the latest snapshot of interaction with a Stream.
StreamBuilderBase<T, S>
Base class for components that build themselves based on interaction with a specified Stream.
strong
The <strong> HTML element indicates that its contents have strong importance, seriousness, or urgency. Browsers typically render the contents in bold type.
Style
Renders the provided list of styles into css and wraps them with a <style> element.
StyleRule
Styles
Represents a set of css styles.
StylesMixin<T>
summary
The <summary> HTML element specifies a summary, caption, or legend for a <details> element's disclosure box. Clicking the <summary> element toggles the state of the parent <details> element open and closed.
svg
The <svg> element is a container that defines a new coordinate system and viewport. It is used as the outermost element of SVG documents, but it can also be used to embed an SVG fragment inside an SVG or HTML document.
SyncAnnotation
SynchronousFuture<T>
A Future whose then implementation calls the callback immediately.
TabBarItemProps
Tab bar item data.
TabBarProps
Tab bar component properties.
TabItemProps
Tab item data.
table
The <table> HTML element represents tabular data—that is, information presented in a two-dimensional table comprised of rows and columns of cells containing data.
TabsProps
Tabs component properties.
tbody
The <tbody> HTML element encapsulates a set of table rows (<tr> elements), indicating that they comprise the body of a table's (main) data.
td
The <td> HTML element defines a cell of a table that contains data and may be used as a child of the <tr> element.
Text
Represents a plain text node with no additional properties.
textarea
The <textarea> HTML element represents a multi-line plain-text editing control, useful when you want to allow users to enter a sizeable amount of free-form text, for example a comment on a review or feedback form.
TextDecorationLine
The text-decoration-line CSS property sets the kind of decoration that is used on text in an element, such as an underline or overline.
TextDecorationThickness
The text-decoration-thickness CSS property sets the stroke thickness of the decoration line that is used on text in an element, such as a line-through, underline, or overline.
TextElement
TextInputProps
Text input component properties.
TextPresets
Common text style presets
TextShadow
The text-shadow CSS property adds shadows to text.
tfoot
The <tfoot> HTML element encapsulates a set of table rows (<tr> elements), indicating that they comprise the foot of a table with information about the table's columns. This is usually a summary of the columns, e.g., a sum of the given numbers in a column.
th
The <th> HTML element defines a cell as the header of a group of table cells and may be used as a child of the <tr> element. The exact nature of this group is defined by the scope and headers attributes.
thead
The <thead> HTML element encapsulates a set of table rows (<tr> elements), indicating that they comprise the head of a table with information about the table's columns. This is usually in the form of column headers (<th> elements).
ThemePalette
Complete color palette derived from ThemeSeed.
ThemeSeed
Minimal color input for theme generation.
TimeOfDay
Represents a time of day with hour and minute.
TimePickerProps
Time picker component properties.
ToastAction
Toast action button data.
ToastContainerProps
Toast container component properties.
ToastProps
Toast component properties.
TocEntry
Represents a heading entry for the table of contents.
ToggleButtonProps
Toggle button component properties.
ToggleGroupItem
A toggle group item.
ToggleGroupItemProps
Toggle group item data.
ToggleGroupProps
Toggle group component properties.
ToggleSwitchProps
Toggle switch component properties.
ToolbarProps
Toolbar component properties.
TopAnnouncementBarProps
Props for the top announcement bar.
tr
The <tr> HTML element defines a row of cells in a table. The row's cells can then be established using a mix of <td> (data cell) and <th> (header cell) elements.
TrackRepeat
Represents a repeated fragment of the track list, allowing a large number of columns that exhibit a recurring pattern to be written in a more compact form.
TrackSize
Represents the size of a grid track in a grid layout.
u
The <u> HTML element represents a span of inline text which should be rendered in a way that indicates that it has a non-textual annotation. This is rendered by default as a simple solid underline, but may be altered using CSS.
ul
The <ul> HTML element represents an unordered list of items, typically rendered as a bulleted list.
UniqueKey
A key that is only equal to itself.
Unit
Represents a CSS unit value.
ValueKey<T>
A key that uses a value of a particular type to identify itself.
ValueListenable<T>
An interface for subclasses of Listenable that expose a value.
ValueListenableBuilder<T>
ValueNotifier<T>
A ChangeNotifier that holds a single value.
video
The <video> HTML element embeds a media player which supports video playback into the document. You can use <video> for audio content as well, but the <audio> element may provide a more appropriate user experience.
VirtualScrollProps<T>
Virtual scroll component properties.
wbr
The <wbr> HTML element represents a word break opportunity—a position within text where the browser may optionally break a line, though its line-breaking rules would not otherwise create a break at that location.

Enums

AccordionVariant
Accordion variant styles.
AlertStyle
Alert visual style variant.
AlignContent
The CSS align-content property sets the distribution of space between and around content items along a flexbox's cross axis, or a grid or block-level element's block axis.
AlignItems
Align items values
Alignment
Alignment positions for layout.
AlignSelf
The align-self CSS property overrides a grid or flex item's align-items value. In grid, it aligns the item inside the grid area. In flexbox, it aligns the item on the cross axis.
All
The all CSS property resets all of an element's properties. It can set properties to their initial or inherited values, or to the values specified in another cascade layer or stylesheet origin.
AnimationDirection
The animation-direction CSS property sets whether an animation should play forward, backward, or alternate back and forth between playing the sequence forward and backward.
AnimationFillMode
The animation-fill-mode CSS property sets how a CSS animation applies styles to its target before and after its execution.
AnimationPlayState
The animation-play-state CSS property sets whether an animation is running or paused.
AnimationPreset
Animation presets for common UI patterns
Appearance
The appearance CSS property specifies the rendered appearance of replaced UI widget elements such as form controls. Most commonly, such elements are given native, platform-specific styling based on the operating system's theme, or a primitive appearance with styles that can be overridden using CSS.
ArcaneColor
Semantic color values that map to theme CSS custom properties.
ArcaneDirectionValue
ArcaneDropdownItemStyle
Style variants for dropdown items
AuthMethod
Supported authentication methods.
AuthStatus
Authentication status enumeration.
AutoComplete
Indicates whether input elements can by default have their values automatically completed by the browser. autocomplete attributes on form elements override it on <form>.
AvatarBadgePosition
Position for avatar badge.
AvatarGroupDirection
Direction for avatar group stacking.
AvatarShape
AvatarSize
Avatar size with extended range for flexibility.
Axis
Axis direction.
BackdropFilter
Backdrop filter presets
Background
Background color presets
BackgroundAlignX
BackgroundAlignY
BackgroundAttachment
The background-attachment CSS property sets whether a background image's position is fixed within the viewport or scrolls with its containing block.
BackgroundAxisRepeat
The background-repeat CSS property sets how background images are repeated. Per-axis values for the BackgroundRepeat property.
BackgroundClip
The background-clip CSS property sets whether an element's background extends underneath its border box, padding box, or content box.
BackgroundOrigin
The background-origin CSS property sets the background's origin: which box (border-box, padding-box or content-box) the background's position is relative to.
BadgeVariant
Badge variant for all badge styles.
BorderColor
Border color presets
BorderPreset
Border presets combining width, style, and color
BorderStyle
Keywords for the visual style of borders (e.g. dotted, solid, double).
BorderWidth
Border width presets
BoxFit
Image fit modes.
BoxSizing
The box-sizing CSS property sets how the total width and height of an element is calculated.
Brightness
Brightness mode for the application.
ButtonSize
Button size enum with icon variants. Supports both abbreviated (sm/md/lg) and spelled-out (small/medium/large) styles.
ButtonType
Defines the default behavior of a button.
ButtonVariant
CalendarMode
Calendar selection mode.
CalendarModeVariant
CardVariant
CheckStyle
CodeBlockStyle
CodexTheme
Color themes for Codex stylesheet.
ColorVariant
Color variants for semantic meaning.
Combinator
ComboboxSize
Size variants for combobox.
ComponentSize
Unified size enum supporting both naming conventions. Use whichever style you prefer - they are aliases.
ConnectionState
The state of connection to an asynchronous computation.
Contrast
The prefers-contrast CSS media feature is used to detect whether the user has requested the web content to be presented with a lower or higher contrast.
CrossAxisAlignment
Cross axis alignment for flex layouts.
CrossOrigin
Indicates if the fetching of the media must be done using a CORS request. Media data from a CORS request can be reused in the <canvas> element without being marked "tainted". If the crossorigin attribute is not specified, then a non-CORS request is sent (without the Origin request header), and the browser marks the media as tainted and restricts access to its data, preventing its usage in <canvas> elements. If the crossorigin attribute is specified, then a CORS request is sent (with the Origin request header); but if the server does not opt into allowing cross-origin access to the media data by the origin site (by not sending any Access-Control-Allow-Origin response header, or by not including the site's origin in any Access-Control-Allow-Origin response header it does send), then the browser blocks the media from loading, and logs a CORS error to the devtools console.
Cursor
Cursor presets
CycleButtonSize
CycleButtonVariant
DataTableTextAlign
DatePickerSize
Size variants for date picker.
DatePickerSizeVariant
DirectionValue
DisclosureVariant
Display
CSS display property values
DrawerPosition
DrawerSize
Easing
Animation timing functions
EmptyStateSizeVariant
EmptyStateStyleVariant
FadeDirection
FlexDirection
Flex direction values
FlexPreset
Flex shorthand presets
FlexWrap
Flex wrap values
FloatingPosition
Position of floating content relative to trigger.
FloatingTrigger
Floating content trigger mode.
FontFamily
Font family presets
FontSize
Font size presets using rem units
FontStyle
Font style values
FontWeight
Font weight values.
FormEncType
The MIME type of a form submission.
FormMethod
The HTTP method to submit a form with.
Gap
Gap presets for flex and grid layouts
GridAutoFlow
Grid auto-flow values
GridColumns
Grid template column presets
GridRows
Grid template row presets
GutterSize
HeadingLevel
HeadlineLevel
IconSize
Icon size presets for consistent sizing.
ImportPlatform
InputType
The type for an <input> element.
JustifyContent
Justify content values
JustifyItems
The CSS justify-items property defines the default justify-self for all items of the box, giving them all a default way of justifying each box along the appropriate axis.
JustifySelf
The CSS justify-self property sets the way a box is justified inside its alignment container along the appropriate axis.
KbdStyle
LetterSpacing
Letter spacing presets
LineHeight
Line height presets
ListStyle
The list-style-type CSS property sets the marker (such as a disc, character, or custom counter style) of a list item element.
ListStylePosition
The list-style-position CSS property sets the position of the ::marker relative to a list item.
MainAxisAlignment
Main axis alignment for flex layouts.
MainAxisSize
Main axis size behavior.
MarginPreset
Compound margin presets
MaxHeight
Max height presets
MaxWidth
Max-width container presets
MediaLoading
Indicates how the browser should load the media. Loading is only deferred when JavaScript is enabled.
MinWidth
Min width presets
NumberingType
The numbering type for a list element.
ObjectFit
Object fit values
ObjectPosition
Object position values
Opacity
Opacity presets
Orientation
The orientation CSS media feature can be used to test the orientation of the viewport (or the page box, for paged media).
OtpInputSize
Size variants for OTP input.
OtpInputSizeVariant
OutlinePreset
Outline presets
OutlineStyle
The style of an element's outline. An outline is a line that is drawn around an element, outside the border.
Overflow
Overflow behavior values
OverflowAxis
Overflow X/Y specific values
PaddingPreset
Compound padding presets
PaginationSize
PaginationSizeVariant
PaginationStyle
PaginationStyleVariant
PlaceContent
Place content values
PlaceItems
Place items values
PointerEvents
Pointer events presets
Position
CSS position values
Preload
Intended to provide a hint to the browser about what the author thinks will lead to the best user experience when loading a media object. The default value is different for each browser. The spec advises it to be set to Preload.metadata.
ProgressVariant
PromoCornerPosition
Position for the corner promo toast.
PromoInlineHeroBannerStyle
Style variants for the inline hero banner.
PromoSidebarPosition
Position for the sliding sidebar.
RadioGroupLayout
RadioGroupVariant
Radius
Border radius presets
ReferrerPolicy
The Referrer-Policy controls how much referrer information (sent with the Referer header) should be included with requests.
ResizeDirection
SchedulerPhase
ScrollbarStyleVariant
ScrollbarVisibilityVariant
ScrollDirectionVariant
ScrollRailPosition
ScrollRailSize
SelectDropdownDirection
SeparatorOrientation
Separator orientation.
SeparatorVariant
Separator visual style variants.
ShadcnTheme
Color themes for ShadCN stylesheet.
Shadow
Box shadow presets
SheetPosition
Sheet position (edge from which it slides).
SheetSize
Sheet size variants.
SheetSizeVariant
Size
Size keyword presets
SkeletonShape
SliderVariant
SlotCounterColor
SlotCounterSize
Spacing
Single-value spacing scale based on 4px unit
SpellCheck
Specifies whether an element is subject to spell checking by the underlying browser/OS.
StatusType
StepJump
Describes how the transition behaves at the start and end when using Curve.steps.
StyleVariant
Style variants for visual treatment.
SvgSize
Target
The name/keyword for a browsing context (a tab, window, or <iframe>).
TextAlign
Text alignment options.
TextAreaResize
Resize direction for textarea.
TextColor
Text/foreground color presets
TextDecoration
Text decoration values
TextDecorationLineKeyword
TextDecorationStyle
The text-decoration-style CSS property sets the style of the lines specified by TextDecorationLine.
TextInputType
TextInputVariant
TextOverflow
Text overflow behavior.
TextTransform
Text transform values
TextWrap
Indicates how the control wraps text.
ThemeMode
Theme mode selection.
ToastPosition
ToastVariant
ToggleGroupSelectionType
ToggleGroupSize
Toggle group size.
ToggleGroupSizeVariant
ToggleGroupType
Toggle group selection type.
ToggleGroupVariant
Toggle group variants.
ToggleGroupVariantStyle
Transform
Transform presets
TransformOrigin
Transform origin presets
Transition
Transition presets
UserSelect
The user-select CSS property controls whether the user can select text. This doesn't have any effect on content loaded as part of a browser's user interface (its chrome), except in textboxes.
Visibility
Visibility values
WhiteSpace
White space handling values
WordBreak
Word break values
WrapAlignment
Wrap alignment for flex wrap layouts.
ZIndex
Z-index layer presets

Mixins

AccordionRendererContract
Mixin defining the renderer methods for accordion components.
AlertRendererContract
Mixin defining the renderer methods for alert components.
AspectRatioRendererContract
Mixin defining the renderer methods for aspect ratio components.
AvatarRendererContract
Mixin defining the renderer methods for avatar components.
Mixin defining the renderer methods for breadcrumb components.
ButtonPanelRendererContract
Mixin defining the renderer methods for button panel components.
ButtonRendererContract
Mixin defining the renderer method for button components.
CalendarRendererContract
Mixin defining the renderer methods for calendar components.
CardRendererContract
Mixin defining the renderer methods for card components.
ChartRendererContract
CheckboxRendererContract
Mixin defining the renderer method for checkbox components.
CheckListRendererContract
Mixin defining the renderer methods for check list components.
CommandRendererContract
Mixin defining the renderer methods for command palette components.
ComponentsBinding
Main app binding, controls the root component and global state
ConfirmDialogRendererContract
Mixin defining the renderer methods for confirm and alert dialog components.
ContextMenuRendererContract
Mixin defining the renderer methods for context menu components.
CycleButtonRendererContract
Mixin defining the renderer methods for cycle button and toggle button components.
DataTableRendererContract
Mixin defining the renderer methods for data table components.
DatePickerRendererContract
Mixin defining the renderer methods for date picker components.
DialogRendererContract
Mixin defining the renderer methods for dialog components.
DirectionRendererContract
DisclosureRendererContract
Mixin defining the renderer methods for disclosure components.
DrawerRendererContract
Mixin defining the renderer methods for drawer components.
Mixin defining the renderer methods for dropdown menu components.
EmptyStateRendererContract
Mixin defining the renderer methods for empty state components.
FadeEdgeRendererContract
Mixin defining the renderer methods for fade edge components.
FieldWrapperRendererContract
Mixin defining the renderer methods for field wrapper components.
FlexiCardsRendererContract
Mixin defining the renderer methods for flexi cards components.
FloatingRendererContract
Mixin defining the renderer methods for floating components.
FlowRendererContract
Mixin defining the renderer methods for flow/layout components.
GutterRendererContract
Mixin defining the renderer methods for gutter/spacing components.
ItemRendererContract
KbdRendererContract
Mixin defining the renderer methods for keyboard shortcut components.
Mixin defining the renderer methods for menubar components.
NativeSelectRendererContract
NotifiableElementMixin
Mixin this class to allow receiving Notification objects dispatched by child elements.
OnFirstBuild
Mixin on StatelessComponent that performs some async task on the first build
OtpInputRendererContract
Mixin defining the renderer method for OTP input components.
PaginationRendererContract
Mixin defining the renderer methods for pagination components.
PreloadStateMixin<T extends StatefulComponent>
Mixin on State that preloads state on the server
ProgressRendererContract
Mixin defining the renderer methods for progress components.
PromoRendererContract
Mixin defining the renderer methods for promo components.
RadioGroupRendererContract
Mixin defining the renderer method for radio group components.
RenderObjectElement
ResizableRendererContract
Mixin defining the renderer methods for resizable components.
SchedulerBinding
ScrollAreaRendererContract
Mixin defining the renderer methods for scroll area components.
ScrollRailRendererContract
Mixin defining the renderer methods for scroll rail components.
SelectRendererContract
Mixin defining the renderer methods for select components.
SeparatorRendererContract
Mixin defining the renderer methods for separator components.
SidebarRendererContract
Mixin defining the renderer methods for sidebar components.
SkeletonRendererContract
Mixin defining the renderer methods for skeleton components.
SliderRendererContract
Mixin defining the renderer method for slider components.
SlotCounterRendererContract
Mixin defining the renderer methods for slot counter components.
SpecRowRendererContract
Mixin defining the renderer methods for spec row components.
StaticTableRendererContract
Mixin defining the renderer methods for static table components.
StatusBadgeRendererContract
Mixin defining the renderer methods for status badge components.
SyncStateMixin<T extends StatefulComponent, U>
Mixin on State that syncs state data from the server to the client.
TabsRendererContract
Mixin defining the renderer methods for tab components.
TextInputRendererContract
Mixin defining the renderer method for text input components.
TimePickerRendererContract
Mixin defining the renderer method for time picker components.
ToastRendererContract
Mixin defining the renderer methods for toast components.
ToggleGroupRendererContract
Mixin defining the renderer methods for toggle group components.
ToggleSwitchRendererContract
Mixin defining the renderer method for toggle switch components.
ViewTransitionMixin<T extends StatefulComponent>

Extensions

AngleExt on num
Extension helpers to create Angle values from numeric literals.
AppContext on BuildContext
ArcaneColorGradient on List<ArcaneColor>
Extension for creating gradients from a list of ArcaneColors.
ArcaneThemeContext on BuildContext
Extension for easy access to theme properties from context.
AuthContextExtension on BuildContext
Extension for accessing auth state from any component.
DurationExt on int
DurationExtension on int
Duration extension for convenience.
IconSizeExtension on IconSize
Extension to convert IconSize to pixel values.
ReadingTimeExtension on String
Extension for calculating reading time from strings.
SelectorMixin on Selector
SvgSizeExtension on SvgSize
UnitExt on num

Constants

arcaneAllDocsStyles → const String
All documentation styles combined.
arcaneAllSidebarStyles → const String
All sidebar styles combined.
arcaneCalloutStyles → const String
Callout/admonition block styles.
arcaneCodeCopyButtonStyles → const String
Code block copy button styles.
arcaneProseCodeStyles → const String
Prose code block styles with syntax highlighting.
arcaneProseStyles → const String
Base prose typography styles for markdown content.
arcaneSidebarCodexStyles → const String
Codex sidebar styles.
arcaneSidebarComponentStyles → const String
ArcaneSidebar component tree-line styles.
arcaneSidebarTreeStyles → const String
Sidebar tree-line navigation styles.
arcaneTocTreeLinesCss → const String
CSS styles for ArcaneToc tree-line visual connectors.
client → const ClientAnnotation
Used to annotate a client component.
css → const CssUtility
Styling utility to create nested style definitions.
decoder → const DecoderAnnotation
Used to annotate an decoder function for a custom model.
encoder → const EncoderAnnotation
Used to annotate an encoder function for a custom model.
factory → const Object
Annotation on a function that creates new objects.
immutable → const Immutable
Annotation on an immutable class.
kDebugMode → const bool
A constant that is true if the application was compiled in debug mode.
kGenerateMode → const bool
A constant that is true if the application is running in static-site-generation mode.
kIsWasm → const bool
A constant that is true if the application was compiled to WebAssembly.
kIsWeb → const bool
A constant that is true if the application was compiled to run on the web.
kReleaseMode → const bool
A constant that is true if the application was compiled in release mode.
kVerboseMode → const bool
A constant that is true if the application was run in verbose mode.
mustCallSuper → const Object
Annotation on instance member that overriding members must call.
nonVirtual → const Object
Annotation on instance member that must not be overridden.
optionalTypeArgs → const Object
Annotation on type arguments that can safely be omitted.
protected → const Object
Annotation on instance member that should only be used by subclasses.
sync → const SyncAnnotation
visibleForTesting → const Object
Annotation on a public declaration that should only be used in tests.

Functions

calculateReadingTime(String content, {int wordsPerMinute = 200}) → ReadingTimeResult
Calculate reading time for markdown or plain text content.
describeIdentity(Object? object) → String
Returns a summary of the runtime type and hash code of object.
events<V>({VoidCallback? onClick, ValueChanged<V>? onInput, ValueChanged<V>? onChange}) → Map<String, EventCallback>
Helper function to provide typed event handlers to the events property of html components.
fragment(List<Component> children, {Key? key}) → Component
Renders a list of children without any wrapping element.
lerpDuration(Duration a, Duration b, double t) → Duration
Linearly interpolate between two Durations.
objectRuntimeType(Object? object, String optimizedValue) → String
Framework code should use this method in favor of calling toString on Object.runtimeType.
raw(String text, {Key? key}) → Component
Renders its input as raw unescaped html using RawText.
runApp(Component app) → void
Main entry point for a jaspr app
shortHash(Object? object) → String
Returns a 5 character long hexadecimal string generated from Object.hashCode's 20 least-significant bits.
text(String text, {Key? key}) → Component
Renders a text node.

Typedefs

ABottomFloatingBanner = ArcaneBottomFloatingBanner
ACornerPromoToast = ArcaneCornerPromoToast
AExpandingFabPromo = ArcaneExpandingFabPromo
AFullscreenTakeover = ArcaneFullscreenTakeover
AInlineHeroBanner = ArcaneInlineHeroBanner
AMarqueeTickerBar = ArcaneMarqueeTickerBar
AMinimizablePromo = ArcaneMinimizablePromo
AProgressClaimBanner = ArcaneProgressClaimBanner
APromoModal = ArcanePromoModal
ArcaneGutterSize = GutterSize
ArcaneRangeSlider = _DeprecatedRangeSlider
ASlidingSidebarBanner = ArcaneSlidingSidebarBanner
AsyncCallback = Future<void> Function()
Signature of callbacks that have no arguments and return no data, but that return a Future to indicate when their work is complete.
AsyncComponentBuilder<T> = Component Function(BuildContext context, AsyncSnapshot<T> snapshot)
Signature for strategies that build components based on asynchronous interaction.
AsyncValueGetter<T> = Future<T> Function()
Signature for callbacks that are to asynchronously report a value on demand.
AsyncValueSetter<T> = Future<void> Function(T value)
Signature for callbacks that report that a value has been set and return a Future that completes when the value has been saved.
ATopAnnouncementBar = ArcaneTopAnnouncementBar
ComponentBuilder = Component Function(BuildContext context)
Signature for a function that creates a component, e.g. StatelessComponent.build or State.build.
ElementVisitor = void Function(Element element)
Signature for the callback to BuildContext.visitChildElements.
EmptyStateSize = EmptyStateSizeVariant
EmptyStateStyle = EmptyStateStyleVariant
EventCallback = void Function(Event event)
IterableFilter<T> = Iterable<T> Function(Iterable<T> input)
Signature for callbacks that filter an iterable.
Margin = Spacing
The margin CSS property sets the outer spacing of an element.
ResizablePanel = ResizablePanelData
ScrollbarStyle = ScrollbarStyleVariant
ScrollbarVisibility = ScrollbarVisibilityVariant
ScrollDirection = ScrollDirectionVariant
SelectInput = ArcaneSelect
StatefulComponentBuilder = Component Function(BuildContext context, StateSetter setState)
Signature for the builder callback used by StatefulBuilder.
StateSetter = void Function(VoidCallback fn)
The signature of State.setState functions.
TextArea = ArcaneTextArea
ValueChanged<T> = void Function(T value)
Signature for callbacks that report that an underlying value has changed.
ValueGetter<T> = T Function()
Signature for callbacks that are to report a value on demand.
ValueSetter<T> = void Function(T value)
Signature for callbacks that report that a value has been set.
VoidCallback = void Function()
Signature of callbacks that have no arguments and return no data.