commander_ui 1.2.0

Commander is a Dart library for creating user interfaces within the terminal.

example/README.md

Input component

import 'dart:io';

import 'package:commander_ui/commander_ui.dart';

final class Item {
  final String name;
  final int value;

  Item(this.name, this.value);
}

Future<void> main() async {
  StdinBuffer.initialize();

  final input = Input(
      answer: 'Please give us your name',
      placeholder: 'firstname lastname',
      secure:
      true, // 👈 Optional, ou can hide the input like html input with password type
      validate: (value) =>
      switch (value) {
        String value when value
            .trim()
            .isNotEmpty => Ok(null),
        _ => Err('Please provide a valid name')
      });

  final value = switch (await input.handle()) {
    Ok(:final value) => 'My value is $value',
    Err(:final error) => Exception('Error: $error'),
    _ => 'Unknown',
  };

  print(value);

  exit(0);
}

Select component

import 'dart:io';

import 'package:commander_ui/commander_ui.dart';

final class Item {
  final String name;
  final int value;

  Item(this.name, this.value);
}

Future<void> main() async {
  StdinBuffer.initialize();

  final List<Item> items = List.generate(
      20, (index) => Item('${index + 1}. Hello World', index + 1));

  String formatSelectedLine(String line) =>
      '${AsciiColors.green('❯')} ${AsciiColors.lightCyan(line)}';

  final select = Select(
      answer: "Please select your best hello",
      options: items,
      placeholder: 'Type to filter',
      selectedLineStyle: formatSelectedLine,
      unselectedLineStyle: (line) => '  $line',
      onDisplay: (item) => item.name);

  final selected = switch (await select.handle()) {
    Ok(:final value) => 'My value is ${value.value}',
    Err(:final error) => Exception('Error: $error'),
    _ => 'Unknown',
  };

  print(selected);

  exit(0);
}

Switch component

import 'dart:io';

import 'package:commander_ui/commander_ui.dart';
import 'package:commander_ui/src/components/switch.dart';

Future<void> main() async {
  StdinBuffer.initialize();

  final input = Switch(answer: 'Do you love cat ?', defaultValue: true);

  final value = switch (await input.handle()) {
    Ok(:final value) => 'My value is $value',
    Err(:final error) => Exception('Error: $error'),
    _ => 'Unknown',
  };

  print(value);

  exit(0);
}