cli_spin

Visão geral do pacote

Orientação gerada a partir de informações públicas. Apenas para referência.

cli_spin é um pacote Dart projetado para melhorar a experiência do usuário no terminal exibindo rotores animados suaves durante operações síncronas e assíncronas. Integra-se perfeitamente em aplicativos de linha de comando, fornecendo feedback visual aos usuários durante tarefas de processamento. O rotor é compatível com múltiplas plataformas, incluindo Android, iOS, macOS, Windows e Linux, garantindo comportamento consistente em diferentes ambientes. Com configuração mínima via `flutter pub add cli_spin`, os desenvolvedores podem aprimorar suas ferramentas de linha de comando com indicadores de progresso profissionais. O pacote é leve e focado na simplicidade e confiabilidade.

Casos de uso

Exibindo progresso em ferramentas de linha de comando
Melhorando o feedback do usuário durante operações assíncronas
Melhorando a UX em scripts de linha de comando
Fornecendo pistas visuais para tarefas de longa duração
Integrando rotores suaves em aplicativos de console

Principais recursos

Suporta operações síncronas e assíncronas
Compatibilidade multiplataforma
Superfície mínima da API
Animação de girador de terminal elegante
Integração fácil com aplicativos Flutter CLI

Indicado para

Desenvolvedores de CLI
Criadores de ferramentas de linha de comando
Desenvolvedores Flutter construindo utilitários de console
Usuários procurando indicadores de progresso simples
Projetos que exigem melhorias leves na UX do terminal

Considerações

Limitado à saída baseada em terminal
Sem personalização para estilos de girador
Não suporta ambientes não terminais
Requer controle manual do ciclo de vida do spinner
Depende das capacidades específicas da plataforma do terminal

README original

Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.

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.

Buscar pacotes, repositórios e categorias de apps

Instalar pacote