DataText
Term-definition value cell rendered as a <dd> element. Displays text content with optional prepend/append avatar or icon. Used inside OrigamDataList to pair with OrigamDataTitle.
Structure
Anatomie
Décomposition visuelle de la structure interne du composant avec les appels de classes BEM.
<origam-data-text> — 4 parts: root <dd> ①, prepend area ②, content span ③, append area ④.- 1.origam-data-text
- Root
- element.
- 2.origam-data-text__prepend
- Prepend span hosting avatar or icon.
- 3.origam-data-text__content
- Content span with data-no-activator attribute.
- 4.origam-data-text__append
- Append span hosting avatar or icon.
API
Props
Toutes les props acceptées par ce composant, avec leur type, valeur par défaut et description.
- textrequisstring | number
- Value content rendered in the default slot when no slot override is provided.
- idstring
- classstring | Array<string> | object
- hoverColor
- Text colour applied on hover. Falls back to color when absent.
- stylestring | Array<string> | object | StyleValue
- hoverBgColor
- Background colour applied on hover.
- appendAvatarstring
- Image URL for an avatar rendered in the append area.
- appendIcon
- MDI icon rendered in the append slot when no slot override is provided.
- prependAvatarstring
- Image URL for an avatar rendered in the prepend area.
- prependIcon
- MDI icon rendered in the prepend slot when no slot override is provided.
- prependAriaLabelstring
- appendAriaLabelstring
- density
- Density modifier forwarded to prepend/append icons and avatars.
- marginboolean | number | string
- marginTopboolean | number | string
- marginLeftboolean | number | string
- marginBottomboolean | number | string
- marginRightboolean | number | string
- marginBlockboolean | number | string
- marginInlineboolean | number | string
- marginInlineStartboolean | number | string
- marginInlineEndboolean | number | string
- marginBlockStartboolean | number | string
- marginBlockEndboolean | number | string
- paddingboolean | number | string
- paddingTopboolean | number | string
- paddingLeftboolean | number | string
- paddingBottomboolean | number | string
- paddingRightboolean | number | string
- paddingBlockboolean | number | string
- paddingInlineboolean | number | string
- paddingInlineStartboolean | number | string
- paddingInlineEndboolean | number | string
- paddingBlockStartboolean | number | string
- paddingBlockEndboolean | number | string
- color
- Text colour — tokenised intent value or custom CSS colour.
- bgColor
- Background colour of the cell.
API
Slots
Emplacements de contenu exposés par ce composant.
- #default
- Value content. Falls back to the text prop.
- #prepend
- Custom content before the value. When absent, renders prependAvatar or prependIcon.
- #append
- Custom content after the value. When absent, renders appendAvatar or appendIcon.
API
Emits
Événements émis par ce composant.
- @click:appendMouseEvent
- Fired when the append area is clicked.
- @click:prependMouseEvent
- Fired when the prepend area is clicked.
API
Membres exposés
Propriétés et méthodes accessibles via ref template (defineExpose). Utilisés pour le contrôle programmatique.
- (props: IDataTextProps, exclude?: string[]) => Partial<IDataTextProps>
- Filters component props for forwarding to child components.
- ComputedRef<string>
- Serialised scoped CSS string.
- string
- Unique style scope identifier.
- () => void
- Mounts the scoped style sheet.
- () => void
- Unmounts the scoped style sheet.
- Ref<boolean>
- Whether the scoped style sheet is currently mounted.
Personnalisation
Variables CSS
Propriétés CSS personnalisées exposées par ce composant. Surchargez-les pour personnaliser sans perdre la compatibilité avec le thème.
- Font size of the value text.
- Text colour of the value cell.
- Line height of the value text.
Inclusion
Accessibilité
Rôles ARIA, navigation clavier et gestion du focus. Sourcé depuis le template réel du composant.
Notes
- Rendered as a <dd> element — semantically correct value cell in a description list.
- The v-contrast directive adjusts text colour automatically for sufficient contrast.
Fondation
Design tokens
Extrait des tokens de ce composant — les variables --origam-<composant>---<propriété>, déclarées dans sa feuille de tokens tenue à la main, sans étape de build.
- dimensionvar(--origam-font__size---md)
- Value text font size.
- colorvar(--origam-color__text---primary)
- Value text colour.
- numbervar(--origam-font__lineHeight---normal)
- Value text line height.
- dimensionvar(--origam-font__letterSpacing---normal)
- Value text letter spacing.
Interactif
Playground
Modifiez les props en direct et observez le composant se mettre à jour. Le snippet de code généré suit vos changements.
Rendu de l’aperçu en cours…
Usage
Exemples
Extraits de code prêts à coller dans vos templates.
Basic usage inside DataList
Écosystème
Famille
Composants du même dossier qui partagent les conventions et se composent souvent ensemble.