Skip to content

Text

A component for displaying text content with various styles and semantic meanings.

Import

vue
<script setup lang="ts">
import { Text } from '@heroui-vue/vue'
</script>

Usage

Basic

Heading text

Body text paragraph with default styling.Small helper text

<template>
  <div class="flex flex-col gap-2">
    <Text as="h3">Heading text</Text>
    <Text>Body text paragraph with default styling.</Text>
    <Text as="small">Small helper text</Text>
  </div>
</template>

<script setup>
import { Text } from '@heroui-vue/vue'
</script>

Variants

vue
<template>
  <div class="flex flex-col gap-2">
    <Text>Default text</Text>
    <Text variant="muted">Muted text</Text>
    <Text variant="success">Success text</Text>
    <Text variant="warning">Warning text</Text>
    <Text variant="danger">Danger text</Text>
  </div>
</template>

Sizes

vue
<template>
  <div class="flex flex-col gap-2">
    <Text size="xs">Extra small text</Text>
    <Text size="sm">Small text</Text>
    <Text size="base">Base text</Text>
    <Text size="lg">Large text</Text>
    <Text size="xl">Extra large text</Text>
  </div>
</template>

API

Text Props

PropTypeDefaultDescription
variant'default' | 'muted' | 'danger' | 'success' | 'warning''default'The text color variant
size'xs' | 'sm' | 'base' | 'lg' | 'xl'undefinedThe text size
asstring'span'The HTML element to render

Text Slots

SlotDescription
defaultThe text content

Accessibility

  • Text uses semantic HTML elements
  • Proper color contrast ratios
  • Screen reader friendly

Released under the Apache-2.0 License.