Skip to content

API index ​

Every component, with its name in each adapter. Generated from the library sources by npm run gen (scripts/gen-api.ts) — props and events come from the real component definitions, so this page cannot drift from the code.

ComponentVueReactAngularProps
ActivityFeedThlActivityFeedActivityFeedthl-activity-feed1
AlertThlAlertAlertthl-alert6
AppLayoutThlAppLayoutAppLayoutthl-app-layout8
AuthLayoutThlAuthLayoutAuthLayoutthl-auth-layout2
AvatarThlAvatarAvatarthl-avatar5
AvatarGroup—AvatarGroup—
BadgeThlBadgeBadgethl-badge4
BarChartThlBarChartBarChartthl-bar-chart5
BlockOverlay—BlockOverlay—
BreadcrumbThlBreadcrumbBreadcrumbthl-breadcrumb1
ButtonThlButtonButtonbutton[thl-button], a[thl-button]14
ButtonGroupThlButtonGroupButtonGroupthl-button-group2
CalendarThlCalendarCalendarthl-calendar1
CalendarGridThlCalendarGridCalendarGridthl-calendar-grid7
CardThlCardCardthl-card5
CardActions——[thlCardActions]
CarouselThlCarouselCarouselthl-carousel7
Cell——ng-template[thlCell]
ChatThlChatChatthl-chat2
CheckboxThlCheckboxCheckboxthl-checkbox7
CheckboxGroupThlCheckboxGroupCheckboxGroupthl-checkbox-group4
ColorBoxThlColorBoxColorBoxthl-color-box4
ColorPickerThlColorPickerColorPickerthl-color-picker3
ConfirmHostThlConfirmHostConfirmHostthl-confirm-host0
DataTableThlDataTableDataTablethl-data-table17
DatePickerThlDatePickerDatePickerthl-date-picker8
DateRangePickerThlDateRangePickerDateRangePickerthl-date-range-picker3
DividerThlDividerDivider—1
DrawerThlDrawerDrawerthl-drawer4
DropdownThlDropdownDropdownthl-dropdown5
EditorThlEditorEditorthl-editor4
ErrorLayoutThlErrorLayoutErrorLayoutthl-error-layout4
FieldThlFieldFieldthl-field9
FloatingLabelThlFloatingLabelFloatingLabel—2
FormThlFormForm—3
FormActionsThlFormActionsFormActions—0
FormSection—FormSection—
GalleryThlGalleryGallerythl-gallery1
HorizontalTimelineThlHorizontalTimelineHorizontalTimelinethl-horizontal-timeline2
IconThlIconIconthl-icon4
InfoBoxThlInfoBoxInfoBoxthl-info-box6
InputThlInputInputinput[thlInput], textarea[thlInput], select[thlInput]5
InputGroupThlInputGroupInputGroupthl-input-group2
LabelThlLabelLabelthl-label4
LineChartThlLineChartLineChartthl-line-chart6
ListThlListListthl-list2
MenuLink——ng-template[thlMenuLink]
ModalThlModalModalthl-modal9
NativeSelectThlNativeSelectNativeSelect—3
NumberInputThlNumberInputNumberInputthl-number-input9
PageThlPagePagethl-page2
PaginationThlPaginationPaginationthl-pagination11
PanelThlPanelPanelthl-panel8
PieChartThlPieChartPieChartthl-pie-chart4
PopoverThlPopoverPopoverthl-popover5
PreloaderThlPreloaderPreloader—1
PricingTableThlPricingTablePricingTablethl-pricing-table1
ProfileCardThlProfileCardProfileCardthl-profile-card5
ProgressThlProgressProgressthl-progress8
ProgressCircleThlProgressCircleProgressCirclethl-progress-circle7
RadioThlRadioRadio—7
RadioGroupThlRadioGroupRadioGroupthl-radio-group5
RibbonThlRibbonRibbonthl-ribbon5
SelectThlSelectSelectthl-select10
SettingsPanelThlSettingsPanelSettingsPanelthl-settings-panel1
SideMenuThlSideMenuSideMenuthl-side-menu4
SkeletonThlSkeletonSkeleton—4
SliderThlSliderSliderthl-slider10
SparklineThlSparklineSparklinethl-sparkline5
SpinnerThlSpinnerSpinnerthl-spinner2
StatBoxThlStatBoxStatBoxthl-stat-box7
StatsRowThlStatsRowStatsRowthl-stats-row1
StepsThlStepsStepsthl-steps5
SwitchThlSwitchSwitchthl-switch5
TableThlTableSimpleTabletable[thlTable]6
TabPanel——ng-template[thlTab]
TabsThlTabsTabsthl-tabs5
TagsInputThlTagsInputTagsInput—3
TextareaThlTextareaTextarea—2
TimelineThlTimelineTimelinethl-timeline3
TimePickerThlTimePickerTimePickerthl-time-picker4
ToasterThlToasterToasterthl-toaster0
TodoListThlTodoListTodoListthl-todo-list2
TooltipThlTooltipTooltipthl-tooltip4
TopbarColorMode—TopbarColorMode—
TopbarLocale—TopbarLocale—
TopbarMessagesThlTopbarMessagesTopbarMessagesthl-topbar-messages5
TopbarUser—TopbarUser—
UploadThlUploadUploadthl-upload7
UserCardThlUserCardUserCardthl-user-card3
WeatherThlWeatherWeatherWidgetthl-weather5
WellThlWellWellthl-well1

Core exports ​

AreaExports
ConfigcreateThl, defaultConfig, PERSIST_KEYS, types ThlConfig, ThlUserConfig, ThlInstance, ThlComponentDefaults
i18ncreateI18n, deepMerge, localeInfo, localeLoaders, types Messages, ThlMessages, TParams
StorecreateStore, type Store
HeadlesscreateTable, createSelect, createTabs, createSteps, createCarousel, createDisclosure, createAccordion, createSidebar, findActiveTrail, createToastManager, createUpload, createIdleTimer, paginate, pageSizeOptions, monthGrid, weekdayNames, monthNames, presetRanges, toISODate, parseISODate
Validationrules, validate, validateAll
Utilitiesbem, cx, uid, focusTrap, scrollLock, clickOutside, computePosition, getFocusable
Tokensskins, skinNames, palette, semanticColors, breakpoints

Adapter exports ​

React (@thl-ui/react)Vue (@thl-ui/vue)Angular (@thl-ui/angular)
InstallThlProviderdefault plugin, ThlUI, createThlUIprovideThlUI, THL_CONFIG
ConfiguseThlConfig, useDefaults, usePrefix, useThluseThlConfig, useDefaults, usePrefix, useThlThlConfigService
i18nuseT, useLocaleuseI18n, $tThlI18nService, ThlTranslatePipe (thlT)
ToastuseToastuseToastThlToastService
ConfirmconfirmconfirmThlModalService
Store bridgeuseStoreuseStorestoreSignal
All components—components (record)THL_UI (imports array)
FormsForm, Field, rulesThlForm, ThlField, rulesReactive Forms + thlValidators, ThlFieldComponent