Documentation
¶
Overview ¶
Package ui is the typed Go surface of Alacris UI — sixty-eight Material Design 3 components, a three-tier token system, and a theme engine.
Enable it on a page with alacris.Config{UI: true}. That loads every component and applies Material defaults (seed #e8ad18, Google Sans Flex, scheme from the OS). Config.Theme re-skins the whole page; every component follows because they consume system tokens.
A component's shadow content is rendered in the browser. What these functions produce is the element, its props and its light-DOM children.
Code in this package is generated from the vendored @alacris/ui sources. Do not edit it; change the upstream component or regenerate.
Code generated by alacris-go. DO NOT EDIT.
Index ¶
- Constants
- Variables
- func Accordion(p AccordionProps) *alacris.Element
- func AccordionItem(p AccordionItemProps) *alacris.Element
- func Alert(p AlertProps) *alacris.Element
- func AppBar(p AppBarProps) *alacris.Element
- func Autocomplete(p AutocompleteProps) *alacris.Element
- func Avatar(p AvatarProps) *alacris.Element
- func Backdrop(p BackdropProps) *alacris.Element
- func Badge(p BadgeProps) *alacris.Element
- func BottomAppBar(p BottomAppBarProps) *alacris.Element
- func BottomNav(p BottomNavProps) *alacris.Element
- func Breadcrumbs(p BreadcrumbsProps) *alacris.Element
- func Button(p ButtonProps) *alacris.Element
- func ButtonGroup(p ButtonGroupProps) *alacris.Element
- func Card(p CardProps) *alacris.Element
- func Carousel(p CarouselProps) *alacris.Element
- func CarouselItem(p CarouselItemProps) *alacris.Element
- func Checkbox(p CheckboxProps) *alacris.Element
- func Chip(p ChipProps) *alacris.Element
- func ChipSet(p ChipSetProps) *alacris.Element
- func Container(p ContainerProps) *alacris.Element
- func DatePicker(p DatePickerProps) *alacris.Element
- func Dialog(p DialogProps) *alacris.Element
- func Divider(p DividerProps) *alacris.Element
- func Drawer(p DrawerProps) *alacris.Element
- func Fab(p FabProps) *alacris.Element
- func FabMenu(p FabMenuProps) *alacris.Element
- func Icon(p IconProps) *alacris.Element
- func IconButton(p IconButtonProps) *alacris.Element
- func List(p ListProps) *alacris.Element
- func ListItem(p ListItemProps) *alacris.Element
- func LoadingIndicator(p LoadingIndicatorProps) *alacris.Element
- func Menu(p MenuProps) *alacris.Element
- func MenuItem(p MenuItemProps) *alacris.Element
- func NavItem(p NavItemProps) *alacris.Element
- func NavRail(p NavRailProps) *alacris.Element
- func Option(p OptionProps) *alacris.Element
- func Pagination(p PaginationProps) *alacris.Element
- func Pending() alacris.Pending
- func Progress(p ProgressProps) *alacris.Element
- func Radio(p RadioProps) *alacris.Element
- func RadioGroup(p RadioGroupProps) *alacris.Element
- func Rating(p RatingProps) *alacris.Element
- func Search(p SearchProps) *alacris.Element
- func Select(p SelectProps) *alacris.Element
- func Sheet(p SheetProps) *alacris.Element
- func SideSheet(p SideSheetProps) *alacris.Element
- func Skeleton(p SkeletonProps) *alacris.Element
- func Slider(p SliderProps) *alacris.Element
- func Snackbar(p SnackbarProps) *alacris.Element
- func Spinner(p SpinnerProps) *alacris.Element
- func SplitButton(p SplitButtonProps) *alacris.Element
- func Stack(p StackProps) *alacris.Element
- func Step(p StepProps) *alacris.Element
- func Stepper(p StepperProps) *alacris.Element
- func Surface(p SurfaceProps) *alacris.Element
- func Switch(p SwitchProps) *alacris.Element
- func Tab(p TabProps) *alacris.Element
- func TabPanel(p TabPanelProps) *alacris.Element
- func Table(p TableProps) *alacris.Element
- func TableFooter(p TableFooterProps) *alacris.Element
- func TableToolbar(p TableToolbarProps) *alacris.Element
- func Tabs(p TabsProps) *alacris.Element
- func Text(p TextProps) *alacris.Element
- func TextField(p TextFieldProps) *alacris.Element
- func TimePicker(p TimePickerProps) *alacris.Element
- func ToggleButton(p ToggleButtonProps) *alacris.Element
- func ToggleGroup(p ToggleGroupProps) *alacris.Element
- func Toolbar(p ToolbarProps) *alacris.Element
- func Tooltip(p TooltipProps) *alacris.Element
- type AccordionChangeDetail
- type AccordionHandle
- type AccordionItemHandle
- type AccordionItemProps
- type AccordionItemUIAccordionToggleDetail
- type AccordionProps
- type AlertHandle
- type AlertProps
- type AppBarHandle
- type AppBarProps
- type AutocompleteChangeDetail
- type AutocompleteHandle
- func (h AutocompleteHandle) Handle() live.Handle
- func (h AutocompleteHandle) SetDisabled(v bool)
- func (h AutocompleteHandle) SetFreeSolo(v bool)
- func (h AutocompleteHandle) SetLabel(v string)
- func (h AutocompleteHandle) SetName(v string)
- func (h AutocompleteHandle) SetOptions(v []any)
- func (h AutocompleteHandle) SetPlaceholder(v string)
- func (h AutocompleteHandle) SetRequired(v bool)
- func (h AutocompleteHandle) SetValue(v string)
- func (h AutocompleteHandle) SetVariant(v string)
- type AutocompleteInputDetail
- type AutocompleteProps
- type AvatarHandle
- type AvatarProps
- type BackdropCloseDetail
- type BackdropHandle
- type BackdropProps
- type BadgeHandle
- type BadgeProps
- type BottomAppBarHandle
- type BottomAppBarProps
- type BottomNavChangeDetail
- type BottomNavHandle
- type BottomNavProps
- type BreadcrumbsHandle
- type BreadcrumbsProps
- type ButtonGroupHandle
- type ButtonGroupProps
- type ButtonHandle
- type ButtonProps
- type CardHandle
- type CardProps
- type CarouselChangeDetail
- type CarouselHandle
- type CarouselItemHandle
- type CarouselItemProps
- type CarouselProps
- type CheckboxChangeDetail
- type CheckboxHandle
- func (h CheckboxHandle) Handle() live.Handle
- func (h CheckboxHandle) SetChecked(v bool)
- func (h CheckboxHandle) SetDisabled(v bool)
- func (h CheckboxHandle) SetIndeterminate(v bool)
- func (h CheckboxHandle) SetLabel(v string)
- func (h CheckboxHandle) SetName(v string)
- func (h CheckboxHandle) SetValue(v string)
- type CheckboxProps
- type ChipChangeDetail
- type ChipHandle
- type ChipProps
- type ChipSetChangeDetail
- type ChipSetHandle
- type ChipSetProps
- type ContainerHandle
- type ContainerProps
- type DatePickerChangeDetail
- type DatePickerHandle
- func (h DatePickerHandle) Handle() live.Handle
- func (h DatePickerHandle) SetDisabled(v bool)
- func (h DatePickerHandle) SetEnd(v string)
- func (h DatePickerHandle) SetLabel(v string)
- func (h DatePickerHandle) SetLocale(v string)
- func (h DatePickerHandle) SetMax(v string)
- func (h DatePickerHandle) SetMin(v string)
- func (h DatePickerHandle) SetName(v string)
- func (h DatePickerHandle) SetPlaceholder(v string)
- func (h DatePickerHandle) SetPresentation(v string)
- func (h DatePickerHandle) SetRange(v bool)
- func (h DatePickerHandle) SetRequired(v bool)
- func (h DatePickerHandle) SetStart(v string)
- func (h DatePickerHandle) SetValue(v string)
- func (h DatePickerHandle) SetVariant(v string)
- type DatePickerInputDetail
- type DatePickerProps
- type DialogCloseDetail
- type DialogHandle
- type DialogProps
- type DividerHandle
- type DividerProps
- type DrawerCloseDetail
- type DrawerHandle
- type DrawerProps
- type FabHandle
- type FabMenuHandle
- type FabMenuProps
- type FabProps
- type IconButtonChangeDetail
- type IconButtonHandle
- func (h IconButtonHandle) Handle() live.Handle
- func (h IconButtonHandle) SetDisabled(v bool)
- func (h IconButtonHandle) SetIcon(v string)
- func (h IconButtonHandle) SetLabel(v string)
- func (h IconButtonHandle) SetSelected(v bool)
- func (h IconButtonHandle) SetSelectedIcon(v string)
- func (h IconButtonHandle) SetToggle(v bool)
- func (h IconButtonHandle) SetVariant(v string)
- type IconButtonProps
- type IconHandle
- type IconProps
- type ListHandle
- type ListItemHandle
- func (h ListItemHandle) Handle() live.Handle
- func (h ListItemHandle) SetDisabled(v bool)
- func (h ListItemHandle) SetHeadline(v string)
- func (h ListItemHandle) SetHref(v string)
- func (h ListItemHandle) SetInteractive(v bool)
- func (h ListItemHandle) SetSelected(v bool)
- func (h ListItemHandle) SetSupporting(v string)
- type ListItemProps
- type ListProps
- type LoadingIndicatorHandle
- type LoadingIndicatorProps
- type MenuHandle
- type MenuItemHandle
- type MenuItemProps
- type MenuItemUIMenuSelectDetail
- type MenuProps
- type MenuSelectDetail
- type NavItemHandle
- func (h NavItemHandle) Handle() live.Handle
- func (h NavItemHandle) SetActiveIcon(v string)
- func (h NavItemHandle) SetDisabled(v bool)
- func (h NavItemHandle) SetIcon(v string)
- func (h NavItemHandle) SetLabel(v string)
- func (h NavItemHandle) SetSelected(v bool)
- func (h NavItemHandle) SetValue(v string)
- type NavItemProps
- type NavItemUINavSelectDetail
- type NavRailChangeDetail
- type NavRailHandle
- type NavRailProps
- type OptionHandle
- type OptionProps
- type PaginationChangeDetail
- type PaginationHandle
- func (h PaginationHandle) Handle() live.Handle
- func (h PaginationHandle) SetBoundaries(v float64)
- func (h PaginationHandle) SetCount(v float64)
- func (h PaginationHandle) SetDisabled(v bool)
- func (h PaginationHandle) SetLabel(v string)
- func (h PaginationHandle) SetPage(v float64)
- func (h PaginationHandle) SetSiblings(v float64)
- type PaginationProps
- type ProgressHandle
- type ProgressProps
- type RadioGroupChangeDetail
- type RadioGroupHandle
- type RadioGroupProps
- type RadioHandle
- type RadioProps
- type RadioUIRadioSelectDetail
- type RatingChangeDetail
- type RatingHandle
- type RatingProps
- type SearchChangeDetail
- type SearchHandle
- func (h SearchHandle) Handle() live.Handle
- func (h SearchHandle) SetDisabled(v bool)
- func (h SearchHandle) SetLabel(v string)
- func (h SearchHandle) SetName(v string)
- func (h SearchHandle) SetOpen(v bool)
- func (h SearchHandle) SetPlaceholder(v string)
- func (h SearchHandle) SetPresentation(v string)
- func (h SearchHandle) SetValue(v string)
- type SearchInputDetail
- type SearchProps
- type SearchSubmitDetail
- type SelectChangeDetail
- type SelectHandle
- func (h SelectHandle) Handle() live.Handle
- func (h SelectHandle) SetDisabled(v bool)
- func (h SelectHandle) SetLabel(v string)
- func (h SelectHandle) SetName(v string)
- func (h SelectHandle) SetPlaceholder(v string)
- func (h SelectHandle) SetRequired(v bool)
- func (h SelectHandle) SetSearch(v string)
- func (h SelectHandle) SetSearchPlaceholder(v string)
- func (h SelectHandle) SetSearchThreshold(v float64)
- func (h SelectHandle) SetValue(v string)
- func (h SelectHandle) SetVariant(v string)
- type SelectProps
- type SheetCloseDetail
- type SheetHandle
- type SheetProps
- type SideSheetCloseDetail
- type SideSheetHandle
- type SideSheetProps
- type SkeletonHandle
- type SkeletonProps
- type SliderChangeDetail
- type SliderHandle
- func (h SliderHandle) Handle() live.Handle
- func (h SliderHandle) SetDisabled(v bool)
- func (h SliderHandle) SetLabel(v string)
- func (h SliderHandle) SetMax(v float64)
- func (h SliderHandle) SetMin(v float64)
- func (h SliderHandle) SetName(v string)
- func (h SliderHandle) SetRange(v bool)
- func (h SliderHandle) SetShowValue(v bool)
- func (h SliderHandle) SetStep(v float64)
- func (h SliderHandle) SetValue(v float64)
- func (h SliderHandle) SetValueEnd(v float64)
- func (h SliderHandle) SetValueStart(v float64)
- type SliderInputDetail
- type SliderProps
- type SnackbarCloseDetail
- type SnackbarHandle
- type SnackbarProps
- type SpinnerHandle
- type SpinnerProps
- type SplitButtonHandle
- type SplitButtonProps
- type SplitButtonSelectDetail
- type StackHandle
- type StackProps
- type StepHandle
- type StepProps
- type StepperHandle
- type StepperProps
- type SurfaceHandle
- type SurfaceProps
- type SwitchChangeDetail
- type SwitchHandle
- type SwitchProps
- type TabHandle
- type TabPanelHandle
- type TabPanelProps
- type TabProps
- type TabUITabSelectDetail
- type TableChangeDetail
- type TableColumnVisibilityDetail
- type TableDensityDetail
- type TableExportDetail
- type TableFilterDetail
- type TableFooterHandle
- func (h TableFooterHandle) Handle() live.Handle
- func (h TableFooterHandle) SetDisabled(v bool)
- func (h TableFooterHandle) SetLabel(v string)
- func (h TableFooterHandle) SetPage(v float64)
- func (h TableFooterHandle) SetPageSize(v float64)
- func (h TableFooterHandle) SetPageSizeOptions(v []any)
- func (h TableFooterHandle) SetRowCount(v float64)
- type TableFooterPageDetail
- type TableFooterProps
- type TableGroupDetail
- type TableHandle
- func (h TableHandle) Handle() live.Handle
- func (h TableHandle) SetColumnMenu(v bool)
- func (h TableHandle) SetColumns(v []any)
- func (h TableHandle) SetCsvExport(v bool)
- func (h TableHandle) SetCsvFileName(v string)
- func (h TableHandle) SetDense(v bool)
- func (h TableHandle) SetDensity(v string)
- func (h TableHandle) SetDensityMenu(v bool)
- func (h TableHandle) SetEmptyText(v string)
- func (h TableHandle) SetExpandedGroups(v []any)
- func (h TableHandle) SetFilter(v string)
- func (h TableHandle) SetGetRowID(v map[string]any)
- func (h TableHandle) SetGroupBy(v string)
- func (h TableHandle) SetHeadline(v string)
- func (h TableHandle) SetHiddenColumns(v []any)
- func (h TableHandle) SetLabel(v string)
- func (h TableHandle) SetLoading(v bool)
- func (h TableHandle) SetMaxHeight(v string)
- func (h TableHandle) SetPage(v float64)
- func (h TableHandle) SetPageSize(v float64)
- func (h TableHandle) SetPageSizeOptions(v []any)
- func (h TableHandle) SetPaginationMode(v string)
- func (h TableHandle) SetQuickFilter(v bool)
- func (h TableHandle) SetRowCount(v float64)
- func (h TableHandle) SetRows(v []any)
- func (h TableHandle) SetSelectable(v string)
- func (h TableHandle) SetSelected(v []any)
- func (h TableHandle) SetSortBy(v string)
- func (h TableHandle) SetSortDir(v string)
- func (h TableHandle) SetSortMode(v string)
- func (h TableHandle) SetStickyFirst(v bool)
- func (h TableHandle) SetStickyHeader(v bool)
- func (h TableHandle) SetStriped(v bool)
- func (h TableHandle) SetSupporting(v string)
- func (h TableHandle) SetVariant(v string)
- type TablePageDetail
- type TableProps
- type TableRowClickDetail
- type TableSortDetail
- type TableToolbarColumnVisibilityDetail
- type TableToolbarDensityDetail
- type TableToolbarExportDetail
- type TableToolbarFilterDetail
- type TableToolbarHandle
- func (h TableToolbarHandle) Handle() live.Handle
- func (h TableToolbarHandle) SetColumnMenu(v bool)
- func (h TableToolbarHandle) SetColumns(v []any)
- func (h TableToolbarHandle) SetCsvExport(v bool)
- func (h TableToolbarHandle) SetDensity(v string)
- func (h TableToolbarHandle) SetDensityMenu(v bool)
- func (h TableToolbarHandle) SetDisabled(v bool)
- func (h TableToolbarHandle) SetFilter(v string)
- func (h TableToolbarHandle) SetHeadline(v string)
- func (h TableToolbarHandle) SetHiddenColumns(v []any)
- func (h TableToolbarHandle) SetQuickFilter(v bool)
- func (h TableToolbarHandle) SetSelectedCount(v float64)
- func (h TableToolbarHandle) SetSupporting(v string)
- type TableToolbarProps
- type TabsChangeDetail
- type TabsHandle
- type TabsProps
- type TextFieldChangeDetail
- type TextFieldHandle
- func (h TextFieldHandle) Handle() live.Handle
- func (h TextFieldHandle) SetAutocapitalize(v string)
- func (h TextFieldHandle) SetAutocomplete(v string)
- func (h TextFieldHandle) SetAutocorrect(v string)
- func (h TextFieldHandle) SetClearable(v bool)
- func (h TextFieldHandle) SetDisabled(v bool)
- func (h TextFieldHandle) SetEnterkeyhint(v string)
- func (h TextFieldHandle) SetError(v string)
- func (h TextFieldHandle) SetHelper(v string)
- func (h TextFieldHandle) SetInputmode(v string)
- func (h TextFieldHandle) SetLabel(v string)
- func (h TextFieldHandle) SetMaxlength(v float64)
- func (h TextFieldHandle) SetName(v string)
- func (h TextFieldHandle) SetPlaceholder(v string)
- func (h TextFieldHandle) SetRequired(v bool)
- func (h TextFieldHandle) SetRows(v float64)
- func (h TextFieldHandle) SetSpellcheck(v string)
- func (h TextFieldHandle) SetType(v string)
- func (h TextFieldHandle) SetValue(v string)
- func (h TextFieldHandle) SetVariant(v string)
- type TextFieldInputDetail
- type TextFieldProps
- type TextHandle
- type TextProps
- type TimePickerChangeDetail
- type TimePickerHandle
- func (h TimePickerHandle) Handle() live.Handle
- func (h TimePickerHandle) SetDisabled(v bool)
- func (h TimePickerHandle) SetHourCycle(v string)
- func (h TimePickerHandle) SetLabel(v string)
- func (h TimePickerHandle) SetLocale(v string)
- func (h TimePickerHandle) SetMinuteStep(v float64)
- func (h TimePickerHandle) SetName(v string)
- func (h TimePickerHandle) SetPlaceholder(v string)
- func (h TimePickerHandle) SetRequired(v bool)
- func (h TimePickerHandle) SetValue(v string)
- func (h TimePickerHandle) SetVariant(v string)
- func (h TimePickerHandle) SetView(v string)
- type TimePickerInputDetail
- type TimePickerProps
- type ToggleButtonHandle
- type ToggleButtonProps
- type ToggleButtonUIToggleDetail
- type ToggleGroupChangeDetail
- type ToggleGroupHandle
- type ToggleGroupProps
- type ToolbarHandle
- type ToolbarProps
- type TooltipHandle
- type TooltipProps
Constants ¶
const ( // message body AlertSlotDefault = "" // trailing action, e.g. a text <ui-button> AlertSlotAction = "action" )
Slots exposed by <ui-alert>. Put one on your own markup to fill it:
<h3 slot={ AlertSlotDefault }>
const ( AppBarSlotNavigation = "navigation" // title text AppBarSlotDefault = "" // trailing icon buttons AppBarSlotActions = "actions" )
Slots exposed by <ui-app-bar>. Put one on your own markup to fill it:
<h3 slot={ AppBarSlotNavigation }>
const ( // every keystroke; detail: { value } (the raw text) AutocompleteEventInput = "input" // committed; detail: { value } AutocompleteEventChange = "change" )
Events emitted by <ui-autocomplete>. Forward one to a server action with On:
Autocomplete(props).On(AutocompleteEventInput, "handler-name")
const ( BottomAppBarSlotNavigation = "navigation" // trailing icon buttons BottomAppBarSlotActions = "actions" // optional <ui-fab> BottomAppBarSlotFab = "fab" )
Slots exposed by <ui-bottom-app-bar>. Put one on your own markup to fill it:
<h3 slot={ BottomAppBarSlotNavigation }>
const ( // label ButtonSlotDefault = "" // leading icon ButtonSlotIcon = "icon" // trailing icon ButtonSlotTrailing = "trailing" )
Slots exposed by <ui-button>. Put one on your own markup to fill it:
<h3 slot={ ButtonSlotDefault }>
const ( // card body (compose freely; padding is yours via parts/vars) CardSlotDefault = "" // full-bleed media at the top CardSlotMedia = "media" )
Slots exposed by <ui-card>. Put one on your own markup to fill it:
<h3 slot={ CardSlotDefault }>
const ( // filter chip toggled; detail: { selected } ChipEventChange = "change" // remove requested (after the collapse animation) ChipEventDismiss = "dismiss" )
Events emitted by <ui-chip>. Forward one to a server action with On:
Chip(props).On(ChipEventChange, "handler-name")
const ( // committed; detail: { value } or { start, end, value } when range DatePickerEventChange = "change" // field keystroke; detail: { value } (the raw text) DatePickerEventInput = "input" // calendar visible (after the enter animation); does not bubble DatePickerEventOpen = "open" // calendar removed (after the exit animation); does not bubble DatePickerEventClose = "close" )
Events emitted by <ui-date-picker>. Forward one to a server action with On:
DatePicker(props).On(DatePickerEventChange, "handler-name")
const ( // body content DialogSlotDefault = "" DialogSlotHeadline = "headline" // right-aligned buttons DialogSlotActions = "actions" )
Slots exposed by <ui-dialog>. Put one on your own markup to fill it:
<h3 slot={ DialogSlotDefault }>
const ( // detail: { reason: 'esc' | 'scrim' | 'method' } DialogEventClose = "close" // enter animation finished DialogEventOpened = "opened" // exit animation finished, DOM removed DialogEventClosed = "closed" )
Events emitted by <ui-dialog>. Forward one to a server action with On:
Dialog(props).On(DialogEventClose, "handler-name")
const ( // modal dismissed; detail: { reason: 'esc' | 'scrim' } DrawerEventClose = "close" // modal enter animation finished DrawerEventOpened = "opened" // modal exit animation finished, DOM removed DrawerEventClosed = "closed" )
Events emitted by <ui-drawer>. Forward one to a server action with On:
Drawer(props).On(DrawerEventClose, "handler-name")
const ( // the <ui-fab> that toggles the menu FabMenuSlotTrigger = "trigger" // related <ui-fab> actions FabMenuSlotDefault = "" )
Slots exposed by <ui-fab-menu>. Put one on your own markup to fill it:
<h3 slot={ FabMenuSlotTrigger }>
const ( // menu visible (after the enter animation); does not bubble FabMenuEventOpen = "open" // menu removed (after the exit animation); does not bubble FabMenuEventClose = "close" )
Events emitted by <ui-fab-menu>. Forward one to a server action with On:
FabMenu(props).On(FabMenuEventOpen, "handler-name")
const ( // headline content when the prop is empty ListItemSlotDefault = "" // icon / avatar / checkbox ListItemSlotLeading = "leading" // secondary line when the prop is empty ListItemSlotSupporting = "supporting" // trailing meta text or icon ListItemSlotTrailing = "trailing" )
Slots exposed by <ui-list-item>. Put one on your own markup to fill it:
<h3 slot={ ListItemSlotDefault }>
const ( // the trigger element MenuSlotAnchor = "anchor" // <ui-menu-item> children MenuSlotDefault = "" )
Slots exposed by <ui-menu>. Put one on your own markup to fill it:
<h3 slot={ MenuSlotAnchor }>
const ( // an item was chosen; detail: { value } MenuEventSelect = "select" // panel visible (after the enter animation); does not bubble MenuEventOpen = "open" // panel removed (after the exit animation); does not bubble MenuEventClose = "close" )
Events emitted by <ui-menu>. Forward one to a server action with On:
Menu(props).On(MenuEventSelect, "handler-name")
const ( // label MenuItemSlotDefault = "" // custom leading icon when `icon` is empty MenuItemSlotIcon = "icon" // trailing hint (keyboard shortcut, badge) MenuItemSlotTrailing = "trailing" )
Slots exposed by <ui-menu-item>. Put one on your own markup to fill it:
<h3 slot={ MenuItemSlotDefault }>
const ( NavRailSlotMenu = "menu" NavRailSlotFab = "fab" NavRailSlotDefault = "" )
Slots exposed by <ui-nav-rail>. Put one on your own markup to fill it:
<h3 slot={ NavRailSlotMenu }>
const ( // replaces the search icon SearchSlotLeading = "leading" // after the clear button (avatar, extra actions) SearchSlotTrailing = "trailing" // suggestion rows (ui-list-item, …). The panel is a list so those rows keep role="listitem"; it is not a listbox. SearchSlotDefault = "" )
Slots exposed by <ui-search>. Put one on your own markup to fill it:
<h3 slot={ SearchSlotLeading }>
const ( // every keystroke; detail: { value } SearchEventInput = "input" // committed (blur/Enter); detail: { value } SearchEventChange = "change" // Enter pressed; detail: { value } SearchEventSubmit = "submit" // the clear affordance was used SearchEventClear = "clear" // suggestions visible (after the enter animation); does not bubble SearchEventOpen = "open" // suggestions removed (after the exit animation); does not bubble SearchEventClose = "close" )
Events emitted by <ui-search>. Forward one to a server action with On:
Search(props).On(SearchEventInput, "handler-name")
const ( // an option was chosen; detail: { value } SelectEventChange = "change" // panel enter animation finished; does not bubble SelectEventOpen = "open" // panel exit animation finished; does not bubble SelectEventClose = "close" )
Events emitted by <ui-select>. Forward one to a server action with On:
Select(props).On(SelectEventChange, "handler-name")
const ( // body content SheetSlotDefault = "" SheetSlotHeadline = "headline" SheetSlotActions = "actions" )
Slots exposed by <ui-sheet>. Put one on your own markup to fill it:
<h3 slot={ SheetSlotDefault }>
const ( // detail: { reason: 'esc' | 'scrim' | 'method' } SheetEventClose = "close" // enter animation finished SheetEventOpened = "opened" // exit animation finished, DOM removed SheetEventClosed = "closed" )
Events emitted by <ui-sheet>. Forward one to a server action with On:
Sheet(props).On(SheetEventClose, "handler-name")
const ( // body content SideSheetSlotDefault = "" SideSheetSlotHeadline = "headline" SideSheetSlotActions = "actions" )
Slots exposed by <ui-side-sheet>. Put one on your own markup to fill it:
<h3 slot={ SideSheetSlotDefault }>
const ( // detail: { reason: 'esc' | 'scrim' | 'method' } SideSheetEventClose = "close" // enter animation finished SideSheetEventOpened = "opened" // exit animation finished, DOM removed SideSheetEventClosed = "closed" )
Events emitted by <ui-side-sheet>. Forward one to a server action with On:
SideSheet(props).On(SideSheetEventClose, "handler-name")
const ( // every drag/keystroke; detail: { value } or { start, end } SliderEventInput = "input" // committed value; detail: { value } or { start, end } SliderEventChange = "change" )
Events emitted by <ui-slider>. Forward one to a server action with On:
Slider(props).On(SliderEventInput, "handler-name")
const ( // action button pressed SnackbarEventAction = "action" // detail: { reason: 'timeout' | 'action' | 'close' | 'method' } SnackbarEventClose = "close" // enter animation finished SnackbarEventOpened = "opened" // exit animation finished, DOM removed SnackbarEventClosed = "closed" )
Events emitted by <ui-snackbar>. Forward one to a server action with On:
Snackbar(props).On(SnackbarEventAction, "handler-name")
const ( // leading-segment label SplitButtonSlotDefault = "" // leading icon on the primary action SplitButtonSlotIcon = "icon" // <ui-menu-item> children SplitButtonSlotMenu = "menu" )
Slots exposed by <ui-split-button>. Put one on your own markup to fill it:
<h3 slot={ SplitButtonSlotDefault }>
const ( // native <table> (markup mode) TableSlotDefault = "" // replaces the default <ui-table-toolbar> TableSlotToolbar = "toolbar" // projected into the default toolbar TableSlotHeadline = "headline" // projected into the default toolbar TableSlotSupporting = "supporting" // projected into the default toolbar TableSlotActions = "actions" // replaces the default <ui-table-footer> TableSlotEmpty = "empty" )
Slots exposed by <ui-table>. Put one on your own markup to fill it:
<h3 slot={ TableSlotDefault }>
const ( // selection; detail: { selected } TableEventChange = "change" // detail: { key, dir } TableEventSort = "sort" // detail: { page, pageSize } TableEventPage = "page" // detail: { value } TableEventFilter = "filter" // detail: { density } TableEventDensity = "density" // detail: { hidden } TableEventColumnVisibility = "column-visibility" // a group was toggled; detail: { key, expanded, expandedGroups } TableEventGroup = "group" // detail: { id, row } TableEventRowClick = "row-click" // CSV produced; detail: { format, filename } TableEventExport = "export" )
Events emitted by <ui-table>. Forward one to a server action with On:
Table(props).On(TableEventChange, "handler-name")
const ( // replaces the headline text TableToolbarSlotHeadline = "headline" TableToolbarSlotSupporting = "supporting" // extra trailing controls (after the built-in tools) TableToolbarSlotActions = "actions" )
Slots exposed by <ui-table-toolbar>. Put one on your own markup to fill it:
<h3 slot={ TableToolbarSlotHeadline }>
const ( // quick filter changed; detail: { value } TableToolbarEventFilter = "filter" // density chosen; detail: { density } TableToolbarEventDensity = "density" // a column was toggled; detail: { hidden } TableToolbarEventColumnVisibility = "column-visibility" // export requested; detail: { format: 'csv' } TableToolbarEventExport = "export" )
Events emitted by <ui-table-toolbar>. Forward one to a server action with On:
TableToolbar(props).On(TableToolbarEventFilter, "handler-name")
const ( // <ui-tab> children TabsSlotDefault = "" // <ui-tab-panel> children TabsSlotPanels = "panels" )
Slots exposed by <ui-tabs>. Put one on your own markup to fill it:
<h3 slot={ TabsSlotDefault }>
const ( // icon before the input TextFieldSlotLeading = "leading" // icon after the input (replaced by ✕ while clearable+content) TextFieldSlotTrailing = "trailing" )
Slots exposed by <ui-text-field>. Put one on your own markup to fill it:
<h3 slot={ TextFieldSlotLeading }>
const ( // every keystroke; detail: { value } TextFieldEventInput = "input" // committed (blur/Enter); detail: { value } TextFieldEventChange = "change" // the clear affordance was used TextFieldEventClear = "clear" )
Events emitted by <ui-text-field>. Forward one to a server action with On:
TextField(props).On(TextFieldEventInput, "handler-name")
const ( // committed; detail: { value } TimePickerEventChange = "change" // field keystroke; detail: { value } (the raw text) TimePickerEventInput = "input" // panel visible (after the enter animation); does not bubble TimePickerEventOpen = "open" // panel removed (after the exit animation); does not bubble TimePickerEventClose = "close" )
Events emitted by <ui-time-picker>. Forward one to a server action with On:
TimePicker(props).On(TimePickerEventChange, "handler-name")
const ( // icon buttons and other actions ToolbarSlotDefault = "" // optional <ui-fab> attached to the end ToolbarSlotFab = "fab" )
Slots exposed by <ui-toolbar>. Put one on your own markup to fill it:
<h3 slot={ ToolbarSlotDefault }>
const ( // the target TooltipSlotDefault = "" // rich tooltip content (title/body/actions) when `rich` TooltipSlotContent = "content" )
Slots exposed by <ui-tooltip>. Put one on your own markup to fill it:
<h3 slot={ TooltipSlotDefault }>
const (
// a panel was toggled by the user; detail: { value }
AccordionEventChange = "change"
)
Events emitted by <ui-accordion>. Forward one to a server action with On:
Accordion(props).On(AccordionEventChange, "handler-name")
const (
// header activated; detail: { value, expanded }
AccordionItemEventUIAccordionToggle = "ui-accordion-toggle"
)
Events emitted by <ui-accordion-item>. Forward one to a server action with On:
AccordionItem(props).On(AccordionItemEventUIAccordionToggle, "handler-name")
const (
// panel content
AccordionItemSlotDefault = ""
)
Slots exposed by <ui-accordion-item>. Put one on your own markup to fill it:
<h3 slot={ AccordionItemSlotDefault }>
const AccordionItemTag = "ui-accordion-item"
AccordionItemTag is the name of the <ui-accordion-item> custom element.
const (
// <ui-accordion-item> children
AccordionSlotDefault = ""
)
Slots exposed by <ui-accordion>. Put one on your own markup to fill it:
<h3 slot={ AccordionSlotDefault }>
const AccordionTag = "ui-accordion"
AccordionTag is the name of the <ui-accordion> custom element.
const (
// close button pressed, after the collapse animation
AlertEventDismiss = "dismiss"
)
Events emitted by <ui-alert>. Forward one to a server action with On:
Alert(props).On(AlertEventDismiss, "handler-name")
const AlertTag = "ui-alert"
AlertTag is the name of the <ui-alert> custom element.
const AppBarTag = "ui-app-bar"
AppBarTag is the name of the <ui-app-bar> custom element.
const AutocompleteTag = "ui-autocomplete"
AutocompleteTag is the name of the <ui-autocomplete> custom element.
const (
// custom content when src/name/icon are all empty
AvatarSlotDefault = ""
)
Slots exposed by <ui-avatar>. Put one on your own markup to fill it:
<h3 slot={ AvatarSlotDefault }>
const AvatarTag = "ui-avatar"
AvatarTag is the name of the <ui-avatar> custom element.
const (
// scrim clicked; detail: { reason: 'scrim' }
BackdropEventClose = "close"
)
Events emitted by <ui-backdrop>. Forward one to a server action with On:
Backdrop(props).On(BackdropEventClose, "handler-name")
const BackdropTag = "ui-backdrop"
BackdropTag is the name of the <ui-backdrop> custom element.
const (
// the anchored content
BadgeSlotDefault = ""
)
Slots exposed by <ui-badge>. Put one on your own markup to fill it:
<h3 slot={ BadgeSlotDefault }>
const BadgeTag = "ui-badge"
BadgeTag is the name of the <ui-badge> custom element.
const BottomAppBarTag = "ui-bottom-app-bar"
BottomAppBarTag is the name of the <ui-bottom-app-bar> custom element.
const (
BottomNavEventChange = "change"
)
Events emitted by <ui-bottom-nav>. Forward one to a server action with On:
BottomNav(props).On(BottomNavEventChange, "handler-name")
const (
BottomNavSlotDefault = ""
)
Slots exposed by <ui-bottom-nav>. Put one on your own markup to fill it:
<h3 slot={ BottomNavSlotDefault }>
BottomNavTag is the name of the <ui-bottom-nav> custom element.
const (
// the trail items. Children MUST be elements (<a>, <span>, <ui-button variant="text">, …), never bare text nodes — separators are drawn with ::slotted(*)::before, which only exists on element children. Mark the current page with aria-current="page".
BreadcrumbsSlotDefault = ""
)
Slots exposed by <ui-breadcrumbs>. Put one on your own markup to fill it:
<h3 slot={ BreadcrumbsSlotDefault }>
const BreadcrumbsTag = "ui-breadcrumbs"
BreadcrumbsTag is the name of the <ui-breadcrumbs> custom element.
const (
// the <ui-button> children
ButtonGroupSlotDefault = ""
)
Slots exposed by <ui-button-group>. Put one on your own markup to fill it:
<h3 slot={ ButtonGroupSlotDefault }>
const ButtonGroupTag = "ui-button-group"
ButtonGroupTag is the name of the <ui-button-group> custom element.
const ButtonTag = "ui-button"
ButtonTag is the name of the <ui-button> custom element.
const (
// interactive card activated (click/Enter/Space)
CardEventAction = "action"
)
Events emitted by <ui-card>. Forward one to a server action with On:
Card(props).On(CardEventAction, "handler-name")
const CardTag = "ui-card"
CardTag is the name of the <ui-card> custom element.
const (
// index moved; detail: { index }
CarouselEventChange = "change"
)
Events emitted by <ui-carousel>. Forward one to a server action with On:
Carousel(props).On(CarouselEventChange, "handler-name")
const (
// slide content
CarouselItemSlotDefault = ""
)
Slots exposed by <ui-carousel-item>. Put one on your own markup to fill it:
<h3 slot={ CarouselItemSlotDefault }>
const CarouselItemTag = "ui-carousel-item"
CarouselItemTag is the name of the <ui-carousel-item> custom element.
const (
// <ui-carousel-item> children
CarouselSlotDefault = ""
)
Slots exposed by <ui-carousel>. Put one on your own markup to fill it:
<h3 slot={ CarouselSlotDefault }>
const CarouselTag = "ui-carousel"
CarouselTag is the name of the <ui-carousel> custom element.
const (
// detail: { checked, indeterminate: false }
CheckboxEventChange = "change"
)
Events emitted by <ui-checkbox>. Forward one to a server action with On:
Checkbox(props).On(CheckboxEventChange, "handler-name")
const CheckboxTag = "ui-checkbox"
CheckboxTag is the name of the <ui-checkbox> custom element.
const (
// single-select mode only; detail: { value }
ChipSetEventChange = "change"
)
Events emitted by <ui-chip-set>. Forward one to a server action with On:
ChipSet(props).On(ChipSetEventChange, "handler-name")
const (
// <ui-chip> children
ChipSetSlotDefault = ""
)
Slots exposed by <ui-chip-set>. Put one on your own markup to fill it:
<h3 slot={ ChipSetSlotDefault }>
const ChipSetTag = "ui-chip-set"
ChipSetTag is the name of the <ui-chip-set> custom element.
const (
// the chip label
ChipSlotDefault = ""
)
Slots exposed by <ui-chip>. Put one on your own markup to fill it:
<h3 slot={ ChipSlotDefault }>
const ChipTag = "ui-chip"
ChipTag is the name of the <ui-chip> custom element.
const (
ContainerSlotDefault = ""
)
Slots exposed by <ui-container>. Put one on your own markup to fill it:
<h3 slot={ ContainerSlotDefault }>
const ContainerTag = "ui-container"
ContainerTag is the name of the <ui-container> custom element.
const DatePickerTag = "ui-date-picker"
DatePickerTag is the name of the <ui-date-picker> custom element.
const DialogTag = "ui-dialog"
DialogTag is the name of the <ui-dialog> custom element.
const DividerTag = "ui-divider"
DividerTag is the name of the <ui-divider> custom element.
const (
// drawer content
DrawerSlotDefault = ""
)
Slots exposed by <ui-drawer>. Put one on your own markup to fill it:
<h3 slot={ DrawerSlotDefault }>
const DrawerTag = "ui-drawer"
DrawerTag is the name of the <ui-drawer> custom element.
const FabMenuTag = "ui-fab-menu"
FabMenuTag is the name of the <ui-fab-menu> custom element.
const (
// custom icon content when `icon` is empty
FabSlotDefault = ""
)
Slots exposed by <ui-fab>. Put one on your own markup to fill it:
<h3 slot={ FabSlotDefault }>
const FabTag = "ui-fab"
FabTag is the name of the <ui-fab> custom element.
const (
// toggle flipped; detail: { selected }
IconButtonEventChange = "change"
)
Events emitted by <ui-icon-button>. Forward one to a server action with On:
IconButton(props).On(IconButtonEventChange, "handler-name")
const (
// custom icon content when `icon` is empty
IconButtonSlotDefault = ""
)
Slots exposed by <ui-icon-button>. Put one on your own markup to fill it:
<h3 slot={ IconButtonSlotDefault }>
const IconButtonTag = "ui-icon-button"
IconButtonTag is the name of the <ui-icon-button> custom element.
const (
// a custom <svg> when no name is given
IconSlotDefault = ""
)
Slots exposed by <ui-icon>. Put one on your own markup to fill it:
<h3 slot={ IconSlotDefault }>
const IconTag = "ui-icon"
IconTag is the name of the <ui-icon> custom element.
const ListItemTag = "ui-list-item"
ListItemTag is the name of the <ui-list-item> custom element.
const (
// <ui-list-item> elements (and <ui-divider>s)
ListSlotDefault = ""
)
Slots exposed by <ui-list>. Put one on your own markup to fill it:
<h3 slot={ ListSlotDefault }>
const ListTag = "ui-list"
ListTag is the name of the <ui-list> custom element.
const LoadingIndicatorTag = "ui-loading-indicator"
LoadingIndicatorTag is the name of the <ui-loading-indicator> custom element.
const (
// internal; detail: { value } (consumed by <ui-menu>)
MenuItemEventUIMenuSelect = "ui-menu-select"
)
Events emitted by <ui-menu-item>. Forward one to a server action with On:
MenuItem(props).On(MenuItemEventUIMenuSelect, "handler-name")
const MenuItemTag = "ui-menu-item"
MenuItemTag is the name of the <ui-menu-item> custom element.
const MenuTag = "ui-menu"
MenuTag is the name of the <ui-menu> custom element.
const (
NavItemEventUINavSelect = "ui-nav-select"
)
Events emitted by <ui-nav-item>. Forward one to a server action with On:
NavItem(props).On(NavItemEventUINavSelect, "handler-name")
const (
NavItemSlotIcon = "icon"
)
Slots exposed by <ui-nav-item>. Put one on your own markup to fill it:
<h3 slot={ NavItemSlotIcon }>
NavItemTag is the name of the <ui-nav-item> custom element.
const (
NavRailEventChange = "change"
)
Events emitted by <ui-nav-rail>. Forward one to a server action with On:
NavRail(props).On(NavRailEventChange, "handler-name")
NavRailTag is the name of the <ui-nav-rail> custom element.
const (
// the visible label (also used by the select's field text)
OptionSlotDefault = ""
)
Slots exposed by <ui-option>. Put one on your own markup to fill it:
<h3 slot={ OptionSlotDefault }>
const OptionTag = "ui-option"
OptionTag is the name of the <ui-option> custom element.
const (
// a page was chosen (numbers, prev, next); detail: { page }
PaginationEventChange = "change"
)
Events emitted by <ui-pagination>. Forward one to a server action with On:
Pagination(props).On(PaginationEventChange, "handler-name")
const PaginationTag = "ui-pagination"
PaginationTag is the name of the <ui-pagination> custom element.
const ProgressTag = "ui-progress"
ProgressTag is the name of the <ui-progress> custom element.
const (
// pressed; detail: { value } (consumed by ui-radio-group)
RadioEventUIRadioSelect = "ui-radio-select"
)
Events emitted by <ui-radio>. Forward one to a server action with On:
Radio(props).On(RadioEventUIRadioSelect, "handler-name")
const (
// detail: { value }
RadioGroupEventChange = "change"
)
Events emitted by <ui-radio-group>. Forward one to a server action with On:
RadioGroup(props).On(RadioGroupEventChange, "handler-name")
const (
// the <ui-radio> children
RadioGroupSlotDefault = ""
)
Slots exposed by <ui-radio-group>. Put one on your own markup to fill it:
<h3 slot={ RadioGroupSlotDefault }>
const RadioGroupTag = "ui-radio-group"
RadioGroupTag is the name of the <ui-radio-group> custom element.
const RadioTag = "ui-radio"
RadioTag is the name of the <ui-radio> custom element.
const (
// committed; detail: { value }
RatingEventChange = "change"
)
Events emitted by <ui-rating>. Forward one to a server action with On:
Rating(props).On(RatingEventChange, "handler-name")
const RatingTag = "ui-rating"
RatingTag is the name of the <ui-rating> custom element.
const SearchTag = "ui-search"
SearchTag is the name of the <ui-search> custom element.
const (
// <ui-option> children (projected into the panel)
SelectSlotDefault = ""
)
Slots exposed by <ui-select>. Put one on your own markup to fill it:
<h3 slot={ SelectSlotDefault }>
const SelectTag = "ui-select"
SelectTag is the name of the <ui-select> custom element.
const SheetTag = "ui-sheet"
SheetTag is the name of the <ui-sheet> custom element.
const SideSheetTag = "ui-side-sheet"
SideSheetTag is the name of the <ui-side-sheet> custom element.
const SkeletonTag = "ui-skeleton"
SkeletonTag is the name of the <ui-skeleton> custom element.
const SliderTag = "ui-slider"
SliderTag is the name of the <ui-slider> custom element.
const SnackbarTag = "ui-snackbar"
SnackbarTag is the name of the <ui-snackbar> custom element.
const SpinnerTag = "ui-spinner"
SpinnerTag is the name of the <ui-spinner> custom element.
const (
// a menu action was chosen; detail: { value }
SplitButtonEventSelect = "select"
)
Events emitted by <ui-split-button>. Forward one to a server action with On:
SplitButton(props).On(SplitButtonEventSelect, "handler-name")
const SplitButtonTag = "ui-split-button"
SplitButtonTag is the name of the <ui-split-button> custom element.
const (
StackSlotDefault = ""
)
Slots exposed by <ui-stack>. Put one on your own markup to fill it:
<h3 slot={ StackSlotDefault }>
const StackTag = "ui-stack"
StackTag is the name of the <ui-stack> custom element.
const StepTag = "ui-step"
StepTag is the name of the <ui-step> custom element.
const (
// <ui-step> children
StepperSlotDefault = ""
)
Slots exposed by <ui-stepper>. Put one on your own markup to fill it:
<h3 slot={ StepperSlotDefault }>
const StepperTag = "ui-stepper"
StepperTag is the name of the <ui-stepper> custom element.
const (
SurfaceSlotDefault = ""
)
Slots exposed by <ui-surface>. Put one on your own markup to fill it:
<h3 slot={ SurfaceSlotDefault }>
const SurfaceTag = "ui-surface"
SurfaceTag is the name of the <ui-surface> custom element.
const (
// detail: { checked }
SwitchEventChange = "change"
)
Events emitted by <ui-switch>. Forward one to a server action with On:
Switch(props).On(SwitchEventChange, "handler-name")
const SwitchTag = "ui-switch"
SwitchTag is the name of the <ui-switch> custom element.
const (
// internal; detail: { value } (consumed by <ui-tabs>)
TabEventUITabSelect = "ui-tab-select"
)
Events emitted by <ui-tab>. Forward one to a server action with On:
Tab(props).On(TabEventUITabSelect, "handler-name")
const (
// panel content
TabPanelSlotDefault = ""
)
Slots exposed by <ui-tab-panel>. Put one on your own markup to fill it:
<h3 slot={ TabPanelSlotDefault }>
const TabPanelTag = "ui-tab-panel"
TabPanelTag is the name of the <ui-tab-panel> custom element.
const (
// label
TabSlotDefault = ""
)
Slots exposed by <ui-tab>. Put one on your own markup to fill it:
<h3 slot={ TabSlotDefault }>
const TabTag = "ui-tab"
TabTag is the name of the <ui-tab> custom element.
const (
TableFooterEventPage = "page"
)
Events emitted by <ui-table-footer>. Forward one to a server action with On:
TableFooter(props).On(TableFooterEventPage, "handler-name")
TableFooterTag is the name of the <ui-table-footer> custom element.
const TableTag = "ui-table"
TableTag is the name of the <ui-table> custom element.
const TableToolbarTag = "ui-table-toolbar"
TableToolbarTag is the name of the <ui-table-toolbar> custom element.
const (
// user selected a tab; detail: { value }
TabsEventChange = "change"
)
Events emitted by <ui-tabs>. Forward one to a server action with On:
Tabs(props).On(TabsEventChange, "handler-name")
const TabsTag = "ui-tabs"
TabsTag is the name of the <ui-tabs> custom element.
const TextFieldTag = "ui-text-field"
TextFieldTag is the name of the <ui-text-field> custom element.
const (
TextSlotDefault = ""
)
Slots exposed by <ui-text>. Put one on your own markup to fill it:
<h3 slot={ TextSlotDefault }>
const TextTag = "ui-text"
TextTag is the name of the <ui-text> custom element.
const TimePickerTag = "ui-time-picker"
TimePickerTag is the name of the <ui-time-picker> custom element.
const (
// pressed; detail: { value } (consumed by ui-toggle-group)
ToggleButtonEventUIToggle = "ui-toggle"
)
Events emitted by <ui-toggle-button>. Forward one to a server action with On:
ToggleButton(props).On(ToggleButtonEventUIToggle, "handler-name")
const (
// label
ToggleButtonSlotDefault = ""
)
Slots exposed by <ui-toggle-button>. Put one on your own markup to fill it:
<h3 slot={ ToggleButtonSlotDefault }>
const ToggleButtonTag = "ui-toggle-button"
ToggleButtonTag is the name of the <ui-toggle-button> custom element.
const (
// selection changed; detail: { value } (string, or array when multi)
ToggleGroupEventChange = "change"
)
Events emitted by <ui-toggle-group>. Forward one to a server action with On:
ToggleGroup(props).On(ToggleGroupEventChange, "handler-name")
const (
// the <ui-toggle-button> children
ToggleGroupSlotDefault = ""
)
Slots exposed by <ui-toggle-group>. Put one on your own markup to fill it:
<h3 slot={ ToggleGroupSlotDefault }>
const ToggleGroupTag = "ui-toggle-group"
ToggleGroupTag is the name of the <ui-toggle-group> custom element.
const ToolbarTag = "ui-toolbar"
ToolbarTag is the name of the <ui-toolbar> custom element.
const TooltipTag = "ui-tooltip"
TooltipTag is the name of the <ui-tooltip> custom element.
Variables ¶
var AccordionItemVars = alacris.Vars(
"--ui-accordion-item-header-min-height",
"--ui-accordion-item-pad-inline",
"--ui-accordion-item-header-fg",
"--ui-accordion-item-icon-fg",
"--ui-accordion-item-content-fg",
"--ui-accordion-item-font",
"--ui-accordion-item-tracking",
"--ui-accordion-item-content-font",
"--ui-accordion-item-content-tracking",
)
AccordionItemVars is the theming contract of <ui-accordion-item>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
AccordionItem(props).Apply(AccordionItemVars, map[string]string{"--ui-accordion-item-header-min-height": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var AccordionVars = alacris.Vars(
"--ui-accordion-divider-color",
)
AccordionVars is the theming contract of <ui-accordion>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Accordion(props).Apply(AccordionVars, map[string]string{"--ui-accordion-divider-color": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var AlertVars = alacris.Vars(
"--ui-alert-radius",
"--ui-alert-padding",
"--ui-alert-gap",
"--ui-alert-font",
"--ui-alert-title-font",
)
AlertVars is the theming contract of <ui-alert>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Alert(props).Apply(AlertVars, map[string]string{"--ui-alert-radius": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var AppBarVars = alacris.Vars(
"--ui-app-bar-bg",
"--ui-app-bar-scrolled-bg",
"--ui-app-bar-fg",
"--ui-app-bar-height-small",
"--ui-app-bar-height-medium",
"--ui-app-bar-height-large",
"--ui-app-bar-font",
"--ui-app-bar-tracking",
)
AppBarVars is the theming contract of <ui-app-bar>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
AppBar(props).Apply(AppBarVars, map[string]string{"--ui-app-bar-bg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var AutocompleteVars = alacris.Vars(
"--ui-autocomplete-bg",
"--ui-autocomplete-fg",
"--ui-autocomplete-label-fg",
"--ui-autocomplete-accent",
"--ui-autocomplete-outline-color",
"--ui-autocomplete-radius",
"--ui-autocomplete-font",
"--ui-autocomplete-height",
"--ui-autocomplete-panel-bg",
)
AutocompleteVars is the theming contract of <ui-autocomplete>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Autocomplete(props).Apply(AutocompleteVars, map[string]string{"--ui-autocomplete-bg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var AvatarVars = alacris.Vars(
"--ui-avatar-size",
"--ui-avatar-bg",
"--ui-avatar-fg",
"--ui-avatar-radius",
)
AvatarVars is the theming contract of <ui-avatar>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Avatar(props).Apply(AvatarVars, map[string]string{"--ui-avatar-size": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var BackdropVars = alacris.Vars(
"--ui-backdrop-bg",
)
BackdropVars is the theming contract of <ui-backdrop>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Backdrop(props).Apply(BackdropVars, map[string]string{"--ui-backdrop-bg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var BadgeVars = alacris.Vars(
"--ui-badge-bg",
"--ui-badge-fg",
"--ui-badge-size",
"--ui-badge-dot-size",
"--ui-badge-font",
"--ui-badge-tracking",
)
BadgeVars is the theming contract of <ui-badge>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Badge(props).Apply(BadgeVars, map[string]string{"--ui-badge-bg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var BottomAppBarVars = alacris.Vars(
"--ui-bottom-app-bar-height",
"--ui-bottom-app-bar-bg",
"--ui-bottom-app-bar-fg",
"--ui-bottom-app-bar-shadow",
)
BottomAppBarVars is the theming contract of <ui-bottom-app-bar>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
BottomAppBar(props).Apply(BottomAppBarVars, map[string]string{"--ui-bottom-app-bar-height": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
"--ui-bottom-nav-height",
"--ui-bottom-nav-bg",
"--ui-bottom-nav-shadow",
)
BottomNavVars is the theming contract of <ui-bottom-nav>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
BottomNav(props).Apply(BottomNavVars, map[string]string{"--ui-bottom-nav-height": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var BreadcrumbsVars = alacris.Vars(
"--ui-breadcrumbs-fg",
"--ui-breadcrumbs-current-fg",
"--ui-breadcrumbs-separator-fg",
"--ui-breadcrumbs-gap",
"--ui-breadcrumbs-font",
"--ui-breadcrumbs-tracking",
)
BreadcrumbsVars is the theming contract of <ui-breadcrumbs>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Breadcrumbs(props).Apply(BreadcrumbsVars, map[string]string{"--ui-breadcrumbs-fg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var ButtonGroupVars = alacris.Vars(
"--ui-button-group-radius",
"--ui-button-group-divider",
)
ButtonGroupVars is the theming contract of <ui-button-group>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
ButtonGroup(props).Apply(ButtonGroupVars, map[string]string{"--ui-button-group-radius": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var ButtonVars = alacris.Vars(
"--ui-button-height",
"--ui-button-pad-inline",
"--ui-button-gap",
"--ui-button-radius",
"--ui-button-font",
"--ui-button-tracking",
"--ui-button-filled-bg",
"--ui-button-filled-fg",
"--ui-button-tonal-bg",
"--ui-button-tonal-fg",
"--ui-button-outlined-fg",
"--ui-button-outline-color",
"--ui-button-text-fg",
"--ui-button-elevated-bg",
"--ui-button-elevated-fg",
)
ButtonVars is the theming contract of <ui-button>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Button(props).Apply(ButtonVars, map[string]string{"--ui-button-height": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var CardVars = alacris.Vars(
"--ui-card-radius",
"--ui-card-bg",
"--ui-card-fg",
"--ui-card-filled-bg",
"--ui-card-outline-color",
"--ui-card-padding",
)
CardVars is the theming contract of <ui-card>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Card(props).Apply(CardVars, map[string]string{"--ui-card-radius": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var CarouselItemVars = alacris.Vars(
"--ui-carousel-item-bg",
"--ui-carousel-item-fg",
"--ui-carousel-item-radius",
)
CarouselItemVars is the theming contract of <ui-carousel-item>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
CarouselItem(props).Apply(CarouselItemVars, map[string]string{"--ui-carousel-item-bg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var CarouselVars = alacris.Vars(
"--ui-carousel-gap",
"--ui-carousel-height",
"--ui-carousel-hero-size",
"--ui-carousel-control-fg",
"--ui-carousel-item-basis",
)
CarouselVars is the theming contract of <ui-carousel>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Carousel(props).Apply(CarouselVars, map[string]string{"--ui-carousel-gap": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var CheckboxVars = alacris.Vars(
"--ui-checkbox-target",
"--ui-checkbox-box-size",
"--ui-checkbox-radius",
"--ui-checkbox-outline-color",
"--ui-checkbox-bg",
"--ui-checkbox-mark-fg",
"--ui-checkbox-label-fg",
)
CheckboxVars is the theming contract of <ui-checkbox>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Checkbox(props).Apply(CheckboxVars, map[string]string{"--ui-checkbox-target": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var ChipSetVars = alacris.Vars(
"--ui-chip-set-gap",
)
ChipSetVars is the theming contract of <ui-chip-set>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
ChipSet(props).Apply(ChipSetVars, map[string]string{"--ui-chip-set-gap": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var ChipVars = alacris.Vars(
"--ui-chip-height",
"--ui-chip-radius",
"--ui-chip-fg",
"--ui-chip-label-fg",
"--ui-chip-outline-color",
"--ui-chip-selected-bg",
"--ui-chip-selected-fg",
"--ui-chip-font",
)
ChipVars is the theming contract of <ui-chip>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Chip(props).Apply(ChipVars, map[string]string{"--ui-chip-height": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var ContainerVars = alacris.Vars(
"--ui-container-sm",
"--ui-container-md",
"--ui-container-lg",
"--ui-container-xl",
"--ui-container-gutter",
"--ui-container-gutter-narrow",
)
ContainerVars is the theming contract of <ui-container>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Container(props).Apply(ContainerVars, map[string]string{"--ui-container-sm": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var DatePickerVars = alacris.Vars(
"--ui-date-picker-bg",
"--ui-date-picker-fg",
"--ui-date-picker-label-fg",
"--ui-date-picker-accent",
"--ui-date-picker-on-accent",
"--ui-date-picker-outline-color",
"--ui-date-picker-radius",
"--ui-date-picker-font",
"--ui-date-picker-height",
"--ui-date-picker-panel-bg",
"--ui-date-picker-panel-radius",
"--ui-date-picker-day-radius",
"--ui-date-picker-today-fg",
"--ui-date-picker-muted-fg",
"--ui-date-picker-range-bg",
"--ui-date-picker-range-fg",
"--ui-date-picker-scrim",
)
DatePickerVars is the theming contract of <ui-date-picker>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
DatePicker(props).Apply(DatePickerVars, map[string]string{"--ui-date-picker-bg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var DialogVars = alacris.Vars(
"--ui-dialog-bg",
"--ui-dialog-fg",
"--ui-dialog-headline-fg",
"--ui-dialog-radius",
"--ui-dialog-width",
"--ui-dialog-scrim",
)
DialogVars is the theming contract of <ui-dialog>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Dialog(props).Apply(DialogVars, map[string]string{"--ui-dialog-bg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var DividerVars = alacris.Vars(
"--ui-divider-color",
"--ui-divider-thickness",
)
DividerVars is the theming contract of <ui-divider>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Divider(props).Apply(DividerVars, map[string]string{"--ui-divider-color": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var DrawerVars = alacris.Vars(
"--ui-drawer-bg",
"--ui-drawer-std-bg",
"--ui-drawer-fg",
"--ui-drawer-width",
"--ui-drawer-radius",
"--ui-drawer-pad",
"--ui-drawer-scrim",
)
DrawerVars is the theming contract of <ui-drawer>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Drawer(props).Apply(DrawerVars, map[string]string{"--ui-drawer-bg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var FabMenuVars = alacris.Vars(
"--ui-fab-menu-gap",
)
FabMenuVars is the theming contract of <ui-fab-menu>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
FabMenu(props).Apply(FabMenuVars, map[string]string{"--ui-fab-menu-gap": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var FabVars = alacris.Vars(
"--ui-fab-size-sm",
"--ui-fab-size-md",
"--ui-fab-size-lg",
"--ui-fab-radius-sm",
"--ui-fab-radius-md",
"--ui-fab-radius-lg",
"--ui-fab-font",
"--ui-fab-tracking",
"--ui-fab-primary-bg",
"--ui-fab-primary-fg",
"--ui-fab-secondary-bg",
"--ui-fab-secondary-fg",
"--ui-fab-tertiary-bg",
"--ui-fab-tertiary-fg",
"--ui-fab-surface-bg",
"--ui-fab-surface-fg",
)
FabVars is the theming contract of <ui-fab>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Fab(props).Apply(FabVars, map[string]string{"--ui-fab-size-sm": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var IconButtonVars = alacris.Vars(
"--ui-icon-button-size",
"--ui-icon-button-radius",
"--ui-icon-button-fg",
"--ui-icon-button-selected-fg",
"--ui-icon-button-filled-bg",
"--ui-icon-button-filled-fg",
"--ui-icon-button-tonal-bg",
"--ui-icon-button-tonal-fg",
"--ui-icon-button-outline-color",
)
IconButtonVars is the theming contract of <ui-icon-button>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
IconButton(props).Apply(IconButtonVars, map[string]string{"--ui-icon-button-size": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var IconVars = alacris.Vars(
"--ui-icon-size",
)
IconVars is the theming contract of <ui-icon>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Icon(props).Apply(IconVars, map[string]string{"--ui-icon-size": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var ListItemVars = alacris.Vars(
"--ui-list-item-height",
"--ui-list-item-two-line-height",
"--ui-list-item-pad-inline",
"--ui-list-item-gap",
"--ui-list-item-headline-fg",
"--ui-list-item-headline-font",
"--ui-list-item-supporting-fg",
"--ui-list-item-supporting-font",
"--ui-list-item-trailing-fg",
"--ui-list-item-trailing-font",
"--ui-list-item-selected-bg",
"--ui-list-item-selected-fg",
)
ListItemVars is the theming contract of <ui-list-item>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
ListItem(props).Apply(ListItemVars, map[string]string{"--ui-list-item-height": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var ListVars = alacris.Vars(
"--ui-list-bg",
"--ui-list-pad-block",
)
ListVars is the theming contract of <ui-list>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
List(props).Apply(ListVars, map[string]string{"--ui-list-bg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var LoadingIndicatorVars = alacris.Vars(
"--ui-loading-indicator-size",
"--ui-loading-indicator-gap",
"--ui-loading-indicator-dot",
"--ui-loading-indicator-contained-bg",
"--ui-loading-indicator-contained-pad",
"--ui-loading-indicator-contained-radius",
)
LoadingIndicatorVars is the theming contract of <ui-loading-indicator>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
LoadingIndicator(props).Apply(LoadingIndicatorVars, map[string]string{"--ui-loading-indicator-size": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var MenuItemVars = alacris.Vars(
"--ui-menu-item-height",
"--ui-menu-item-pad-inline",
"--ui-menu-item-gap",
"--ui-menu-item-font",
"--ui-menu-item-tracking",
"--ui-menu-item-fg",
"--ui-menu-item-icon-fg",
"--ui-menu-item-trailing-fg",
"--ui-menu-item-danger-fg",
)
MenuItemVars is the theming contract of <ui-menu-item>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
MenuItem(props).Apply(MenuItemVars, map[string]string{"--ui-menu-item-height": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var MenuVars = alacris.Vars(
"--ui-menu-bg",
"--ui-menu-radius",
"--ui-menu-min-width",
"--ui-menu-max-width",
"--ui-menu-elevation",
)
MenuVars is the theming contract of <ui-menu>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Menu(props).Apply(MenuVars, map[string]string{"--ui-menu-bg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
"--ui-nav-item-pill-bg",
"--ui-nav-item-icon-fg",
"--ui-nav-item-icon-fg-active",
"--ui-nav-item-label-fg",
"--ui-nav-item-label-fg-active",
"--ui-nav-item-font",
"--ui-nav-item-tracking",
)
NavItemVars is the theming contract of <ui-nav-item>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
NavItem(props).Apply(NavItemVars, map[string]string{"--ui-nav-item-pill-bg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
"--ui-nav-rail-width",
"--ui-nav-rail-bg",
"--ui-nav-rail-pad",
)
NavRailVars is the theming contract of <ui-nav-rail>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
NavRail(props).Apply(NavRailVars, map[string]string{"--ui-nav-rail-width": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var OptionVars = alacris.Vars(
"--ui-option-fg",
"--ui-option-selected-bg",
"--ui-option-selected-fg",
"--ui-option-font",
"--ui-option-height",
)
OptionVars is the theming contract of <ui-option>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Option(props).Apply(OptionVars, map[string]string{"--ui-option-fg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var PaginationVars = alacris.Vars(
"--ui-pagination-size",
"--ui-pagination-radius",
"--ui-pagination-fg",
"--ui-pagination-current-bg",
"--ui-pagination-current-fg",
"--ui-pagination-font",
"--ui-pagination-tracking",
)
PaginationVars is the theming contract of <ui-pagination>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Pagination(props).Apply(PaginationVars, map[string]string{"--ui-pagination-size": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var ProgressVars = alacris.Vars(
"--ui-progress-height",
"--ui-progress-radius",
"--ui-progress-track-bg",
"--ui-progress-bar-bg",
)
ProgressVars is the theming contract of <ui-progress>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Progress(props).Apply(ProgressVars, map[string]string{"--ui-progress-height": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var RadioGroupVars = alacris.Vars(
"--ui-radio-group-gap",
)
RadioGroupVars is the theming contract of <ui-radio-group>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
RadioGroup(props).Apply(RadioGroupVars, map[string]string{"--ui-radio-group-gap": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var RadioVars = alacris.Vars(
"--ui-radio-target",
"--ui-radio-circle-size",
"--ui-radio-outline-color",
"--ui-radio-checked-color",
"--ui-radio-label-fg",
)
RadioVars is the theming contract of <ui-radio>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Radio(props).Apply(RadioVars, map[string]string{"--ui-radio-target": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var RatingVars = alacris.Vars(
"--ui-rating-active-fg",
"--ui-rating-empty-fg",
"--ui-rating-gap",
)
RatingVars is the theming contract of <ui-rating>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Rating(props).Apply(RatingVars, map[string]string{"--ui-rating-active-fg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var SearchVars = alacris.Vars(
"--ui-search-bg",
"--ui-search-bg-active",
"--ui-search-fg",
"--ui-search-placeholder-fg",
"--ui-search-radius",
"--ui-search-font",
"--ui-search-height",
"--ui-search-panel-bg",
"--ui-search-panel-radius",
"--ui-search-divider",
)
SearchVars is the theming contract of <ui-search>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Search(props).Apply(SearchVars, map[string]string{"--ui-search-bg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var SelectVars = alacris.Vars(
"--ui-select-bg",
"--ui-select-fg",
"--ui-select-label-fg",
"--ui-select-accent",
"--ui-select-outline-color",
"--ui-select-radius",
"--ui-select-font",
"--ui-select-height",
"--ui-select-panel-bg",
)
SelectVars is the theming contract of <ui-select>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Select(props).Apply(SelectVars, map[string]string{"--ui-select-bg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var SheetVars = alacris.Vars(
"--ui-sheet-bg",
"--ui-sheet-fg",
"--ui-sheet-radius",
"--ui-sheet-width",
"--ui-sheet-handle",
"--ui-sheet-scrim",
)
SheetVars is the theming contract of <ui-sheet>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Sheet(props).Apply(SheetVars, map[string]string{"--ui-sheet-bg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var SideSheetVars = alacris.Vars(
"--ui-side-sheet-bg",
"--ui-side-sheet-fg",
"--ui-side-sheet-width",
"--ui-side-sheet-radius",
"--ui-side-sheet-scrim",
)
SideSheetVars is the theming contract of <ui-side-sheet>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
SideSheet(props).Apply(SideSheetVars, map[string]string{"--ui-side-sheet-bg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var SkeletonVars = alacris.Vars(
"--ui-skeleton-bg",
"--ui-skeleton-wave",
"--ui-skeleton-radius",
)
SkeletonVars is the theming contract of <ui-skeleton>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Skeleton(props).Apply(SkeletonVars, map[string]string{"--ui-skeleton-bg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var SliderVars = alacris.Vars(
"--ui-slider-track-height",
"--ui-slider-thumb-size",
"--ui-slider-track",
"--ui-slider-active",
"--ui-slider-thumb",
"--ui-slider-bubble-bg",
"--ui-slider-bubble-fg",
)
SliderVars is the theming contract of <ui-slider>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Slider(props).Apply(SliderVars, map[string]string{"--ui-slider-track-height": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var SnackbarVars = alacris.Vars(
"--ui-snackbar-bg",
"--ui-snackbar-fg",
"--ui-snackbar-action-fg",
"--ui-snackbar-radius",
"--ui-snackbar-min-width",
"--ui-snackbar-max-width",
"--ui-snackbar-elevation",
)
SnackbarVars is the theming contract of <ui-snackbar>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Snackbar(props).Apply(SnackbarVars, map[string]string{"--ui-snackbar-bg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var SpinnerVars = alacris.Vars(
"--ui-spinner-size",
"--ui-spinner-color",
"--ui-spinner-track-color",
)
SpinnerVars is the theming contract of <ui-spinner>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Spinner(props).Apply(SpinnerVars, map[string]string{"--ui-spinner-size": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var SplitButtonVars = alacris.Vars(
"--ui-split-button-height",
"--ui-split-button-pad-inline",
"--ui-split-button-radius",
"--ui-split-button-font",
"--ui-split-button-tracking",
"--ui-split-button-filled-bg",
"--ui-split-button-filled-fg",
"--ui-split-button-tonal-bg",
"--ui-split-button-tonal-fg",
"--ui-split-button-outlined-fg",
"--ui-split-button-outline-color",
"--ui-split-button-elevated-bg",
"--ui-split-button-elevated-fg",
"--ui-split-button-divider",
)
SplitButtonVars is the theming contract of <ui-split-button>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
SplitButton(props).Apply(SplitButtonVars, map[string]string{"--ui-split-button-height": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var StepVars = alacris.Vars(
"--ui-step-indicator-size",
"--ui-step-bg",
"--ui-step-fg",
"--ui-step-active-bg",
"--ui-step-active-fg",
"--ui-step-label-fg",
"--ui-step-label-fg-active",
"--ui-step-font",
"--ui-step-tracking",
"--ui-step-optional-font",
"--ui-step-optional-tracking",
)
StepVars is the theming contract of <ui-step>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Step(props).Apply(StepVars, map[string]string{"--ui-step-indicator-size": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var StepperVars = alacris.Vars(
"--ui-stepper-connector",
"--ui-stepper-connector-active",
)
StepperVars is the theming contract of <ui-stepper>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Stepper(props).Apply(StepperVars, map[string]string{"--ui-stepper-connector": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var SwitchVars = alacris.Vars(
"--ui-switch-track-width",
"--ui-switch-track-height",
"--ui-switch-track-bg",
"--ui-switch-track-bg-checked",
"--ui-switch-track-outline",
"--ui-switch-handle-bg",
"--ui-switch-handle-bg-checked",
"--ui-switch-icon-fg",
"--ui-switch-icon-fg-checked",
)
SwitchVars is the theming contract of <ui-switch>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Switch(props).Apply(SwitchVars, map[string]string{"--ui-switch-track-width": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var TabPanelVars = alacris.Vars(
"--ui-tab-panel-fg",
"--ui-tab-panel-font",
"--ui-tab-panel-pad-block",
)
TabPanelVars is the theming contract of <ui-tab-panel>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
TabPanel(props).Apply(TabPanelVars, map[string]string{"--ui-tab-panel-fg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var TabVars = alacris.Vars(
"--ui-tab-height",
"--ui-tab-pad-inline",
"--ui-tab-gap",
"--ui-tab-font",
"--ui-tab-tracking",
"--ui-tab-fg",
"--ui-tab-selected-fg",
)
TabVars is the theming contract of <ui-tab>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Tab(props).Apply(TabVars, map[string]string{"--ui-tab-height": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
"--ui-table-footer-height",
"--ui-table-footer-fg",
"--ui-table-footer-border-color",
)
TableFooterVars is the theming contract of <ui-table-footer>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
TableFooter(props).Apply(TableFooterVars, map[string]string{"--ui-table-footer-height": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var TableToolbarVars = alacris.Vars(
"--ui-table-toolbar-height",
"--ui-table-toolbar-bg",
"--ui-table-toolbar-selected-bg",
"--ui-table-toolbar-selected-fg",
"--ui-table-toolbar-panel-bg",
"--ui-table-toolbar-radius",
"--ui-table-toolbar-elevation",
)
TableToolbarVars is the theming contract of <ui-table-toolbar>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
TableToolbar(props).Apply(TableToolbarVars, map[string]string{"--ui-table-toolbar-height": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var TableVars = alacris.Vars(
"--ui-table-row-height",
"--ui-table-dense-row-height",
"--ui-table-comfortable-row-height",
"--ui-table-check-col",
"--ui-table-border-color",
"--ui-table-header-fg",
"--ui-table-header-bg",
"--ui-table-fg",
"--ui-table-bg",
"--ui-table-hover-bg",
"--ui-table-selected-bg",
"--ui-table-stripe-bg",
"--ui-table-group-bg",
"--ui-table-agg-fg",
"--ui-table-radius",
)
TableVars is the theming contract of <ui-table>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Table(props).Apply(TableVars, map[string]string{"--ui-table-row-height": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var TabsVars = alacris.Vars(
"--ui-tabs-indicator",
"--ui-tabs-indicator-height",
"--ui-tabs-divider",
)
TabsVars is the theming contract of <ui-tabs>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Tabs(props).Apply(TabsVars, map[string]string{"--ui-tabs-indicator": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var Tags = []string{
"ui-accordion",
"ui-accordion-item",
"ui-alert",
"ui-app-bar",
"ui-autocomplete",
"ui-avatar",
"ui-backdrop",
"ui-badge",
"ui-bottom-app-bar",
"ui-bottom-nav",
"ui-breadcrumbs",
"ui-button",
"ui-button-group",
"ui-card",
"ui-carousel",
"ui-carousel-item",
"ui-checkbox",
"ui-chip",
"ui-chip-set",
"ui-container",
"ui-date-picker",
"ui-dialog",
"ui-divider",
"ui-drawer",
"ui-fab",
"ui-fab-menu",
"ui-icon",
"ui-icon-button",
"ui-list",
"ui-list-item",
"ui-loading-indicator",
"ui-menu",
"ui-menu-item",
"ui-nav-item",
"ui-nav-rail",
"ui-option",
"ui-pagination",
"ui-progress",
"ui-radio",
"ui-radio-group",
"ui-rating",
"ui-search",
"ui-select",
"ui-sheet",
"ui-side-sheet",
"ui-skeleton",
"ui-slider",
"ui-snackbar",
"ui-spinner",
"ui-split-button",
"ui-stack",
"ui-step",
"ui-stepper",
"ui-surface",
"ui-switch",
"ui-tab",
"ui-tab-panel",
"ui-table",
"ui-table-footer",
"ui-table-toolbar",
"ui-tabs",
"ui-text",
"ui-text-field",
"ui-time-picker",
"ui-toggle-button",
"ui-toggle-group",
"ui-toolbar",
"ui-tooltip",
}
Tags lists every component in this package.
It is what alacris.Pending wants, so that elements do not flash before their module has loaded:
@alacris.Pending{Tags: ui.Tags}
var TextFieldVars = alacris.Vars(
"--ui-text-field-bg",
"--ui-text-field-fg",
"--ui-text-field-label-fg",
"--ui-text-field-accent",
"--ui-text-field-error-fg",
"--ui-text-field-outline-color",
"--ui-text-field-radius",
"--ui-text-field-font",
"--ui-text-field-height",
"--ui-text-field-stepper-width",
)
TextFieldVars is the theming contract of <ui-text-field>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
TextField(props).Apply(TextFieldVars, map[string]string{"--ui-text-field-bg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var TimePickerVars = alacris.Vars(
"--ui-time-picker-bg",
"--ui-time-picker-fg",
"--ui-time-picker-label-fg",
"--ui-time-picker-accent",
"--ui-time-picker-on-accent",
"--ui-time-picker-outline-color",
"--ui-time-picker-radius",
"--ui-time-picker-font",
"--ui-time-picker-height",
"--ui-time-picker-panel-bg",
"--ui-time-picker-panel-radius",
"--ui-time-picker-digit-bg",
"--ui-time-picker-selected-bg",
"--ui-time-picker-selected-fg",
)
TimePickerVars is the theming contract of <ui-time-picker>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
TimePicker(props).Apply(TimePickerVars, map[string]string{"--ui-time-picker-bg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var ToggleButtonVars = alacris.Vars(
"--ui-toggle-button-height",
"--ui-toggle-button-radius",
"--ui-toggle-button-bg",
"--ui-toggle-button-fg",
"--ui-toggle-button-selected-bg",
"--ui-toggle-button-selected-fg",
"--ui-toggle-button-font",
"--ui-toggle-button-tracking",
)
ToggleButtonVars is the theming contract of <ui-toggle-button>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
ToggleButton(props).Apply(ToggleButtonVars, map[string]string{"--ui-toggle-button-height": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var ToggleGroupVars = alacris.Vars(
"--ui-toggle-group-radius",
"--ui-toggle-group-outline-color",
)
ToggleGroupVars is the theming contract of <ui-toggle-group>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
ToggleGroup(props).Apply(ToggleGroupVars, map[string]string{"--ui-toggle-group-radius": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var ToolbarVars = alacris.Vars(
"--ui-toolbar-height",
"--ui-toolbar-bg",
"--ui-toolbar-fg",
"--ui-toolbar-radius",
"--ui-toolbar-pad",
"--ui-toolbar-elevation",
)
ToolbarVars is the theming contract of <ui-toolbar>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Toolbar(props).Apply(ToolbarVars, map[string]string{"--ui-toolbar-height": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
var TooltipVars = alacris.Vars(
"--ui-tooltip-bg",
"--ui-tooltip-fg",
"--ui-tooltip-font",
"--ui-tooltip-radius",
"--ui-tooltip-max-width",
"--ui-tooltip-rich-bg",
"--ui-tooltip-rich-fg",
"--ui-tooltip-rich-radius",
"--ui-tooltip-rich-max-width",
)
TooltipVars is the theming contract of <ui-tooltip>: the custom properties it is styled through, and the only supported way to restyle it from outside its shadow root.
Tooltip(props).Apply(TooltipVars, map[string]string{"--ui-tooltip-bg": "#111"})
Applying a property that is not in the contract is an error, so a rename in the component turns up here rather than as styling that silently stops working.
Functions ¶
func Accordion ¶
func Accordion(p AccordionProps) *alacris.Element
Accordion renders <ui-accordion>.
<ui-accordion> — groups <ui-accordion-item> panels.
<ui-accordion> <ui-accordion-item value="a" headline="First">…</ui-accordion-item> <ui-accordion-item value="b" headline="Second">…</ui-accordion-item> </ui-accordion>
Coordination rides the bubbling `ui-accordion-toggle` event from the items, so only user interaction triggers single-open collapse; programmatic `expanded` writes on an item are left alone.
func AccordionItem ¶
func AccordionItem(p AccordionItemProps) *alacris.Element
AccordionItem renders <ui-accordion-item>.
<ui-accordion-item> — one expandable panel inside <ui-accordion>.
Expand/collapse animates block-size from the measured content height; in environments without layout (zero heights) the animation is skipped and the state applies instantly. The content region gets `hidden` only AFTER the collapse animation completes.
func Alert ¶
func Alert(p AlertProps) *alacris.Element
Alert renders <ui-alert>.
<ui-alert> — a severity-colored callout for statuses and messages.
<ui-alert severity="success" title="Saved" dismissible @dismiss=${remove}> Your changes are safe. <ui-button slot="action" variant="text">Undo</ui-button> </ui-alert>
Live-region semantics: the host defaults to role="status" (announced politely). If the alert appears dynamically in response to an event and must interrupt, set role="alert" on the element yourself — an author-set role is never overwritten.
Dismissing: the close button collapses the alert (height + opacity), then emits `dismiss`. The PARENT owns the DOM and removes the element (or flips the condition rendering it).
func AppBar ¶
func AppBar(p AppBarProps) *alacris.Element
AppBar renders <ui-app-bar>.
<ui-app-bar> — the Material top app bar.
<ui-app-bar variant="small" scroll-elevate> <ui-icon-button slot="navigation" icon="menu" label="Menu"></ui-icon-button> Page title <ui-icon-button slot="actions" icon="search" label="Search"></ui-icon-button> </ui-app-bar>
The host is position:sticky at the top. `elevated` forces the on-scroll container tint + shadow; `scrollElevate` listens to window scroll and applies it automatically once the page is scrolled (listener removed when the prop turns off or the element leaves the document).
func Autocomplete ¶
func Autocomplete(p AutocompleteProps) *alacris.Element
Autocomplete renders <ui-autocomplete>.
<ui-autocomplete> — a combobox with a filtering text input.
<ui-autocomplete label="Fruit" options=${['Apple', 'Banana']} Typing filters the options case-insensitively and opens a listbox panel while there are matches. ArrowUp/Down move the active option, Enter commits the active option (or, with `freeSolo`, the raw text), Escape closes, blur commits an exact label match — or the raw text when `freeSolo` — and otherwise reverts to the last committed value.
func Avatar ¶
func Avatar(p AvatarProps) *alacris.Element
Avatar renders <ui-avatar>.
<ui-avatar> — a circular avatar: image, initials, or icon.
Fallback chain: `src` image → initials from `name` (first + last word) → `icon` → slotted content. A broken image (error event) falls back to the initials automatically. Initials scale with the avatar (~40% of its size).
func Backdrop ¶
func Backdrop(p BackdropProps) *alacris.Element
Backdrop renders <ui-backdrop>.
<ui-backdrop> — a full-screen scrim behind custom overlays.
<ui-backdrop open=${open} @close=${() => open(false)}></ui-backdrop>
Fades in/out, locks page scroll while open, and requests closing by emitting `close` when the scrim is clicked — the PARENT owns the state and flips the signal.
func Badge ¶
func Badge(p BadgeProps) *alacris.Element
Badge renders <ui-badge>.
<ui-badge> — a small status badge anchored to the top-end corner of its slotted content (an icon button, a nav item, an avatar…).
Hidden while `value` is 0 unless `dot`. Counts above `max` render '99+' style. Appearing/disappearing animates with a scale-in/out.
func BottomAppBar ¶
func BottomAppBar(p BottomAppBarProps) *alacris.Element
BottomAppBar renders <ui-bottom-app-bar>.
<ui-bottom-app-bar> — the Material bottom app bar.
<ui-bottom-app-bar> <ui-icon-button slot="navigation" icon="menu" label="Menu"></ui-icon-button> <ui-icon-button slot="actions" icon="search" label="Search"></ui-icon-button> <ui-fab slot="fab" icon="add"></ui-fab> </ui-bottom-app-bar>
A surface for a leading navigation icon, trailing actions, and an optional FAB. The host flows with the page — pin it with CSS when it should hug the viewport bottom. Distinct from <ui-bottom-nav>, which is destination tabs.
func BottomNav ¶
func BottomNav(p BottomNavProps) *alacris.Element
BottomNav renders <ui-bottom-nav>.
<ui-bottom-nav> — the Material navigation bar.
<ui-bottom-nav value=${route} @change=${(e) => route(e.detail.value)}> <ui-nav-item value="home" icon="home" label="Home"></ui-nav-item> <ui-nav-item value="search" icon="search" label="Search"></ui-nav-item> </ui-bottom-nav>
The host is `display: block` and flows with the page — apps that want the bar pinned to the viewport position it themselves (position: fixed; bottom: 0; left: 0; right: 0). Selection reflects down: every `value` write (or slotchange) sets `selected` on the children. Keyboard: one Tab stop, arrow keys rove between items (rovingTabindex, horizontal).
func Breadcrumbs ¶
func Breadcrumbs(p BreadcrumbsProps) *alacris.Element
Breadcrumbs renders <ui-breadcrumbs>.
<ui-breadcrumbs> — a navigation trail of slotted links.
<ui-breadcrumbs separator-icon="chevron-right"> <a href="/">Home</a> <a href="/library">Library</a> <span aria-current="page">Data</span> </ui-breadcrumbs>
Separators are rendered as generated content on every item but the first: text mode sets the `content` from a private custom property; icon mode masks a currentColor box with the icon's path, so it themes like any glyph.
func Button ¶
func Button(p ButtonProps) *alacris.Element
Button renders <ui-button>.
<ui-button> — the Material common button, all five variants.
func ButtonGroup ¶
func ButtonGroup(p ButtonGroupProps) *alacris.Element
ButtonGroup renders <ui-button-group>.
<ui-button-group> — joins slotted <ui-button>s into one segmented bar.
Slotted buttons lose their own rounding (their `--ui-button-radius` is zeroed); the group container carries the full radius and clips, and a 1px gap lets the container's divider color show between segments — the Material connected button group.
func Carousel ¶
func Carousel(p CarouselProps) *alacris.Element
Carousel renders <ui-carousel>.
<ui-carousel> — a Material carousel: snap-scrolling slides with previous / next controls.
<ui-carousel label="Photos" variant="multi-browse"> <ui-carousel-item>One</ui-carousel-item> <ui-carousel-item>Two</ui-carousel-item> </ui-carousel>
multi-browse shows several items; uncontained lets slides overflow the frame; hero makes the selected slide dominate. Selection reflects down as `selected` on each <ui-carousel-item>. Prev/next (and arrow keys) scroll the selected slide into view; dragging the track updates `index`. The last slide snaps to the end of the viewport so a hero (or any oversized) last item can still become selected.
func CarouselItem ¶
func CarouselItem(p CarouselItemProps) *alacris.Element
CarouselItem renders <ui-carousel-item>.
<ui-carousel-item> — one slide inside <ui-carousel>.
`selected` is written by the parent carousel; set the carousel's `index` instead of this prop. Width comes from `--ui-carousel-item-basis` on the parent (so the carousel variants can size slides without fighting `:host`). The last item snaps to the end of the track so it can be scrolled fully into view.
func Checkbox ¶
func Checkbox(p CheckboxProps) *alacris.Element
Checkbox renders <ui-checkbox>.
<ui-checkbox> — the Material checkbox with indeterminate support.
The interactive element is a native <button role="checkbox"> sized to a 40px touch target; the visible 18px box sits centered inside it. Clicking clears `indeterminate` and toggles `checked`. The check/dash is the MD3 2px stroke mark in the 18dp icon, not the generic 24dp `check` glyph.
func Chip ¶
Chip renders <ui-chip>.
<ui-chip> — Material chip: assist, filter, input, and suggestion.
The HOST is the interactive element (focusable, role="button" — or role="option" with aria-selected for filter chips) so that <ui-chip-set>'s roving tabindex can move focus across plain light-DOM chips.
Filter chips toggle `selected` on click/Enter/Space and emit `change`; assist/suggestion/input chips just let the native click bubble. A dismissible chip animates the host collapsing, then emits `dismiss` — the PARENT owns the list and removes the chip from the DOM; the chip never removes itself.
func ChipSet ¶
func ChipSet(p ChipSetProps) *alacris.Element
ChipSet renders <ui-chip-set>.
<ui-chip-set> — a wrapping row of <ui-chip>s with roving-tabindex focus.
When any slotted chip is a filter chip the set is a listbox (aria-multiselectable mirrors `multi`); otherwise it is a plain group. Single-select coordination: with `multi=false`, selecting a filter chip deselects its siblings and the set emits `change` with the selected chip's `value`; deselecting the active chip emits `change` with ”.
func Container ¶
func Container(p ContainerProps) *alacris.Element
Container renders <ui-container>.
<ui-container> — a centered max-width content wrapper.
<ui-container size="lg">…</ui-container>
func DatePicker ¶
func DatePicker(p DatePickerProps) *alacris.Element
DatePicker renders <ui-date-picker>.
<ui-date-picker> — Material date picker: a text-field-style control that opens a calendar. Docked (default) commits on day click; modal confirms with OK / Cancel.
<ui-date-picker label="Event" value=${date} `value` is an ISO date string (YYYY-MM-DD), or ” for none. Typing an ISO or locale-formatted date into the field commits on blur / Enter. Set `range` to pick a start and end; `change` then reports `{ start, end, value }` where `value` is `start/end`.
func Dialog ¶
func Dialog(p DialogProps) *alacris.Element
Dialog renders <ui-dialog>.
<ui-dialog> — a modal dialog.
<ui-dialog open=${open} @close=${() => open(false)}> <span slot="headline">Discard draft?</span> Your changes will be lost. <ui-button slot="actions" variant="text">Cancel</ui-button> <ui-button slot="actions">Discard</ui-button> </ui-dialog>
Opening: set the `open` prop (pass a signal from the parent to stay live). The dialog animates in, traps focus, and locks page scroll. It requests closing by emitting `close` with a reason — the PARENT owns the state and flips the signal; Escape and scrim clicks emit `close` too (unless `persistent`).
func Divider ¶
func Divider(p DividerProps) *alacris.Element
Divider renders <ui-divider>.
<ui-divider> — a 1px rule separating content, horizontal or vertical.
Props reflect to host attributes so the styling is pure CSS on :host.
role="separator" with aria-orientation.
func Drawer ¶
func Drawer(p DrawerProps) *alacris.Element
Drawer renders <ui-drawer>.
<ui-drawer> — a navigation drawer, modal or standard.
<ui-drawer open=${open} @close=${() => open(false)}>…nav content…</ui-drawer> <ui-drawer variant="standard" anchor="start" open=${open}>…</ui-drawer>
Modal: a fixed overlay — scrim plus a full-height panel that slides in from the anchor side. Focus is trapped and page scroll locked while open. The PARENT owns `open`: Escape and scrim clicks emit `close` with a reason and the parent flips the signal. `opened`/`closed` fire after the enter/exit animations settle. Standard: an in-flow panel; the host animates its inline size open/closed — no scrim, no trap.
func Fab ¶
Fab renders <ui-fab>.
<ui-fab> — the Material floating action button, regular and extended.
A non-empty `label` renders the extended FAB (icon + text) and is always the accessible name, extended or not.
func FabMenu ¶
func FabMenu(p FabMenuProps) *alacris.Element
FabMenu renders <ui-fab-menu>.
<ui-fab-menu> — a Material FAB menu: a trigger FAB that expands related actions stacked above it.
<ui-fab-menu> <ui-fab slot="trigger" icon="add"></ui-fab> <ui-fab icon="edit" label="Edit" size="sm"></ui-fab> <ui-fab icon="send" label="Send" size="sm"></ui-fab> </ui-fab-menu>
The PARENT may pass `open`; clicking the trigger toggles it and emits `open`/`close`. Related actions are a disclosure of buttons (not a menu widget) so slotted `<ui-fab>`s keep their native button semantics. Escape closes and returns focus to the trigger.
func Icon ¶
Icon renders <ui-icon>.
<ui-icon> — an icon from the registry, or any slotted SVG.
Names are kebab-case (`arrow-forward`). Underscores are accepted (`arrow_forward`). `iconNames()` lists the built-in set; apps add more with `registerIcons({ name: 'M…' })`. An unknown name logs a warning once and renders a placeholder instead of an empty hole.
func IconButton ¶
func IconButton(p IconButtonProps) *alacris.Element
IconButton renders <ui-icon-button>.
<ui-icon-button> — a 40px icon button, optionally a toggle.
func List ¶
List renders <ui-list>.
<ui-list> — a Material list container for <ui-list-item> children.
role="list" on the host; items carry role="listitem".
func ListItem ¶
func ListItem(p ListItemProps) *alacris.Element
ListItem renders <ui-list-item>.
<ui-list-item> — one row of a <ui-list>.
One line (56px) by default; supplying supporting text (prop or slot) makes it two lines (72px). `interactive` adds button semantics, a state layer and a ripple; `href` renders the row as a link instead. Activation emits only the native (bubbling) click — no custom event.
func LoadingIndicator ¶
func LoadingIndicator(p LoadingIndicatorProps) *alacris.Element
LoadingIndicator renders <ui-loading-indicator>.
<ui-loading-indicator> — the Material loading indicator: morphing dots, distinct from determinate <ui-progress> / <ui-spinner>.
<ui-loading-indicator label="Loading"></ui-loading-indicator> <ui-loading-indicator variant="contained"></ui-loading-indicator>
Always indeterminate. `contained` draws the dots on a tonal pill.
func Menu ¶
Menu renders <ui-menu>.
<ui-menu> — a menu anchored to a slotted trigger.
<ui-menu placement="bottom-start" @select=${(e) => ...}> <ui-icon-button slot="anchor" icon="more-vert" label="More"></ui-icon-button> <ui-menu-item value="edit" icon="edit">Edit</ui-menu-item> <ui-menu-item value="delete" icon="delete" danger>Delete</ui-menu-item> </ui-menu>
The "anchor" slot renders inline; clicking it toggles the menu. The panel is position:fixed, anchored to the slotted trigger, flips when it would overflow, and stays glued through scroll/resize. While open, focus moves to the first item and arrows rove vertically; Escape closes and refocuses the anchor, Tab and outside pointerdown close. Selecting an item emits `select` and closes.
func MenuItem ¶
func MenuItem(p MenuItemProps) *alacris.Element
MenuItem renders <ui-menu-item>.
<ui-menu-item> — one action inside <ui-menu>.
The host carries the `menuitem` semantics so the menu's roving tabindex can manage it directly in the light DOM.
func NavItem ¶
func NavItem(p NavItemProps) *alacris.Element
NavItem renders <ui-nav-item>.
<ui-nav-item> — one destination inside <ui-bottom-nav> or <ui-nav-rail>.
Focus: the host is the roving tab stop (<ui-bottom-nav> assigns tabindex); focus is forwarded to the inner button so Enter/Space activate natively.
func NavRail ¶
func NavRail(p NavRailProps) *alacris.Element
NavRail renders <ui-nav-rail>.
<ui-nav-rail> — the Material navigation rail.
<ui-nav-rail value=${route} @change=${(e) => route(e.detail.value)}> <ui-fab slot="fab" icon="add"></ui-fab> <ui-nav-item value="home" icon="home" label="Home"></ui-nav-item> <ui-nav-item value="search" icon="search" label="Search"></ui-nav-item> </ui-nav-rail>
A compact vertical destination list (the large-screen counterpart of <ui-bottom-nav>). Reuses <ui-nav-item>. The host flows with the page — pin it with position: sticky/fixed yourself.
func Option ¶
func Option(p OptionProps) *alacris.Element
Option renders <ui-option>.
<ui-option> — one choice inside <ui-select>.
The host itself is the option (role="option"): it lives in the select's light DOM and is projected into the select's listbox panel. The select drives `selected`/`active` (via their attributes) and handles activation; the option only renders itself and its state layer.
func Pagination ¶
func Pagination(p PaginationProps) *alacris.Element
Pagination renders <ui-pagination>.
<ui-pagination> — page navigation with sibling/boundary windows.
<ui-pagination count="10" page=${page} @change=${(e) => page(e.detail.page)}> </ui-pagination>
func Pending ¶
Pending is the stylesheet that hides every Alacris UI element until it is defined. Put it in <head> next to alacris.Scripts.
func Progress ¶
func Progress(p ProgressProps) *alacris.Element
Progress renders <ui-progress>.
<ui-progress> — Material linear progress.
<ui-progress label="Upload" value=${pct}></ui-progress> determinate <ui-progress label="Loading"></ui-progress> indeterminate
The determinate width rides a custom property bound from the template (`--ui-progress-pct`), so a value change is one property write. The indeterminate mode is the Material two-bar translate/scale loop, written as CSS keyframes; its cycle length derives from the motion tokens so a theme's motion scale slows or stops it with everything else.
func Radio ¶
func Radio(p RadioProps) *alacris.Element
Radio renders <ui-radio>.
<ui-radio> — one Material radio button, managed by <ui-radio-group>.
The interactive element is a native <button role="radio"> on a 40px touch target. The radio never checks itself: it emits `ui-radio-select` and the owning group sets `checked` back down and roves the host's tabindex (the host forwards focus to the inner button).
func RadioGroup ¶
func RadioGroup(p RadioGroupProps) *alacris.Element
RadioGroup renders <ui-radio-group>.
<ui-radio-group> — owns a set of slotted <ui-radio>s: one selected value, one tab stop, arrow keys move AND select (ARIA APG radio group pattern).
<ui-radio-group name="size" value=${size} @change=${(e) => size.set(e.detail.value)}> <ui-radio value="s" label="Small"></ui-radio> <ui-radio value="m" label="Medium"></ui-radio> </ui-radio-group>
func Rating ¶
func Rating(p RatingProps) *alacris.Element
Rating renders <ui-rating>.
<ui-rating> — a star rating.
A11y choice: the whole rating is ONE control — role="slider" with aria-valuenow/-min/-max and aria-valuetext, a single tab stop, and arrow keys adjusting the value (Home=0, End=max). The stars themselves are pointer affordances only (hover previews, click commits), so there is no tab-stop-per-star noise for keyboard and screen-reader users.
Clicking the star matching the current value clears the rating to 0 (MUI parity).
func Search ¶
func Search(p SearchProps) *alacris.Element
Search renders <ui-search>.
<ui-search> — Material search bar.
<ui-search label="Search mail" value=${q} A pill-shaped field with a leading search icon, a trailing clear control while there is text, and an optional trailing slot (avatar, voice, …). Enter emits `submit`. The field chrome is the focus indicator — the inner input has no extra outline.
`presentation="view"` opens a search view: a back control and a suggestions list (the default slot) while open. The list overlays the page — it does not grow the layout. Typing a query opens the view; clearing the field (keyboard or the clear button) closes it back to the pill bar. Focus on an empty view still shows recents, but a clear while focused stays on the bar. The open surface is one extra-large rounded container (bar + overlay list) with a divider between the field and the list.
func Select ¶
func Select(p SelectProps) *alacris.Element
Select renders <ui-select>.
<ui-select> — Material select: a text-field-style field button that opens a listbox of slotted <ui-option>s.
<ui-select label="Flavor" value=${flavor} @change=${(e) => flavor(e.detail.value)}> <ui-option value="vanilla">Vanilla</ui-option> <ui-option value="mint">Mint</ui-option> </ui-select>
Keyboard (APG select-only combobox): Enter/Space/ArrowDown/ArrowUp open; arrows move the active option, Enter/Space selects it, Escape closes the panel only — an enclosing dialog keeps its own Escape for a second press, typing jumps to the next option starting with that letter. The panel closes on outside pointerdown and returns focus to the field. `open`/`close` do not bubble: they share those names with dialogs and sheets, and a bubbling select-close looks like the sheet dismissed itself.
Past a handful of options the panel gets a filter field, because scrolling is not a way to find one entry among several hundred. It takes focus when the panel opens, the arrows and Enter work from it, and the options it hides are hidden from the keyboard too. The query is dropped when the panel closes.
Note: the combobox's aria-activedescendant references option ids in the host's light DOM; the options also carry aria-selected for AT that walks the composed tree.
func Sheet ¶
func Sheet(p SheetProps) *alacris.Element
Sheet renders <ui-sheet>.
<ui-sheet> — a Material bottom sheet.
<ui-sheet open=${open} @close=${() => open(false)}> <span slot="headline">Title</span> Sheet body <ui-button slot="actions" variant="text">Close</ui-button> </ui-sheet>
Modal (default): a scrim plus a panel that slides up from the bottom. Focus is trapped and page scroll locked while open. The PARENT owns `open`: Escape and scrim clicks emit `close` with a reason. Standard: an in-flow panel that expands from zero height — no scrim, no trap.
func SideSheet ¶
func SideSheet(p SideSheetProps) *alacris.Element
SideSheet renders <ui-side-sheet>.
<ui-side-sheet> — a Material side sheet for complementary content.
<ui-side-sheet open=${open} @close=${() => open(false)}> <span slot="headline">Filters</span> Sheet body <ui-button slot="actions" variant="text">Apply</ui-button> </ui-side-sheet>
Distinct from <ui-drawer> (navigation) and <ui-sheet> (bottom). Modal (default): a scrim plus a panel that slides in from the end edge. Focus is trapped and page scroll locked while open. The PARENT owns `open`. Standard: an in-flow panel that animates its inline size — no scrim, no trap.
func Skeleton ¶
func Skeleton(p SkeletonProps) *alacris.Element
Skeleton renders <ui-skeleton>.
<ui-skeleton> — a loading placeholder shape.
<ui-skeleton variant="circular" width="40px" height="40px"></ui-skeleton> <ui-skeleton width="60%"></ui-skeleton> <ui-skeleton variant="rectangular" height="120px" animation="wave"></ui-skeleton>
Always aria-hidden: a skeleton is decorative. Announce loading state on the region that will receive the content (aria-busy), not on the placeholder.
func Slider ¶
func Slider(p SliderProps) *alacris.Element
Slider renders <ui-slider>.
<ui-slider> — a Material slider on native <input type="range">s for keyboard and screen-reader behavior.
<ui-slider label="Volume" value=${volume} Bind `value` (or `.value`) to a signal like any other control. `input` / `change` report a number in `detail.value` (or `detail.start` / `detail.end` when `range`). The host `.value` is a string, matching a native range input, so composed-path helpers that look for `typeof node.value === 'string'` work the same as they do for text fields.
The active track portion is painted with `--ui-slider-fill` (or start/end when `range`) bound from the template into a gradient; the thumb's hover/focus halo is a box-shadow state layer.
func Snackbar ¶
func Snackbar(p SnackbarProps) *alacris.Element
Snackbar renders <ui-snackbar>.
<ui-snackbar> — a transient bottom-center message, plus `showSnackbar()`, an imperative service that queues messages through one shared instance.
Declarative (parent owns the state):
<ui-snackbar open=${open} message="Draft saved" action="Undo" Imperative (fire and forget; FIFO — one visible at a time):
const { close, closed } = showSnackbar('Message archived', { action: 'Undo' });
The component requests closing by emitting `close` with a reason — the PARENT flips `open`. `closed` fires after the exit animation finishes.
func Spinner ¶
func Spinner(p SpinnerProps) *alacris.Element
Spinner renders <ui-spinner>.
<ui-spinner> — Material circular progress.
<ui-spinner label="Loading"></ui-spinner> indeterminate <ui-spinner label="Upload" value=${pct}></ui-spinner> determinate <ui-spinner label="Loading" size="24px"></ui-spinner>
One SVG circle in a 44-unit viewBox with a 4-unit stroke, so the stroke scales with `size`. Determinate progress binds stroke-dashoffset from the value; indeterminate is the classic rotate + dash-grow loop as CSS keyframes, its cycle derived from the motion tokens.
func SplitButton ¶
func SplitButton(p SplitButtonProps) *alacris.Element
SplitButton renders <ui-split-button>.
<ui-split-button> — a Material split button: a primary action plus a connected chevron that opens related actions.
<ui-split-button variant="filled" @click=${save}> Save <ui-menu-item slot="menu" value="draft">Save draft</ui-menu-item> <ui-menu-item slot="menu" value="copy">Save a copy</ui-menu-item> </ui-split-button>
The leading segment is the primary action (native click bubbles). Choosing a menu item emits `select` with that item's value.
func Stack ¶
func Stack(p StackProps) *alacris.Element
Stack renders <ui-stack>.
<ui-stack> — a flexbox layout primitive.
<ui-stack direction="row" gap="4" align="center">…</ui-stack>
func Step ¶
Step renders <ui-step>.
<ui-step> — one step inside <ui-stepper>.
Presentation only: the circle shows the 1-based number (or a check when completed); <ui-stepper> owns index/state assignment and the connectors.
func Stepper ¶
func Stepper(p StepperProps) *alacris.Element
Stepper renders <ui-stepper>.
<ui-stepper> — a horizontal stepper of <ui-step> children.
<ui-stepper active=${active}> <ui-step label="Cart"></ui-step> <ui-step label="Shipping" optional-text="Optional"></ui-step> <ui-step label="Payment"></ui-step> </ui-stepper>
Presentation only — it emits nothing; wiring next/back navigation to `active` is application logic. On slotchange (and every `active` write) it assigns each child's `index`, `state`, a `data-state` attribute (used by the connector CSS), `role="listitem"`, and `aria-current="step"` on the active step. Connector lines between steps turn primary once the segment before a step is completed.
func Surface ¶
func Surface(p SurfaceProps) *alacris.Element
Surface renders <ui-surface>.
<ui-surface> — a themable surface (the Paper equivalent).
<ui-surface elevation="2" radius="lg" bg="surface-container">…</ui-surface>
func Switch ¶
func Switch(p SwitchProps) *alacris.Element
Switch renders <ui-switch>.
<ui-switch> — the Material switch.
func Tab ¶
Tab renders <ui-tab>.
<ui-tab> — one tab inside <ui-tabs>.
The host element carries the `tab` semantics (role, aria-selected, focusability) so <ui-tabs>' roving tabindex can manage it directly in the light DOM. `selected` is written by the parent <ui-tabs>; do not set it yourself — set the tabs' `value` instead.
func TabPanel ¶
func TabPanel(p TabPanelProps) *alacris.Element
TabPanel renders <ui-tab-panel>.
<ui-tab-panel> — the content pane paired with a <ui-tab>.
Slot it into <ui-tabs slot="panels">. The parent sets `active` when its `value` matches; do not set `active` yourself. The panel is hidden while inactive and fades in when it becomes active.
func Table ¶
func Table(p TableProps) *alacris.Element
Table renders <ui-table>.
<ui-table> — Material data-table / DataGrid.
Markup mode — pass a native <table> (adopted into the shadow so cells can be themed). `data-sortable` / `data-numeric` decorate headers.
<ui-table label="Nutrition"> <table>…</table> </ui-table>
Data mode — `columns` + `rows`. The grid is `role="table"` (Alacris cannot bind inside native <tr>). Pipeline (filter → sort → group → paginate → aggregate) lives in `util/table.js`. Chrome is <ui-table-toolbar> and <ui-table-footer>, composed from search, menus, checkboxes, and pagination.
<ui-table headline="Trades" columns=${cols} rows=${rows} selectable="multiple" group-by="commodity" quick-filter column-menu density-menu csv-export page-size="10"></ui-table>
Column objects: { key, label, numeric, sortable, width, hidden, align, aggregate: 'sum'|'avg'|'min'|'max'|'count', render(row, col), sortValue(row) }
func TableFooter ¶
func TableFooter(p TableFooterProps) *alacris.Element
TableFooter renders <ui-table-footer>.
<ui-table-footer> — pagination and row-count for <ui-table>. Composes <ui-pagination> for the page window and a rows-per-page <select>.
<ui-table-footer page=${page} page-size="10" row-count=${n}
func TableToolbar ¶
func TableToolbar(p TableToolbarProps) *alacris.Element
TableToolbar renders <ui-table-toolbar>.
<ui-table-toolbar> — DataGrid chrome: title, selection count, quick filter, column visibility, density, and CSV export. Built from <ui-search>, <ui-icon-button>, <ui-menu>, and <ui-checkbox>.
<ui-table-toolbar headline="Nutrition" quick-filter column-menu density-menu csv-export columns=${cols} hidden-columns=${hidden}
func Tabs ¶
Tabs renders <ui-tabs>.
<ui-tabs> — Material tabs: a tab bar with an animated active indicator.
<ui-tabs value="one" label="Demo tabs" @change=${(e) => ...}> <ui-tab value="one" icon="home">One</ui-tab> <ui-tab value="two">Two</ui-tab> <ui-tab-panel slot="panels" value="one">…</ui-tab-panel> <ui-tab-panel slot="panels" value="two">…</ui-tab-panel> </ui-tabs>
Tabs go in the default slot, panels in the "panels" slot. The parent reflects `selected` onto each <ui-tab> and `active` onto each <ui-tab-panel>, and wires aria-controls/aria-labelledby ids between them. Activation is AUTOMATIC per the ARIA APG: arrow keys move focus AND select (one Tab stop for the whole bar via roving tabindex).
func Text ¶
Text renders <ui-text>.
<ui-text> — typography, the type scale as an element.
<ui-text variant="headline-md" as="h2">Section</ui-text>
Semantics: <ui-text> is styling only. Keep real headings in your markup (`<h2><ui-text variant="headline-md">…</ui-text></h2>`) or set an ARIA role on the host when the document outline needs one.
func TextField ¶
func TextField(p TextFieldProps) *alacris.Element
TextField renders <ui-text-field>.
<ui-text-field> — Material text field, filled and outlined, floating label.
func TimePicker ¶
func TimePicker(p TimePickerProps) *alacris.Element
TimePicker renders <ui-time-picker>.
<ui-time-picker> — Material time picker: a text-field-style control that opens an hour/minute chooser. Value is a 24-hour `HH:mm` string.
<ui-time-picker label="Alarm" value=${time} The keyboard icon in the panel toggles between the analog dial and the digital hour/minute grids (MD3 input-method toggle). Hour and minute faces crossfade; the clock hand rotates with the motion tokens.
func ToggleButton ¶
func ToggleButton(p ToggleButtonProps) *alacris.Element
ToggleButton renders <ui-toggle-button>.
<ui-toggle-button> — one Material segmented button, used inside <ui-toggle-group> (the group draws the outlined container and dividers; standalone the segment is a flat pill).
Selecting animates a leading check icon in smoothly via width and scale transitions, adhering to Material Design 3. When an icon is already present, selecting smoothly crossfades and morphs between the custom icon and the checkmark in both directions. The button does not own its selection: it emits `ui-toggle` and the group (or any parent) sets `selected` back down.
func ToggleGroup ¶
func ToggleGroup(p ToggleGroupProps) *alacris.Element
ToggleGroup renders <ui-toggle-group>.
<ui-toggle-group> — Material segmented buttons: an outlined container that owns the selection of its slotted <ui-toggle-button>s.
<ui-toggle-group value=${align} @change=${(e) => align.set(e.detail.value)}> <ui-toggle-button value="left">Left</ui-toggle-button> <ui-toggle-button value="right">Right</ui-toggle-button> </ui-toggle-group>
Single-select by default (`value` is the selected string, ” for none; pressing the selected segment deselects it). With `multi`, `value` is an array (a JSON array string works as an attribute). Buttons are natural tab stops — no roving tabindex, per the toolbar-of-toggle-buttons pattern.
func Toolbar ¶
func Toolbar(p ToolbarProps) *alacris.Element
Toolbar renders <ui-toolbar>.
<ui-toolbar> — a Material contextual toolbar: a floating strip of icon actions, optionally with an attached FAB.
<ui-toolbar label="Selection"> <ui-icon-button icon="edit" label="Edit"></ui-icon-button> <ui-icon-button icon="delete" label="Delete"></ui-icon-button> <ui-fab slot="fab" icon="add" size="sm"></ui-fab> </ui-toolbar>
func Tooltip ¶
func Tooltip(p TooltipProps) *alacris.Element
Tooltip renders <ui-tooltip>.
<ui-tooltip> — a plain (or rich) tooltip on hover/focus around its target.
<ui-tooltip text="Save changes"><ui-button>Save</ui-button></ui-tooltip>
Shows after `delay` ms on pointerenter (timer cancelled on leave) and immediately on focusin; hides on pointerleave, focusout, and Escape. The panel is position: fixed, anchored to the host with position()/autoUpdate, flipping to the opposite side when it would overflow the viewport.
a11y: `aria-describedby` cannot point across shadow boundaries, so the association is not programmatic — the panel carries role="tooltip" and the target keeps its own accessible name. Give the target a matching label/aria-label when the tooltip is the only description.
Types ¶
type AccordionChangeDetail ¶
type AccordionChangeDetail struct {
Value any `json:"value"`
}
AccordionChangeDetail is the detail of the "change" event of <ui-accordion>.
a panel was toggled by the user; detail: { value }
type AccordionHandle ¶
type AccordionHandle struct {
// contains filtered or unexported fields
}
AccordionHandle patches a rendered <ui-accordion> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with AccordionElement.
func AccordionElement ¶
func AccordionElement(s *live.Session, id string) AccordionHandle
AccordionElement addresses the <ui-accordion> rendered with this id, for patching its props with compile-checked names instead of strings:
AccordionElement(c.Session, "id").SetMulti(v)
func (AccordionHandle) Handle ¶
func (h AccordionHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (AccordionHandle) SetMulti ¶
func (h AccordionHandle) SetMulti(v bool)
SetMulti writes the multi prop.
type AccordionItemHandle ¶
type AccordionItemHandle struct {
// contains filtered or unexported fields
}
AccordionItemHandle patches a rendered <ui-accordion-item> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with AccordionItemElement.
func AccordionItemElement ¶
func AccordionItemElement(s *live.Session, id string) AccordionItemHandle
AccordionItemElement addresses the <ui-accordion-item> rendered with this id, for patching its props with compile-checked names instead of strings:
AccordionItemElement(c.Session, "id").SetValue(v)
func (AccordionItemHandle) Handle ¶
func (h AccordionItemHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (AccordionItemHandle) SetDisabled ¶
func (h AccordionItemHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (AccordionItemHandle) SetExpanded ¶
func (h AccordionItemHandle) SetExpanded(v bool)
SetExpanded writes the expanded prop.
func (AccordionItemHandle) SetHeadline ¶
func (h AccordionItemHandle) SetHeadline(v string)
SetHeadline writes the headline prop.
func (AccordionItemHandle) SetValue ¶
func (h AccordionItemHandle) SetValue(v string)
SetValue writes the value prop.
type AccordionItemProps ¶
type AccordionItemProps struct {
// Value is REQUIRED identity of the panel (reported in events).
//
// The component defaults it to ”.
Value string
// The component defaults it to false.
Expanded bool
// The component defaults it to false.
Disabled bool
// Headline is header text.
//
// The component defaults it to ”.
Headline string
}
AccordionItemProps are the props of <ui-accordion-item>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type AccordionItemUIAccordionToggleDetail ¶
type AccordionItemUIAccordionToggleDetail struct {
Value any `json:"value"`
Expanded any `json:"expanded"`
}
AccordionItemUIAccordionToggleDetail is the detail of the "ui-accordion-toggle" event of <ui-accordion-item>.
header activated; detail: { value, expanded }
type AccordionProps ¶
type AccordionProps struct {
// Multi is allow several panels open at once; when false, expanding one collapses the others.
//
// The component defaults it to false.
Multi bool
}
AccordionProps are the props of <ui-accordion>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type AlertHandle ¶
type AlertHandle struct {
// contains filtered or unexported fields
}
AlertHandle patches a rendered <ui-alert> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with AlertElement.
func AlertElement ¶
func AlertElement(s *live.Session, id string) AlertHandle
AlertElement addresses the <ui-alert> rendered with this id, for patching its props with compile-checked names instead of strings:
AlertElement(c.Session, "id").SetSeverity(v)
func (AlertHandle) Handle ¶
func (h AlertHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (AlertHandle) SetDismissible ¶
func (h AlertHandle) SetDismissible(v bool)
SetDismissible writes the dismissible prop.
func (AlertHandle) SetSeverity ¶
func (h AlertHandle) SetSeverity(v string)
SetSeverity writes the severity prop.
func (AlertHandle) SetTitle ¶
func (h AlertHandle) SetTitle(v string)
SetTitle writes the title prop.
func (AlertHandle) SetVariant ¶
func (h AlertHandle) SetVariant(v string)
SetVariant writes the variant prop.
type AlertProps ¶
type AlertProps struct {
// Severity is info | success | warning | error.
//
// The component defaults it to 'info'.
Severity string
// Variant is tonal | filled | outlined.
//
// The component defaults it to 'tonal'.
Variant string
// Dismissible is shows a trailing close button.
//
// The component defaults it to false.
Dismissible bool
// Icon is leading icon override; defaults per severity (info → 'info', success → 'check-circle', warning → 'warning', error → 'error').
//
// The component defaults it to ”.
Icon string
// Title is optional bold first line.
//
// The component defaults it to ”.
Title string
}
AlertProps are the props of <ui-alert>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type AppBarHandle ¶
type AppBarHandle struct {
// contains filtered or unexported fields
}
AppBarHandle patches a rendered <ui-app-bar> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with AppBarElement.
func AppBarElement ¶
func AppBarElement(s *live.Session, id string) AppBarHandle
AppBarElement addresses the <ui-app-bar> rendered with this id, for patching its props with compile-checked names instead of strings:
AppBarElement(c.Session, "id").SetVariant(v)
func (AppBarHandle) Handle ¶
func (h AppBarHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (AppBarHandle) SetElevated ¶
func (h AppBarHandle) SetElevated(v bool)
SetElevated writes the elevated prop.
func (AppBarHandle) SetScrollElevate ¶
func (h AppBarHandle) SetScrollElevate(v bool)
SetScrollElevate writes the scrollElevate prop.
func (AppBarHandle) SetVariant ¶
func (h AppBarHandle) SetVariant(v string)
SetVariant writes the variant prop.
type AppBarProps ¶
type AppBarProps struct {
// Variant is small | center | medium | large.
//
// The component defaults it to 'small'.
Variant string
// Elevated is force the scrolled container/elevation.
//
// The component defaults it to false.
Elevated bool
// ScrollElevate is auto-elevate once window is scrolled.
//
// The component defaults it to false.
ScrollElevate bool
}
AppBarProps are the props of <ui-app-bar>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type AutocompleteChangeDetail ¶
type AutocompleteChangeDetail struct {
Value any `json:"value"`
}
AutocompleteChangeDetail is the detail of the "change" event of <ui-autocomplete>.
committed; detail: { value }
type AutocompleteHandle ¶
type AutocompleteHandle struct {
// contains filtered or unexported fields
}
AutocompleteHandle patches a rendered <ui-autocomplete> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with AutocompleteElement.
func AutocompleteElement ¶
func AutocompleteElement(s *live.Session, id string) AutocompleteHandle
AutocompleteElement addresses the <ui-autocomplete> rendered with this id, for patching its props with compile-checked names instead of strings:
AutocompleteElement(c.Session, "id").SetLabel(v)
func (AutocompleteHandle) Handle ¶
func (h AutocompleteHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (AutocompleteHandle) SetDisabled ¶
func (h AutocompleteHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (AutocompleteHandle) SetFreeSolo ¶
func (h AutocompleteHandle) SetFreeSolo(v bool)
SetFreeSolo writes the freeSolo prop.
func (AutocompleteHandle) SetLabel ¶
func (h AutocompleteHandle) SetLabel(v string)
SetLabel writes the label prop.
func (AutocompleteHandle) SetName ¶
func (h AutocompleteHandle) SetName(v string)
SetName writes the name prop.
func (AutocompleteHandle) SetOptions ¶
func (h AutocompleteHandle) SetOptions(v []any)
SetOptions writes the options prop.
func (AutocompleteHandle) SetPlaceholder ¶
func (h AutocompleteHandle) SetPlaceholder(v string)
SetPlaceholder writes the placeholder prop.
func (AutocompleteHandle) SetRequired ¶
func (h AutocompleteHandle) SetRequired(v bool)
SetRequired writes the required prop.
func (AutocompleteHandle) SetValue ¶
func (h AutocompleteHandle) SetValue(v string)
SetValue writes the value prop.
func (AutocompleteHandle) SetVariant ¶
func (h AutocompleteHandle) SetVariant(v string)
SetVariant writes the variant prop.
type AutocompleteInputDetail ¶
type AutocompleteInputDetail struct {
Value any `json:"value"`
}
AutocompleteInputDetail is the detail of the "input" event of <ui-autocomplete>.
every keystroke; detail: { value } (the raw text)
type AutocompleteProps ¶
type AutocompleteProps struct {
// The component defaults it to ”.
Label string
// Value is the committed value.
//
// The component defaults it to ”.
Value string
// Options is strings or { value, label } objects (JSON attribute or property).
//
// Crosses as JSON in the options attribute.
Options []any
// Variant is filled | outlined.
//
// The component defaults it to 'filled'.
Variant string
// The component defaults it to false.
Disabled bool
// The component defaults it to false.
Required bool
// Name is form participation.
//
// The component defaults it to ”.
Name string
// The component defaults it to ”.
Placeholder string
// FreeSolo is allow values not present in options.
//
// The component defaults it to false.
FreeSolo bool
}
AutocompleteProps are the props of <ui-autocomplete>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type AvatarHandle ¶
type AvatarHandle struct {
// contains filtered or unexported fields
}
AvatarHandle patches a rendered <ui-avatar> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with AvatarElement.
func AvatarElement ¶
func AvatarElement(s *live.Session, id string) AvatarHandle
AvatarElement addresses the <ui-avatar> rendered with this id, for patching its props with compile-checked names instead of strings:
AvatarElement(c.Session, "id").SetSrc(v)
func (AvatarHandle) Handle ¶
func (h AvatarHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (AvatarHandle) SetLabel ¶
func (h AvatarHandle) SetLabel(v string)
SetLabel writes the label prop.
type AvatarProps ¶
type AvatarProps struct {
// Src is image URL (object-fit: cover).
//
// The component defaults it to ”.
Src string
// Name is person's name; drives initials and the aria-label fallback.
//
// The component defaults it to ”.
Name string
// Icon is registry icon shown when there is no image and no name.
//
// The component defaults it to ”.
Icon string
// Size is CSS length overriding the 40px default (sets --ui-avatar-size).
//
// The component defaults it to ”.
Size string
// Label is accessible name; falls back to `name`, else decorative.
//
// The component defaults it to ”.
Label string
}
AvatarProps are the props of <ui-avatar>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type BackdropCloseDetail ¶
type BackdropCloseDetail struct {
Reason any `json:"reason"`
}
BackdropCloseDetail is the detail of the "close" event of <ui-backdrop>.
scrim clicked; detail: { reason: 'scrim' }
type BackdropHandle ¶
type BackdropHandle struct {
// contains filtered or unexported fields
}
BackdropHandle patches a rendered <ui-backdrop> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with BackdropElement.
func BackdropElement ¶
func BackdropElement(s *live.Session, id string) BackdropHandle
BackdropElement addresses the <ui-backdrop> rendered with this id, for patching its props with compile-checked names instead of strings:
BackdropElement(c.Session, "id").SetOpen(v)
func (BackdropHandle) Handle ¶
func (h BackdropHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (BackdropHandle) SetInvisible ¶
func (h BackdropHandle) SetInvisible(v bool)
SetInvisible writes the invisible prop.
func (BackdropHandle) SetOpen ¶
func (h BackdropHandle) SetOpen(v bool)
SetOpen writes the open prop.
type BackdropProps ¶
type BackdropProps struct {
// The component defaults it to false.
Open bool
// Invisible is transparent scrim (still catches clicks).
//
// The component defaults it to false.
Invisible bool
}
BackdropProps are the props of <ui-backdrop>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type BadgeHandle ¶
type BadgeHandle struct {
// contains filtered or unexported fields
}
BadgeHandle patches a rendered <ui-badge> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with BadgeElement.
func BadgeElement ¶
func BadgeElement(s *live.Session, id string) BadgeHandle
BadgeElement addresses the <ui-badge> rendered with this id, for patching its props with compile-checked names instead of strings:
BadgeElement(c.Session, "id").SetValue(v)
func (BadgeHandle) Handle ¶
func (h BadgeHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (BadgeHandle) SetLabel ¶
func (h BadgeHandle) SetLabel(v string)
SetLabel writes the label prop.
func (BadgeHandle) SetValue ¶
func (h BadgeHandle) SetValue(v float64)
SetValue writes the value prop.
type BadgeProps ¶
type BadgeProps struct {
// Value is the count; 0 hides the badge (unless `dot`).
//
// The component defaults it to 0.
Value float64
// Max is counts above this render as 'max+'.
//
// The component defaults it to 99.
Max float64
// Dot is a plain 8px dot instead of a count.
//
// The component defaults it to false.
Dot bool
// Show is master visibility switch.
//
// The component defaults it to true.
Show *bool
// Label is accessible meaning of the badge ('3 unread'); empty marks the badge decorative.
//
// The component defaults it to ”.
Label string
}
BadgeProps are the props of <ui-badge>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type BottomAppBarHandle ¶
type BottomAppBarHandle struct {
// contains filtered or unexported fields
}
BottomAppBarHandle patches a rendered <ui-bottom-app-bar> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with BottomAppBarElement.
func BottomAppBarElement ¶
func BottomAppBarElement(s *live.Session, id string) BottomAppBarHandle
BottomAppBarElement addresses the <ui-bottom-app-bar> rendered with this id, for patching its props with compile-checked names instead of strings:
BottomAppBarElement(c.Session, "id").SetLabel(v)
func (BottomAppBarHandle) Handle ¶
func (h BottomAppBarHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (BottomAppBarHandle) SetFabAlign ¶
func (h BottomAppBarHandle) SetFabAlign(v string)
SetFabAlign writes the fabAlign prop.
func (BottomAppBarHandle) SetLabel ¶
func (h BottomAppBarHandle) SetLabel(v string)
SetLabel writes the label prop.
type BottomAppBarProps ¶
type BottomAppBarProps struct {
// Label is accessible name of the toolbar.
//
// The component defaults it to 'Bottom app bar'.
Label string
// FabAlign is end | center | start — where the FAB sits.
//
// The component defaults it to 'end'.
FabAlign string
}
BottomAppBarProps are the props of <ui-bottom-app-bar>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type BottomNavChangeDetail ¶
type BottomNavChangeDetail struct {
}
BottomNavChangeDetail is the detail of the "change" event of <ui-bottom-nav>.
a destination was chosen; detail: { value }
type BottomNavHandle ¶
type BottomNavHandle struct {
// contains filtered or unexported fields
}
BottomNavHandle patches a rendered <ui-bottom-nav> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with BottomNavElement.
func BottomNavElement ¶
func BottomNavElement(s *live.Session, id string) BottomNavHandle
BottomNavElement addresses the <ui-bottom-nav> rendered with this id, for patching its props with compile-checked names instead of strings:
BottomNavElement(c.Session, "id").SetValue(v)
func (BottomNavHandle) Handle ¶
func (h BottomNavHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (BottomNavHandle) SetLabel ¶
func (h BottomNavHandle) SetLabel(v string)
SetLabel writes the label prop.
func (BottomNavHandle) SetValue ¶
func (h BottomNavHandle) SetValue(v string)
SetValue writes the value prop.
type BottomNavProps ¶
type BottomNavProps struct {
//
// The component defaults it to ”.
Value string
//
// The component defaults it to ”.
Label string
}
BottomNavProps are the props of <ui-bottom-nav>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type BreadcrumbsHandle ¶
type BreadcrumbsHandle struct {
// contains filtered or unexported fields
}
BreadcrumbsHandle patches a rendered <ui-breadcrumbs> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with BreadcrumbsElement.
func BreadcrumbsElement ¶
func BreadcrumbsElement(s *live.Session, id string) BreadcrumbsHandle
BreadcrumbsElement addresses the <ui-breadcrumbs> rendered with this id, for patching its props with compile-checked names instead of strings:
BreadcrumbsElement(c.Session, "id").SetSeparator(v)
func (BreadcrumbsHandle) Handle ¶
func (h BreadcrumbsHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (BreadcrumbsHandle) SetLabel ¶
func (h BreadcrumbsHandle) SetLabel(v string)
SetLabel writes the label prop.
func (BreadcrumbsHandle) SetSeparator ¶
func (h BreadcrumbsHandle) SetSeparator(v string)
SetSeparator writes the separator prop.
func (BreadcrumbsHandle) SetSeparatorIcon ¶
func (h BreadcrumbsHandle) SetSeparatorIcon(v string)
SetSeparatorIcon writes the separatorIcon prop.
type BreadcrumbsProps ¶
type BreadcrumbsProps struct {
// Separator is separator text between items.
//
// The component defaults it to '/'.
Separator string
// SeparatorIcon is registry icon name; overrides `separator`.
//
// The component defaults it to ”.
SeparatorIcon string
// Label is accessible name of the <nav>.
//
// The component defaults it to 'Breadcrumb'.
Label string
}
BreadcrumbsProps are the props of <ui-breadcrumbs>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type ButtonGroupHandle ¶
type ButtonGroupHandle struct {
// contains filtered or unexported fields
}
ButtonGroupHandle patches a rendered <ui-button-group> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with ButtonGroupElement.
func ButtonGroupElement ¶
func ButtonGroupElement(s *live.Session, id string) ButtonGroupHandle
ButtonGroupElement addresses the <ui-button-group> rendered with this id, for patching its props with compile-checked names instead of strings:
ButtonGroupElement(c.Session, "id").SetLabel(v)
func (ButtonGroupHandle) Handle ¶
func (h ButtonGroupHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (ButtonGroupHandle) SetLabel ¶
func (h ButtonGroupHandle) SetLabel(v string)
SetLabel writes the label prop.
type ButtonGroupProps ¶
type ButtonGroupProps struct {
// Label is accessible name for the group.
//
// The component defaults it to ”.
Label string
}
ButtonGroupProps are the props of <ui-button-group>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type ButtonHandle ¶
type ButtonHandle struct {
// contains filtered or unexported fields
}
ButtonHandle patches a rendered <ui-button> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with ButtonElement.
func ButtonElement ¶
func ButtonElement(s *live.Session, id string) ButtonHandle
ButtonElement addresses the <ui-button> rendered with this id, for patching its props with compile-checked names instead of strings:
ButtonElement(c.Session, "id").SetVariant(v)
func (ButtonHandle) Handle ¶
func (h ButtonHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (ButtonHandle) SetDisabled ¶
func (h ButtonHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (ButtonHandle) SetTarget ¶
func (h ButtonHandle) SetTarget(v string)
SetTarget writes the target prop.
func (ButtonHandle) SetVariant ¶
func (h ButtonHandle) SetVariant(v string)
SetVariant writes the variant prop.
type ButtonProps ¶
type ButtonProps struct {
// Variant is filled | tonal | outlined | text | elevated.
//
// The component defaults it to 'filled'.
Variant string
// The component defaults it to false.
Disabled bool
// Type is button | submit (submit reaches the enclosing form).
//
// The component defaults it to 'button'.
Type string
// Href is renders a link styled as a button.
//
// The component defaults it to ”.
Href string
// Target is link target when href is set.
//
// The component defaults it to ”.
Target string
}
ButtonProps are the props of <ui-button>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type CardHandle ¶
type CardHandle struct {
// contains filtered or unexported fields
}
CardHandle patches a rendered <ui-card> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with CardElement.
func CardElement ¶
func CardElement(s *live.Session, id string) CardHandle
CardElement addresses the <ui-card> rendered with this id, for patching its props with compile-checked names instead of strings:
CardElement(c.Session, "id").SetVariant(v)
func (CardHandle) Handle ¶
func (h CardHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (CardHandle) SetInteractive ¶
func (h CardHandle) SetInteractive(v bool)
SetInteractive writes the interactive prop.
func (CardHandle) SetVariant ¶
func (h CardHandle) SetVariant(v string)
SetVariant writes the variant prop.
type CardProps ¶
type CardProps struct {
// Variant is elevated | filled | outlined.
//
// The component defaults it to 'elevated'.
Variant string
// Interactive is hover elevation + ripple + button semantics.
//
// The component defaults it to false.
Interactive bool
}
CardProps are the props of <ui-card>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type CarouselChangeDetail ¶
type CarouselChangeDetail struct {
Index any `json:"index"`
}
CarouselChangeDetail is the detail of the "change" event of <ui-carousel>.
index moved; detail: { index }
type CarouselHandle ¶
type CarouselHandle struct {
// contains filtered or unexported fields
}
CarouselHandle patches a rendered <ui-carousel> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with CarouselElement.
func CarouselElement ¶
func CarouselElement(s *live.Session, id string) CarouselHandle
CarouselElement addresses the <ui-carousel> rendered with this id, for patching its props with compile-checked names instead of strings:
CarouselElement(c.Session, "id").SetIndex(v)
func (CarouselHandle) Handle ¶
func (h CarouselHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (CarouselHandle) SetIndex ¶
func (h CarouselHandle) SetIndex(v float64)
SetIndex writes the index prop.
func (CarouselHandle) SetLabel ¶
func (h CarouselHandle) SetLabel(v string)
SetLabel writes the label prop.
func (CarouselHandle) SetVariant ¶
func (h CarouselHandle) SetVariant(v string)
SetVariant writes the variant prop.
type CarouselItemHandle ¶
type CarouselItemHandle struct {
// contains filtered or unexported fields
}
CarouselItemHandle patches a rendered <ui-carousel-item> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with CarouselItemElement.
func CarouselItemElement ¶
func CarouselItemElement(s *live.Session, id string) CarouselItemHandle
CarouselItemElement addresses the <ui-carousel-item> rendered with this id, for patching its props with compile-checked names instead of strings:
CarouselItemElement(c.Session, "id").SetSelected(v)
func (CarouselItemHandle) Handle ¶
func (h CarouselItemHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (CarouselItemHandle) SetSelected ¶
func (h CarouselItemHandle) SetSelected(v bool)
SetSelected writes the selected prop.
type CarouselItemProps ¶
type CarouselItemProps struct {
// Selected is managed by the parent <ui-carousel>.
//
// The component defaults it to false.
Selected bool
}
CarouselItemProps are the props of <ui-carousel-item>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type CarouselProps ¶
type CarouselProps struct {
// Index is the selected slide.
//
// The component defaults it to 0.
Index float64
// Variant is multi-browse | uncontained | hero.
//
// The component defaults it to 'multi-browse'.
Variant string
// Label is accessible name for the region.
//
// The component defaults it to ”.
Label string
}
CarouselProps are the props of <ui-carousel>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type CheckboxChangeDetail ¶
type CheckboxChangeDetail struct {
Checked any `json:"checked"`
Indeterminate any `json:"indeterminate"`
}
CheckboxChangeDetail is the detail of the "change" event of <ui-checkbox>.
detail: { checked, indeterminate: false }
type CheckboxHandle ¶
type CheckboxHandle struct {
// contains filtered or unexported fields
}
CheckboxHandle patches a rendered <ui-checkbox> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with CheckboxElement.
func CheckboxElement ¶
func CheckboxElement(s *live.Session, id string) CheckboxHandle
CheckboxElement addresses the <ui-checkbox> rendered with this id, for patching its props with compile-checked names instead of strings:
CheckboxElement(c.Session, "id").SetChecked(v)
func (CheckboxHandle) Handle ¶
func (h CheckboxHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (CheckboxHandle) SetChecked ¶
func (h CheckboxHandle) SetChecked(v bool)
SetChecked writes the checked prop.
func (CheckboxHandle) SetDisabled ¶
func (h CheckboxHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (CheckboxHandle) SetIndeterminate ¶
func (h CheckboxHandle) SetIndeterminate(v bool)
SetIndeterminate writes the indeterminate prop.
func (CheckboxHandle) SetLabel ¶
func (h CheckboxHandle) SetLabel(v string)
SetLabel writes the label prop.
func (CheckboxHandle) SetName ¶
func (h CheckboxHandle) SetName(v string)
SetName writes the name prop.
func (CheckboxHandle) SetValue ¶
func (h CheckboxHandle) SetValue(v string)
SetValue writes the value prop.
type CheckboxProps ¶
type CheckboxProps struct {
// The component defaults it to false.
Checked bool
// Indeterminate is aria-checked="mixed", shows a dash.
//
// The component defaults it to false.
Indeterminate bool
// The component defaults it to false.
Disabled bool
// Label is visible label; also the accessible name. Empty leaves the control unnamed (authoring error).
//
// The component defaults it to ”.
Label string
// Name is form field name (submits `value` while checked).
//
// The component defaults it to ”.
Name string
// The component defaults it to 'on'.
Value string
}
CheckboxProps are the props of <ui-checkbox>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type ChipChangeDetail ¶
type ChipChangeDetail struct {
Selected any `json:"selected"`
}
ChipChangeDetail is the detail of the "change" event of <ui-chip>.
filter chip toggled; detail: { selected }
type ChipHandle ¶
type ChipHandle struct {
// contains filtered or unexported fields
}
ChipHandle patches a rendered <ui-chip> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with ChipElement.
func ChipElement ¶
func ChipElement(s *live.Session, id string) ChipHandle
ChipElement addresses the <ui-chip> rendered with this id, for patching its props with compile-checked names instead of strings:
ChipElement(c.Session, "id").SetVariant(v)
func (ChipHandle) Handle ¶
func (h ChipHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (ChipHandle) SetDisabled ¶
func (h ChipHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (ChipHandle) SetDismissible ¶
func (h ChipHandle) SetDismissible(v bool)
SetDismissible writes the dismissible prop.
func (ChipHandle) SetSelected ¶
func (h ChipHandle) SetSelected(v bool)
SetSelected writes the selected prop.
func (ChipHandle) SetVariant ¶
func (h ChipHandle) SetVariant(v string)
SetVariant writes the variant prop.
type ChipProps ¶
type ChipProps struct {
// Variant is assist | filter | input | suggestion.
//
// The component defaults it to 'assist'.
Variant string
// Selected is filter chips only.
//
// The component defaults it to false.
Selected bool
// The component defaults it to false.
Disabled bool
// Icon is leading icon name (check replaces it while a filter chip is selected).
//
// The component defaults it to ”.
Icon string
// Dismissible is trailing remove button.
//
// The component defaults it to false.
Dismissible bool
// Value is identity within a <ui-chip-set>.
//
// The component defaults it to ”.
Value string
}
ChipProps are the props of <ui-chip>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type ChipSetChangeDetail ¶
type ChipSetChangeDetail struct {
Value any `json:"value"`
}
ChipSetChangeDetail is the detail of the "change" event of <ui-chip-set>.
single-select mode only; detail: { value }
type ChipSetHandle ¶
type ChipSetHandle struct {
// contains filtered or unexported fields
}
ChipSetHandle patches a rendered <ui-chip-set> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with ChipSetElement.
func ChipSetElement ¶
func ChipSetElement(s *live.Session, id string) ChipSetHandle
ChipSetElement addresses the <ui-chip-set> rendered with this id, for patching its props with compile-checked names instead of strings:
ChipSetElement(c.Session, "id").SetLabel(v)
func (ChipSetHandle) Handle ¶
func (h ChipSetHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (ChipSetHandle) SetLabel ¶
func (h ChipSetHandle) SetLabel(v string)
SetLabel writes the label prop.
func (ChipSetHandle) SetMulti ¶
func (h ChipSetHandle) SetMulti(v bool)
SetMulti writes the multi prop.
type ChipSetProps ¶
type ChipSetProps struct {
// Label is accessible name for the set.
//
// The component defaults it to ”.
Label string
// Multi is allow several filter chips selected at once.
//
// The component defaults it to false.
Multi bool
}
ChipSetProps are the props of <ui-chip-set>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type ContainerHandle ¶
type ContainerHandle struct {
// contains filtered or unexported fields
}
ContainerHandle patches a rendered <ui-container> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with ContainerElement.
func ContainerElement ¶
func ContainerElement(s *live.Session, id string) ContainerHandle
ContainerElement addresses the <ui-container> rendered with this id, for patching its props with compile-checked names instead of strings:
ContainerElement(c.Session, "id").SetSize(v)
func (ContainerHandle) Handle ¶
func (h ContainerHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (ContainerHandle) SetGutters ¶
func (h ContainerHandle) SetGutters(v bool)
SetGutters writes the gutters prop.
func (ContainerHandle) SetSize ¶
func (h ContainerHandle) SetSize(v string)
SetSize writes the size prop.
type ContainerProps ¶
type ContainerProps struct {
// Size is sm (640px) | md (960px) | lg (1280px) | xl (1536px) | full (no max width).
//
// The component defaults it to 'md'.
Size string
// Gutters is inline padding: space(6), space(4) under 600px.
//
// The component defaults it to true.
Gutters *bool
}
ContainerProps are the props of <ui-container>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type DatePickerChangeDetail ¶
type DatePickerChangeDetail struct {
Value any `json:"value"`
}
DatePickerChangeDetail is the detail of the "change" event of <ui-date-picker>.
committed; detail: { value } or { start, end, value } when range
type DatePickerHandle ¶
type DatePickerHandle struct {
// contains filtered or unexported fields
}
DatePickerHandle patches a rendered <ui-date-picker> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with DatePickerElement.
func DatePickerElement ¶
func DatePickerElement(s *live.Session, id string) DatePickerHandle
DatePickerElement addresses the <ui-date-picker> rendered with this id, for patching its props with compile-checked names instead of strings:
DatePickerElement(c.Session, "id").SetLabel(v)
func (DatePickerHandle) Handle ¶
func (h DatePickerHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (DatePickerHandle) SetDisabled ¶
func (h DatePickerHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (DatePickerHandle) SetEnd ¶
func (h DatePickerHandle) SetEnd(v string)
SetEnd writes the end prop.
func (DatePickerHandle) SetLabel ¶
func (h DatePickerHandle) SetLabel(v string)
SetLabel writes the label prop.
func (DatePickerHandle) SetLocale ¶
func (h DatePickerHandle) SetLocale(v string)
SetLocale writes the locale prop.
func (DatePickerHandle) SetMax ¶
func (h DatePickerHandle) SetMax(v string)
SetMax writes the max prop.
func (DatePickerHandle) SetMin ¶
func (h DatePickerHandle) SetMin(v string)
SetMin writes the min prop.
func (DatePickerHandle) SetName ¶
func (h DatePickerHandle) SetName(v string)
SetName writes the name prop.
func (DatePickerHandle) SetPlaceholder ¶
func (h DatePickerHandle) SetPlaceholder(v string)
SetPlaceholder writes the placeholder prop.
func (DatePickerHandle) SetPresentation ¶
func (h DatePickerHandle) SetPresentation(v string)
SetPresentation writes the presentation prop.
func (DatePickerHandle) SetRange ¶
func (h DatePickerHandle) SetRange(v bool)
SetRange writes the range prop.
func (DatePickerHandle) SetRequired ¶
func (h DatePickerHandle) SetRequired(v bool)
SetRequired writes the required prop.
func (DatePickerHandle) SetStart ¶
func (h DatePickerHandle) SetStart(v string)
SetStart writes the start prop.
func (DatePickerHandle) SetValue ¶
func (h DatePickerHandle) SetValue(v string)
SetValue writes the value prop.
func (DatePickerHandle) SetVariant ¶
func (h DatePickerHandle) SetVariant(v string)
SetVariant writes the variant prop.
type DatePickerInputDetail ¶
type DatePickerInputDetail struct {
Value any `json:"value"`
}
DatePickerInputDetail is the detail of the "input" event of <ui-date-picker>.
field keystroke; detail: { value } (the raw text)
type DatePickerProps ¶
type DatePickerProps struct {
// The component defaults it to ”.
Label string
// Value is ISO date (YYYY-MM-DD); range: start/end.
//
// The component defaults it to ”.
Value string
// Range is pick a start and end date.
//
// The component defaults it to false.
Range bool
// Start is range start ISO.
//
// The component defaults it to ”.
Start string
// End is range end ISO.
//
// The component defaults it to ”.
End string
// Variant is filled | outlined.
//
// The component defaults it to 'filled'.
Variant string
// Presentation is docked | modal.
//
// The component defaults it to 'docked'.
Presentation string
// Min is inclusive ISO lower bound.
//
// The component defaults it to ”.
Min string
// Max is inclusive ISO upper bound.
//
// The component defaults it to ”.
Max string
// Locale is BCP 47 tag; empty uses the runtime locale.
//
// The component defaults it to ”.
Locale string
// The component defaults it to false.
Disabled bool
// The component defaults it to false.
Required bool
// Name is form participation.
//
// The component defaults it to ”.
Name string
// The component defaults it to ”.
Placeholder string
}
DatePickerProps are the props of <ui-date-picker>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type DialogCloseDetail ¶
type DialogCloseDetail struct {
Reason any `json:"reason"`
}
DialogCloseDetail is the detail of the "close" event of <ui-dialog>.
detail: { reason: 'esc' | 'scrim' | 'method' }
type DialogHandle ¶
type DialogHandle struct {
// contains filtered or unexported fields
}
DialogHandle patches a rendered <ui-dialog> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with DialogElement.
func DialogElement ¶
func DialogElement(s *live.Session, id string) DialogHandle
DialogElement addresses the <ui-dialog> rendered with this id, for patching its props with compile-checked names instead of strings:
DialogElement(c.Session, "id").SetOpen(v)
func (DialogHandle) Handle ¶
func (h DialogHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (DialogHandle) SetLabel ¶
func (h DialogHandle) SetLabel(v string)
SetLabel writes the label prop.
func (DialogHandle) SetPersistent ¶
func (h DialogHandle) SetPersistent(v bool)
SetPersistent writes the persistent prop.
type DialogProps ¶
type DialogProps struct {
// The component defaults it to false.
Open bool
// Persistent is escape/scrim do not request closing.
//
// The component defaults it to false.
Persistent bool
// Label is accessible name if no headline slot.
//
// The component defaults it to ”.
Label string
}
DialogProps are the props of <ui-dialog>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type DividerHandle ¶
type DividerHandle struct {
// contains filtered or unexported fields
}
DividerHandle patches a rendered <ui-divider> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with DividerElement.
func DividerElement ¶
func DividerElement(s *live.Session, id string) DividerHandle
DividerElement addresses the <ui-divider> rendered with this id, for patching its props with compile-checked names instead of strings:
DividerElement(c.Session, "id").SetOrientation(v)
func (DividerHandle) Handle ¶
func (h DividerHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (DividerHandle) SetInset ¶
func (h DividerHandle) SetInset(v bool)
SetInset writes the inset prop.
func (DividerHandle) SetMiddle ¶
func (h DividerHandle) SetMiddle(v bool)
SetMiddle writes the middle prop.
func (DividerHandle) SetOrientation ¶
func (h DividerHandle) SetOrientation(v string)
SetOrientation writes the orientation prop.
type DividerProps ¶
type DividerProps struct {
// Orientation is horizontal | vertical.
//
// The component defaults it to 'horizontal'.
Orientation string
// Inset is indented from the start edge (16px).
//
// The component defaults it to false.
Inset bool
// Middle is indented from both edges.
//
// The component defaults it to false.
Middle bool
}
DividerProps are the props of <ui-divider>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type DrawerCloseDetail ¶
type DrawerCloseDetail struct {
Reason any `json:"reason"`
}
DrawerCloseDetail is the detail of the "close" event of <ui-drawer>.
modal dismissed; detail: { reason: 'esc' | 'scrim' }
type DrawerHandle ¶
type DrawerHandle struct {
// contains filtered or unexported fields
}
DrawerHandle patches a rendered <ui-drawer> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with DrawerElement.
func DrawerElement ¶
func DrawerElement(s *live.Session, id string) DrawerHandle
DrawerElement addresses the <ui-drawer> rendered with this id, for patching its props with compile-checked names instead of strings:
DrawerElement(c.Session, "id").SetOpen(v)
func (DrawerHandle) Handle ¶
func (h DrawerHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (DrawerHandle) SetAnchor ¶
func (h DrawerHandle) SetAnchor(v string)
SetAnchor writes the anchor prop.
func (DrawerHandle) SetLabel ¶
func (h DrawerHandle) SetLabel(v string)
SetLabel writes the label prop.
func (DrawerHandle) SetVariant ¶
func (h DrawerHandle) SetVariant(v string)
SetVariant writes the variant prop.
type DrawerProps ¶
type DrawerProps struct {
// The component defaults it to false.
Open bool
// Variant is modal | standard.
//
// The component defaults it to 'modal'.
Variant string
// Anchor is start | end (which edge it slides from).
//
// The component defaults it to 'start'.
Anchor string
// Label is accessible name; falls back to "Navigation".
//
// The component defaults it to ”.
Label string
}
DrawerProps are the props of <ui-drawer>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type FabHandle ¶
type FabHandle struct {
// contains filtered or unexported fields
}
FabHandle patches a rendered <ui-fab> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with FabElement.
func FabElement ¶
FabElement addresses the <ui-fab> rendered with this id, for patching its props with compile-checked names instead of strings:
FabElement(c.Session, "id").SetIcon(v)
func (FabHandle) SetDisabled ¶
SetDisabled writes the disabled prop.
func (FabHandle) SetVariant ¶
SetVariant writes the variant prop.
type FabMenuHandle ¶
type FabMenuHandle struct {
// contains filtered or unexported fields
}
FabMenuHandle patches a rendered <ui-fab-menu> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with FabMenuElement.
func FabMenuElement ¶
func FabMenuElement(s *live.Session, id string) FabMenuHandle
FabMenuElement addresses the <ui-fab-menu> rendered with this id, for patching its props with compile-checked names instead of strings:
FabMenuElement(c.Session, "id").SetOpen(v)
func (FabMenuHandle) Handle ¶
func (h FabMenuHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (FabMenuHandle) SetLabel ¶
func (h FabMenuHandle) SetLabel(v string)
SetLabel writes the label prop.
type FabMenuProps ¶
type FabMenuProps struct {
// The component defaults it to false.
Open bool
// Label is accessible name for the action list.
//
// The component defaults it to ”.
Label string
}
FabMenuProps are the props of <ui-fab-menu>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type FabProps ¶
type FabProps struct {
// Icon is registry icon name (or slot custom content).
//
// The component defaults it to ”.
Icon string
// Label is extended-FAB text; always used as aria-label (falls back to the icon name when empty).
//
// The component defaults it to ”.
Label string
// Variant is primary | secondary | tertiary | surface.
//
// The component defaults it to 'primary'.
Variant string
// Size is sm (40px) | md (56px) | lg (96px).
//
// The component defaults it to 'md'.
Size string
// The component defaults it to false.
Disabled bool
}
FabProps are the props of <ui-fab>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type IconButtonChangeDetail ¶
type IconButtonChangeDetail struct {
Selected any `json:"selected"`
}
IconButtonChangeDetail is the detail of the "change" event of <ui-icon-button>.
toggle flipped; detail: { selected }
type IconButtonHandle ¶
type IconButtonHandle struct {
// contains filtered or unexported fields
}
IconButtonHandle patches a rendered <ui-icon-button> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with IconButtonElement.
func IconButtonElement ¶
func IconButtonElement(s *live.Session, id string) IconButtonHandle
IconButtonElement addresses the <ui-icon-button> rendered with this id, for patching its props with compile-checked names instead of strings:
IconButtonElement(c.Session, "id").SetIcon(v)
func (IconButtonHandle) Handle ¶
func (h IconButtonHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (IconButtonHandle) SetDisabled ¶
func (h IconButtonHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (IconButtonHandle) SetIcon ¶
func (h IconButtonHandle) SetIcon(v string)
SetIcon writes the icon prop.
func (IconButtonHandle) SetLabel ¶
func (h IconButtonHandle) SetLabel(v string)
SetLabel writes the label prop.
func (IconButtonHandle) SetSelected ¶
func (h IconButtonHandle) SetSelected(v bool)
SetSelected writes the selected prop.
func (IconButtonHandle) SetSelectedIcon ¶
func (h IconButtonHandle) SetSelectedIcon(v string)
SetSelectedIcon writes the selectedIcon prop.
func (IconButtonHandle) SetToggle ¶
func (h IconButtonHandle) SetToggle(v bool)
SetToggle writes the toggle prop.
func (IconButtonHandle) SetVariant ¶
func (h IconButtonHandle) SetVariant(v string)
SetVariant writes the variant prop.
type IconButtonProps ¶
type IconButtonProps struct {
// Icon is registry icon name (or slot an <ui-icon>).
//
// The component defaults it to ”.
Icon string
// SelectedIcon is icon while selected (toggle mode; defaults to `icon`).
//
// The component defaults it to ”.
SelectedIcon string
// Label is REQUIRED accessible name.
//
// The component defaults it to ”.
Label string
// Variant is standard | filled | tonal | outlined.
//
// The component defaults it to 'standard'.
Variant string
// Toggle is makes it a pressed-state toggle.
//
// The component defaults it to false.
Toggle bool
// Selected is toggle state.
//
// The component defaults it to false.
Selected bool
// The component defaults it to false.
Disabled bool
}
IconButtonProps are the props of <ui-icon-button>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type IconHandle ¶
type IconHandle struct {
// contains filtered or unexported fields
}
IconHandle patches a rendered <ui-icon> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with IconElement.
func IconElement ¶
func IconElement(s *live.Session, id string) IconHandle
IconElement addresses the <ui-icon> rendered with this id, for patching its props with compile-checked names instead of strings:
IconElement(c.Session, "id").SetName(v)
func (IconHandle) Handle ¶
func (h IconHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
type IconProps ¶
type IconProps struct {
// Name is registry name; empty renders the slot.
//
// The component defaults it to ”.
Name string
// Label is accessible name; empty marks the icon decorative.
//
// The component defaults it to ”.
Label string
// Size is CSS length; overrides --ui-icon-size for this element.
//
// The component defaults it to ”.
Size string
}
IconProps are the props of <ui-icon>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type ListHandle ¶
type ListHandle struct {
// contains filtered or unexported fields
}
ListHandle patches a rendered <ui-list> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with ListElement.
func ListElement ¶
func ListElement(s *live.Session, id string) ListHandle
ListElement addresses the <ui-list> rendered with this id, for patching its props with compile-checked names instead of strings:
ListElement(c.Session, "id").SetLabel(v)
func (ListHandle) Handle ¶
func (h ListHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
type ListItemHandle ¶
type ListItemHandle struct {
// contains filtered or unexported fields
}
ListItemHandle patches a rendered <ui-list-item> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with ListItemElement.
func ListItemElement ¶
func ListItemElement(s *live.Session, id string) ListItemHandle
ListItemElement addresses the <ui-list-item> rendered with this id, for patching its props with compile-checked names instead of strings:
ListItemElement(c.Session, "id").SetHeadline(v)
func (ListItemHandle) Handle ¶
func (h ListItemHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (ListItemHandle) SetDisabled ¶
func (h ListItemHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (ListItemHandle) SetHeadline ¶
func (h ListItemHandle) SetHeadline(v string)
SetHeadline writes the headline prop.
func (ListItemHandle) SetHref ¶
func (h ListItemHandle) SetHref(v string)
SetHref writes the href prop.
func (ListItemHandle) SetInteractive ¶
func (h ListItemHandle) SetInteractive(v bool)
SetInteractive writes the interactive prop.
func (ListItemHandle) SetSelected ¶
func (h ListItemHandle) SetSelected(v bool)
SetSelected writes the selected prop.
func (ListItemHandle) SetSupporting ¶
func (h ListItemHandle) SetSupporting(v string)
SetSupporting writes the supporting prop.
type ListItemProps ¶
type ListItemProps struct {
// Headline is primary text (or use the default slot).
//
// The component defaults it to ”.
Headline string
// Supporting is secondary text (or use the supporting slot).
//
// The component defaults it to ”.
Supporting string
// Interactive is state layer + ripple + role="button".
//
// The component defaults it to false.
Interactive bool
// Href is renders the row as an <a>.
//
// The component defaults it to ”.
Href string
// Selected is secondaryContainer background.
//
// The component defaults it to false.
Selected bool
// The component defaults it to false.
Disabled bool
}
ListItemProps are the props of <ui-list-item>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type ListProps ¶
type ListProps struct {
// Label is accessible name for the list.
//
// The component defaults it to ”.
Label string
}
ListProps are the props of <ui-list>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type LoadingIndicatorHandle ¶
type LoadingIndicatorHandle struct {
// contains filtered or unexported fields
}
LoadingIndicatorHandle patches a rendered <ui-loading-indicator> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with LoadingIndicatorElement.
func LoadingIndicatorElement ¶
func LoadingIndicatorElement(s *live.Session, id string) LoadingIndicatorHandle
LoadingIndicatorElement addresses the <ui-loading-indicator> rendered with this id, for patching its props with compile-checked names instead of strings:
LoadingIndicatorElement(c.Session, "id").SetVariant(v)
func (LoadingIndicatorHandle) Handle ¶
func (h LoadingIndicatorHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (LoadingIndicatorHandle) SetLabel ¶
func (h LoadingIndicatorHandle) SetLabel(v string)
SetLabel writes the label prop.
func (LoadingIndicatorHandle) SetVariant ¶
func (h LoadingIndicatorHandle) SetVariant(v string)
SetVariant writes the variant prop.
type LoadingIndicatorProps ¶
type LoadingIndicatorProps struct {
// Variant is uncontained | contained.
//
// The component defaults it to 'uncontained'.
Variant string
// Label is accessible name.
//
// The component defaults it to 'Loading'.
Label string
}
LoadingIndicatorProps are the props of <ui-loading-indicator>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type MenuHandle ¶
type MenuHandle struct {
// contains filtered or unexported fields
}
MenuHandle patches a rendered <ui-menu> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with MenuElement.
func MenuElement ¶
func MenuElement(s *live.Session, id string) MenuHandle
MenuElement addresses the <ui-menu> rendered with this id, for patching its props with compile-checked names instead of strings:
MenuElement(c.Session, "id").SetOpen(v)
func (MenuHandle) Handle ¶
func (h MenuHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (MenuHandle) SetPlacement ¶
func (h MenuHandle) SetPlacement(v string)
SetPlacement writes the placement prop.
type MenuItemHandle ¶
type MenuItemHandle struct {
// contains filtered or unexported fields
}
MenuItemHandle patches a rendered <ui-menu-item> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with MenuItemElement.
func MenuItemElement ¶
func MenuItemElement(s *live.Session, id string) MenuItemHandle
MenuItemElement addresses the <ui-menu-item> rendered with this id, for patching its props with compile-checked names instead of strings:
MenuItemElement(c.Session, "id").SetValue(v)
func (MenuItemHandle) Handle ¶
func (h MenuItemHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (MenuItemHandle) SetDanger ¶
func (h MenuItemHandle) SetDanger(v bool)
SetDanger writes the danger prop.
func (MenuItemHandle) SetDisabled ¶
func (h MenuItemHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (MenuItemHandle) SetIcon ¶
func (h MenuItemHandle) SetIcon(v string)
SetIcon writes the icon prop.
func (MenuItemHandle) SetValue ¶
func (h MenuItemHandle) SetValue(v string)
SetValue writes the value prop.
type MenuItemProps ¶
type MenuItemProps struct {
// Value is reported in the menu's `select` detail.
//
// The component defaults it to ”.
Value string
// Icon is leading registry icon.
//
// The component defaults it to ”.
Icon string
// The component defaults it to false.
Disabled bool
// Danger is error color for destructive actions.
//
// The component defaults it to false.
Danger bool
}
MenuItemProps are the props of <ui-menu-item>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type MenuItemUIMenuSelectDetail ¶
type MenuItemUIMenuSelectDetail struct {
Value any `json:"value"`
}
MenuItemUIMenuSelectDetail is the detail of the "ui-menu-select" event of <ui-menu-item>.
internal; detail: { value } (consumed by <ui-menu>)
type MenuProps ¶
type MenuProps struct {
// The component defaults it to false.
Open bool
// Placement is side[-alignment] (see util/position.js).
//
// The component defaults it to 'bottom-start'.
Placement string
}
MenuProps are the props of <ui-menu>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type MenuSelectDetail ¶
type MenuSelectDetail struct {
Value any `json:"value"`
}
MenuSelectDetail is the detail of the "select" event of <ui-menu>.
an item was chosen; detail: { value }
type NavItemHandle ¶
type NavItemHandle struct {
// contains filtered or unexported fields
}
NavItemHandle patches a rendered <ui-nav-item> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with NavItemElement.
func NavItemElement ¶
func NavItemElement(s *live.Session, id string) NavItemHandle
NavItemElement addresses the <ui-nav-item> rendered with this id, for patching its props with compile-checked names instead of strings:
NavItemElement(c.Session, "id").SetValue(v)
func (NavItemHandle) Handle ¶
func (h NavItemHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (NavItemHandle) SetActiveIcon ¶
func (h NavItemHandle) SetActiveIcon(v string)
SetActiveIcon writes the activeIcon prop.
func (NavItemHandle) SetDisabled ¶
func (h NavItemHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (NavItemHandle) SetIcon ¶
func (h NavItemHandle) SetIcon(v string)
SetIcon writes the icon prop.
func (NavItemHandle) SetLabel ¶
func (h NavItemHandle) SetLabel(v string)
SetLabel writes the label prop.
func (NavItemHandle) SetSelected ¶
func (h NavItemHandle) SetSelected(v bool)
SetSelected writes the selected prop.
func (NavItemHandle) SetValue ¶
func (h NavItemHandle) SetValue(v string)
SetValue writes the value prop.
type NavItemProps ¶
type NavItemProps struct {
//
// The component defaults it to ”.
Value string
//
// The component defaults it to ”.
Icon string
//
// The component defaults it to ”.
ActiveIcon string
//
// The component defaults it to ”.
Label string
//
// The component defaults it to false.
Selected bool
Disabled bool
}
NavItemProps are the props of <ui-nav-item>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type NavItemUINavSelectDetail ¶
type NavItemUINavSelectDetail struct {
}
NavItemUINavSelectDetail is the detail of the "ui-nav-select" event of <ui-nav-item>.
activated; detail: { value }
type NavRailChangeDetail ¶
type NavRailChangeDetail struct {
}
NavRailChangeDetail is the detail of the "change" event of <ui-nav-rail>.
a destination was chosen; detail: { value }
type NavRailHandle ¶
type NavRailHandle struct {
// contains filtered or unexported fields
}
NavRailHandle patches a rendered <ui-nav-rail> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with NavRailElement.
func NavRailElement ¶
func NavRailElement(s *live.Session, id string) NavRailHandle
NavRailElement addresses the <ui-nav-rail> rendered with this id, for patching its props with compile-checked names instead of strings:
NavRailElement(c.Session, "id").SetValue(v)
func (NavRailHandle) Handle ¶
func (h NavRailHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (NavRailHandle) SetAlign ¶
func (h NavRailHandle) SetAlign(v string)
SetAlign writes the align prop.
func (NavRailHandle) SetLabel ¶
func (h NavRailHandle) SetLabel(v string)
SetLabel writes the label prop.
func (NavRailHandle) SetValue ¶
func (h NavRailHandle) SetValue(v string)
SetValue writes the value prop.
type NavRailProps ¶
type NavRailProps struct {
//
// The component defaults it to ”.
Value string
//
// The component defaults it to ”.
Label string
//
// The component defaults it to 'start'.
Align string
}
NavRailProps are the props of <ui-nav-rail>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type OptionHandle ¶
type OptionHandle struct {
// contains filtered or unexported fields
}
OptionHandle patches a rendered <ui-option> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with OptionElement.
func OptionElement ¶
func OptionElement(s *live.Session, id string) OptionHandle
OptionElement addresses the <ui-option> rendered with this id, for patching its props with compile-checked names instead of strings:
OptionElement(c.Session, "id").SetValue(v)
func (OptionHandle) Handle ¶
func (h OptionHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (OptionHandle) SetActive ¶
func (h OptionHandle) SetActive(v bool)
SetActive writes the active prop.
func (OptionHandle) SetDisabled ¶
func (h OptionHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (OptionHandle) SetSelected ¶
func (h OptionHandle) SetSelected(v bool)
SetSelected writes the selected prop.
func (OptionHandle) SetValue ¶
func (h OptionHandle) SetValue(v string)
SetValue writes the value prop.
type OptionProps ¶
type OptionProps struct {
// Value is the value this option contributes (required).
//
// The component defaults it to ”.
Value string
// The component defaults it to false.
Disabled bool
// Selected is set by the owning select; mirrors aria-selected.
//
// The component defaults it to false.
Selected bool
// Active is set by the owning select while keyboard-active.
//
// The component defaults it to false.
Active bool
}
OptionProps are the props of <ui-option>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type PaginationChangeDetail ¶
type PaginationChangeDetail struct {
Page any `json:"page"`
}
PaginationChangeDetail is the detail of the "change" event of <ui-pagination>.
a page was chosen (numbers, prev, next); detail: { page }
type PaginationHandle ¶
type PaginationHandle struct {
// contains filtered or unexported fields
}
PaginationHandle patches a rendered <ui-pagination> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with PaginationElement.
func PaginationElement ¶
func PaginationElement(s *live.Session, id string) PaginationHandle
PaginationElement addresses the <ui-pagination> rendered with this id, for patching its props with compile-checked names instead of strings:
PaginationElement(c.Session, "id").SetPage(v)
func (PaginationHandle) Handle ¶
func (h PaginationHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (PaginationHandle) SetBoundaries ¶
func (h PaginationHandle) SetBoundaries(v float64)
SetBoundaries writes the boundaries prop.
func (PaginationHandle) SetCount ¶
func (h PaginationHandle) SetCount(v float64)
SetCount writes the count prop.
func (PaginationHandle) SetDisabled ¶
func (h PaginationHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (PaginationHandle) SetLabel ¶
func (h PaginationHandle) SetLabel(v string)
SetLabel writes the label prop.
func (PaginationHandle) SetPage ¶
func (h PaginationHandle) SetPage(v float64)
SetPage writes the page prop.
func (PaginationHandle) SetSiblings ¶
func (h PaginationHandle) SetSiblings(v float64)
SetSiblings writes the siblings prop.
type PaginationProps ¶
type PaginationProps struct {
// Page is current page (1-based).
//
// The component defaults it to 1.
Page float64
// Count is total pages.
//
// The component defaults it to 1.
Count float64
// Siblings is pages shown on each side of the current page.
//
// The component defaults it to 1.
Siblings float64
// Boundaries is pages always shown at each end.
//
// The component defaults it to 1.
Boundaries float64
// The component defaults it to false.
Disabled bool
// Label is accessible name of the <nav>.
//
// The component defaults it to 'Pagination'.
Label string
}
PaginationProps are the props of <ui-pagination>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type ProgressHandle ¶
type ProgressHandle struct {
// contains filtered or unexported fields
}
ProgressHandle patches a rendered <ui-progress> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with ProgressElement.
func ProgressElement ¶
func ProgressElement(s *live.Session, id string) ProgressHandle
ProgressElement addresses the <ui-progress> rendered with this id, for patching its props with compile-checked names instead of strings:
ProgressElement(c.Session, "id").SetValue(v)
func (ProgressHandle) Handle ¶
func (h ProgressHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (ProgressHandle) SetLabel ¶
func (h ProgressHandle) SetLabel(v string)
SetLabel writes the label prop.
func (ProgressHandle) SetMax ¶
func (h ProgressHandle) SetMax(v float64)
SetMax writes the max prop.
func (ProgressHandle) SetValue ¶
func (h ProgressHandle) SetValue(v float64)
SetValue writes the value prop.
type ProgressProps ¶
type ProgressProps struct {
// Value is current value; -1 (any negative) = indeterminate.
//
// The component defaults it to -1.
Value float64
// Max is value scale.
//
// The component defaults it to 100.
Max float64
// Label is accessible name (aria-label on the progressbar).
//
// The component defaults it to ”.
Label string
}
ProgressProps are the props of <ui-progress>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type RadioGroupChangeDetail ¶
type RadioGroupChangeDetail struct {
Value any `json:"value"`
}
RadioGroupChangeDetail is the detail of the "change" event of <ui-radio-group>.
detail: { value }
type RadioGroupHandle ¶
type RadioGroupHandle struct {
// contains filtered or unexported fields
}
RadioGroupHandle patches a rendered <ui-radio-group> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with RadioGroupElement.
func RadioGroupElement ¶
func RadioGroupElement(s *live.Session, id string) RadioGroupHandle
RadioGroupElement addresses the <ui-radio-group> rendered with this id, for patching its props with compile-checked names instead of strings:
RadioGroupElement(c.Session, "id").SetValue(v)
func (RadioGroupHandle) Handle ¶
func (h RadioGroupHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (RadioGroupHandle) SetDisabled ¶
func (h RadioGroupHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (RadioGroupHandle) SetLabel ¶
func (h RadioGroupHandle) SetLabel(v string)
SetLabel writes the label prop.
func (RadioGroupHandle) SetName ¶
func (h RadioGroupHandle) SetName(v string)
SetName writes the name prop.
func (RadioGroupHandle) SetOrientation ¶
func (h RadioGroupHandle) SetOrientation(v string)
SetOrientation writes the orientation prop.
func (RadioGroupHandle) SetValue ¶
func (h RadioGroupHandle) SetValue(v string)
SetValue writes the value prop.
type RadioGroupProps ¶
type RadioGroupProps struct {
// The component defaults it to ”.
Value string
// Name is form participation (submits `value`).
//
// The component defaults it to ”.
Name string
// Label is accessible name for the group.
//
// The component defaults it to ”.
Label string
// Disabled is disables every radio.
//
// The component defaults it to false.
Disabled bool
// Orientation is vertical | horizontal (layout only; arrows work on both axes per the APG).
//
// The component defaults it to 'vertical'.
Orientation string
}
RadioGroupProps are the props of <ui-radio-group>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type RadioHandle ¶
type RadioHandle struct {
// contains filtered or unexported fields
}
RadioHandle patches a rendered <ui-radio> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with RadioElement.
func RadioElement ¶
func RadioElement(s *live.Session, id string) RadioHandle
RadioElement addresses the <ui-radio> rendered with this id, for patching its props with compile-checked names instead of strings:
RadioElement(c.Session, "id").SetValue(v)
func (RadioHandle) Handle ¶
func (h RadioHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (RadioHandle) SetChecked ¶
func (h RadioHandle) SetChecked(v bool)
SetChecked writes the checked prop.
func (RadioHandle) SetDisabled ¶
func (h RadioHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (RadioHandle) SetLabel ¶
func (h RadioHandle) SetLabel(v string)
SetLabel writes the label prop.
func (RadioHandle) SetValue ¶
func (h RadioHandle) SetValue(v string)
SetValue writes the value prop.
type RadioProps ¶
type RadioProps struct {
// Value is REQUIRED identity within the group.
//
// The component defaults it to ”.
Value string
// Checked is set by the owning group.
//
// The component defaults it to false.
Checked bool
// The component defaults it to false.
Disabled bool
// Label is visible label; also the accessible name. Empty leaves the control unnamed (authoring error).
//
// The component defaults it to ”.
Label string
}
RadioProps are the props of <ui-radio>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type RadioUIRadioSelectDetail ¶
type RadioUIRadioSelectDetail struct {
Value any `json:"value"`
}
RadioUIRadioSelectDetail is the detail of the "ui-radio-select" event of <ui-radio>.
pressed; detail: { value } (consumed by ui-radio-group)
type RatingChangeDetail ¶
type RatingChangeDetail struct {
Value any `json:"value"`
}
RatingChangeDetail is the detail of the "change" event of <ui-rating>.
committed; detail: { value }
type RatingHandle ¶
type RatingHandle struct {
// contains filtered or unexported fields
}
RatingHandle patches a rendered <ui-rating> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with RatingElement.
func RatingElement ¶
func RatingElement(s *live.Session, id string) RatingHandle
RatingElement addresses the <ui-rating> rendered with this id, for patching its props with compile-checked names instead of strings:
RatingElement(c.Session, "id").SetValue(v)
func (RatingHandle) Handle ¶
func (h RatingHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (RatingHandle) SetDisabled ¶
func (h RatingHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (RatingHandle) SetLabel ¶
func (h RatingHandle) SetLabel(v string)
SetLabel writes the label prop.
func (RatingHandle) SetReadonly ¶
func (h RatingHandle) SetReadonly(v bool)
SetReadonly writes the readonly prop.
func (RatingHandle) SetValue ¶
func (h RatingHandle) SetValue(v float64)
SetValue writes the value prop.
type RatingProps ¶
type RatingProps struct {
// The component defaults it to 0.
Value float64
// The component defaults it to 5.
Max float64
// Readonly is shows the value, no interaction.
//
// The component defaults it to false.
Readonly bool
// The component defaults it to false.
Disabled bool
// Label is accessible name.
//
// The component defaults it to 'Rating'.
Label string
// Size is CSS length for the stars (overrides --ui-icon-size).
//
// The component defaults it to ”.
Size string
}
RatingProps are the props of <ui-rating>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type SearchChangeDetail ¶
type SearchChangeDetail struct {
Value any `json:"value"`
}
SearchChangeDetail is the detail of the "change" event of <ui-search>.
committed (blur/Enter); detail: { value }
type SearchHandle ¶
type SearchHandle struct {
// contains filtered or unexported fields
}
SearchHandle patches a rendered <ui-search> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with SearchElement.
func SearchElement ¶
func SearchElement(s *live.Session, id string) SearchHandle
SearchElement addresses the <ui-search> rendered with this id, for patching its props with compile-checked names instead of strings:
SearchElement(c.Session, "id").SetLabel(v)
func (SearchHandle) Handle ¶
func (h SearchHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (SearchHandle) SetDisabled ¶
func (h SearchHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (SearchHandle) SetLabel ¶
func (h SearchHandle) SetLabel(v string)
SetLabel writes the label prop.
func (SearchHandle) SetPlaceholder ¶
func (h SearchHandle) SetPlaceholder(v string)
SetPlaceholder writes the placeholder prop.
func (SearchHandle) SetPresentation ¶
func (h SearchHandle) SetPresentation(v string)
SetPresentation writes the presentation prop.
func (SearchHandle) SetValue ¶
func (h SearchHandle) SetValue(v string)
SetValue writes the value prop.
type SearchInputDetail ¶
type SearchInputDetail struct {
Value any `json:"value"`
}
SearchInputDetail is the detail of the "input" event of <ui-search>.
every keystroke; detail: { value }
type SearchProps ¶
type SearchProps struct {
// Label is accessible name (and the floating placeholder).
//
// The component defaults it to 'Search'.
Label string
// The component defaults it to ”.
Value string
// Placeholder is shown in the field; falls back to `label`.
//
// The component defaults it to ”.
Placeholder string
// Presentation is bar | view.
//
// The component defaults it to 'bar'.
Presentation string
// Open is view / suggestions visibility.
//
// The component defaults it to false.
Open bool
// The component defaults it to false.
Disabled bool
// Name is form participation.
//
// The component defaults it to ”.
Name string
}
SearchProps are the props of <ui-search>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type SearchSubmitDetail ¶
type SearchSubmitDetail struct {
Value any `json:"value"`
}
SearchSubmitDetail is the detail of the "submit" event of <ui-search>.
Enter pressed; detail: { value }
type SelectChangeDetail ¶
type SelectChangeDetail struct {
Value any `json:"value"`
}
SelectChangeDetail is the detail of the "change" event of <ui-select>.
an option was chosen; detail: { value }
type SelectHandle ¶
type SelectHandle struct {
// contains filtered or unexported fields
}
SelectHandle patches a rendered <ui-select> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with SelectElement.
func SelectElement ¶
func SelectElement(s *live.Session, id string) SelectHandle
SelectElement addresses the <ui-select> rendered with this id, for patching its props with compile-checked names instead of strings:
SelectElement(c.Session, "id").SetLabel(v)
func (SelectHandle) Handle ¶
func (h SelectHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (SelectHandle) SetDisabled ¶
func (h SelectHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (SelectHandle) SetLabel ¶
func (h SelectHandle) SetLabel(v string)
SetLabel writes the label prop.
func (SelectHandle) SetPlaceholder ¶
func (h SelectHandle) SetPlaceholder(v string)
SetPlaceholder writes the placeholder prop.
func (SelectHandle) SetRequired ¶
func (h SelectHandle) SetRequired(v bool)
SetRequired writes the required prop.
func (SelectHandle) SetSearch ¶ added in v0.10.0
func (h SelectHandle) SetSearch(v string)
SetSearch writes the search prop.
func (SelectHandle) SetSearchPlaceholder ¶ added in v0.10.0
func (h SelectHandle) SetSearchPlaceholder(v string)
SetSearchPlaceholder writes the searchPlaceholder prop.
func (SelectHandle) SetSearchThreshold ¶ added in v0.10.0
func (h SelectHandle) SetSearchThreshold(v float64)
SetSearchThreshold writes the searchThreshold prop.
func (SelectHandle) SetValue ¶
func (h SelectHandle) SetValue(v string)
SetValue writes the value prop.
func (SelectHandle) SetVariant ¶
func (h SelectHandle) SetVariant(v string)
SetVariant writes the variant prop.
type SelectProps ¶
type SelectProps struct {
// The component defaults it to ”.
Label string
// Value is the selected option's value.
//
// The component defaults it to ”.
Value string
// Variant is filled | outlined.
//
// The component defaults it to 'filled'.
Variant string
// The component defaults it to false.
Disabled bool
// The component defaults it to false.
Required bool
// Name is form participation.
//
// The component defaults it to ”.
Name string
// Placeholder is shown while nothing is selected.
//
// The component defaults it to ”.
Placeholder string
// Search is auto | always | never; 'auto' shows the filter once there are searchThreshold options or more.
//
// The component defaults it to 'auto'.
Search string
// The component defaults it to 8.
SearchThreshold float64
// The component defaults it to 'Search'.
SearchPlaceholder string
}
SelectProps are the props of <ui-select>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type SheetCloseDetail ¶
type SheetCloseDetail struct {
Reason any `json:"reason"`
}
SheetCloseDetail is the detail of the "close" event of <ui-sheet>.
detail: { reason: 'esc' | 'scrim' | 'method' }
type SheetHandle ¶
type SheetHandle struct {
// contains filtered or unexported fields
}
SheetHandle patches a rendered <ui-sheet> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with SheetElement.
func SheetElement ¶
func SheetElement(s *live.Session, id string) SheetHandle
SheetElement addresses the <ui-sheet> rendered with this id, for patching its props with compile-checked names instead of strings:
SheetElement(c.Session, "id").SetOpen(v)
func (SheetHandle) Handle ¶
func (h SheetHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (SheetHandle) SetLabel ¶
func (h SheetHandle) SetLabel(v string)
SetLabel writes the label prop.
func (SheetHandle) SetPersistent ¶
func (h SheetHandle) SetPersistent(v bool)
SetPersistent writes the persistent prop.
func (SheetHandle) SetVariant ¶
func (h SheetHandle) SetVariant(v string)
SetVariant writes the variant prop.
type SheetProps ¶
type SheetProps struct {
// The component defaults it to false.
Open bool
// Variant is modal | standard.
//
// The component defaults it to 'modal'.
Variant string
// Persistent is escape/scrim do not request closing.
//
// The component defaults it to false.
Persistent bool
// Label is accessible name if no headline slot.
//
// The component defaults it to ”.
Label string
}
SheetProps are the props of <ui-sheet>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type SideSheetCloseDetail ¶
type SideSheetCloseDetail struct {
Reason any `json:"reason"`
}
SideSheetCloseDetail is the detail of the "close" event of <ui-side-sheet>.
detail: { reason: 'esc' | 'scrim' | 'method' }
type SideSheetHandle ¶
type SideSheetHandle struct {
// contains filtered or unexported fields
}
SideSheetHandle patches a rendered <ui-side-sheet> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with SideSheetElement.
func SideSheetElement ¶
func SideSheetElement(s *live.Session, id string) SideSheetHandle
SideSheetElement addresses the <ui-side-sheet> rendered with this id, for patching its props with compile-checked names instead of strings:
SideSheetElement(c.Session, "id").SetOpen(v)
func (SideSheetHandle) Handle ¶
func (h SideSheetHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (SideSheetHandle) SetAnchor ¶
func (h SideSheetHandle) SetAnchor(v string)
SetAnchor writes the anchor prop.
func (SideSheetHandle) SetLabel ¶
func (h SideSheetHandle) SetLabel(v string)
SetLabel writes the label prop.
func (SideSheetHandle) SetOpen ¶
func (h SideSheetHandle) SetOpen(v bool)
SetOpen writes the open prop.
func (SideSheetHandle) SetPersistent ¶
func (h SideSheetHandle) SetPersistent(v bool)
SetPersistent writes the persistent prop.
func (SideSheetHandle) SetVariant ¶
func (h SideSheetHandle) SetVariant(v string)
SetVariant writes the variant prop.
type SideSheetProps ¶
type SideSheetProps struct {
// The component defaults it to false.
Open bool
// Variant is modal | standard.
//
// The component defaults it to 'modal'.
Variant string
// Anchor is start | end.
//
// The component defaults it to 'end'.
Anchor string
// Persistent is escape/scrim do not request closing.
//
// The component defaults it to false.
Persistent bool
// Label is accessible name if no headline slot.
//
// The component defaults it to ”.
Label string
}
SideSheetProps are the props of <ui-side-sheet>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type SkeletonHandle ¶
type SkeletonHandle struct {
// contains filtered or unexported fields
}
SkeletonHandle patches a rendered <ui-skeleton> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with SkeletonElement.
func SkeletonElement ¶
func SkeletonElement(s *live.Session, id string) SkeletonHandle
SkeletonElement addresses the <ui-skeleton> rendered with this id, for patching its props with compile-checked names instead of strings:
SkeletonElement(c.Session, "id").SetVariant(v)
func (SkeletonHandle) Handle ¶
func (h SkeletonHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (SkeletonHandle) SetAnimation ¶
func (h SkeletonHandle) SetAnimation(v string)
SetAnimation writes the animation prop.
func (SkeletonHandle) SetHeight ¶
func (h SkeletonHandle) SetHeight(v string)
SetHeight writes the height prop.
func (SkeletonHandle) SetVariant ¶
func (h SkeletonHandle) SetVariant(v string)
SetVariant writes the variant prop.
func (SkeletonHandle) SetWidth ¶
func (h SkeletonHandle) SetWidth(v string)
SetWidth writes the width prop.
type SkeletonProps ¶
type SkeletonProps struct {
// Variant is text | circular | rectangular.
//
// The component defaults it to 'text'.
Variant string
// Width is CSS length; defaults to 100%.
//
// The component defaults it to ”.
Width string
// Height is CSS length; text defaults to 1em.
//
// The component defaults it to ”.
Height string
// Animation is pulse | wave | none.
//
// The component defaults it to 'pulse'.
Animation string
}
SkeletonProps are the props of <ui-skeleton>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type SliderChangeDetail ¶
type SliderChangeDetail struct {
Value any `json:"value"`
}
SliderChangeDetail is the detail of the "change" event of <ui-slider>.
committed value; detail: { value } or { start, end }
type SliderHandle ¶
type SliderHandle struct {
// contains filtered or unexported fields
}
SliderHandle patches a rendered <ui-slider> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with SliderElement.
func SliderElement ¶
func SliderElement(s *live.Session, id string) SliderHandle
SliderElement addresses the <ui-slider> rendered with this id, for patching its props with compile-checked names instead of strings:
SliderElement(c.Session, "id").SetValue(v)
func (SliderHandle) Handle ¶
func (h SliderHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (SliderHandle) SetDisabled ¶
func (h SliderHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (SliderHandle) SetLabel ¶
func (h SliderHandle) SetLabel(v string)
SetLabel writes the label prop.
func (SliderHandle) SetRange ¶
func (h SliderHandle) SetRange(v bool)
SetRange writes the range prop.
func (SliderHandle) SetShowValue ¶
func (h SliderHandle) SetShowValue(v bool)
SetShowValue writes the showValue prop.
func (SliderHandle) SetStep ¶
func (h SliderHandle) SetStep(v float64)
SetStep writes the step prop.
func (SliderHandle) SetValue ¶
func (h SliderHandle) SetValue(v float64)
SetValue writes the value prop.
func (SliderHandle) SetValueEnd ¶
func (h SliderHandle) SetValueEnd(v float64)
SetValueEnd writes the valueEnd prop.
func (SliderHandle) SetValueStart ¶
func (h SliderHandle) SetValueStart(v float64)
SetValueStart writes the valueStart prop.
type SliderInputDetail ¶
type SliderInputDetail struct {
Value any `json:"value"`
}
SliderInputDetail is the detail of the "input" event of <ui-slider>.
every drag/keystroke; detail: { value } or { start, end }
type SliderProps ¶
type SliderProps struct {
// The component defaults it to 0.
Value float64
// The component defaults it to 0.
Min float64
// The component defaults it to 100.
Max float64
// The component defaults it to 1.
Step float64
// Range is two thumbs; uses valueStart / valueEnd.
//
// The component defaults it to false.
Range bool
// The component defaults it to 0.
ValueStart float64
// The component defaults it to 100.
ValueEnd float64
// Label is REQUIRED accessible name (aria-label).
//
// The component defaults it to ”.
Label string
// The component defaults it to false.
Disabled bool
// ShowValue is value bubble above the thumb while focused/dragging (animates in and out).
//
// The component defaults it to false.
ShowValue bool
// Name is form participation.
//
// The component defaults it to ”.
Name string
}
SliderProps are the props of <ui-slider>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type SnackbarCloseDetail ¶
type SnackbarCloseDetail struct {
Reason any `json:"reason"`
}
SnackbarCloseDetail is the detail of the "close" event of <ui-snackbar>.
detail: { reason: 'timeout' | 'action' | 'close' | 'method' }
type SnackbarHandle ¶
type SnackbarHandle struct {
// contains filtered or unexported fields
}
SnackbarHandle patches a rendered <ui-snackbar> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with SnackbarElement.
func SnackbarElement ¶
func SnackbarElement(s *live.Session, id string) SnackbarHandle
SnackbarElement addresses the <ui-snackbar> rendered with this id, for patching its props with compile-checked names instead of strings:
SnackbarElement(c.Session, "id").SetOpen(v)
func (SnackbarHandle) Handle ¶
func (h SnackbarHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (SnackbarHandle) SetAction ¶
func (h SnackbarHandle) SetAction(v string)
SetAction writes the action prop.
func (SnackbarHandle) SetCloseButton ¶
func (h SnackbarHandle) SetCloseButton(v bool)
SetCloseButton writes the closeButton prop.
func (SnackbarHandle) SetDuration ¶
func (h SnackbarHandle) SetDuration(v float64)
SetDuration writes the duration prop.
func (SnackbarHandle) SetMessage ¶
func (h SnackbarHandle) SetMessage(v string)
SetMessage writes the message prop.
func (SnackbarHandle) SetOpen ¶
func (h SnackbarHandle) SetOpen(v bool)
SetOpen writes the open prop.
type SnackbarProps ¶
type SnackbarProps struct {
// The component defaults it to false.
Open bool
// The component defaults it to ”.
Message string
// Action is label for a trailing text action button.
//
// The component defaults it to ”.
Action string
// Duration is auto-dismiss after ms; 0 = sticky.
//
// The component defaults it to 4000.
Duration float64
// CloseButton is trailing close icon button.
//
// The component defaults it to false.
CloseButton bool
}
SnackbarProps are the props of <ui-snackbar>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type SpinnerHandle ¶
type SpinnerHandle struct {
// contains filtered or unexported fields
}
SpinnerHandle patches a rendered <ui-spinner> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with SpinnerElement.
func SpinnerElement ¶
func SpinnerElement(s *live.Session, id string) SpinnerHandle
SpinnerElement addresses the <ui-spinner> rendered with this id, for patching its props with compile-checked names instead of strings:
SpinnerElement(c.Session, "id").SetValue(v)
func (SpinnerHandle) Handle ¶
func (h SpinnerHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (SpinnerHandle) SetLabel ¶
func (h SpinnerHandle) SetLabel(v string)
SetLabel writes the label prop.
func (SpinnerHandle) SetSize ¶
func (h SpinnerHandle) SetSize(v string)
SetSize writes the size prop.
func (SpinnerHandle) SetValue ¶
func (h SpinnerHandle) SetValue(v float64)
SetValue writes the value prop.
type SpinnerProps ¶
type SpinnerProps struct {
// Value is current value; -1 (any negative) = indeterminate.
//
// The component defaults it to -1.
Value float64
// Max is value scale.
//
// The component defaults it to 100.
Max float64
// Size is CSS length; overrides --ui-spinner-size (default 48px).
//
// The component defaults it to ”.
Size string
// Label is accessible name (aria-label on the progressbar).
//
// The component defaults it to ”.
Label string
}
SpinnerProps are the props of <ui-spinner>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type SplitButtonHandle ¶
type SplitButtonHandle struct {
// contains filtered or unexported fields
}
SplitButtonHandle patches a rendered <ui-split-button> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with SplitButtonElement.
func SplitButtonElement ¶
func SplitButtonElement(s *live.Session, id string) SplitButtonHandle
SplitButtonElement addresses the <ui-split-button> rendered with this id, for patching its props with compile-checked names instead of strings:
SplitButtonElement(c.Session, "id").SetVariant(v)
func (SplitButtonHandle) Handle ¶
func (h SplitButtonHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (SplitButtonHandle) SetDisabled ¶
func (h SplitButtonHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (SplitButtonHandle) SetVariant ¶
func (h SplitButtonHandle) SetVariant(v string)
SetVariant writes the variant prop.
type SplitButtonProps ¶
type SplitButtonProps struct {
// Variant is filled | tonal | outlined | elevated.
//
// The component defaults it to 'filled'.
Variant string
// The component defaults it to false.
Disabled bool
}
SplitButtonProps are the props of <ui-split-button>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type SplitButtonSelectDetail ¶
type SplitButtonSelectDetail struct {
Value any `json:"value"`
}
SplitButtonSelectDetail is the detail of the "select" event of <ui-split-button>.
a menu action was chosen; detail: { value }
type StackHandle ¶
type StackHandle struct {
// contains filtered or unexported fields
}
StackHandle patches a rendered <ui-stack> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with StackElement.
func StackElement ¶
func StackElement(s *live.Session, id string) StackHandle
StackElement addresses the <ui-stack> rendered with this id, for patching its props with compile-checked names instead of strings:
StackElement(c.Session, "id").SetDirection(v)
func (StackHandle) Handle ¶
func (h StackHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (StackHandle) SetAlign ¶
func (h StackHandle) SetAlign(v string)
SetAlign writes the align prop.
func (StackHandle) SetDirection ¶
func (h StackHandle) SetDirection(v string)
SetDirection writes the direction prop.
func (StackHandle) SetJustify ¶
func (h StackHandle) SetJustify(v string)
SetJustify writes the justify prop.
type StackProps ¶
type StackProps struct {
// Direction is row | column | row-reverse | column-reverse.
//
// The component defaults it to 'column'.
Direction string
// Gap is a spacing step (maps to the --ui-space-N token: 1,2,3,4,5,6,7,8,10,12,16,20,24) or any raw CSS length ('1.5rem', '12px').
//
// The component defaults it to '2'.
Gap any
// Align is align-items value (” leaves the default).
//
// The component defaults it to ”.
Align string
// Justify is justify-content value.
//
// The component defaults it to ”.
Justify string
// Wrap is flex-wrap: wrap.
//
// The component defaults it to false.
Wrap bool
}
StackProps are the props of <ui-stack>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type StepHandle ¶
type StepHandle struct {
// contains filtered or unexported fields
}
StepHandle patches a rendered <ui-step> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with StepElement.
func StepElement ¶
func StepElement(s *live.Session, id string) StepHandle
StepElement addresses the <ui-step> rendered with this id, for patching its props with compile-checked names instead of strings:
StepElement(c.Session, "id").SetLabel(v)
func (StepHandle) Handle ¶
func (h StepHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (StepHandle) SetIndex ¶
func (h StepHandle) SetIndex(v float64)
SetIndex writes the index prop.
func (StepHandle) SetOptionalText ¶
func (h StepHandle) SetOptionalText(v string)
SetOptionalText writes the optionalText prop.
type StepProps ¶
type StepProps struct {
// The component defaults it to ”.
Label string
// Index is 0-based position; assigned by <ui-stepper>.
//
// The component defaults it to 0.
Index float64
// State is upcoming | active | completed; assigned by <ui-stepper> from its `active` prop.
//
// The component defaults it to 'upcoming'.
State string
// OptionalText is small secondary line under the label.
//
// The component defaults it to ”.
OptionalText string
}
StepProps are the props of <ui-step>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type StepperHandle ¶
type StepperHandle struct {
// contains filtered or unexported fields
}
StepperHandle patches a rendered <ui-stepper> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with StepperElement.
func StepperElement ¶
func StepperElement(s *live.Session, id string) StepperHandle
StepperElement addresses the <ui-stepper> rendered with this id, for patching its props with compile-checked names instead of strings:
StepperElement(c.Session, "id").SetActive(v)
func (StepperHandle) Handle ¶
func (h StepperHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (StepperHandle) SetActive ¶
func (h StepperHandle) SetActive(v float64)
SetActive writes the active prop.
type StepperProps ¶
type StepperProps struct {
// Active is index of the active step; steps before it become `completed`, steps after it `upcoming`.
//
// The component defaults it to 0.
Active float64
}
StepperProps are the props of <ui-stepper>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type SurfaceHandle ¶
type SurfaceHandle struct {
// contains filtered or unexported fields
}
SurfaceHandle patches a rendered <ui-surface> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with SurfaceElement.
func SurfaceElement ¶
func SurfaceElement(s *live.Session, id string) SurfaceHandle
SurfaceElement addresses the <ui-surface> rendered with this id, for patching its props with compile-checked names instead of strings:
SurfaceElement(c.Session, "id").SetElevation(v)
func (SurfaceHandle) Handle ¶
func (h SurfaceHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (SurfaceHandle) SetElevation ¶
func (h SurfaceHandle) SetElevation(v float64)
SetElevation writes the elevation prop.
func (SurfaceHandle) SetOutlined ¶
func (h SurfaceHandle) SetOutlined(v bool)
SetOutlined writes the outlined prop.
func (SurfaceHandle) SetRadius ¶
func (h SurfaceHandle) SetRadius(v string)
SetRadius writes the radius prop.
type SurfaceProps ¶
type SurfaceProps struct {
// Elevation is shadow level 0..5 (--ui-elevation-N).
//
// The component defaults it to 0.
Elevation float64
// Radius is none | xs | sm | md | lg | xl | full.
//
// The component defaults it to 'md'.
Radius string
// Bg is any color role name, kebab or camel ('primary-container', 'surfaceContainerHigh'); text color pairs automatically with the role's on- counterpart when one exists, falling back to on-surface.
//
// The component defaults it to 'surface'.
Bg string
// Outlined is 1px outline-variant border.
//
// The component defaults it to false.
Outlined bool
}
SurfaceProps are the props of <ui-surface>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type SwitchChangeDetail ¶
type SwitchChangeDetail struct {
Checked any `json:"checked"`
}
SwitchChangeDetail is the detail of the "change" event of <ui-switch>.
detail: { checked }
type SwitchHandle ¶
type SwitchHandle struct {
// contains filtered or unexported fields
}
SwitchHandle patches a rendered <ui-switch> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with SwitchElement.
func SwitchElement ¶
func SwitchElement(s *live.Session, id string) SwitchHandle
SwitchElement addresses the <ui-switch> rendered with this id, for patching its props with compile-checked names instead of strings:
SwitchElement(c.Session, "id").SetChecked(v)
func (SwitchHandle) Handle ¶
func (h SwitchHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (SwitchHandle) SetChecked ¶
func (h SwitchHandle) SetChecked(v bool)
SetChecked writes the checked prop.
func (SwitchHandle) SetDisabled ¶
func (h SwitchHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (SwitchHandle) SetIcons ¶
func (h SwitchHandle) SetIcons(v bool)
SetIcons writes the icons prop.
func (SwitchHandle) SetLabel ¶
func (h SwitchHandle) SetLabel(v string)
SetLabel writes the label prop.
func (SwitchHandle) SetValue ¶
func (h SwitchHandle) SetValue(v string)
SetValue writes the value prop.
type SwitchProps ¶
type SwitchProps struct {
// The component defaults it to false.
Checked bool
// The component defaults it to false.
Disabled bool
// Label is visible label; also the accessible name. Empty leaves the control unnamed (authoring error).
//
// The component defaults it to ”.
Label string
// Name is form field name (submits 'on'/value while checked).
//
// The component defaults it to ”.
Name string
// The component defaults it to 'on'.
Value string
// Icons is show check/close glyphs in the handle.
//
// The component defaults it to false.
Icons bool
}
SwitchProps are the props of <ui-switch>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type TabHandle ¶
type TabHandle struct {
// contains filtered or unexported fields
}
TabHandle patches a rendered <ui-tab> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with TabElement.
func TabElement ¶
TabElement addresses the <ui-tab> rendered with this id, for patching its props with compile-checked names instead of strings:
TabElement(c.Session, "id").SetValue(v)
func (TabHandle) SetDisabled ¶
SetDisabled writes the disabled prop.
func (TabHandle) SetSelected ¶
SetSelected writes the selected prop.
type TabPanelHandle ¶
type TabPanelHandle struct {
// contains filtered or unexported fields
}
TabPanelHandle patches a rendered <ui-tab-panel> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with TabPanelElement.
func TabPanelElement ¶
func TabPanelElement(s *live.Session, id string) TabPanelHandle
TabPanelElement addresses the <ui-tab-panel> rendered with this id, for patching its props with compile-checked names instead of strings:
TabPanelElement(c.Session, "id").SetValue(v)
func (TabPanelHandle) Handle ¶
func (h TabPanelHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (TabPanelHandle) SetActive ¶
func (h TabPanelHandle) SetActive(v bool)
SetActive writes the active prop.
func (TabPanelHandle) SetValue ¶
func (h TabPanelHandle) SetValue(v string)
SetValue writes the value prop.
type TabPanelProps ¶
type TabPanelProps struct {
// Value is REQUIRED; matched against the tabs' value.
//
// The component defaults it to ”.
Value string
// Active is managed by the parent <ui-tabs>.
//
// The component defaults it to false.
Active bool
}
TabPanelProps are the props of <ui-tab-panel>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type TabProps ¶
type TabProps struct {
// Value is REQUIRED; matched against the tabs' value.
//
// The component defaults it to ”.
Value string
// Icon is leading registry icon.
//
// The component defaults it to ”.
Icon string
// The component defaults it to false.
Disabled bool
// Selected is managed by the parent <ui-tabs>.
//
// The component defaults it to false.
Selected bool
}
TabProps are the props of <ui-tab>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type TabUITabSelectDetail ¶
type TabUITabSelectDetail struct {
Value any `json:"value"`
}
TabUITabSelectDetail is the detail of the "ui-tab-select" event of <ui-tab>.
internal; detail: { value } (consumed by <ui-tabs>)
type TableChangeDetail ¶
type TableChangeDetail struct {
Selected any `json:"selected"`
}
TableChangeDetail is the detail of the "change" event of <ui-table>.
selection; detail: { selected }
type TableColumnVisibilityDetail ¶
type TableColumnVisibilityDetail struct {
Hidden any `json:"hidden"`
}
TableColumnVisibilityDetail is the detail of the "column-visibility" event of <ui-table>.
detail: { hidden }
type TableDensityDetail ¶
type TableDensityDetail struct {
Density any `json:"density"`
}
TableDensityDetail is the detail of the "density" event of <ui-table>.
detail: { density }
type TableExportDetail ¶
TableExportDetail is the detail of the "export" event of <ui-table>.
CSV produced; detail: { format, filename }
type TableFilterDetail ¶
type TableFilterDetail struct {
Value any `json:"value"`
}
TableFilterDetail is the detail of the "filter" event of <ui-table>.
detail: { value }
type TableFooterHandle ¶
type TableFooterHandle struct {
// contains filtered or unexported fields
}
TableFooterHandle patches a rendered <ui-table-footer> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with TableFooterElement.
func TableFooterElement ¶
func TableFooterElement(s *live.Session, id string) TableFooterHandle
TableFooterElement addresses the <ui-table-footer> rendered with this id, for patching its props with compile-checked names instead of strings:
TableFooterElement(c.Session, "id").SetPage(v)
func (TableFooterHandle) Handle ¶
func (h TableFooterHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (TableFooterHandle) SetDisabled ¶
func (h TableFooterHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (TableFooterHandle) SetLabel ¶
func (h TableFooterHandle) SetLabel(v string)
SetLabel writes the label prop.
func (TableFooterHandle) SetPage ¶
func (h TableFooterHandle) SetPage(v float64)
SetPage writes the page prop.
func (TableFooterHandle) SetPageSize ¶
func (h TableFooterHandle) SetPageSize(v float64)
SetPageSize writes the pageSize prop.
func (TableFooterHandle) SetPageSizeOptions ¶
func (h TableFooterHandle) SetPageSizeOptions(v []any)
SetPageSizeOptions writes the pageSizeOptions prop.
func (TableFooterHandle) SetRowCount ¶
func (h TableFooterHandle) SetRowCount(v float64)
SetRowCount writes the rowCount prop.
type TableFooterPageDetail ¶
type TableFooterPageDetail struct {
}
TableFooterPageDetail is the detail of the "page" event of <ui-table-footer>.
page or page-size changed; detail: { page, pageSize }
type TableFooterProps ¶
type TableFooterProps struct {
Page float64
//
// The component defaults it to 0.
PageSize float64
RowCount float64
//
// Crosses as JSON in the page-size-options attribute.
PageSizeOptions []any
Disabled bool
Label string
}
TableFooterProps are the props of <ui-table-footer>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type TableGroupDetail ¶
type TableGroupDetail struct {
Key any `json:"key"`
Expanded any `json:"expanded"`
Expandedgroups any `json:"expandedgroups"`
}
TableGroupDetail is the detail of the "group" event of <ui-table>.
a group was toggled; detail: { key, expanded, expandedGroups }
type TableHandle ¶
type TableHandle struct {
// contains filtered or unexported fields
}
TableHandle patches a rendered <ui-table> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with TableElement.
func TableElement ¶
func TableElement(s *live.Session, id string) TableHandle
TableElement addresses the <ui-table> rendered with this id, for patching its props with compile-checked names instead of strings:
TableElement(c.Session, "id").SetLabel(v)
func (TableHandle) Handle ¶
func (h TableHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (TableHandle) SetColumnMenu ¶
func (h TableHandle) SetColumnMenu(v bool)
SetColumnMenu writes the columnMenu prop.
func (TableHandle) SetColumns ¶
func (h TableHandle) SetColumns(v []any)
SetColumns writes the columns prop.
func (TableHandle) SetCsvExport ¶
func (h TableHandle) SetCsvExport(v bool)
SetCsvExport writes the csvExport prop.
func (TableHandle) SetCsvFileName ¶
func (h TableHandle) SetCsvFileName(v string)
SetCsvFileName writes the csvFileName prop.
func (TableHandle) SetDensity ¶
func (h TableHandle) SetDensity(v string)
SetDensity writes the density prop.
func (TableHandle) SetDensityMenu ¶
func (h TableHandle) SetDensityMenu(v bool)
SetDensityMenu writes the densityMenu prop.
func (TableHandle) SetEmptyText ¶
func (h TableHandle) SetEmptyText(v string)
SetEmptyText writes the emptyText prop.
func (TableHandle) SetExpandedGroups ¶
func (h TableHandle) SetExpandedGroups(v []any)
SetExpandedGroups writes the expandedGroups prop.
func (TableHandle) SetFilter ¶
func (h TableHandle) SetFilter(v string)
SetFilter writes the filter prop.
func (TableHandle) SetGetRowID ¶
func (h TableHandle) SetGetRowID(v map[string]any)
SetGetRowID writes the getRowId prop.
func (TableHandle) SetGroupBy ¶
func (h TableHandle) SetGroupBy(v string)
SetGroupBy writes the groupBy prop.
func (TableHandle) SetHeadline ¶
func (h TableHandle) SetHeadline(v string)
SetHeadline writes the headline prop.
func (TableHandle) SetHiddenColumns ¶
func (h TableHandle) SetHiddenColumns(v []any)
SetHiddenColumns writes the hiddenColumns prop.
func (TableHandle) SetLabel ¶
func (h TableHandle) SetLabel(v string)
SetLabel writes the label prop.
func (TableHandle) SetLoading ¶
func (h TableHandle) SetLoading(v bool)
SetLoading writes the loading prop.
func (TableHandle) SetMaxHeight ¶
func (h TableHandle) SetMaxHeight(v string)
SetMaxHeight writes the maxHeight prop.
func (TableHandle) SetPageSize ¶
func (h TableHandle) SetPageSize(v float64)
SetPageSize writes the pageSize prop.
func (TableHandle) SetPageSizeOptions ¶
func (h TableHandle) SetPageSizeOptions(v []any)
SetPageSizeOptions writes the pageSizeOptions prop.
func (TableHandle) SetPaginationMode ¶
func (h TableHandle) SetPaginationMode(v string)
SetPaginationMode writes the paginationMode prop.
func (TableHandle) SetQuickFilter ¶
func (h TableHandle) SetQuickFilter(v bool)
SetQuickFilter writes the quickFilter prop.
func (TableHandle) SetRowCount ¶
func (h TableHandle) SetRowCount(v float64)
SetRowCount writes the rowCount prop.
func (TableHandle) SetSelectable ¶
func (h TableHandle) SetSelectable(v string)
SetSelectable writes the selectable prop.
func (TableHandle) SetSelected ¶
func (h TableHandle) SetSelected(v []any)
SetSelected writes the selected prop.
func (TableHandle) SetSortBy ¶
func (h TableHandle) SetSortBy(v string)
SetSortBy writes the sortBy prop.
func (TableHandle) SetSortDir ¶
func (h TableHandle) SetSortDir(v string)
SetSortDir writes the sortDir prop.
func (TableHandle) SetSortMode ¶
func (h TableHandle) SetSortMode(v string)
SetSortMode writes the sortMode prop.
func (TableHandle) SetStickyFirst ¶
func (h TableHandle) SetStickyFirst(v bool)
SetStickyFirst writes the stickyFirst prop.
func (TableHandle) SetStickyHeader ¶
func (h TableHandle) SetStickyHeader(v bool)
SetStickyHeader writes the stickyHeader prop.
func (TableHandle) SetStriped ¶
func (h TableHandle) SetStriped(v bool)
SetStriped writes the striped prop.
func (TableHandle) SetSupporting ¶
func (h TableHandle) SetSupporting(v string)
SetSupporting writes the supporting prop.
func (TableHandle) SetVariant ¶
func (h TableHandle) SetVariant(v string)
SetVariant writes the variant prop.
type TablePageDetail ¶
TablePageDetail is the detail of the "page" event of <ui-table>.
detail: { page, pageSize }
type TableProps ¶
type TableProps struct {
// The component defaults it to ”.
Label string
// The component defaults it to ”.
Headline string
// The component defaults it to ”.
Supporting string
// Variant is outlined | standard.
//
// The component defaults it to 'outlined'.
Variant string
// Density is compact | standard | comfortable.
//
// The component defaults it to 'standard'.
Density string
// Dense is alias for density="compact".
//
// The component defaults it to false.
Dense bool
// The component defaults it to false.
StickyHeader bool
// The component defaults it to false.
StickyFirst bool
// The component defaults it to false.
Striped bool
// The component defaults it to false.
Loading bool
// The component defaults it to ”.
MaxHeight string
// Selectable is none | single | multiple.
//
// The component defaults it to 'none'.
Selectable string
// Crosses as JSON in the selected attribute.
Selected []any
// Crosses as JSON in the columns attribute.
Columns []any
// Crosses as JSON in the rows attribute.
Rows []any
// GetRowID is (row, index) => id.
//
// The component defaults it to null.
//
// Crosses as JSON in the get-row-id attribute.
GetRowID map[string]any
// The component defaults it to ”.
SortBy string
// SortDir is asc | desc.
//
// The component defaults it to 'asc'.
SortDir string
// SortMode is client | server.
//
// The component defaults it to 'client'.
SortMode string
// The component defaults it to ”.
Filter string
// GroupBy is column key to group rows.
//
// The component defaults it to ”.
GroupBy string
// ExpandedGroups is empty means all groups expanded.
//
// Crosses as JSON in the expanded-groups attribute.
ExpandedGroups []any
// Crosses as JSON in the hidden-columns attribute.
HiddenColumns []any
// The component defaults it to 1.
Page float64
// PageSize is 0 shows every row.
//
// The component defaults it to 0.
PageSize float64
// The component defaults it to 0.
RowCount float64
// PaginationMode is client | server.
//
// The component defaults it to 'client'.
PaginationMode string
// Crosses as JSON in the page-size-options attribute.
PageSizeOptions []any
// The component defaults it to false.
QuickFilter bool
// The component defaults it to false.
ColumnMenu bool
// The component defaults it to false.
DensityMenu bool
// The component defaults it to false.
CsvExport bool
// The component defaults it to 'table.csv'.
CsvFileName string
// The component defaults it to 'No results'.
EmptyText string
}
TableProps are the props of <ui-table>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type TableRowClickDetail ¶
TableRowClickDetail is the detail of the "row-click" event of <ui-table>.
detail: { id, row }
type TableSortDetail ¶
TableSortDetail is the detail of the "sort" event of <ui-table>.
detail: { key, dir }
type TableToolbarColumnVisibilityDetail ¶
type TableToolbarColumnVisibilityDetail struct {
Hidden any `json:"hidden"`
}
TableToolbarColumnVisibilityDetail is the detail of the "column-visibility" event of <ui-table-toolbar>.
a column was toggled; detail: { hidden }
type TableToolbarDensityDetail ¶
type TableToolbarDensityDetail struct {
Density any `json:"density"`
}
TableToolbarDensityDetail is the detail of the "density" event of <ui-table-toolbar>.
density chosen; detail: { density }
type TableToolbarExportDetail ¶
type TableToolbarExportDetail struct {
Format any `json:"format"`
}
TableToolbarExportDetail is the detail of the "export" event of <ui-table-toolbar>.
export requested; detail: { format: 'csv' }
type TableToolbarFilterDetail ¶
type TableToolbarFilterDetail struct {
Value any `json:"value"`
}
TableToolbarFilterDetail is the detail of the "filter" event of <ui-table-toolbar>.
quick filter changed; detail: { value }
type TableToolbarHandle ¶
type TableToolbarHandle struct {
// contains filtered or unexported fields
}
TableToolbarHandle patches a rendered <ui-table-toolbar> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with TableToolbarElement.
func TableToolbarElement ¶
func TableToolbarElement(s *live.Session, id string) TableToolbarHandle
TableToolbarElement addresses the <ui-table-toolbar> rendered with this id, for patching its props with compile-checked names instead of strings:
TableToolbarElement(c.Session, "id").SetHeadline(v)
func (TableToolbarHandle) Handle ¶
func (h TableToolbarHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (TableToolbarHandle) SetColumnMenu ¶
func (h TableToolbarHandle) SetColumnMenu(v bool)
SetColumnMenu writes the columnMenu prop.
func (TableToolbarHandle) SetColumns ¶
func (h TableToolbarHandle) SetColumns(v []any)
SetColumns writes the columns prop.
func (TableToolbarHandle) SetCsvExport ¶
func (h TableToolbarHandle) SetCsvExport(v bool)
SetCsvExport writes the csvExport prop.
func (TableToolbarHandle) SetDensity ¶
func (h TableToolbarHandle) SetDensity(v string)
SetDensity writes the density prop.
func (TableToolbarHandle) SetDensityMenu ¶
func (h TableToolbarHandle) SetDensityMenu(v bool)
SetDensityMenu writes the densityMenu prop.
func (TableToolbarHandle) SetDisabled ¶
func (h TableToolbarHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (TableToolbarHandle) SetFilter ¶
func (h TableToolbarHandle) SetFilter(v string)
SetFilter writes the filter prop.
func (TableToolbarHandle) SetHeadline ¶
func (h TableToolbarHandle) SetHeadline(v string)
SetHeadline writes the headline prop.
func (TableToolbarHandle) SetHiddenColumns ¶
func (h TableToolbarHandle) SetHiddenColumns(v []any)
SetHiddenColumns writes the hiddenColumns prop.
func (TableToolbarHandle) SetQuickFilter ¶
func (h TableToolbarHandle) SetQuickFilter(v bool)
SetQuickFilter writes the quickFilter prop.
func (TableToolbarHandle) SetSelectedCount ¶
func (h TableToolbarHandle) SetSelectedCount(v float64)
SetSelectedCount writes the selectedCount prop.
func (TableToolbarHandle) SetSupporting ¶
func (h TableToolbarHandle) SetSupporting(v string)
SetSupporting writes the supporting prop.
type TableToolbarProps ¶
type TableToolbarProps struct {
// The component defaults it to ”.
Headline string
// The component defaults it to ”.
Supporting string
// SelectedCount is when >0 the bar switches to the "N selected" selection state.
//
// The component defaults it to 0.
SelectedCount float64
// Filter is quick-filter value.
//
// The component defaults it to ”.
Filter string
// The component defaults it to false.
QuickFilter bool
// The component defaults it to false.
ColumnMenu bool
// The component defaults it to false.
DensityMenu bool
// The component defaults it to false.
CsvExport bool
// Columns is { key, label } (JSON or property).
//
// Crosses as JSON in the columns attribute.
Columns []any
// Crosses as JSON in the hidden-columns attribute.
HiddenColumns []any
// Density is compact | standard | comfortable.
//
// The component defaults it to 'standard'.
Density string
// The component defaults it to false.
Disabled bool
}
TableToolbarProps are the props of <ui-table-toolbar>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type TabsChangeDetail ¶
type TabsChangeDetail struct {
Value any `json:"value"`
}
TabsChangeDetail is the detail of the "change" event of <ui-tabs>.
user selected a tab; detail: { value }
type TabsHandle ¶
type TabsHandle struct {
// contains filtered or unexported fields
}
TabsHandle patches a rendered <ui-tabs> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with TabsElement.
func TabsElement ¶
func TabsElement(s *live.Session, id string) TabsHandle
TabsElement addresses the <ui-tabs> rendered with this id, for patching its props with compile-checked names instead of strings:
TabsElement(c.Session, "id").SetValue(v)
func (TabsHandle) Handle ¶
func (h TabsHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (TabsHandle) SetVariant ¶
func (h TabsHandle) SetVariant(v string)
SetVariant writes the variant prop.
type TabsProps ¶
type TabsProps struct {
// Value is the selected tab's value.
//
// The component defaults it to ”.
Value string
// Variant is primary | secondary.
//
// The component defaults it to 'primary'.
Variant string
// Label is accessible name for the tablist.
//
// The component defaults it to ”.
Label string
}
TabsProps are the props of <ui-tabs>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type TextFieldChangeDetail ¶
type TextFieldChangeDetail struct {
Value any `json:"value"`
}
TextFieldChangeDetail is the detail of the "change" event of <ui-text-field>.
committed (blur/Enter); detail: { value }
type TextFieldHandle ¶
type TextFieldHandle struct {
// contains filtered or unexported fields
}
TextFieldHandle patches a rendered <ui-text-field> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with TextFieldElement.
func TextFieldElement ¶
func TextFieldElement(s *live.Session, id string) TextFieldHandle
TextFieldElement addresses the <ui-text-field> rendered with this id, for patching its props with compile-checked names instead of strings:
TextFieldElement(c.Session, "id").SetVariant(v)
func (TextFieldHandle) Handle ¶
func (h TextFieldHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (TextFieldHandle) SetAutocapitalize ¶ added in v0.11.0
func (h TextFieldHandle) SetAutocapitalize(v string)
SetAutocapitalize writes the autocapitalize prop.
func (TextFieldHandle) SetAutocomplete ¶ added in v0.11.0
func (h TextFieldHandle) SetAutocomplete(v string)
SetAutocomplete writes the autocomplete prop.
func (TextFieldHandle) SetAutocorrect ¶ added in v0.11.0
func (h TextFieldHandle) SetAutocorrect(v string)
SetAutocorrect writes the autocorrect prop.
func (TextFieldHandle) SetClearable ¶
func (h TextFieldHandle) SetClearable(v bool)
SetClearable writes the clearable prop.
func (TextFieldHandle) SetDisabled ¶
func (h TextFieldHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (TextFieldHandle) SetEnterkeyhint ¶ added in v0.11.0
func (h TextFieldHandle) SetEnterkeyhint(v string)
SetEnterkeyhint writes the enterkeyhint prop.
func (TextFieldHandle) SetError ¶
func (h TextFieldHandle) SetError(v string)
SetError writes the error prop.
func (TextFieldHandle) SetHelper ¶
func (h TextFieldHandle) SetHelper(v string)
SetHelper writes the helper prop.
func (TextFieldHandle) SetInputmode ¶ added in v0.11.0
func (h TextFieldHandle) SetInputmode(v string)
SetInputmode writes the inputmode prop.
func (TextFieldHandle) SetLabel ¶
func (h TextFieldHandle) SetLabel(v string)
SetLabel writes the label prop.
func (TextFieldHandle) SetMaxlength ¶
func (h TextFieldHandle) SetMaxlength(v float64)
SetMaxlength writes the maxlength prop.
func (TextFieldHandle) SetName ¶
func (h TextFieldHandle) SetName(v string)
SetName writes the name prop.
func (TextFieldHandle) SetPlaceholder ¶
func (h TextFieldHandle) SetPlaceholder(v string)
SetPlaceholder writes the placeholder prop.
func (TextFieldHandle) SetRequired ¶
func (h TextFieldHandle) SetRequired(v bool)
SetRequired writes the required prop.
func (TextFieldHandle) SetRows ¶
func (h TextFieldHandle) SetRows(v float64)
SetRows writes the rows prop.
func (TextFieldHandle) SetSpellcheck ¶ added in v0.11.0
func (h TextFieldHandle) SetSpellcheck(v string)
SetSpellcheck writes the spellcheck prop.
func (TextFieldHandle) SetType ¶
func (h TextFieldHandle) SetType(v string)
SetType writes the type prop.
func (TextFieldHandle) SetValue ¶
func (h TextFieldHandle) SetValue(v string)
SetValue writes the value prop.
func (TextFieldHandle) SetVariant ¶
func (h TextFieldHandle) SetVariant(v string)
SetVariant writes the variant prop.
type TextFieldInputDetail ¶
type TextFieldInputDetail struct {
Value any `json:"value"`
}
TextFieldInputDetail is the detail of the "input" event of <ui-text-field>.
every keystroke; detail: { value }
type TextFieldProps ¶
type TextFieldProps struct {
// Variant is filled | outlined.
//
// The component defaults it to 'filled'.
Variant string
// The component defaults it to ”.
Label string
// The component defaults it to ”.
Value string
// Type is any native input type; 'textarea' renders one.
//
// The component defaults it to 'text'.
Type string
// The component defaults it to ”.
Placeholder string
// Helper is supporting text under the field.
//
// The component defaults it to ”.
Helper string
// Error is error message; non-empty switches to error state.
//
// The component defaults it to ”.
Error string
// The component defaults it to false.
Disabled bool
// The component defaults it to false.
Required bool
// Clearable is trailing ✕ while there is content.
//
// The component defaults it to false.
Clearable bool
// Name is form participation.
//
// The component defaults it to ”.
Name string
// Maxlength is >0 shows a character counter and enforces it.
//
// The component defaults it to 0.
Maxlength float64
// The component defaults it to 3.
Rows float64
// Autocomplete is absent unless set; 'off' keeps the browser's saved-value list out of a field whose contents are not a name, an address or a password.
//
// The component defaults it to ”.
Autocomplete string
// Autocapitalize is 'off' for anything case-sensitive.
//
// The component defaults it to ”.
Autocapitalize string
// Autocorrect is 'off' to stop substitutions.
//
// The component defaults it to ”.
Autocorrect string
// Spellcheck is 'false' for code and query syntax.
//
// The component defaults it to ”.
Spellcheck string
// The component defaults it to ”.
Inputmode string
// Enterkeyhint is textarea rows.
//
// The component defaults it to ”.
Enterkeyhint string
}
TextFieldProps are the props of <ui-text-field>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type TextHandle ¶
type TextHandle struct {
// contains filtered or unexported fields
}
TextHandle patches a rendered <ui-text> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with TextElement.
func TextElement ¶
func TextElement(s *live.Session, id string) TextHandle
TextElement addresses the <ui-text> rendered with this id, for patching its props with compile-checked names instead of strings:
TextElement(c.Session, "id").SetVariant(v)
func (TextHandle) Handle ¶
func (h TextHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (TextHandle) SetVariant ¶
func (h TextHandle) SetVariant(v string)
SetVariant writes the variant prop.
type TextProps ¶
type TextProps struct {
// Variant is any type role: display|headline|title|body|label × lg|md|sm.
//
// The component defaults it to 'body-md'.
Variant string
// Color is a color role name ('primary', 'onSurfaceVariant', …).
//
// The component defaults it to ”.
Color string
}
TextProps are the props of <ui-text>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type TimePickerChangeDetail ¶
type TimePickerChangeDetail struct {
Value any `json:"value"`
}
TimePickerChangeDetail is the detail of the "change" event of <ui-time-picker>.
committed; detail: { value }
type TimePickerHandle ¶
type TimePickerHandle struct {
// contains filtered or unexported fields
}
TimePickerHandle patches a rendered <ui-time-picker> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with TimePickerElement.
func TimePickerElement ¶
func TimePickerElement(s *live.Session, id string) TimePickerHandle
TimePickerElement addresses the <ui-time-picker> rendered with this id, for patching its props with compile-checked names instead of strings:
TimePickerElement(c.Session, "id").SetLabel(v)
func (TimePickerHandle) Handle ¶
func (h TimePickerHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (TimePickerHandle) SetDisabled ¶
func (h TimePickerHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (TimePickerHandle) SetHourCycle ¶
func (h TimePickerHandle) SetHourCycle(v string)
SetHourCycle writes the hourCycle prop.
func (TimePickerHandle) SetLabel ¶
func (h TimePickerHandle) SetLabel(v string)
SetLabel writes the label prop.
func (TimePickerHandle) SetLocale ¶
func (h TimePickerHandle) SetLocale(v string)
SetLocale writes the locale prop.
func (TimePickerHandle) SetMinuteStep ¶
func (h TimePickerHandle) SetMinuteStep(v float64)
SetMinuteStep writes the minuteStep prop.
func (TimePickerHandle) SetName ¶
func (h TimePickerHandle) SetName(v string)
SetName writes the name prop.
func (TimePickerHandle) SetPlaceholder ¶
func (h TimePickerHandle) SetPlaceholder(v string)
SetPlaceholder writes the placeholder prop.
func (TimePickerHandle) SetRequired ¶
func (h TimePickerHandle) SetRequired(v bool)
SetRequired writes the required prop.
func (TimePickerHandle) SetValue ¶
func (h TimePickerHandle) SetValue(v string)
SetValue writes the value prop.
func (TimePickerHandle) SetVariant ¶
func (h TimePickerHandle) SetVariant(v string)
SetVariant writes the variant prop.
func (TimePickerHandle) SetView ¶
func (h TimePickerHandle) SetView(v string)
SetView writes the view prop.
type TimePickerInputDetail ¶
type TimePickerInputDetail struct {
Value any `json:"value"`
}
TimePickerInputDetail is the detail of the "input" event of <ui-time-picker>.
field keystroke; detail: { value } (the raw text)
type TimePickerProps ¶
type TimePickerProps struct {
// The component defaults it to ”.
Label string
// Value is 24-hour HH:mm, or ” for none.
//
// The component defaults it to ”.
Value string
// Variant is filled | outlined.
//
// The component defaults it to 'filled'.
Variant string
// View is clock | input (dial vs digital grid).
//
// The component defaults it to 'clock'.
View string
// HourCycle is 12 | 24.
//
// The component defaults it to '12'.
HourCycle string
// MinuteStep is minute choices (1, 5, or 15 typical).
//
// The component defaults it to 5.
MinuteStep float64
// Locale is BCP 47 tag; empty uses the runtime locale.
//
// The component defaults it to ”.
Locale string
// The component defaults it to false.
Disabled bool
// The component defaults it to false.
Required bool
// Name is form participation.
//
// The component defaults it to ”.
Name string
// The component defaults it to ”.
Placeholder string
}
TimePickerProps are the props of <ui-time-picker>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type ToggleButtonHandle ¶
type ToggleButtonHandle struct {
// contains filtered or unexported fields
}
ToggleButtonHandle patches a rendered <ui-toggle-button> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with ToggleButtonElement.
func ToggleButtonElement ¶
func ToggleButtonElement(s *live.Session, id string) ToggleButtonHandle
ToggleButtonElement addresses the <ui-toggle-button> rendered with this id, for patching its props with compile-checked names instead of strings:
ToggleButtonElement(c.Session, "id").SetValue(v)
func (ToggleButtonHandle) Handle ¶
func (h ToggleButtonHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (ToggleButtonHandle) SetDisabled ¶
func (h ToggleButtonHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (ToggleButtonHandle) SetIcon ¶
func (h ToggleButtonHandle) SetIcon(v string)
SetIcon writes the icon prop.
func (ToggleButtonHandle) SetSelected ¶
func (h ToggleButtonHandle) SetSelected(v bool)
SetSelected writes the selected prop.
func (ToggleButtonHandle) SetValue ¶
func (h ToggleButtonHandle) SetValue(v string)
SetValue writes the value prop.
type ToggleButtonProps ¶
type ToggleButtonProps struct {
// Value is REQUIRED identity within the group.
//
// The component defaults it to ”.
Value string
// Selected is set by the owning group.
//
// The component defaults it to false.
Selected bool
// The component defaults it to false.
Disabled bool
// Icon is optional leading icon.
//
// The component defaults it to ”.
Icon string
}
ToggleButtonProps are the props of <ui-toggle-button>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type ToggleButtonUIToggleDetail ¶
type ToggleButtonUIToggleDetail struct {
Value any `json:"value"`
}
ToggleButtonUIToggleDetail is the detail of the "ui-toggle" event of <ui-toggle-button>.
pressed; detail: { value } (consumed by ui-toggle-group)
type ToggleGroupChangeDetail ¶
type ToggleGroupChangeDetail struct {
Value any `json:"value"`
}
ToggleGroupChangeDetail is the detail of the "change" event of <ui-toggle-group>.
selection changed; detail: { value } (string, or array when multi)
type ToggleGroupHandle ¶
type ToggleGroupHandle struct {
// contains filtered or unexported fields
}
ToggleGroupHandle patches a rendered <ui-toggle-group> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with ToggleGroupElement.
func ToggleGroupElement ¶
func ToggleGroupElement(s *live.Session, id string) ToggleGroupHandle
ToggleGroupElement addresses the <ui-toggle-group> rendered with this id, for patching its props with compile-checked names instead of strings:
ToggleGroupElement(c.Session, "id").SetValue(v)
func (ToggleGroupHandle) Handle ¶
func (h ToggleGroupHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (ToggleGroupHandle) SetDisabled ¶
func (h ToggleGroupHandle) SetDisabled(v bool)
SetDisabled writes the disabled prop.
func (ToggleGroupHandle) SetLabel ¶
func (h ToggleGroupHandle) SetLabel(v string)
SetLabel writes the label prop.
func (ToggleGroupHandle) SetMulti ¶
func (h ToggleGroupHandle) SetMulti(v bool)
SetMulti writes the multi prop.
func (ToggleGroupHandle) SetValue ¶
func (h ToggleGroupHandle) SetValue(v any)
SetValue writes the value prop.
type ToggleGroupProps ¶
type ToggleGroupProps struct {
// Value is selected value, or array when `multi`.
//
// The component defaults it to ”.
Value any
// Multi is multiple segments may be selected.
//
// The component defaults it to false.
Multi bool
// Disabled is disables every segment.
//
// The component defaults it to false.
Disabled bool
// Label is accessible name for the group.
//
// The component defaults it to ”.
Label string
}
ToggleGroupProps are the props of <ui-toggle-group>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type ToolbarHandle ¶
type ToolbarHandle struct {
// contains filtered or unexported fields
}
ToolbarHandle patches a rendered <ui-toolbar> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with ToolbarElement.
func ToolbarElement ¶
func ToolbarElement(s *live.Session, id string) ToolbarHandle
ToolbarElement addresses the <ui-toolbar> rendered with this id, for patching its props with compile-checked names instead of strings:
ToolbarElement(c.Session, "id").SetLabel(v)
func (ToolbarHandle) Handle ¶
func (h ToolbarHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (ToolbarHandle) SetLabel ¶
func (h ToolbarHandle) SetLabel(v string)
SetLabel writes the label prop.
type ToolbarProps ¶
type ToolbarProps struct {
// Label is accessible name for the toolbar.
//
// The component defaults it to ”.
Label string
}
ToolbarProps are the props of <ui-toolbar>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
type TooltipHandle ¶
type TooltipHandle struct {
// contains filtered or unexported fields
}
TooltipHandle patches a rendered <ui-tooltip> over a live session.
Each setter writes one component prop — one property write, one DOM update on the page. Obtain one with TooltipElement.
func TooltipElement ¶
func TooltipElement(s *live.Session, id string) TooltipHandle
TooltipElement addresses the <ui-tooltip> rendered with this id, for patching its props with compile-checked names instead of strings:
TooltipElement(c.Session, "id").SetText(v)
func (TooltipHandle) Handle ¶
func (h TooltipHandle) Handle() live.Handle
Handle returns the untyped handle, for attributes, classes and slot HTML.
func (TooltipHandle) SetDelay ¶
func (h TooltipHandle) SetDelay(v float64)
SetDelay writes the delay prop.
func (TooltipHandle) SetPosition ¶
func (h TooltipHandle) SetPosition(v string)
SetPosition writes the position prop.
func (TooltipHandle) SetText ¶
func (h TooltipHandle) SetText(v string)
SetText writes the text prop.
type TooltipProps ¶
type TooltipProps struct {
// Text is plain tooltip content.
//
// The component defaults it to ”.
Text string
// Position is top | bottom | left | right.
//
// The component defaults it to 'top'.
Position string
// Delay is hover show delay (ms); focus shows instantly.
//
// The component defaults it to 500.
Delay float64
// Rich is renders the `content` slot in a surface panel instead of the text pill.
//
// The component defaults it to false.
Rich bool
}
TooltipProps are the props of <ui-tooltip>.
A field left at its zero value, or set to the component's own default, is left off the element, so the component keeps its default. To send a zero value deliberately, set it with Prop on the returned element.
Source Files
¶
- alacris_gen.go
- pending.go
- ui_accordion_gen.go
- ui_accordion_item_gen.go
- ui_alert_gen.go
- ui_app_bar_gen.go
- ui_autocomplete_gen.go
- ui_avatar_gen.go
- ui_backdrop_gen.go
- ui_badge_gen.go
- ui_bottom_app_bar_gen.go
- ui_bottom_nav_gen.go
- ui_breadcrumbs_gen.go
- ui_button_gen.go
- ui_button_group_gen.go
- ui_card_gen.go
- ui_carousel_gen.go
- ui_carousel_item_gen.go
- ui_checkbox_gen.go
- ui_chip_gen.go
- ui_chip_set_gen.go
- ui_container_gen.go
- ui_date_picker_gen.go
- ui_dialog_gen.go
- ui_divider_gen.go
- ui_drawer_gen.go
- ui_fab_gen.go
- ui_fab_menu_gen.go
- ui_icon_button_gen.go
- ui_icon_gen.go
- ui_list_gen.go
- ui_list_item_gen.go
- ui_loading_indicator_gen.go
- ui_menu_gen.go
- ui_menu_item_gen.go
- ui_nav_item_gen.go
- ui_nav_rail_gen.go
- ui_option_gen.go
- ui_pagination_gen.go
- ui_progress_gen.go
- ui_radio_gen.go
- ui_radio_group_gen.go
- ui_rating_gen.go
- ui_search_gen.go
- ui_select_gen.go
- ui_sheet_gen.go
- ui_side_sheet_gen.go
- ui_skeleton_gen.go
- ui_slider_gen.go
- ui_snackbar_gen.go
- ui_spinner_gen.go
- ui_split_button_gen.go
- ui_stack_gen.go
- ui_step_gen.go
- ui_stepper_gen.go
- ui_surface_gen.go
- ui_switch_gen.go
- ui_tab_gen.go
- ui_tab_panel_gen.go
- ui_table_footer_gen.go
- ui_table_gen.go
- ui_table_toolbar_gen.go
- ui_tabs_gen.go
- ui_text_field_gen.go
- ui_text_gen.go
- ui_time_picker_gen.go
- ui_toggle_button_gen.go
- ui_toggle_group_gen.go
- ui_toolbar_gen.go
- ui_tooltip_gen.go