Spinner terminal elegante
NPM Instale ORA
Confira yocto-spinner
para uma alternativa menor.
importar ora de 'ora'; const spinner = ora ('carregando unicorns'). start (); setTimeout (() => {spinner.color = 'amarelo'; spinner.text = 'carregando arco -íris';}, 1000) ;
Se uma string for fornecida, ela será tratada como um atalho para options.text
.
Tipo: object
Tipo: string
O texto a ser exibido ao lado do girador.
Tipo: string | () => string
Texto ou uma função que retorna o texto para exibir antes do spinner. Nenhum texto de prefixo será exibido se definido como uma string vazia.
Tipo: string | () => string
Texto ou uma função que retorna o texto para exibir após o texto do girador. Nenhum texto de sufixo será exibido se definido como uma string vazia.
Tipo: string | object
Padrão: 'dots'
O nome de um dos spinners fornecidos. Consulte example.js
Neste repo se você quiser testar diferentes spinners. No Windows (exceto no terminal do Windows), ele sempre usará o spinner line
, pois a linha de comando do Windows não possui suporte adequado para unicode.
Ou um objeto como:
{quadros: ['-', '+', '-'], intervalo: 80 // opcional}
Tipo: string
Padrão: 'cyan'
Valores: 'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'gray'
A cor do spinner.
Tipo: boolean
Padrão: true
Defina como false
para impedir que Ora oculte o cursor.
Tipo: number
Padrão: 0
Recupe o girador com o número dado de espaços.
Tipo: number
Padrão: fornecido pelo spinner ou 100
Intervalo entre cada quadro.
Os spinners fornecem seu próprio intervalo recomendado, então você realmente não precisa especificar isso.
Tipo: stream.Writable
Padrão: process.stderr
Stream para escrever a saída.
Você pode, por exemplo, definir isso como process.stdout
.
Tipo: boolean
Força Ative/Desative o Spinner. Se não for especificado, o spinner será ativado se o stream
estiver sendo executado dentro de um contexto TTY (não gerado ou canalizado) e/ou não em um ambiente de IC.
Observe que {isEnabled: false}
não significa que não será exibido nada. Significa apenas que não produzirá o spinner, as cores e outros códigos de escape da ANSI. Ainda será registrado o texto.
Tipo: boolean
Padrão: false
Desative o spinner e todo o texto do log. Toda a saída é suprimida e isEnabled
será considerado false
.
Tipo: boolean
Padrão: true
Descarte a entrada do stdin (exceto Ctrl+C) enquanto estiver em execução, se for tty. Isso impede que o spinner se contraa na entrada, a saída de linhas quebradas no Enter tecla pressiona e impede o buffer da entrada enquanto o spinner está em execução.
Isso não afeta o Windows, pois não há uma boa maneira de implementar o descarte de stdin corretamente lá.
Altere o texto exibido após o spinner.
Altere o texto antes do spinner.
Nenhum texto de prefixo será exibido se definido como uma string vazia.
Altere o texto após o texto do girador.
Nenhum texto de sufixo será exibido se definido como uma string vazia.
Altere a cor do girador.
Mude o spinner.
Altere o indent spinner.
Um booleano indicando se a instância está girando no momento.
O intervalo entre cada quadro.
O intervalo é decidido pelo spinner escolhido.
Inicie o girador. Retorna a instância. Defina o texto atual se text
for fornecido.
Pare e limpe o girador. Retorna a instância.
Pare o girador, altere -o para um verde ✔
e persista o texto atual ou text
, se fornecido. Retorna a instância. Veja o gif abaixo.
Pare o girador, altere -o para um vermelho ✖
e persista o texto atual ou text
, se fornecido. Retorna a instância. Veja o gif abaixo.
Pare o girador, altere -o para um amarelo e persista o texto atual ou text
, se fornecido. Retorna a instância.
Pare o girador, altere -o para um azul ℹ
e persista o texto atual ou text
, se fornecido. Retorna a instância.
Pare o spinner e altere o símbolo ou o texto. Retorna a instância. Veja o gif abaixo.
Tipo: object
Tipo: string
Padrão: ' '
Símbolo para substituir o girador por.
Tipo: string
Padrão: 'text'
atual
Texto a ser persistido após o símbolo.
Tipo: string | () => string
Padrão: prefixText
atual
Texto ou uma função que retorna o texto a ser persistido antes do símbolo. Nenhum texto de prefixo será exibido se definido como uma string vazia.
Tipo: string | () => string
Padrão: suffixText
atual
Texto ou uma função que retorna o texto a ser persistido após o texto após o símbolo. Nenhum texto de sufixo será exibido se definido como uma string vazia.
Limpe o girador. Retorna a instância.
Renderizar manualmente um novo quadro. Retorna a instância.
Obtenha um novo quadro.
Inicia um spinner para uma função de promessa ou promessa de retorno. O spinner é interrompido com .succeed()
se a promessa cumprir ou com .fail()
se rejeitar. Retorna a promessa.
importar {orapromise} de 'ora'; aguarda orapromise (algumapromises);
Tipo: Promise | ((spinner: ora.Ora) => Promise)
Tipo: object
Todas as opções mais as seguintes:
Tipo: string | ((result: T) => string) | undefined
O novo texto do spinner quando a promessa é resolvida.
Mantém o texto existente se undefined
.
Tipo: string | ((error: Error) => string) | undefined
O novo texto do spinner quando a promessa é rejeitada.
Mantém o texto existente se undefined
.
Tipo: Record<string, Spinner>
Todos forneceram spinners.
Use chalk
ou yoctocolors
:
importar ora de 'ora'; importar giz de 'giz'; const spinner = ora (`carregando $ {chalk.red ('unicorns')}`) .start ();
O JavaScript é um thread único, portanto, quaisquer operações síncronas bloquearão a animação do Spinner. Para evitar isso, prefira usar operações assíncronas.
Yocto -Spinner - Spinner Tiny Terminal
CLI -Spinners - Spinners para uso no terminal
Portas
Clispinner - Biblioteca Spinner Terminal para Swift
Halo - Porta Python
Spinners - Spinners Terminal para ferrugem
Marquee -ora - rolando o spinner de marquise para Ora
Briandowns/Spinner - Indicador de Spinner/Progresso do Terminal para GO
TJ/Go -spin - pacote de spinner terminal para ir
obserablehq.com/@vicordidenko/ora - Ora Port to observable Notebooks
Kia - Spinners de terminais simples para deno?