cli_spin

Paketübersicht

Aus öffentlichen Paketdaten erstellte Orientierung.

cli_spin ist ein Dart-Paket, das entwickelt wurde, um die Terminalnutzererfahrung durch glatte, animierte Spinner während synchroner und asynchroner Operationen zu verbessern. Es integriert sich nahtlos in CLI-Anwendungen und bietet visuelle Rückmeldungen an Benutzer während der Verarbeitungsaufgaben. Der Spinner unterstützt mehrere Plattformen wie Android, iOS, macOS, Windows und Linux und sorgt für konsistentes Verhalten über verschiedene Umgebungen hinweg. Mit minimalem Setup über `flutter pub add cli_spin` können Entwickler ihre Befehlszeilenwerkzeuge mit professionell aussehenden Fortschrittsanzeigen verbessern. Das Paket ist leichtgewichtig und auf Einfachheit und Zuverlässigkeit ausgelegt.

Anwendungsfälle

Fortschritt in CLI-Tools anzeigen
Verbesserung der Benutzerfeedback während asynchroner Operationen
Verbesserung der Benutzererfahrung in Befehlszeilen-Skripts
Visuelle Hinweise für langlaufende Aufgaben bereitstellen
Glatte Spinner in Konsolenanwendungen integrieren

Hauptmerkmale

Unterstützt synchron und asynchron Operationen
Plattformübergreifende Kompatibilität
Minimale API-Oberfläche
Glatte Terminal-Spinner-Animation
Einfache Integration mit Flutter CLI-Anwendungen

Geeignet für

CLI-Entwickler
Ersteller von Befehlszeilenwerkzeugen
Flutter-Entwickler, die Konsolenwerkzeuge erstellen
Benutzer, die einfache Fortschrittsanzeiger suchen
Projekte, die leichte Terminal-UX-Erweiterungen erfordern

Hinweise

Beschränkt auf terminalbasierte Ausgabe
Keine Anpassung für Spinner-Stile
Unterstützt keine nicht-terminale Umgebungen
Benötigt manuelle Steuerung des Spinner-Lebenszyklus
Abhängig von plattformspezifischen Terminalfähigkeiten

Original-README

Originaler README-Schnappschuss aus dem verknüpften Quell-Repository. Aktuelle Inhalte finden Sie im Repository.

A Dart package that enhances the user experience by displaying a sleek terminal spinner for both sync and async operations.

preview

Features

80+ predefined spinners accessible via CliSpinners
Easily change color of spinners and/or text with use of CliSpinnerColor helper
Define your own character sets (frames) and intervals for your custom spinners
Custom spinner text (w/ separate suffix and prefix options)
Start/stop methods
Stop and persist the spinner with custom text and symbol
Predefiend success, fail, warn and info methods (cross-platform compatible)

Getting started

TODO: List prerequisites and provide or point to information on how to start using the package.

Usage example

import 'dart:async';
import 'package:cli_spin/cli_spin.dart';

void main() {
  // Instantiate spinner
  final spinner = CliSpin(
    text: 'Loading data...',
    spinner: CliSpinners.line,
  ).start(); // Chaining methods

  Timer(Duration(milliseconds: 1000), () {
    // Change spinner color
    spinner.color = CliSpinnerColor.yellow; 
    
    // Change spinner text
    spinner.text = 'Still loading, please wait...';

    Timer(Duration(milliseconds: 1000), () {
      // Alias for `stopAndPersist(...)` method
      spinner.success('Data loaded successfully.');
    });
  });
}

Additional information

Inspired by the ora library written in Javascript.

Pakete, Repositories und App-Kategorien suchen

Paket installieren