Text

Die Text-Component sorgt für eine konsistente Formatierung und Strukturierung von Text.

Grundlagen

Best Practices

Achte bei der Verwendung von Text darauf, dass ...

  • Texte prägnant, verständlich und hilfreich sein sollen. Beachte zum konsistenten Umgang mit Text auch den Sprach-Guide.
  • Text häufig nicht oder nur unaufmerksam wahrgenommen wird, sodass eine Benutzeroberfläche auch ohne zusätzliche Erläuterungen funktionieren sollte.
  • die Zeilenlänge 75 Zeichen nicht überschreitet. Längere Zeilen erschweren die Lesbarkeit und das Verständnis des Inhalts.
  • Absätze über elementType korrekt als <p> gekennzeichnet werden.

Verwendung

Verwende Text, um ...

  • Fließtext in der Benutzeroberfläche anzuzeigen.
  • Text innerhalb von Components darzustellen.

Playground

Um Text zu formatieren und zu gruppieren, schließe ihn mit dem <Text>-Tag ein.

Das ist ein Text
import { Text } from "@mittwald/flow-react-components";

<Text>Das ist ein Text</Text>

Size

Neben der Default-Schriftgröße unterstützt Text auch die Size Small. Nutze das <small>-Tag, um sie zu verwenden.

Das ist ein Text in small

HTML-Elemente und Formatierungen

Die Text-Component unterstützt alle gängigen Formatierungen und Elemente wie <strong>, <i>, <ul>, <ol> usw.

  • Item 1
  • Item 2
Dies ist ein Beispiel für verschiedene HTML-Formatierungen.

Mit elementType

Verwende die elementType-Property, um festzulegen, welches HTML-Element die Text-Component rendern soll. Standardmäßig wird ein <span> erzeugt. Für Fließtexte, die als eigenständige Absätze erkennbar sein sollen, verwende stattdessen ein <p>-Element.

Das ist ein Absatz


Color

Zusätzlich zur Standard-Color kann Text auch in den Colors Light und Dark dargestellt werden. Beide Colors sind Alternativen zur Standard-Color, falls diese nicht auf farbigen oder dekorativen Hintergründen funktioniert.

Dark

Das ist ein Text

Light

Das ist ein Text

Light: Verwende die Light-Color bei dunklen Hintergründen mit einem HSL Lightness-Wert von weniger als 50.

Dark: Verwende die Dark-Color bei hellen, farbigen Hintergründen mit einem HSL Lightness-Wert von größer als 50.


No ligatures

Verwende die noLigatures-Property, um typografische Ligaturen in der Text-Component zu deaktivieren. Dadurch werden Zeichen unverändert und einzeln dargestellt.

4x5=20vs.Short-ID: p-ah4x5fs

Kombiniere mit ...

Align

Benutze die Align-Component, um neben dem Text z. B. ein Icon, einen CopyButton oder ein ContextualHelp zu platzieren.

mail.agenturserver.de
mail.agenturserver.de
mail.agenturserver.de

Properties

PropertyTypeDefaultDescription
emulateBoldWidthboolean-
color"default" | "dark" | "light" | "dark-static" | "light-static"-
align"start" | "end" | "center"-
wrap"wrap" | "balance" | "pretty"-
whiteSpaceWhiteSpace-
wordBreakWordBreak-
noLigaturesboolean-
childrenReactNode-
classNamestring-
styleCSSProperties-
renderDOMRenderFunction<"div", TooltipRenderProps>-Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements: - You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). - Only a single root DOM element can be rendered (no fragments). - You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.
dirstring-
langstring-
hiddenboolean-
inertboolean-@see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert
translate"yes" | "no"-
autoFocusboolean-
defaultValuestring | number | readonly string[]-
idstring-
slotstring-
enterKeyHint"enter" | "done" | "go" | "next" | "previous" | "search" | "send"-
inputMode"text" | "none" | "search" | "url" | "tel" | "email" | "numeric" | "decimal"-Hints at the type of data that might be entered by the user while editing the element or its contents @see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute
autoCorrectstring-
spellCheckBooleanish-
defaultCheckedboolean-
suppressContentEditableWarningboolean-
suppressHydrationWarningboolean-
accessKeystring-
autoCapitalize"none" | (string & {}) | "off" | "on" | "sentences" | "words" | "characters"-
contentEditable"inherit" | Booleanish | "plaintext-only"-
contextMenustring-
draggableBooleanish-
noncestring-
tabIndexnumber-
titlestring-
radioGroupstring-
roleAriaRole-
aboutstring-
contentstring-
datatypestring-
inlistany-
prefixstring-
propertystring-
relstring-
resourcestring-
revstring-
typeofstring-
vocabstring-
autoSavestring-
itemPropstring-
itemScopeboolean-
itemTypestring-
itemIDstring-
itemRefstring-
resultsnumber-
securitystring-
unselectable"off" | "on"-
popover"" | "manual" | "auto" | "hint"-
popoverTargetAction"toggle" | "show" | "hide"-
popoverTargetstring-
isstring-Specify that a standard HTML element should behave like a defined custom built-in element @see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is
exportpartsstring-@see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts
partstring-@see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part
dangerouslySetInnerHTML{ __html: string | TrustedHTML; }-
elementType"div" | "span" | "p" | ExoticComponent<{}>-
wrapWithReactElement<unknown, string | JSXElementConstructor<any>>-
refRef<HTMLSpanElement>-Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref). @see React Docs
keyKey-

Events

PropertyTypeDefaultDescription
onClickMouseEventHandler<HTMLSpanElement>-
onClickCaptureMouseEventHandler<HTMLSpanElement>-
onAuxClickMouseEventHandler<HTMLSpanElement>-
onAuxClickCaptureMouseEventHandler<HTMLSpanElement>-
onContextMenuMouseEventHandler<HTMLSpanElement>-
onContextMenuCaptureMouseEventHandler<HTMLSpanElement>-
onDoubleClickMouseEventHandler<HTMLSpanElement>-
onDoubleClickCaptureMouseEventHandler<HTMLSpanElement>-
onMouseDownMouseEventHandler<HTMLSpanElement>-
onMouseDownCaptureMouseEventHandler<HTMLSpanElement>-
onMouseEnterMouseEventHandler<HTMLSpanElement>-
onMouseLeaveMouseEventHandler<HTMLSpanElement>-
onMouseMoveMouseEventHandler<HTMLSpanElement>-
onMouseMoveCaptureMouseEventHandler<HTMLSpanElement>-
onMouseOutMouseEventHandler<HTMLSpanElement>-
onMouseOutCaptureMouseEventHandler<HTMLSpanElement>-
onMouseOverMouseEventHandler<HTMLSpanElement>-
onMouseOverCaptureMouseEventHandler<HTMLSpanElement>-
onMouseUpMouseEventHandler<HTMLSpanElement>-
onMouseUpCaptureMouseEventHandler<HTMLSpanElement>-
onTouchCancelTouchEventHandler<HTMLSpanElement>-
onTouchCancelCaptureTouchEventHandler<HTMLSpanElement>-
onTouchEndTouchEventHandler<HTMLSpanElement>-
onTouchEndCaptureTouchEventHandler<HTMLSpanElement>-
onTouchMoveTouchEventHandler<HTMLSpanElement>-
onTouchMoveCaptureTouchEventHandler<HTMLSpanElement>-
onTouchStartTouchEventHandler<HTMLSpanElement>-
onTouchStartCaptureTouchEventHandler<HTMLSpanElement>-
onPointerDownPointerEventHandler<HTMLSpanElement>-
onPointerDownCapturePointerEventHandler<HTMLSpanElement>-
onPointerMovePointerEventHandler<HTMLSpanElement>-
onPointerMoveCapturePointerEventHandler<HTMLSpanElement>-
onPointerUpPointerEventHandler<HTMLSpanElement>-
onPointerUpCapturePointerEventHandler<HTMLSpanElement>-
onPointerCancelPointerEventHandler<HTMLSpanElement>-
onPointerCancelCapturePointerEventHandler<HTMLSpanElement>-
onPointerEnterPointerEventHandler<HTMLSpanElement>-
onPointerLeavePointerEventHandler<HTMLSpanElement>-
onPointerOverPointerEventHandler<HTMLSpanElement>-
onPointerOverCapturePointerEventHandler<HTMLSpanElement>-
onPointerOutPointerEventHandler<HTMLSpanElement>-
onPointerOutCapturePointerEventHandler<HTMLSpanElement>-
onGotPointerCapturePointerEventHandler<HTMLSpanElement>-
onGotPointerCaptureCapturePointerEventHandler<HTMLSpanElement>-
onLostPointerCapturePointerEventHandler<HTMLSpanElement>-
onLostPointerCaptureCapturePointerEventHandler<HTMLSpanElement>-
onScrollUIEventHandler<HTMLSpanElement>-
onScrollCaptureUIEventHandler<HTMLSpanElement>-
onWheelWheelEventHandler<HTMLSpanElement>-
onWheelCaptureWheelEventHandler<HTMLSpanElement>-
onAnimationStartAnimationEventHandler<HTMLSpanElement>-
onAnimationStartCaptureAnimationEventHandler<HTMLSpanElement>-
onAnimationEndAnimationEventHandler<HTMLSpanElement>-
onAnimationEndCaptureAnimationEventHandler<HTMLSpanElement>-
onAnimationIterationAnimationEventHandler<HTMLSpanElement>-
onAnimationIterationCaptureAnimationEventHandler<HTMLSpanElement>-
onTransitionCancelTransitionEventHandler<HTMLSpanElement>-
onTransitionCancelCaptureTransitionEventHandler<HTMLSpanElement>-
onTransitionEndTransitionEventHandler<HTMLSpanElement>-
onTransitionEndCaptureTransitionEventHandler<HTMLSpanElement>-
onTransitionRunTransitionEventHandler<HTMLSpanElement>-
onTransitionRunCaptureTransitionEventHandler<HTMLSpanElement>-
onTransitionStartTransitionEventHandler<HTMLSpanElement>-
onTransitionStartCaptureTransitionEventHandler<HTMLSpanElement>-
onFocusFocusEventHandler<HTMLSpanElement>-
onBlurFocusEventHandler<HTMLSpanElement>-
onKeyDownKeyboardEventHandler<HTMLSpanElement>-
onKeyUpKeyboardEventHandler<HTMLSpanElement>-
onChangeChangeEventHandler<HTMLSpanElement, Element>-
onCopyClipboardEventHandler<HTMLSpanElement>-
onCutClipboardEventHandler<HTMLSpanElement>-
onPasteClipboardEventHandler<HTMLSpanElement>-
onCompositionStartCompositionEventHandler<HTMLSpanElement>-
onCompositionEndCompositionEventHandler<HTMLSpanElement>-
onCompositionUpdateCompositionEventHandler<HTMLSpanElement>-
onSelectReactEventHandler<HTMLSpanElement>-
onBeforeInputInputEventHandler<HTMLSpanElement>-
onInputInputEventHandler<HTMLSpanElement>-
onCopyCaptureClipboardEventHandler<HTMLSpanElement>-
onCutCaptureClipboardEventHandler<HTMLSpanElement>-
onPasteCaptureClipboardEventHandler<HTMLSpanElement>-
onCompositionEndCaptureCompositionEventHandler<HTMLSpanElement>-
onCompositionStartCaptureCompositionEventHandler<HTMLSpanElement>-
onCompositionUpdateCaptureCompositionEventHandler<HTMLSpanElement>-
onFocusCaptureFocusEventHandler<HTMLSpanElement>-
onBlurCaptureFocusEventHandler<HTMLSpanElement>-
onChangeCaptureChangeEventHandler<HTMLSpanElement, Element>-
onBeforeInputCaptureInputEventHandler<HTMLSpanElement>-
onInputCaptureInputEventHandler<HTMLSpanElement>-
onResetReactEventHandler<HTMLSpanElement>-
onResetCaptureReactEventHandler<HTMLSpanElement>-
onSubmitSubmitEventHandler<HTMLSpanElement>-
onSubmitCaptureSubmitEventHandler<HTMLSpanElement>-
onInvalidReactEventHandler<HTMLSpanElement>-
onInvalidCaptureReactEventHandler<HTMLSpanElement>-
onLoadReactEventHandler<HTMLSpanElement>-
onLoadCaptureReactEventHandler<HTMLSpanElement>-
onErrorReactEventHandler<HTMLSpanElement>-
onErrorCaptureReactEventHandler<HTMLSpanElement>-
onKeyDownCaptureKeyboardEventHandler<HTMLSpanElement>-
onKeyPressKeyboardEventHandler<HTMLSpanElement>-@deprecated Use `onKeyUp` or `onKeyDown` instead
onKeyPressCaptureKeyboardEventHandler<HTMLSpanElement>-@deprecated Use `onKeyUpCapture` or `onKeyDownCapture` instead
onKeyUpCaptureKeyboardEventHandler<HTMLSpanElement>-
onAbortReactEventHandler<HTMLSpanElement>-
onAbortCaptureReactEventHandler<HTMLSpanElement>-
onCanPlayReactEventHandler<HTMLSpanElement>-
onCanPlayCaptureReactEventHandler<HTMLSpanElement>-
onCanPlayThroughReactEventHandler<HTMLSpanElement>-
onCanPlayThroughCaptureReactEventHandler<HTMLSpanElement>-
onDurationChangeReactEventHandler<HTMLSpanElement>-
onDurationChangeCaptureReactEventHandler<HTMLSpanElement>-
onEmptiedReactEventHandler<HTMLSpanElement>-
onEmptiedCaptureReactEventHandler<HTMLSpanElement>-
onEncryptedReactEventHandler<HTMLSpanElement>-
onEncryptedCaptureReactEventHandler<HTMLSpanElement>-
onEndedReactEventHandler<HTMLSpanElement>-
onEndedCaptureReactEventHandler<HTMLSpanElement>-
onLoadedDataReactEventHandler<HTMLSpanElement>-
onLoadedDataCaptureReactEventHandler<HTMLSpanElement>-
onLoadedMetadataReactEventHandler<HTMLSpanElement>-
onLoadedMetadataCaptureReactEventHandler<HTMLSpanElement>-
onLoadStartReactEventHandler<HTMLSpanElement>-
onLoadStartCaptureReactEventHandler<HTMLSpanElement>-
onPauseReactEventHandler<HTMLSpanElement>-
onPauseCaptureReactEventHandler<HTMLSpanElement>-
onPlayReactEventHandler<HTMLSpanElement>-
onPlayCaptureReactEventHandler<HTMLSpanElement>-
onPlayingReactEventHandler<HTMLSpanElement>-
onPlayingCaptureReactEventHandler<HTMLSpanElement>-
onProgressReactEventHandler<HTMLSpanElement>-
onProgressCaptureReactEventHandler<HTMLSpanElement>-
onRateChangeReactEventHandler<HTMLSpanElement>-
onRateChangeCaptureReactEventHandler<HTMLSpanElement>-
onSeekedReactEventHandler<HTMLSpanElement>-
onSeekedCaptureReactEventHandler<HTMLSpanElement>-
onSeekingReactEventHandler<HTMLSpanElement>-
onSeekingCaptureReactEventHandler<HTMLSpanElement>-
onStalledReactEventHandler<HTMLSpanElement>-
onStalledCaptureReactEventHandler<HTMLSpanElement>-
onSuspendReactEventHandler<HTMLSpanElement>-
onSuspendCaptureReactEventHandler<HTMLSpanElement>-
onTimeUpdateReactEventHandler<HTMLSpanElement>-
onTimeUpdateCaptureReactEventHandler<HTMLSpanElement>-
onVolumeChangeReactEventHandler<HTMLSpanElement>-
onVolumeChangeCaptureReactEventHandler<HTMLSpanElement>-
onWaitingReactEventHandler<HTMLSpanElement>-
onWaitingCaptureReactEventHandler<HTMLSpanElement>-
onDragDragEventHandler<HTMLSpanElement>-
onDragCaptureDragEventHandler<HTMLSpanElement>-
onDragEndDragEventHandler<HTMLSpanElement>-
onDragEndCaptureDragEventHandler<HTMLSpanElement>-
onDragEnterDragEventHandler<HTMLSpanElement>-
onDragEnterCaptureDragEventHandler<HTMLSpanElement>-
onDragExitDragEventHandler<HTMLSpanElement>-
onDragExitCaptureDragEventHandler<HTMLSpanElement>-
onDragLeaveDragEventHandler<HTMLSpanElement>-
onDragLeaveCaptureDragEventHandler<HTMLSpanElement>-
onDragOverDragEventHandler<HTMLSpanElement>-
onDragOverCaptureDragEventHandler<HTMLSpanElement>-
onDragStartDragEventHandler<HTMLSpanElement>-
onDragStartCaptureDragEventHandler<HTMLSpanElement>-
onDropDragEventHandler<HTMLSpanElement>-
onDropCaptureDragEventHandler<HTMLSpanElement>-
onSelectCaptureReactEventHandler<HTMLSpanElement>-
onScrollEndUIEventHandler<HTMLSpanElement>-
onScrollEndCaptureUIEventHandler<HTMLSpanElement>-
onToggleToggleEventHandler<HTMLSpanElement>-
onBeforeToggleToggleEventHandler<HTMLSpanElement>-

Accessibility

PropertyTypeDefaultDescription
aria-labelstring-Defines a string value that labels the current element. @see aria-labelledby.
aria-labelledbystring-Identifies the element (or elements) that labels the current element. @see aria-describedby.
aria-describedbystring-Identifies the element (or elements) that describes the object. @see aria-labelledby
aria-detailsstring-Identifies the element that provides a detailed, extended description for the object. @see aria-describedby.
aria-activedescendantstring-Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-autocomplete"list" | "none" | "inline" | "both"-Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.
aria-haspopupboolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog"-Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-controlsstring-Identifies the element (or elements) whose contents or presence are controlled by the current element. @see aria-owns.
aria-errormessagestring-Identifies the element that provides an error message for the object. @see aria-invalid @see aria-describedby.
aria-atomicBooleanish-Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-braillelabelstring-Defines a string value that labels the current element, which is intended to be converted into Braille. @see aria-label.
aria-brailleroledescriptionstring-Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. @see aria-roledescription.
aria-busyBooleanish-
aria-checkedboolean | "false" | "true" | "mixed"-Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. @see aria-pressed @see aria-selected.
aria-colcountnumber-Defines the total number of columns in a table, grid, or treegrid. @see aria-colindex.
aria-colindexnumber-Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. @see aria-colcount @see aria-colspan.
aria-colindextextstring-Defines a human readable text alternative of aria-colindex. @see aria-rowindextext.
aria-colspannumber-Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. @see aria-colindex @see aria-rowspan.
aria-currentboolean | "step" | "false" | "true" | "time" | "page" | "location" | "date"-Indicates the element that represents the current item within a container or set of related elements.
aria-descriptionstring-Defines a string value that describes or annotates the current element. @see related aria-describedby.
aria-disabledBooleanish-Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. @see aria-hidden @see aria-readonly.
aria-dropeffect"none" | "link" | "copy" | "execute" | "move" | "popup"-Indicates what functions can be performed when a dragged object is released on the drop target. @deprecated in ARIA 1.1
aria-expandedBooleanish-Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring-Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.
aria-grabbedBooleanish-Indicates an element's "grabbed" state in a drag-and-drop operation. @deprecated in ARIA 1.1
aria-hiddenBooleanish-Indicates whether the element is exposed to an accessibility API. @see aria-disabled.
aria-invalidboolean | "false" | "true" | "grammar" | "spelling"-Indicates the entered value does not conform to the format expected by the application. @see aria-errormessage.
aria-keyshortcutsstring-Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-levelnumber-Defines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite"-Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalBooleanish-Indicates whether an element is modal when displayed.
aria-multilineBooleanish-Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableBooleanish-Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical"-Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring-Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. @see aria-controls.
aria-placeholderstring-Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.
aria-posinsetnumber-Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. @see aria-setsize.
aria-pressedboolean | "false" | "true" | "mixed"-Indicates the current "pressed" state of toggle buttons. @see aria-checked @see aria-selected.
aria-readonlyBooleanish-Indicates that the element is not editable, but is otherwise operable. @see aria-disabled.
aria-relevant"text" | "all" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"-Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. @see aria-atomic.
aria-requiredBooleanish-Indicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring-Defines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber-Defines the total number of rows in a table, grid, or treegrid. @see aria-rowindex.
aria-rowindexnumber-Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. @see aria-rowcount @see aria-rowspan.
aria-rowindextextstring-Defines a human readable text alternative of aria-rowindex. @see aria-colindextext.
aria-rowspannumber-Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. @see aria-rowindex @see aria-colspan.
aria-selectedBooleanish-Indicates the current "selected" state of various widgets. @see aria-checked @see aria-pressed.
aria-setsizenumber-Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. @see aria-posinset.
aria-sort"none" | "ascending" | "descending" | "other"-Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber-Defines the maximum allowed value for a range widget.
aria-valueminnumber-Defines the minimum allowed value for a range widget.
aria-valuenownumber-Defines the current value for a range widget. @see aria-valuetext.
aria-valuetextstring-Defines the human readable text alternative of aria-valuenow for a range widget.

Auf dieser Seite