Expand description
HeroGPUI components — a faithful Rust/GPUI port of the HeroUI v3 component
library. One module per @heroui/* package.
Re-exports§
pub use util::app_focus_root;pub use accordion::*;pub use alert::*;pub use alert_dialog::*;pub use anim::*;pub use assets::*;pub use autocomplete::*;pub use avatar::*;pub use badge::*;pub use breadcrumbs::*;pub use button::*;pub use button_group::*;pub use calendar::*;pub use calendar_view::*;pub use card::*;pub use checkbox::*;pub use chip::*;pub use close_button::*;pub use color_picker::*;pub use combo_box::*;pub use date_constraints::*;pub use date_picker::*;pub use disclosure::*;pub use drawer::*;pub use dropdown::*;pub use field::*;pub use filter::*;pub use form::*;pub use icons::*;pub use input::*;pub use input_group::*;pub use input_otp::*;pub use kbd::*;pub use link::*;pub use list_box::*;pub use meter::*;pub use modal::*;pub use number_field::*;pub use pagination::*;pub use picker_item::*;pub use popover::*;pub use progress::*;pub use radio_group::*;pub use range_calendar::*;pub use scroll_shadow::*;pub use scrollbar::*;pub use select::*;pub use selection::*;pub use separator::*;pub use skeleton::*;pub use slider::*;pub use spinner::*;pub use surface::*;pub use switch::*;pub use table::*;pub use tabs::*;pub use tag_group::*;pub use textarea::*;pub use time_field::*;pub use toast::*;pub use toggle_button::*;pub use toolbar::*;pub use tooltip::*;pub use typography::*;pub use validation::*;
Modules§
- a11y
- What each control tells assistive technology, stated once per control.
- accordion
- Accordion — port of
@heroui/accordion. - alert
- Alert — port of
@heroui/alert. - alert_
dialog - AlertDialog — port of
@heroui/alert-dialog(v3). - anim
- Motion primitives shared by every animated component.
- assets
- Embedded assets used by HeroGPUI’s built-in component chrome.
- autocomplete
- Autocomplete — port of
@heroui/autocomplete. - avatar
- Avatar — port of
@heroui/avatar(v3.2.4, Radix Avatar 1.1.11 semantics). - badge
- Badge — port of
@heroui/badge. - breadcrumbs
- Breadcrumbs — port of
@heroui/breadcrumbs. - button
- Button — port of
@heroui/button(v3). - button_
group - ButtonGroup — port of
@heroui/button-group(v3). - calendar
- Calendar & RangeCalendar — port of
@heroui/calendarand@heroui/date-picker’s range grid (std-only date math). - calendar_
system - The calendar system a month grid is drawn in.
- calendar_
view - The v3 calendar view model:
visibleDuration,pageBehaviorandselectionAlignment. - card
- Card — port of
@heroui/card. - checkbox
- Checkbox — port of
@heroui/checkbox. - chip
- Chip — port of
@heroui/chip. - close_
button - CloseButton — port of
@heroui/close-button. - color_
picker - Colors — port of
@heroui/color-area,color-field,color-picker,color-slider,color-swatchandcolor-swatch-picker(v3). - combo_
box - ComboBox — port of
@heroui/combo-box(v3). - date_
constraints - The date constraints v3 puts on every date component.
- date_
picker - DatePicker, DateRangePicker & DateField — port of the v3
@heroui/date-pickerfamily: a popover calendar plus ISO text entry. - disclosure
- Disclosure & DisclosureGroup — HeroUI v3
Disclosure. - drawer
- Drawer — port of
@heroui/drawer. - dropdown
- Dropdown & Menu — port of
@heroui/dropdown,@heroui/menuand@heroui/listbox. - field
- Form field primitives — port of
@heroui/label,@heroui/description,@heroui/error-message,@heroui/field-errorand@heroui/fieldset. - filter
useFilter— the string matchers v3 hands an Autocomplete or a ComboBox.- form
- Form — port of
@heroui/form(v3). - gallery_
source - Component source embedded only for the installable gallery’s generic API reference fallback.
- icons
- Icon asset paths used by HeroGPUI components.
- input
- Input & InputState — port of
@heroui/input. - input_
group - InputGroup — port of
@heroui/input-group(v3). - input_
otp - InputOTP — port of
@heroui/input-otp. - kbd
- Kbd — port of
@heroui/kbd. - link
- Link — port of
@heroui/link(v3). - list_
box - ListBox — port of
@heroui/list-box(v3). - list_
nav - Arrow-key navigation shared by every list-shaped control.
- meter
- Meter — HeroUI v3
Meter(value within a known range). - modal
- Modal — port of
@heroui/modal. - number_
field - NumberField — port of
@heroui/number-field(v3). - pagination
- Pagination — port of
@heroui/pagination. - picker_
item - The shared keyed item for the pickers.
- popover
- Popover — port of
@heroui/popover. - progress
- ProgressBar / ProgressCircle — port of
@heroui/progress. - radio_
group - RadioGroup — port of
@heroui/radio. - range_
calendar - RangeCalendar — port of
@heroui/range-calendar(v3). - scroll_
shadow - ScrollShadow — port of
@heroui/scroll-shadow(v3). - scrollbar
- Painted scrollbar — the GPUI stand-in for HeroUI’s CSS
scrollbartoken. - select
- Select — port of
@heroui/selectwith single and multiple selection. - selection
- The shared
selectionModesemantics. - separator
- Separator — port of
@heroui/separator(v3, formerlyDivider). - skeleton
- Skeleton — port of
@heroui/skeleton(v3). - slider
- Slider — port of
@heroui/slider(single or multi-thumb). - spinner
- Spinner — port of
@heroui/spinner(v3). - surface
- Surface — port of
@heroui/surface. - switch
- Switch — port of
@heroui/switch. - table
- Table — port of
@heroui/table(v3). - tabs
- Tabs — port of
@heroui/tabs. - tag_
group - TagGroup — port of
@heroui/tag-group(v3). - textarea
- TextArea — port of
@heroui/text-area(v3). - time_
field - TimeField — port of
@heroui/time-field(v3). - toast
- Toast — port of
@heroui/toast(v3). - toggle_
button - ToggleButton & ToggleButtonGroup — port of
@heroui/toggle-buttonv3. - toolbar
- Toolbar — port of
@heroui/toolbar. - tooltip
- Tooltip — port of
@heroui/tooltip(v3). - typography
- Typography — port of
@heroui/typography(HeroUI v3.2.4). - util
- Shared render helpers for HeroGPUI components.
- validation
- The shared
validate/validationErrorsmodel.
Structs§
- Number
Format formatOptionsfor the components that take it, re-exported so a caller reaches it beside the component it configures. TheformatOptionssubset these components use.
Enums§
- Backdrop
- Overlay scrim style —
Modal,DrawerandAlertDialog. - Color
- Semantic color roles — HeroUI v3.
- Currency
Sign formatOptionsfor the components that take it, re-exported so a caller reaches it beside the component it configures.Intl.NumberFormatOptions["currencySign"].- Field
Variant - Form-control emphasis —
primarycarries the field shadow,secondaryis the flat low-emphasis style for use inside aSurface. - Number
Style formatOptionsfor the components that take it, re-exported so a caller reaches it beside the component it configures.Intl.NumberFormatOptions["style"].- Orientation
- Orientation for separators, toolbars, sliders and groups.
- Placement
placement— where a floating panel sits relative to its trigger.- Placement
Align - How a panel lines up along the trigger’s cross axis.
- Prominence
- Container prominence —
SurfaceandCard.Separatoruses the same ladder minustransparent. - Selection
Behavior - How a multi-select collection changes selection when an item is activated.
- Selection
Mode - How many items a collection lets the user select.
- Size
- The
sm | md | lgscale used by most components. - SizeXl
- The
xs | sm | md | lg | xlscale used bySpinner,ColorSwatchandColorSwatchPicker. - Unit
Display formatOptionsfor the components that take it, re-exported so a caller reaches it beside the component it configures.Intl.NumberFormatOptions["unitDisplay"].- Variant
- Button emphasis variant —
Button, and the vocabularyButtonGroupinherits to its direct children (the pinned group context takesButtonProps["variant"], every value on this enum).