ink task list

liste de tâches

Composants de liste de tâches pour l'encre

_{Soutenez ce projet en le mettant en vedette et en le partageant. Suivez-moi pour voir sur quels autres projets sympas sur lesquels je travaille! ❤️}

Installer

npm i ink-task-list

? Utilisation rapide

 import React from 'react' ;
import { render } from 'ink' ;
import { TaskList , Task } from 'ink-task-list' ;
import spinners from 'cli-spinners' ;

render (
    < TaskList >
        { /* Pending state */ }
        < Task
            label = "Pending"
            state = "pending"
        />

        { /* Loading state */ }
        < Task
            label = "Loading"
            state = "loading"
            spinner = { spinners . dots }
        />

        { /* Success state */ }
        < Task
            label = "Success"
            state = "success"
        />

        { /* Warning state */ }
        < Task
            label = "Warning"
            state = "warning"
        />

        { /* Error state */ }
        < Task
            label = "Error"
            state = "error"
        />

        { /* Item with children */ }
        < Task
            label = "Item with children"
            isExpanded
        >
            < Task
                label = "Loading"
                state = "loading"
                spinner = { spinners . dots }
            />
        </ Task >
    </ TaskList > ,
) ; 

? API

Liste de tâches

Emballage en option pour contenir une liste de Tasks .

Fondamentalement, juste un <Box flexDirection="column"> ; uniquement à des fins de style et de sémantique.

enfants

Type: ReactNode | ReactNode[]

Requis

Passer la liste des tâches

Tâche

Représente chaque tâche.

étiquette

Type: string

Requis

État

Type: 'pending'|'loading'|'success'|'warning'|'error'

Par défaut: pending

statut

Type: string

Statut de la tâche à afficher à droite de l' label

sortir

Type: string

Sortie unique préfixée par → pour afficher sous l' label

fileur

Taper:

 type Spinner = {
    interval : number
    frames : string [ ]
}

Requis si l'état se loading

Données de spinner utilisées pour le chargement de l'état. Passez un spinner de Cli-Spinners pour plus de commodité.

est expansé

Type: boolean

Par défaut: false

Que ce soit pour montrer ou non les enfants.

enfants

Type: ReactNode | ReactNode[]

Passer un ou plusieurs composants <Task>

Crédits

L'interface utilisateur du composant a été inspirée List et List2 ❤️