Skip to content

BigText

The BigText component renders text as ASCII art using figlet fonts. It supports font selection, alignment, and text styling.

Basic Usage

vue
<template>
  <BigText font="Slant">Hello World</BigText>
</template>

<script setup>
import { BigText } from 'vuetty';
</script>

Props

NameTypeDefaultDescription
fontstring'Standard'Font name for ASCII art
horizontalLayoutstring'default'Layout mode: 'default', 'full', or 'fitted'
alignstring'left'Text alignment: 'left', 'center', or 'right'
colorstring-Text color (chalk color names)
bgstring-Background color
boldbooleanfalseBold text
italicbooleanfalseItalic text
underlinebooleanfalseUnderlined text
dimbooleanfalseDimmed text

Layout Props (Box Props)

NameTypeDefaultDescription
flexnumber | stringnullFlex shorthand when inside a flex container
flexGrownumbernullFlex grow factor
flexShrinknumbernullFlex shrink factor
flexBasisnumber | stringnullFlex basis
alignSelfstringnullSelf alignment: 'auto', 'flex-start', 'flex-end', 'center', 'stretch', 'baseline'
widthnumber | stringnullWidth (chars or %)
heightnumber | stringnullHeight (rows)
minWidthnumbernullMinimum width
maxWidthnumbernullMaximum width
minHeightnumbernullMinimum height
maxHeightnumbernullMaximum height
paddingnumbernullPadding
paddingLeftnumbernullLeft padding
paddingRightnumbernullRight padding
paddingTopnumbernullTop padding
paddingBottomnumbernullBottom padding
marginnumbernullMargin
marginLeftnumbernullLeft margin
marginRightnumbernullRight margin
marginTopnumbernullTop margin
marginBottomnumbernullBottom margin

Fonts

Standard Font

vue
<template>
  <BigText font="Standard">Standard</BigText>
</template>

<script setup>
import { BigText } from 'vuetty';
</script>

Slant Font

vue
<template>
  <BigText font="Slant">Slant</BigText>
</template>

<script setup>
import { BigText } from 'vuetty';
</script>

Big Font

vue
<template>
  <BigText font="Big">Big</BigText>
</template>

<script setup>
import { BigText } from 'vuetty';
</script>

Layout Modes

Default Layout

vue
<template>
  <BigText horizontalLayout="default">Default</BigText>
</template>

<script setup>
import { BigText } from 'vuetty';
</script>

Full Layout

vue
<template>
  <BigText horizontalLayout="full">Full</BigText>
</template>

<script setup>
import { BigText } from 'vuetty';
</script>

Fitted Layout

vue
<template>
  <BigText horizontalLayout="fitted">Fitted</BigText>
</template>

<script setup>
import { BigText } from 'vuetty';
</script>

Alignment

Left Alignment

vue
<template>
  <BigText align="left">Left</BigText>
</template>

<script setup>
import { BigText } from 'vuetty';
</script>

Center Alignment

vue
<template>
  <BigText align="center">Center</BigText>
</template>

<script setup>
import { BigText } from 'vuetty';
</script>

Right Alignment

vue
<template>
  <BigText align="right">Right</BigText>
</template>

<script setup>
import { BigText } from 'vuetty';
</script>

Styling

Custom Colors

vue
<template>
  <BigText color="cyan">Cyan</BigText>
</template>

<script setup>
import { BigText } from 'vuetty';
</script>

Background Colors

vue
<template>
  <BigText bg="blue" color="white">Blue Background</BigText>
</template>

<script setup>
import { BigText } from 'vuetty';
</script>

Text Styling

vue
<template>
  <BigText bold>Bold</BigText>
</template>

<script setup>
import { BigText } from 'vuetty';
</script>

Usage with Other Components

With Gradient

vue
<template>
  <Gradient name="rainbow">
    <BigText font="Big">Rainbow</BigText>
  </Gradient>
</template>

<script setup>
import { BigText, Gradient } from 'vuetty';
</script>

With Box

vue
<template>
  <Box :padding="2" color="magenta" borderStyle="double">
    <BigText font="Slant">VUETTY</BigText>
  </Box>
</template>

<script setup>
import { BigText, Box } from 'vuetty';
</script>

Common Patterns

Title

vue
<template>
  <BigText font="Slant" color="cyan">Application Title</BigText>
</template>

<script setup>
import { BigText } from 'vuetty';
</script>
vue
<template>
  <BigText font="Big" align="center">Welcome</BigText>
</template>

<script setup>
import { BigText } from 'vuetty';
</script>

Decorative Element

vue
<template>
  <BigText font="Standard" color="green" bold>Success!</BigText>
</template>

<script setup>
import { BigText } from 'vuetty';
</script>

Released under the MIT License.