aliases
library
Classes
AbstractStatefulScreen
AbstractStatelessScreen
AccordionItemProps
Accordion item data.
AccordionProps
Accordion component properties.
ActionSheetItem
An action item for ArcaneActionSheet.
AlertDialogProps
Alert dialog component properties.
AlertProps
Alert component properties.
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.
ArcaneBoolField
ArcaneBottomFloatingBanner
Bottom floating banner that slides up with optional countdown timer.
ArcaneBox
A container component with enum-based styling.
ArcaneBreadcrumbs
Navigation breadcrumbs component.
ArcaneCalendar
A calendar component for date selection.
ArcaneCarouselSection
Marketing section with an infinite carousel.
ArcaneChart
ArcaneChartPoint
ArcaneCheckbox
Checkbox input component.
ArcaneCircularProgress
Circular progress indicator.
ArcaneColorField
ArcaneColors
Color design tokens as CSS variable references.
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.
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.
ArcaneDateField
ArcaneDatePicker
A date picker input with calendar dropdown.
ArcaneDecoration
A per-instance, theme-permeable box surface — the semantic counterpart to
the literal ArcaneStyleData escape hatch (styles:).
ArcaneDialog
ArcaneDirection
ArcaneDisclosure
Disclosure widget using native HTML details/summary elements.
ArcaneDisclosureGroup
Group of disclosure widgets.
ArcaneDisclosureItem
Item in an ArcaneDisclosureGroup.
ArcaneDrawer
Slide-in drawer/sheet panel.
ArcaneDropdownDivider
Divider for dropdown menus - subtle horizontal line.
ArcaneDropdownItem
Dropdown item component with multiple style variants.
Dropdown menu component.
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.
ArcaneEnumField <T >
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.
ArcaneFieldDirectProvider <T >
Field provider delegating to custom getter/setter functions.
ArcaneFieldMapProvider <T >
Field provider using nested Map storage with dot notation access.
ArcaneFieldMetadata
Metadata for an ArcaneField.
ArcaneFieldProvider <T >
Abstract base class for form field providers.
ArcaneFieldStyles
ArcaneFieldWrapper
Wrapper for form fields providing consistent styling and layout.
ArcaneForm
Complete form component with built-in state management.
ArcaneFormContext
Form context data for accessing form state.
ArcaneFormProvider
Form provider component that manages form state.
ArcaneFormScope
Inherited component to provide form context to descendants.
ArcaneFormSection
Form section that groups multiple fields together.
ArcaneFullscreenTakeover
A dramatic full-screen takeover for major promotions.
ArcaneGallery
A themeable masonry gallery of media tiles.
ArcaneGalleryMedia
The primary media of a gallery tile.
ArcaneGalleryTile
One tile in an ArcaneGallery . Arcane owns the themed frame, the title/meta
placement, and the layout; the consumer fills the app-specific slots.
ArcaneGap
A flexible gap component.
ArcaneHeroCarousel
Hero carousel with full-width slides.
ArcaneHoverCard
A unified floating content component.
ArcaneIcon
Wrapper class providing access to all 1666 Lucide icons.
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.
ArcaneInteraction
ArcaneItem
ArcaneKbd
Keyboard shortcut display component.
ArcaneLayout
Layout design tokens.
ArcaneLoadingSpinner
Indeterminate loading spinner.
ArcaneMarqueeTickerBar
A scrolling marquee-style announcement bar.
Navigation dropdown with mega-menu style.
Section in a mega menu.
Horizontal menu bar component.
Top-level menu in the menubar.
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.
ArcaneNavDropdown
Hover-based navigation dropdown for header menus.
ArcaneNavigableCarousel
Carousel with navigation arrows.
ArcaneNotFoundAction
A recovery link rendered by ArcaneNotFoundPage .
ArcaneNotFoundPage
A theme-aware 404 surface with semantic recovery navigation.
ArcaneOtpInput
One-time password input with separate digit fields.
ArcanePage
A semantic, responsive page shell shared by Arcane Jaspr applications.
Page navigation component.
ArcanePopover
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.
ArcaneRadio
Radio button component.
ArcaneRadioGroup <T >
A radio button group component.
ArcaneRadius
Border radius design tokens.
ArcaneRangeSlider
ArcaneResizable
A resizable panel group with draggable dividers.
ArcaneScaffold
ArcaneScaffoldProps
ArcaneScripts
ArcaneScriptsComponent
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.
Sidebar navigation component.
Content that only displays when sidebar is collapsed.
ArcaneSidebarExpanded
Content that only displays when sidebar is expanded.
Sidebar item group with optional label.
Sidebar navigation item.
Fixed sidebar section that is always expanded.
Visual separator between sidebar groups or items.
Collapsible submenu section using native <details>/<summary>.
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.
A vertical sidebar banner that slides in from the edge of the screen.
ArcaneSonner
ArcaneSpacing
Spacing design tokens as CSS value strings.
ArcaneSpinner
ArcaneStatusBadge
Unified badge component for status indicators and card overlays.
ArcaneStringField
ArcaneStructuredCard
Card with header, body, and footer sections.
ArcaneStyleData
Immutable style configuration with type-safe enum properties.
ArcaneStylesheet
ArcaneTabBar
A simple tab bar without content for custom tab handling.
ArcaneTabBarItem
A tab bar item.
ArcaneTabItem
A tab item for ArcaneTabs.
ArcaneTableMd
ArcaneTabs
A tab component for switching between views.
ArcaneThemeProvider
Provides the current stylesheet and brightness to the component tree.
ArcaneTimeField
ArcaneToast
Toast notification component with auto-dismiss and global API support.
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.
AspectRatioProps
Aspect ratio container component properties.
AuthGuard
Stub route protection for non-web platforms.
AuthState
Authentication state container.
AuthUser
Represents an authenticated user.
AvatarProps
Avatar component properties.
BadgePosition
Position configuration for absolutely positioned badges.
Bar
Border
Border for BoxDecoration.
BorderRadius
Border radius for rounded corners.
BottomFloatingBannerProps
Props for the bottom floating banner.
BoxConstraints
Flutter-like box constraints.
BoxDecoration
Box decoration for Container.
BoxShadow
Box shadow for elevation effects.
BreadcrumbItem
Breadcrumb item in the navigation trail.
BreadcrumbItemProps
Breadcrumb item data.
BreadcrumbsProps
Breadcrumbs component properties.
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.
Button
A styled button component.
ButtonGroup
A group of related buttons or controls.
ButtonGroupProps
Button group component properties.
ButtonPanel
A panel component for action buttons, typically used in dialogs or footers.
ButtonPanelProps
Button panel component properties.
ButtonProps
CalendarProps
Calendar component properties.
Card
Card component with consistent styling and multiple variants.
CardCarousel
Horizontally scrollable widget container with edge fading.
CardCarouselTheme
Theme configuration for CardCarousel widgets.
CardProps
Card component properties.
CardSection
Carpet
Center
A center alignment component.
CenterBody
CenterProps
Center alignment component properties.
ChartPointProps
ChartProps
CheckboxProps
Checkbox component properties.
CheckItemProps
Check item component properties.
CheckListProps
Check list component properties.
CircularProgressProps
Circular progress component properties.
Collection
Color
ARGB color representation with CSS output.
Colors
Common color constants.
Column
A column layout component (vertical flex).
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.
ComponentRenderers
ConfirmDialogProps
Confirm dialog component properties.
ConfirmText
Container
A container component with styling options.
Context menu component properties.
CornerPromoToastProps
Props for the corner promo toast.
CssGenerator
Generates CSS variable blocks from ThemePalette .
CtaCard
A dashed-border, centered call-to-action card: an optional icon in an accent
circle, a bold title, a muted description, and a prominent CTA control that
links via href or invokes onTap . Themed automatically by the active
stylesheet.
CTACardProps
CTA (Call-to-Action) card component properties.
CycleButtonProps <T >
Cycle button component properties.
CycleOption <T >
Cycle option data.
DataColumn <T >
DataColumnProps <T >
Data column definition.
DataTable <T >
DataTableProps <T >
Data table component properties.
DatePickerProps
Date picker component properties.
DateRange
A date range.
DateRangeValue
Date range value.
DefaultLayoutRenderers
DeleteIconButton
DialogDate
DialogDateMulti
DialogDateRange
DialogEmail
DialogProps
Dialog component properties.
DialogText
DialogTime
DirectionProps
DisclosureGroupProps
Disclosure group component properties.
DisclosureItemProps
Disclosure item data.
DisclosureProps
Disclosure component properties.
DrawerProps
Drawer component properties.
Dropdown menu component properties.
EdgeInsets
Flutter-like edge insets for padding and margin.
EmptyStateProps
Empty state component properties.
Expanded
An expanded component that fills available space.
ExpandedProps
Expanded component properties.
Expander
ExpandingFabPromoProps
Props for the expanding FAB promo.
Fab
FabSocket
FadeEdgeProps
Fade edge component properties.
FancyIcon
FancyProgressBar
FeatureCard
A feature/navigation surface: an optional accent-tinted icon badge, a bold
title, a muted description, and an optional call-to-action row. Lays out
vertically by default and horizontally when horizontal is set. Becomes an
anchor when href is set, or a clickable button when onTap is set. Themed
automatically by the active stylesheet.
FeatureCardProps
Feature card component properties.
FeatureRowProps
Feature row component properties.
FieldWrapperProps
Field wrapper component properties.
FillScreen
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.
FormProps
Form component properties.
FormSectionProps
Form section component properties.
FullscreenTakeoverProps
Props for the fullscreen takeover.
GalleryProps
Properties for the gallery surface, passed to context.renderers.gallery.
GapProps
Gap component properties.
Glass
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.
GuestGuard
Stub guest route protection for non-web platforms.
Gutter
A spacing component that provides consistent gaps between elements.
GutterProps
Gutter/spacing component properties.
Icon
IconBadge
A small icon inside a tinted, rounded container — the ubiquitous
"colored icon circle/square" idiom as a first-class component.
IconButton
IconCard
A compact surface: an accent-tinted icon badge, a bold title, and an optional
muted subtitle. Becomes an anchor when href is set, or a clickable button
when onTap is set. Themed automatically by the active stylesheet.
IconCardProps
Icon card component properties.
Icons
Image
InheritedWidget
InlineHeroBannerProps
Props for the inline hero banner.
InputGroupProps
Input group component properties.
ItemProps
JasprAuthService
Stub implementation of JasprAuthService for non-web platforms.
KbdProps
Keyboard shortcut display component properties.
Key
A Key is an identifier for Component s and Element s.
KeyValueRow
KeyValueRowData
Key-value row data.
KeyValueTable
KeyValueTableProps
Key-value table component properties.
LayoutRenderers
LoadingSpinnerProps
Loading spinner component properties.
Logo
Markdown
MarqueeTickerBarProps
Props for the marquee ticker bar.
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.
MinimizablePromoProps
Props for the minimizable promo.
MutableText
NativeSelectOptionProps
NativeSelectProps
OnGesture
OnHover
OtpInputProps
OTP input component properties.
Padding
A padding wrapper component.
PaddingWrapperProps
Padding wrapper component properties.
Pagination component properties.
PaletteGenerator
Generates a complete ThemePalette from a ThemeSeed .
PasswordPolicy
Password validation policy with configurable requirements.
Positioned
A positioned child for use within a Stack.
PricingCard
A plan surface: an optional badge and icon, a title, a price row (optional
struck-through original price + large price + muted period), an optional
subtitle, an included/excluded feature list, an optional spec table, and a
call-to-action button. Themed automatically by the active stylesheet.
PricingCardProps
Pricing card component properties.
PricingGrid
A responsive grid of pricing cards, one per tiers entry, laid out in
columns equal columns (defaulting to one column per tier). Themed
automatically by the active stylesheet.
PricingGridProps
Pricing grid component properties.
PricingTier
Pricing tier data.
ProgressClaimBannerProps
Props for the progress claim banner.
ProgressProps
Progress bar component properties.
PromoModalProps
Props for the promo modal.
RadioCards <T >
RadioGroupProps <T >
Radio group component properties.
RadioOption <T >
Radio button option model.
RadioOptionProps <T >
Radio option data.
RadiusConfig
Border radius configuration for a theme.
RatingStars
A simple row of text rating stars (★/☆), sized by size and colored with
the palette's warning token. When interactive , each star click reports its
1-based position via onRatingChanged .
Simple rating stars component properties.
ReadingTimeResult
Result of reading time calculation.
ResizablePanelData
Resizable panel data.
ResizableProps
Resizable panel group component properties.
RichText
Rich text component supporting mixed styling.
Row
A row layout component (horizontal flex).
RowProps
Row layout component properties.
Screen
ScrollAreaProps
Scroll area component properties.
ScrollRailLayoutProps
Scroll rail layout component properties.
ScrollRailProps
Scroll rail component properties.
Search
SearchResult
Section
SelectOptionProps <T >
Select option data.
Selector <T >
SelectProps <T >
Select component properties.
SeparatorProps
Unified separator component properties.
SheetProps
Sheet/drawer component properties.
Sidebar group component properties.
Sidebar item component properties.
Sidebar component properties.
Sidebar section component properties (fixed, non-collapsible section).
Sidebar submenu component properties (collapsible section).
SizedBox
A sized box component.
SizedBoxProps
SizedBox component properties.
SkeletonProps
Skeleton component properties.
SliderProps
Slider component properties.
Props for the sliding sidebar banner.
SliverScreen
SlotCounterCardProps
Slot counter card component properties.
SlotCounterProps
Slot counter component properties.
SlotCounterRowProps
Slot counter row component properties.
Spacer
A flexible spacer component.
SpacerProps
Spacer component properties.
SpecEntry
Hardware/feature specification entry.
SpecRowProps
Spec row component properties.
Stack
An Stack component for positioning children on top of each other.
StatCard
A compact metric surface: an uppercase label, a large value, and optional
icon, trend, and description. Themed automatically by the active stylesheet.
StatCardProps
Stat card component properties.
StatCardRow
A responsive grid of StatCard s laid out in columns equal columns.
StatCardRowProps
Stat card row component properties.
StatefulWidget
StatelessWidget
StaticTable
StaticTableProps
Static table component properties.
StatusBadgeProps
Unified badge component properties.
TabBarItemProps
Tab bar item data.
TabBarProps
Tab bar component properties.
TabItemProps
Tab item data.
TabsProps
Tabs component properties.
TestimonialCard
A quote surface: an optional uniform accent border, a large decorative
quote, an optional rating row, and an author row (avatar or initials, name,
and a muted title · company line). Themed automatically by the active
stylesheet.
TestimonialCardProps
Testimonial card component properties.
Text
Text component with enum-based styling.
TextArea
A textarea component.
TextAreaProps
Text area component properties.
TextInput
A styled text input component.
TextInputProps
Text input component properties.
TextSpan
Text span for use within RichText.
ThemePalette
Complete color palette derived from ThemeSeed .
ThemeSeed
Minimal color input for theme generation.
Tile
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.
ToastData
Toast data for the queue.
ToastManager
Global toast manager singleton.
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.
UniqueKey
A key that is only equal to itself.
ValueKey <T >
A key that uses a value of a particular type to identify itself.
VirtualScrollProps <T >
Virtual scroll component properties.
Wrap
A flexible flow layout component that wraps children.
Functions
anchorAttrs (String anchorId → Map <String String
calculateReadingTime (String content , {int wordsPerMinute = 200 → ReadingTimeResult
Calculate reading time for markdown or plain text content.
calendarAttrs ({required String calendarId , required int year , required int month , String mode = 'single' , DateTime ?selected , DateTime ?rangeStart , DateTime ?rangeEnd , DateTime ?minDate , DateTime ?maxDate , bool showWeekNumbers = false , bool showToday = true , int firstDayOfWeek = 0 → Map <String String
calendarPickerAttrs (String calendarId → Map <String String
calendarTriggerAttrs (String calendarId → Map <String String
carouselAttrs ({required String groupId , required int activeIndex , required int slideCount , bool loop = false , String ?autoplayMs → Map <String String
carouselSlideAttrs ({required String groupId , required int index , bool active = false → Map <String String
cx (List <String ? classes → String
Joins CSS class names into a single space-separated string, skipping nulls
and blank entries.
dismissAttrs ()
→ Map <String String
encodeArcaneAction (ArcaneInteraction action → String
encodeArcaneActions (List <ArcaneInteraction actions → String
fieldAttrs ({required String formId , required String name , String ?value , bool required = false , bool disabled = false , String ?type , String ?validate → Map <String String
formAttrs ({required String formId , String ?endpoint , String ?method , bool resetOnSubmit = false → Map <String String
groupAttrs ({required String groupId , String mode = 'single' , String ?value , bool ?required , bool ?disabled , String ?minSelections , String ?maxSelections , String ?changeAction → Map <String String
groupItemAttrs ({required String groupId , required String value , bool selected = false , bool disabled = false → Map <String String
interactionAttrs (ArcaneInteraction ?action → Map <String String
interactionEventAttrs ({ArcaneInteraction ?onClick , ArcaneInteraction ?onChange , ArcaneInteraction ?onSubmit , ArcaneInteraction ?onDoubleClick , ArcaneInteraction ?onMouseEnter , ArcaneInteraction ?onMouseLeave , ArcaneInteraction ?onFocus , ArcaneInteraction ?onBlur , ArcaneInteraction ?onKeyDown , ArcaneInteraction ?onLongPress → Map <String String
mergeAttrs (List <Map <String String attrs → Map <String String
panelAttrs ({required String groupId , required String panelId , bool expanded = false , bool exclusive = false → Map <String String
panelContentAttrs ({required String groupId , required String panelId , bool expanded = false → Map <String String
runApp (Component app → void
Main entry point for a jaspr app
sliderAttrs ({required String sliderId , required double min , required double max , double ?value , double ?lo , double ?hi , double ?step , bool range = false , bool disabled = false , String ?changeAction → Map <String String
stepAttrs ({required String groupId , required int index , bool active = false , bool completed = false → Map <String String
stepperAttrs ({required String groupId , required int activeStep , required int stepCount , bool linear = true → Map <String String
surfaceAttrs ({required String surface , required String id , bool initiallyOpen = false , bool dismissible = true , bool escapeCloses = true , bool focusTrap = true , bool scrimCloses = true , bool restoreFocus = true , String ?anchorId , String ?anchorPlacement , String ?anchorOffset , String ?anchorAlign , String ?animation , String ?group , bool exclusive = false → Map <String String
tabPanelAttrs ({required String groupId , required String tabId , bool active = false → Map <String String
tabsAttrs ({required String groupId , required String activeTab , String orientation = 'horizontal' → Map <String String
tabTriggerAttrs ({required String groupId , required String tabId , bool active = false , bool disabled = false → Map <String String
textInputAttrs ({ArcaneInteraction ?onChange , ArcaneInteraction ?onSubmit , String ?formId , String ?fieldName , String ?fieldType , String ?fieldValidate , bool required = false , bool disabled = false → Map <String String
timePickerAttrs ({required String pickerId , bool use24Hour = false , bool clearable = true , String ?placeholder , String ?value → Map <String String
timePickerClearAttrs ()
→ Map <String String
timePickerDisplayAttrs ()
→ Map <String String
