Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "react-hooks"

Index

Functions

useMultiProgressBar

  • useMultiProgressBar

    ink

    example
    function App() {
      const [Bars, multiBar] = useMultiProgressBar({
        title: 'multi progress'
      });
    
      useEffect(() => {
        const bar = multiBar.startBar({
          title: 'bar',
          clean: true,
          total: 100,
          width: process.stdout.columns!,
          render: themes.inverse
        });
        const timer = setInterval(() => {
          bar.tick(1);
        }, 30);
        bar.events.on('complete-post', () => {
          clearInterval(timer);
        });
      }, [multiBar]);
    
      return <Bars />;
    }

    Parameters

    Returns [function, MultiProgressBar | undefined]

useProgressBar

  • useProgressBar

    ink

    example
    function App {
      const [Bar, bar] = useProgressBar({
        title: 'progress',
        width: process.stdout.columns! - title.length - 1,
        total: 100,
      });
    
      useEffect(() => {
        if (! bar) return;
    
        bar.events.on('complete-post', () => {
          app.unmount();
        });
    
        const timer = setInterval(() => {
          bar.tick(1);
        }, 100);
    
        return () => {
          clearInterval(timer);
        };
      }, [bar]);
    
      return <Text><Color blue>title</Color> <Bar/></Text>;
    }

    Parameters

    Returns [function, ProgressBar | undefined]

Generated using TypeDoc