https://github.com/vadimdemedes/ink Skip to content Toggle navigation Sign up * Product + Actions Automate any workflow + Packages Host and manage packages + Security Find and fix vulnerabilities + Codespaces Instant dev environments + Copilot Write better code with AI + Code review Manage code changes + Issues Plan and track work + Discussions Collaborate outside of code Explore + All features + Documentation + GitHub Skills + Blog * Solutions For + Enterprise + Teams + Startups + Education By Solution + CI/CD & Automation + DevOps + DevSecOps Case Studies + Customer Stories + Resources * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles Repositories + Topics + Trending + Collections * Pricing [ ] * # In this repository All GitHub | Jump to | * No suggested jump to results * # In this repository All GitHub | Jump to | * # In this user All GitHub | Jump to | * # In this repository All GitHub | Jump to | Sign in Sign up {{ message }} vadimdemedes / ink Public * * Notifications * Fork 554 * Star 21.6k React for interactive command-line apps term.ink License MIT license 21.6k stars 554 forks Star Notifications * Code * Issues 35 * Pull requests 4 * Discussions * Actions * Projects 0 * Security * Insights More * Code * Issues * Pull requests * Discussions * Actions * Projects * Security * Insights vadimdemedes/ink This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. master Switch branches/tags [ ] Branches Tags Could not load branches Nothing to show {{ refName }} default View all branches Could not load tags Nothing to show {{ refName }} default View all tags Name already in use A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch? Cancel Create 11 branches 68 tags Code * Local * Codespaces * Clone HTTPS GitHub CLI [https://github.com/v] Use Git or checkout with SVN using the web URL. [gh repo clone vadimd] Work fast with our official CLI. Learn more about the CLI. * Open with GitHub Desktop * Download ZIP Sign In Required Please sign in to use Codespaces. Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Launching Xcode If nothing happens, download Xcode and try again. Launching Visual Studio Code Your codespace will open once ready. There was a problem preparing your codespace, please try again. Latest commit @vadimdemedes vadimdemedes Dim border color (#582) ... 8a04760 May 2, 2023 Dim border color (#582) 8a04760 Git stats * 549 commits Files Permalink Failed to load latest commit information. Type Name Latest commit message Commit time .github/workflows Minor CI tweaks March 1, 2023 22:11 benchmark Migrate Ink to ESM and update React (#546) February 28, 2023 21:59 examples Migrate Ink to ESM and update React (#546) February 28, 2023 21:59 media Migrate Ink to ESM and update React (#546) February 28, 2023 21:59 src Dim border color (#582) May 2, 2023 11:36 test Dim border color (#582) May 2, 2023 11:36 .editorconfig Meta tweaks (#9) July 10, 2017 12:53 .gitattributes Various minor cleanup (#141) March 6, 2019 22:22 .gitignore Various minor cleanup (#141) March 6, 2019 22:22 .npmrc Meta tweaks (#9) July 10, 2017 12:53 license Minor changes March 1, 2023 22:13 package.json 4.2.0 April 24, 2023 09:58 readme.md Dim border color (#582) May 2, 2023 11:36 tsconfig.json Disable esModuleInterop March 28, 2023 20:56 View code [ ] Install Usage Who's Using Ink? Contents Getting Started Components color backgroundColor dimColor bold italic underline strikethrough inverse wrap Dimensions width height minWidth minHeight Padding paddingTop paddingBottom paddingLeft paddingRight paddingX paddingY padding Margin marginTop marginBottom marginLeft marginRight marginX marginY margin Gap gap columnGap rowGap Flex flexGrow flexShrink flexBasis flexDirection flexWrap alignItems alignSelf justifyContent Visibility display overflowX overflowY overflow Borders borderStyle borderColor borderTopColor borderRightColor borderRightColor borderBottomColor borderLeftColor borderDimColor borderTopDimColor borderBottomDimColor borderLeftDimColor borderRightDimColor borderTop borderRight borderBottom borderLeft count items style children(item) transform(children) children Hooks useInput(inputHandler, options?) inputHandler(input, key) input key key.leftArrow key.rightArrow key.upArrow key.downArrow key.return key.escape key.ctrl key.shift key.tab key.backspace key.delete key.pageDown key.pageUp key.meta options isActive useApp() exit (error?) error useStdin() stdin isRawModeSupported setRawMode (isRawModeEnabled) isRawModeEnabled useStdout() stdout write(data) data useStderr() stderr write(data) data useFocus(options?) options autoFocus isActive id useFocusManager() enableFocus() disableFocus() focusNext() focusPrevious() focus(id) id API render(tree, options?) tree options stdout stdin exitOnCtrlC patchConsole debug Instance rerender(tree) tree unmount() waitUntilExit() clear() measureElement (ref) ref Testing Using React Devtools Useful Components Useful Hooks Examples Maintainers readme.md [banner2-di] --------------------------------------------------------------------- Ink React for CLIs. Build and test your CLI output using components. Build Status npm Ink provides the same component-based UI building experience that React offers in the browser, but for command-line apps. It uses Yoga to build Flexbox layouts in the terminal, so most CSS-like props are available in Ink as well. If you are already familiar with React, you already know Ink. Since Ink is a React renderer, it means that all features of React are supported. Head over to React website for documentation on how to use it. Only Ink's methods will be documented in this readme. Note: This is documentation for Ink 4. If you're looking for docs on Ink 3, check out this release. --------------------------------------------------------------------- ^ My open source work is supported by the community [?] ^Special thanks to: WorkOS Your app, enterprise-ready. [Start selling to enterprise customers with just a few lines of code.] ^Add Single Sign-On (and more) in minutes instead of months. Install npm install ink react Usage import React, {useState, useEffect} from 'react'; import {render, Text} from 'ink'; const Counter = () => { const [counter, setCounter] = useState(0); useEffect(() => { const timer = setInterval(() => { setCounter(previousCounter => previousCounter + 1); }, 100); return () => { clearInterval(timer); }; }, []); return {counter} tests passed; }; render(); [demo] You can also check it out live on repl.it sandbox. Feel free to play around with the code and fork this repl at https://repl.it/ @vadimdemedes/ink-counter-demo. Who's Using Ink? * GitHub Copilot for CLI - Just say what you want the shell to do. * Cloudflare's Wrangler - The CLI for Cloudflare Workers. * Gatsby - Gatsby is a modern web framework for blazing fast websites. * tap - A Test-Anything-Protocol library for JavaScript. * Terraform CDK - CDK (Cloud Development Kit) for HashiCorp Terraform. * Twilio's SIGNAL - CLI for Twilio's SIGNAL conference. Blog post. * Typewriter - Generates strongly-typed Segment analytics clients from arbitrary JSON Schema. * Prisma - The unified data layer for modern applications. * Wallace - Pretty CSS analytics. * Blitz - The Fullstack React Framework. * New York Times - NYT uses Ink kyt - a toolkit that encapsulates and manages the configuration for web apps. * tink - Next-generation runtime and package manager. * Inkle - Wordle game. * loki - Visual regression testing for Storybook. * Bit - Build, distribute and collaborate on components. * Remirror - Your friendly, world-class editor toolkit. * Prime - Open source GraphQL CMS. * Splash - Observe the splash zone of a change across the Shopify's Polaris component library. * emoj - Find relevant emojis. * emma - Find and install npm packages. * swiff - Multi-environment command line tools for time-saving web developers. * share - Quickly share files. * Kubelive - CLI for Kubernetes to provide live data about the cluster and its resources. * changelog-view - View changelogs. * cfpush - An interactive Cloud Foundry tutorial. * startd - Turn your React component into a web app. * wiki-cli - Search Wikipedia and read summaries. * garson - Build interactive config-based command-line interfaces. * git-contrib-calendar - Display a contributions calendar for any git repository. * gitgud - An interactive command-line GUI for Git. * Autarky - Find and delete old node_modules directories in order to free up disk space. * fast-cli - Test your download and upload speed. * tasuku - Minimal task runner. * mnswpr - Minesweeper game. * lrn - Learning by repetition. * turdle - Wordle game. * Shopify CLI - Build apps, themes, and storefronts for Shopify. * ToDesktop CLI - An all-in-one platform for building Electron apps. Contents * Getting Started * Components + + + + + + * Hooks + useInput + useApp + useStdin + useStdout + useStderr + useFocus + useFocusManager * API * Testing * Using React Devtools * Useful Components * Useful Hooks * Examples Getting Started Use create-ink-app to quickly scaffold a new Ink-based CLI. npx create-ink-app my-ink-cli Alternatively, create a TypeScript project: npx create-ink-app --typescript my-ink-cli Manual JavaScript setup Ink requires the same Babel setup as you would do for regular React-based apps in the browser. Set up Babel with a React preset to ensure all examples in this readme work as expected. After installing Babel, install @babel/ preset-react and insert the following configuration in babel.config.json: npm install --save-dev @babel/preset-react { "presets": ["@babel/preset-react"] } Next, create a file source.js, where you'll type code that uses Ink: import React from 'react'; import {render, Text} from 'ink'; const Demo = () => Hello World; render(); Then, transpile this file with Babel: npx babel source.js -o cli.js Now you can run cli.js with Node.js: node cli If you don't like transpiling files during development, you can use import-jsx or @esbuild-kit/esm-loader to import a JSX file and transpile it on the fly. Ink uses Yoga - a Flexbox layout engine to build great user interfaces for your CLIs using familiar CSS-like props you've used when building apps for the browser. It's important to remember that each element is a Flexbox container. Think of it as if each
in the browser had display: flex. See built-in component below for documentation on how to use Flexbox layouts in Ink. Note that all text must be wrapped in a component. Components This component can display text, and change its style to make it bold, underline, italic or strikethrough. import {render, Text} from 'ink'; const Example = () => ( <> I am green I am black on white I am white I am bold I am italic I am underline I am strikethrough I am inversed ); render(); Note: allows only text nodes and nested components inside of it. For example, component can't be used inside . color Type: string Change text color. Ink uses chalk under the hood, so all its functionality is supported. Green Blue Red [text-color] backgroundColor Type: string Same as color above, but for background. Green Blue Red [text-backgroundColor] dimColor Type: boolean Default: false Dim the color (emit a small amount of light). Dimmed Red [text-dimColor] bold Type: boolean Default: false Make the text bold. italic Type: boolean Default: false Make the text italic. underline Type: boolean Default: false Make the text underlined. strikethrough Type: boolean Default: false Make the text crossed with a line. inverse Type: boolean Default: false Inverse background and foreground colors. Inversed Yellow [text-inverse] wrap Type: string Allowed values: wrap truncate truncate-start truncate-middle truncate-end Default: wrap This property tells Ink to wrap or truncate text if its width is larger than container. If wrap is passed (by default), Ink will wrap text and split it into multiple lines. If truncate-* is passed, Ink will truncate text instead, which will result in one line of text with the rest cut off. Hello World //=> 'Hello\nWorld' // `truncate` is an alias to `truncate-end` Hello World //=> 'Hello...' Hello World //=> 'He...ld' Hello World //=> '...World' is an essential Ink component to build your layout. It's like
in the browser. import {render, Box, Text} from 'ink'; const Example = () => ( This is a box with margin ); render(); Dimensions width Type: number string Width of the element in spaces. You can also set it in percent, which will calculate the width based on the width of parent element. X //=> 'X ' X Y //=> 'X Y' height Type: number string Height of the element in lines (rows). You can also set it in percent, which will calculate the height based on the height of parent element. X //=> 'X\n\n\n' X Y //=> 'X\n\n\nY\n\n' minWidth Type: number Sets a minimum width of the element. Percentages aren't supported yet, see facebook/yoga#872. minHeight Type: number Sets a minimum height of the element. Percentages aren't supported yet, see facebook/yoga#872. Padding paddingTop Type: number Default: 0 Top padding. paddingBottom Type: number Default: 0 Bottom padding. paddingLeft Type: number Default: 0 Left padding. paddingRight Type: number Default: 0 Right padding. paddingX Type: number Default: 0 Horizontal padding. Equivalent to setting paddingLeft and paddingRight. paddingY Type: number Default: 0 Vertical padding. Equivalent to setting paddingTop and paddingBottom. padding Type: number Default: 0 Padding on all sides. Equivalent to setting paddingTop, paddingBottom, paddingLeft and paddingRight. Top Bottom Left Right Left and right Top and bottom Top, bottom, left and right Margin marginTop Type: number Default: 0 Top margin. marginBottom Type: number Default: 0 Bottom margin. marginLeft Type: number Default: 0 Left margin. marginRight Type: number Default: 0 Right margin. marginX Type: number Default: 0 Horizontal margin. Equivalent to setting marginLeft and marginRight. marginY Type: number Default: 0 Vertical margin. Equivalent to setting marginTop and marginBottom. margin Type: number Default: 0 Margin on all sides. Equivalent to setting marginTop, marginBottom, marginLeft and marginRight. Top Bottom Left Right Left and right Top and bottom Top, bottom, left and right Gap gap Type: number Default: 0 Size of the gap between an element's columns and rows. Shorthand for columnGap and rowGap. A B C // A B // // C columnGap Type: number Default: 0 Size of the gap between an element's columns. A B // A B rowGap Type: number Default: 0 Size of the gap between element's rows. A B // A // // B Flex flexGrow Type: number Default: 0 See flex-grow. Label: Fills all remaining space flexShrink Type: number Default: 1 See flex-shrink. Will be 1/4 Will be 3/4 flexBasis Type: number string See flex-basis. X Y //=> 'X Y' X Y //=> 'X Y' flexDirection Type: string Allowed values: row row-reverse column column-reverse See flex-direction. X Y // X Y X Y // Y X X Y // X // Y X Y // Y // X flexWrap Type: string Allowed values: nowrap wrap wrap-reverse See flex-wrap. A BC // A // B C A B C // A C // B alignItems Type: string Allowed values: flex-start center flex-end See align-items. X A B C // X A // B // C X A B C // A // X B // C X A B C // A // B // X C alignSelf Type: string Default: auto Allowed values: auto flex-start center flex-end See align-self. X // X // // X // // X // X // // // X justifyContent Type: string Allowed values: flex-start center flex-end space-between space-around See justify-content. X // [X ] X // [ X ] X // [ X] X Y // [X Y] X Y // [ X Y ] Visibility display Type: string Allowed values: flex none Default: flex Set this property to none to hide the element. overflowX Type: string Allowed values: visible hidden Default: visible Behavior for an element's overflow in horizontal direction. overflowY Type: string Allowed values: visible hidden Default: visible Behavior for an element's overflow in vertical direction. overflow Type: string Allowed values: visible hidden Default: visible Shortcut for setting overflowX and overflowY at the same time. Borders borderStyle Type: string Allowed values: single double round bold singleDouble doubleSingle classic | BoxStyle Add a border with a specified style. If borderStyle is undefined (which it is by default), no border will be added. Ink uses border styles from cli-boxes module. single double round bold singleDouble doubleSingle classic [box-borderStyle] Alternatively, pass a custom border style like so: Custom See example in examples/borders. borderColor Type: string Change border color. Shorthand for setting borderTopColor, borderRightColor, borderBottomColor and borderLeftColor. Green Rounded Box [box-borderColor] borderTopColor Type: string Change top border color. Accepts the same values as color in component. Hello world borderRightColor Type: string Change right border color. Accepts the same values as color in component. Hello world borderRightColor Type: string Change right border color. Accepts the same values as color in component. Hello world borderBottomColor Type: string Change bottom border color. Accepts the same values as color in component. Hello world borderLeftColor Type: string Change left border color. Accepts the same values as color in component. Hello world borderDimColor Type: boolean Default: false Dim the border color. Shorthand for setting borderTopDimColor, borderBottomDimColor, borderLeftDimColor and borderRightDimColor. Hello world borderTopDimColor Type: boolean Default: false Dim the top border color. Hello world borderBottomDimColor Type: boolean Default: false Dim the bottom border color. Hello world borderLeftDimColor Type: boolean Default: false Dim the left border color. Hello world borderRightDimColor Type: boolean Default: false Dim the right border color. Hello world borderTop Type: boolean Default: true Determines whether top border is visible. borderRight Type: boolean Default: true Determines whether right border is visible. borderBottom Type: boolean Default: true Determines whether bottom border is visible. borderLeft Type: boolean Default: true Determines whether left border is visible. Adds one or more newline (\n) characters. Must be used within components. count Type: number Default: 1 Number of newlines to insert. import {render, Text, Newline} from 'ink'; const Example = () => ( Hello World ); render(); Output: Hello World A flexible space that expands along the major axis of its containing layout. It's useful as a shortcut for filling all the available spaces between elements. For example, using in a with default flex direction (row) will position "Left" on the left side and will push "Right" to the right side. import {render, Box, Text, Spacer} from 'ink'; const Example = () => ( Left Right ); render(); In a vertical flex direction (column), it will position "Top" to the top of the container and push "Bottom" to the bottom of it. Note, that container needs to be tall to enough to see this in effect. import {render, Box, Text, Spacer} from 'ink'; const Example = () => ( Top Bottom ); render(); component permanently renders its output above everything else. It's useful for displaying activity like completed tasks or logs - things that are not changing after they're rendered (hence the name "Static"). It's preferred to use for use cases like these, when you can't know or control the amount of items that need to be rendered. For example, Tap uses to display a list of completed tests. Gatsby uses it to display a list of generated pages, while still displaying a live progress bar. import React, {useState, useEffect} from 'react'; import {render, Static, Box, Text} from 'ink'; const Example = () => { const [tests, setTests] = useState([]); useEffect(() => { let completedTests = 0; let timer; const run = () => { // Fake 10 completed tests if (completedTests++ < 10) { setTests(previousTests => [ ...previousTests, { id: previousTests.length, title: `Test #${previousTests.length + 1}` } ]); setTimeout(run, 100); } }; run(); return () => { clearTimeout(timer); }; }, []); return ( <> {/* This part will be rendered once to the terminal */} {test => ( {test.title} )} {/* This part keeps updating as state changes */} Completed tests: {tests.length} ); }; render(); Note: only renders new items in items prop and ignores items that were previously rendered. This means that when you add new items to items array, changes you make to previous items will not trigger a rerender. See examples/static for an example usage of component. items Type: Array Array of items of any type to render using a function you pass as a component child. style Type: object Styles to apply to a container of child elements. See for supported properties. {...} children(item) Type: Function Function that is called to render every item in items array. First argument is an item itself and second argument is index of that item in items array. Note that key must be assigned to the root component. {(item, index) => { // This function is called for every item in ['a', 'b', 'c'] // `item` is 'a', 'b', 'c' // `index` is 0, 1, 2 return ( Item: {item} ); }} Transform a string representation of React components before they are written to output. For example, you might want to apply a gradient to text, add a clickable link or create some text effects. These use cases can't accept React nodes as input, they are expecting a string. That's what component does, it gives you an output string of its child components and lets you transform it in any way. Note: must be applied only to children components and shouldn't change the dimensions of the output, otherwise layout will be incorrect. import {render, Transform} from 'ink'; const Example = () => ( output.toUpperCase()}> Hello World ); render(); Since transform function converts all characters to upper case, final output that's rendered to the terminal will be "HELLO WORLD", not "Hello World". transform(children) Type: Function Function which transforms children output. It accepts children and must return transformed children too. children Type: string Output of child components. Hooks useInput(inputHandler, options?) This hook is used for handling user input. It's a more convenient alternative to using useStdin and listening to data events. The callback you pass to useInput is called for each character when user enters any input. However, if user pastes text and it's more than one character, the callback will be called only once and the whole string will be passed as input. You can find a full example of using useInput at examples/use-input. import {useInput} from 'ink'; const UserInput = () => { useInput((input, key) => { if (input === 'q') { // Exit program } if (key.leftArrow) { // Left arrow key pressed } }); return ... }; inputHandler(input, key) Type: Function The handler function that you pass to useInput receives two arguments: input Type: string The input that the program received. key Type: object Handy information about a key that was pressed. key.leftArrow key.rightArrow key.upArrow key.downArrow Type: boolean Default: false If an arrow key was pressed, the corresponding property will be true. For example, if user presses left arrow key, key.leftArrow equals true. key.return Type: boolean Default: false Return (Enter) key was pressed. key.escape Type: boolean Default: false Escape key was pressed. key.ctrl Type: boolean Default: false Ctrl key was pressed. key.shift Type: boolean Default: false Shift key was pressed. key.tab Type: boolean Default: false Tab key was pressed. key.backspace Type: boolean Default: false Backspace key was pressed. key.delete Type: boolean Default: false Delete key was pressed. key.pageDown key.pageUp Type: boolean Default: false If Page Up or Page Down key was pressed, the corresponding property will be true. For example, if user presses Page Down, key.pageDown equals true. key.meta Type: boolean Default: false Meta key was pressed. options Type: object isActive Type: boolean Default: true Enable or disable capturing of user input. Useful when there are multiple useInput hooks used at once to avoid handling the same input several times. useApp() useApp is a React hook, which exposes a method to manually exit the app (unmount). exit(error?) Type: Function Exit (unmount) the whole Ink app. error Type: Error Optional error. If passed, waitUntilExit will reject with that error. import {useApp} from 'ink'; const Example = () => { const {exit} = useApp(); // Exit the app after 5 seconds useEffect(() => { setTimeout(() => { exit(); }, 5000); }, []); return ... }; useStdin() useStdin is a React hook, which exposes stdin stream. stdin Type: stream.Readable Default: process.stdin Stdin stream passed to render() in options.stdin or process.stdin by default. Useful if your app needs to handle user input. import {useStdin} from 'ink'; const Example = () => { const {stdin} = useStdin(); return ... }; isRawModeSupported Type: boolean A boolean flag determining if the current stdin supports setRawMode. A component using setRawMode might want to use isRawModeSupported to nicely fall back in environments where raw mode is not supported. import {useStdin} from 'ink'; const Example = () => { const {isRawModeSupported} = useStdin(); return isRawModeSupported ? ( ) : ( ); }; setRawMode(isRawModeEnabled) Type: function isRawModeEnabled Type: boolean See setRawMode. Ink exposes this function to be able to handle Ctrl+C, that's why you should use Ink's setRawMode instead of process.stdin.setRawMode. Warning: This function will throw unless the current stdin supports setRawMode. Use isRawModeSupported to detect setRawMode support. import {useStdin} from 'ink'; const Example = () => { const {setRawMode} = useStdin(); useEffect(() => { setRawMode(true); return () => { setRawMode(false); }; }); return ... }; useStdout() useStdout is a React hook, which exposes stdout stream, where Ink renders your app. stdout Type: stream.Writable Default: process.stdout import {useStdout} from 'ink'; const Example = () => { const {stdout} = useStdout(); return ... }; write(data) Write any string to stdout, while preserving Ink's output. It's useful when you want to display some external information outside of Ink's rendering and ensure there's no conflict between the two. It's similar to , except it can't accept components, it only works with strings. data Type: string Data to write to stdout. import {useStdout} from 'ink'; const Example = () => { const {write} = useStdout(); useEffect(() => { // Write a single message to stdout, above Ink's output write('Hello from Ink to stdout\n'); }, []); return ... }; See additional usage example in examples/use-stdout. useStderr() useStderr is a React hook, which exposes stderr stream. stderr Type: stream.Writable Default: process.stderr Stderr stream. import {useStderr} from 'ink'; const Example = () => { const {stderr} = useStderr(); return ... }; write(data) Write any string to stderr, while preserving Ink's output. It's useful when you want to display some external information outside of Ink's rendering and ensure there's no conflict between the two. It's similar to , except it can't accept components, it only works with strings. data Type: string Data to write to stderr. import {useStderr} from 'ink'; const Example = () => { const {write} = useStderr(); useEffect(() => { // Write a single message to stderr, above Ink's output write('Hello from Ink to stderr\n'); }, []); return ... }; useFocus(options?) Component that uses useFocus hook becomes "focusable" to Ink, so when user presses Tab, Ink will switch focus to this component. If there are multiple components that execute useFocus hook, focus will be given to them in the order that these components are rendered in. This hook returns an object with isFocused boolean property, which determines if this component is focused or not. options autoFocus Type: boolean Default: false Auto focus this component, if there's no active (focused) component right now. isActive Type: boolean Default: true Enable or disable this component's focus, while still maintaining its position in the list of focusable components. This is useful for inputs that are temporarily disabled. id Type: string Required: false Set a component's focus ID, which can be used to programmatically focus the component. This is useful for large interfaces with many focusable elements, to avoid having to cycle through all of them. import {render, useFocus, Text} from 'ink'; const Example = () => { const {isFocused} = useFocus(); return {isFocused ? 'I am focused' : 'I am not focused'}; }; render(); See example in examples/use-focus and examples/use-focus-with-id. useFocusManager() This hook exposes methods to enable or disable focus management for all components or manually switch focus to next or previous components. enableFocus() Enable focus management for all components. Note: You don't need to call this method manually, unless you've disabled focus management. Focus management is enabled by default. import {useFocusManager} from 'ink'; const Example = () => { const {enableFocus} = useFocusManager(); useEffect(() => { enableFocus(); }, []); return ... }; disableFocus() Disable focus management for all components. Currently active component (if there's one) will lose its focus. import {useFocusManager} from 'ink'; const Example = () => { const {disableFocus} = useFocusManager(); useEffect(() => { disableFocus(); }, []); return ... }; focusNext() Switch focus to the next focusable component. If there's no active component right now, focus will be given to the first focusable component. If active component is the last in the list of focusable components, focus will be switched to the first component. Note: Ink calls this method when user presses Tab. import {useFocusManager} from 'ink'; const Example = () => { const {focusNext} = useFocusManager(); useEffect(() => { focusNext(); }, []); return ... }; focusPrevious() Switch focus to the previous focusable component. If there's no active component right now, focus will be given to the first focusable component. If active component is the first in the list of focusable components, focus will be switched to the last component. Note: Ink calls this method when user presses Shift+Tab. import {useFocusManager} from 'ink'; const Example = () => { const {focusPrevious} = useFocusManager(); useEffect(() => { focusPrevious(); }, []); return ... }; focus(id) id Type: string Switch focus to the component with the given id. If there's no component with that ID, focus will be given to the next focusable component. import {useFocusManager, useInput} from 'ink'; const Example = () => { const {focus} = useFocusManager(); useInput(input => { if (input === 's') { // Focus the component with focus ID 'someId' focus('someId'); } }); return ... }; API render(tree, options?) Returns: Instance Mount a component and render the output. tree Type: ReactElement options Type: object stdout Type: stream.Writable Default: process.stdout Output stream where app will be rendered. stdin Type: stream.Readable Default: process.stdin Input stream where app will listen for input. exitOnCtrlC Type: boolean Default: true Configure whether Ink should listen to Ctrl+C keyboard input and exit the app. This is needed in case process.stdin is in raw mode, because then Ctrl+C is ignored by default and process is expected to handle it manually. patchConsole Type: boolean Default: true Patch console methods to ensure console output doesn't mix with Ink output. When any of console.* methods are called (like console.log ()), Ink intercepts their output, clears main output, renders output from the console method and then rerenders main output again. That way both are visible and are not overlapping each other. This functionality is powered by patch-console, so if you need to disable Ink's interception of output but want to build something custom, you can use it. debug Type: boolean Default: false If true, each update will be rendered as a separate output, without replacing the previous one. Instance This is the object that render() returns. rerender(tree) Replace previous root node with a new one or update props of the current root node. tree Type: ReactElement // Update props of the root node const {rerender} = render(); rerender(); // Replace root node const {rerender} = render(); rerender(); unmount() Manually unmount the whole Ink app. const {unmount} = render(); unmount(); waitUntilExit() Returns a promise, which resolves when app is unmounted. const {unmount, waitUntilExit} = render(); setTimeout(unmount, 1000); await waitUntilExit(); // resolves after `unmount()` is called clear() Clear output. const {clear} = render(); clear(); measureElement(ref) Measure the dimensions of a particular element. It returns an object with width and height properties. This function is useful when your component needs to know the amount of available space it has. You could use it when you need to change the layout based on the length of its content. Note: measureElement() returns correct results only after the initial render, when layout has been calculated. Until then, width and height equal to zero. It's recommended to call measureElement() in a useEffect hook, which fires after the component has rendered. ref Type: MutableRef A reference to a element captured with a ref property. See Refs for more information on how to capture references. import {render, measureElement, Box, Text} from 'ink'; const Example = () => { const ref = useRef(); useEffect(() => { const {width, height} = measureElement(ref.current); // width = 100, height = 1 }, []); return ( This box will stretch to 100 width ); }; render(); Testing Ink components are simple to test with ink-testing-library. Here's a simple example that checks how component is rendered: import React from 'react'; import {Text} from 'ink'; import {render} from 'ink-testing-library'; const Test = () => Hello World; const {lastFrame} = render(); lastFrame() === 'Hello World'; //=> true Check out ink-testing-library for more examples and full documentation. Using React Devtools [devtools] Ink supports React Devtools out-of-the-box. To enable integration with React Devtools in your Ink-based CLI, run it with DEV=true environment variable: DEV=true my-cli Then, start React Devtools itself: npx react-devtools After it starts up, you should see the component tree of your CLI. You can even inspect and change the props of components, and see the results immediatelly in the CLI, without restarting it. Note: You must manually quit your CLI via Ctrl+C after you're done testing. Useful Components * ink-text-input - Text input. * ink-spinner - Spinner. * ink-select-input - Select (dropdown) input. * ink-link - Link. * ink-gradient - Gradient color. * ink-big-text - Awesome text. * ink-image - Display images inside the terminal. * ink-tab - Tab. * ink-color-pipe - Create color text with simpler style strings. * ink-multi-select - Select one or more values from a list * ink-divider - A divider. * ink-progress-bar - Progress bar. * ink-table - Table. * ink-ascii - Awesome text component with more font choices, based on Figlet. * ink-markdown - Render syntax highlighted Markdown. * ink-quicksearch-input - Select component with fast quicksearch-like navigation. * ink-confirm-input - Yes/No confirmation input. * ink-syntax-highlight - Code syntax highlighting. * ink-form - Form. * ink-task-list - Task list. Useful Hooks * ink-use-stdout-dimensions - Subscribe to stdout dimensions. Examples The examples directory contains a set of real examples. You can run them with: npm run example examples/[example name] # e.g. npm run example examples/borders * Jest - Implementation of basic Jest UI (live demo). * Counter - Simple counter that increments every 100ms (live demo). * Form with validation - Manage form state using Final Form. * Borders - Add borders to component. * Suspense - Use React Suspense. * Table - Render a table with multiple columns and rows. * Focus management - Use useFocus hook to manage focus between components. * User input - Listen to user input. * Write to stdout - Write to stdout bypassing main Ink output. * Write to stderr - Write to stderr bypassing main Ink output. * Static - Use to render permanent output. * Child process - Render output from a child process. Maintainers * Vadim Demedes * Sindre Sorhus About React for interactive command-line apps term.ink Topics react javascript cli command-line interactive flexbox Resources Readme License MIT license Code of conduct Code of conduct Stars 21.6k stars Watchers 107 watching Forks 554 forks Report repository Releases 46 v4.2.0 Latest Apr 24, 2023 + 45 releases Sponsor this project * open_collective opencollective.com/vadimdemedes * https://www.comebackalive.in.ua Used by 60.8k * @EmilianoBruni * @shikyonayuta * @akshatcoder-hash * @ohiowebpro * @dan-hoerr + 60,768 Contributors 100 * @vadimdemedes * @sindresorhus * @LitoMore * @karaggeorge * @SimenB * @cameronhunter * @eweilow * @privatenumber * @ForbesLindesay * @jdeniau * @bartlangelaan + 89 contributors Languages * TypeScript 99.5% * JavaScript 0.5% Footer (c) 2023 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact GitHub * Pricing * API * Training * Blog * About You can't perform that action at this time. You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.