Enums und Typen

Alles, was das Paket ausser den Elementen exportiert.

Die Attributwerte sind Strings, die Enums sind also optional. Sie sind aber die Liste des Erlaubten und machen aus einem Tippfehler einen Compile-Fehler.

import {
    BorderRadiusPaper,
    CheckboxLabelSide,
    DarkPalette,
    DescriptionType,
    DropdownType,
    IconName,
    IconSizeVariant,
    InputType,
    LinkTarget,
    MainVariant,
    PaperElevation,
    Palette,
    ScreenSizes,
    TextSize,
    TextVariant,
    ToastType,
} from 'tuix-webcomponents'

MainVariant

Die Zweiteilung, die jeder Button und jeder Link verwendet.

EintragWert
MainVariant.PRIMARYprimary
MainVariant.SECONDARYsecondary

TextSize

Vierzehn Textstile. Die Tabelle mit Grössen und Gewichten steht bei tuix-text.

TextVariant

Sechzehn semantische Farben, je Theme aufgelöst. Die Zuordnung zu Palette und DarkPalette steht bei tuix-text.

Palette und DarkPalette

Die reinen Farben, ein Enum pro Theme, mit denselben Einträgen. Die Werte stehen unter Theming.

IconName und IconSizeVariant

IconName hat 88 Einträge, aufgelistet im Icon-Katalog. IconSizeVariant ist SMALL (16px), MEDIUM (24px), LARGE (32px) und FULL (100%).

InputType und DescriptionType

EnumEinträge
InputTypeTEXT text, SEARCH search, PASSWORD password, TEXT_AREA textarea
DescriptionTypeTEXT text, WARNING warning, ERROR error, SUCCESS success, LOADING loading

Beide werden von tuix-input und tuix-dropdown verwendet.

EintragWertVerhalten
DropdownType.SINGLEsingleNur lesbares Feld, Klick öffnet
DropdownType.SEARCHsearchTippen filtert die Optionen

CheckboxLabelSide

EintragWert
CheckboxLabelSide.LEFTleft
CheckboxLabelSide.RIGHTright

Gemeinsam genutzt von Checkbox, Radio-Gruppe und Toggle.

PaperElevation und BorderRadiusPaper

EnumEinträge
PaperElevationVARIANT_0 0 … VARIANT_4 4
BorderRadiusPaperNONE 0px, SOFT 4px, MEDIUM 10px, STRONG 20px

LinkTarget

EintragWert
LinkTarget.BLANK_blank
LinkTarget.SELF_self
LinkTarget.PARENT_parent
LinkTarget.TOP_top

ToastType

NONE none, TEXT text, WARNING warning, ERROR error, SUCCESS success. Siehe tuix-toast.

ScreenSizes

EintragWert
ScreenSizes.TABLET1280
ScreenSizes.MOBILE640

Typen

TypForm
DetailValue<T>{ value: T }, die Nutzlast der meisten Events
DetailValueCheckboxDetailValue<boolean> plus ein optionales label
TuixDropdownPlainOptionstring | number | boolean
TuixDropdownObjectOption{ name: string, value: TuixDropdownPlainOption }
TuixDropdownOptionEines der beiden oben
TuixRadioButtonOptionstring | number, ein Eintrag der options der Radio-Gruppe
IDataTableHeader<TRowData>Eine Tabellenspalte, siehe tuix-table
TuixTableElement<TRowData>HTMLElement, typisiert mit den Properties der Tabelle
ThreeDotsLoaderConfigDer loader der Tabelle, siehe tuix-table
PaginationEventDetail{ page: number, pageSize: number }
CustomEventTuixButtonCustomEvent<undefined>
CustomEventTuixInputCustomEvent<DetailValue<string>>
CustomEventTuixCheckboxCustomEvent<DetailValueCheckbox>
CustomEventTuixToggleWie das Checkbox-Event
CustomEventTuixRadioButton<T>CustomEvent<DetailValue<T>>
CustomEventTuixDropdownSelect<T>CustomEvent<DetailValue<T>>
CustomEventTuixDropdownInputWie das Input-Event
TuixPaginationEventCustomEvent<PaginationEventDetail>

Element-Klassen

TuixButton, TuixCheckbox, TuixDropdown, TuixIcon, TuixIconButton, TuixInput, TuixLink, TuixModal, TuixPaper, TuixRadioButton, TuixTable, TuixText, TuixToast, TuixToggleButton.

Der Import einer Klasse registriert ihr Tag. Die fertigen React-Wrapper darauf exportiert tuix-webcomponents/react; siehe den React-Guide.

Auf dieser Seite