Use higher-level console components

Console.components groups common, higher-level patterns such as titled messages, bullet lists, and spinners. Use it when a basic Console method is too small but a full TUI would be too much.

Console is the primary facade for output, prompts, and operations. Console.components is a namespaced facade for structured display blocks. Overlapping conveniences such as task and spin use the same underlying operation lifecycle, so capability detection, cursor cleanup, timing, and fallback behavior are consistent.

Quick Start

import 'package:artisanal/artisanal.dart';

Future<void> main() async {
  final io = Console();

  io.components.info('Status', 'Ready');
  io.components.bulletList(['One', 'Two', 'Three']);

  final result = await io.components.spin(
    'Working...',
    run: () async {
      await Future.delayed(const Duration(milliseconds: 200));
      return 42;
    },
  );

  io.writeln('Result: $result');
}

Common Helpers

• info, success, warn, error, comment
• alert
• twoColumnDetail, definitionList, horizontalTable
• bulletList, line, rule
• spin, textArea
• renderException

Console lines versus component blocks

Direct semantic methods write one message line:

io.info('Ready');

The similarly named component methods render titled blocks:

io.components.info('Status', 'Ready');

Prefer direct Console methods for ordinary output, prompts, tasks, spinners, and progress. Use Console.components for titled blocks, definition lists, horizontal tables, comments, exceptions, and other structured presentation.

Text Area Prompt

import 'package:artisanal/artisanal.dart';
import 'package:artisanal/bubbles.dart';

Future<void> main() async {
  final io = Console();
  final model = TextAreaModel(placeholder: 'Notes...');

  final value = await io.components.textArea(
    model,
    options: textareaPromptOptions,
  );

  io.components.comment(value ?? 'No input');
}

Things to keep in mind

• Many helpers add their own newlines; avoid double spacing.
• spin() falls back to non-animated output when interactive is false.
• line() and rule() use terminal width to size their output.

Where to go next

• docs_index.md - Full documentation index
• console.md
• bubbles.md