PyModel/pythinker-code / .agents/skills/opentui
opentui
VerifiedBuild terminal UIs with OpenTUI. Covers core, components, audio, keymaps, React, Solid, plugins, testing, standalone executables, QR encoding, SSH, and Three.js WebGPU.
docs/components/ascii-font.mdx
View on GitHub---
title: ASCIIFont
description: Display text using ASCII art fonts
order: 14
---
# ASCIIFont
Display text using ASCII art fonts with multiple font styles available. Great for titles, headers, and decorative text.
## Basic Usage
### Renderable API
```typescript
import { ASCIIFontRenderable, RGBA, createCliRenderer } from "@opentui/core"
const renderer = await createCliRenderer()
const title = new ASCIIFontRenderable(renderer, {
id: "title",
text: "OPENTUI",
font: "tiny",
color: RGBA.fromInts(255, 255, 255, 255),
})
renderer.root.add(title)
```
### Construct API
```typescript
import { ASCIIFont, createCliRenderer } from "@opentui/core"
const renderer = await createCliRenderer()
renderer.root.add(
ASCIIFont({
text: "HELLO",
font: "block",
color: "#00FF00",
}),
)
```
## Available Fonts
OpenTUI includes several ASCII art font styles:
```typescript
// Small, compact font
{
font: "tiny"
}
// Block style font
{
font: "block"
}
// Shaded style font
{
font: "shade"
}
// Slick style font
{
font: "slick"
}
// Large font
{
font: "huge"
}
// Grid style font
{
font: "grid"
}
// Pallet style font
{
font: "pallet"
}
```
## Positioning
ASCIIFont inherits the standard layout positioning options. To position it at coordinates relative to its parent, use absolute positioning with `left` and `top`:
```typescript
const title = new ASCIIFontRenderable(renderer, {
id: "title",
text: "TITLE",
font: "block",
color: RGBA.fromHex("#FFFF00"),
position: "absolute",
left: 10,
top: 2,
})
```
## Properties
| Property | Type | Default | Description |
| ----------------- | -------------------------------------- | --------------- | -------------------------- |
| `text` | `string` | `""` | Text to display |
| `font` | `ASCIIFontName` | `"tiny"` | Font style |
| `color` | `ColorInput \| ColorInput[]` | `"#FFFFFF"` | Text color or color bands |
| `backgroundColor` | `ColorInput` | `"transparent"` | Background color |
| `selectable` | `boolean` | `true` | Whether text is selectable |
| `selectionBg` | `ColorInput` | - | Selection background color |
| `selectionFg` | `ColorInput` | - | Selection foreground color |
| `position` | `"relative" \| "absolute"` | `"relative"` | Effective positioning mode |
| `top` | number, `"auto"`, or percentage string | - | Top position offset |
| `right` | number, `"auto"`, or percentage string | - | Right position offset |
| `bottom` | number, `"auto"`, or percentage string | - | Bottom position offset |
| `left` | number, `"auto"`, or percentage string | - | Left position offset |
## Example: Welcome Screen
```typescript
import { Box, ASCIIFont, Text, createCliRenderer } from "@opentui/core"
const renderer = await createCliRenderer()
const welcomeScreen = Box(
{
width: "100%",
height: "100%",
flexDirection: "column",
alignItems: "center",
justifyContent: "center",
},
ASCIIFont({
text: "OPENTUI",
font: "huge",
color: "#00FFFF",
}),
Text({
content: "Terminal UI Framework",
fg: "#888888",
}),
Text({
content: "Press any key to continue...",
fg: "#444444",
}),
)
renderer.root.add(welcomeScreen)
```
## Dynamic Text
Update the text content dynamically:
```typescript
const counter = new ASCIIFontRenderable(renderer, {
id: "counter",
text: "0",
font: "block",
color: RGBA.fromHex("#FF0000"),
})
let count = 0
setInterval(() => {
count++
counter.text = count.toString()
}, 1000)
```
## Color Effects
Create a shadow by overlaying two ASCII fonts:
```typescript
import { Box, ASCIIFont } from "@opentui/core"
const shadowTitle = Box(
{ position: "relative" },
ASCIIFont({
text: "HELLO",
font: "block",
color: "#880000",
position: "absolute",
left: 1,
top: 1,
zIndex: 0,
}),
ASCIIFont({
text: "HELLO",
font: "block",
color: "#FF0000",
zIndex: 1,
}),
)
```
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| finishing-a-development-branchobra/superpowersUse when implementation is complete, all tests pass, and you need to decide how to integrate the work | Stars: 319k | Updated | Claude CodeCodex | Verified | Install |
| systematic-debuggingobra/superpowersUse when encountering any bug, test failure, or unexpected behavior, before proposing fixes | Stars: 319k | Updated | Claude CodeCodex | Verified | Install |
| test-driven-developmentobra/superpowersUse when implementing any feature or bugfix, before writing implementation code | Stars: 319k | Updated | Claude CodeCodex | Verified | Install |
| skill-creatoranthropics/skillsCreate new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy. | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |