Ink-UI

Collection of customizable UI components for CLIs made with Ink

CLI
vadimdemedes/ink-uiterm.ink/ui@inkjs/ui

README


Ink UI


Collection of customizable UI components for CLIs made with Ink .


Install


  1. ``` shell
  2. npm install @inkjs/ui
  3. ```

This assumes you've already set up Ink . The easiest way to get started is create-ink-app .

Components


Text input


Documentation

TextInputis used for entering any single-line input with an optional autocomplete.

  1. ``` js
  2. import {TextInput} from '@inkjs/ui';

  4. <TextInput
  5. placeholder="Enter your name..."
  6. onSubmit={name => {
  7.   // `name` contains user input
  8. }}
  9. />;
  10. ```

undefined text-input.gif

Email input


Documentation

EmailInputis used for entering an email. After "@" character is entered, domain can be autocompleted from the list of most popular email providers.

  1. ``` js
  2. import {EmailInput} from '@inkjs/ui';

  4. <EmailInput
  5. placeholder="Enter email..."
  6. onSubmit={email => {
  7.   // `email` contains user input
  8. }}
  9. />;
  10. ```

undefined email-input.gif

Password input


Documentation

PasswordInputis used for entering sensitive data, like passwords, API keys and so on. It works the same way as TextInput, except input value is masked and replaced with asterisks ("*").

  1. ``` js
  2. import {PasswordInput} from '@inkjs/ui';

  4. <PasswordInput
  5. placeholder="Enter password..."
  6. onSubmit={password => {
  7.   // `password` contains user input
  8. }}
  9. />;
  10. ```

undefined password-input.gif

Confirm input


Documentation

ConfirmInputshows a common "Y/n" input to confirm or cancel an operation your CLI wants to perform.

  1. ``` js
  2. import {ConfirmInput} from '@inkjs/ui';

  4. <ConfirmInput
  5. onConfirm={() => {
  6.   // confirmed
  7. }}
  8. onCancel={() => {
  9.   // cancelled
  10. }}
  11. />;
  12. ```

undefined

Select


Documentation

Selectshows a scrollable list of options for a user to choose from.

  1. ``` js
  2. import {Select} from '@inkjs/ui';

  4. <Select
  5. options={[
  6.   {
  7.    label: 'Red',
  8.    value: 'red',
  9.   },
  10.   {
  11.    label: 'Green',
  12.    value: 'green',
  13.   },
  14.   {
  15.    label: 'Yellow',
  16.    value: 'yellow',
  17.   },
  18.   /* ... */
  19. ]}
  20. onChange={newValue => {
  21.   // `newValue` equals the `value` field of the selected option
  22.   // For example, "yellow"
  23. }}
  24. />;
  25. ```

undefined select.gif

Multi select


Documentation

MultiSelectis similar to Select, except user can choose multiple options.

  1. ``` js
  2. import {MultiSelect} from '@inkjs/ui';

  4. <MultiSelect
  5. options={[
  6.   {
  7.    label: 'Red',
  8.    value: 'red',
  9.   },
  10.   {
  11.    label: 'Green',
  12.    value: 'green',
  13.   },
  14.   {
  15.    label: 'Yellow',
  16.    value: 'yellow',
  17.   },
  18.   /* ... */
  19. ]}
  20. onChange={newValue => {
  21.   // `newValue` is an array of `value` fields of the selected options
  22.   // For example, ["green", "yellow"]
  23. }}
  24. />;
  25. ```

undefined multi-select.gif

Spinner


Documentation

Spinnerindicates that something is being processed and CLI is waiting for it to complete.

  1. ``` js
  2. import {Spinner} from '@inkjs/ui';

  4. <Spinner label="Loading" />;
  5. ```

undefined spinner.gif

Progress bar


Documentation

ProgressBaris an extended version of Spinner, where it's possible to calculate a progress percentage.

  1. ``` js
  2. import {ProgressBar} from '@inkjs/ui';

  4. // `progress` must be a number between 0 and 100
  5. <ProgressBar value={progress} />;
  6. ```

undefined progress-bar.gif

Badge


Documentation

Badgecan be used to indicate a status of a certain item, usually positioned nearby the element it's related to.

  1. ``` js
  2. import {Badge} from '@inkjs/ui';

  4. <Badge color="green">Pass</Badge>
  5. <Badge color="red">Fail</Badge>
  6. <Badge color="yellow">Warn</Badge>
  7. <Badge color="blue">Todo</Badge>
  8. ```

undefined

Status message


Documentation

StatusMessagecan also be used to indicate a status, but when longer explanation of such status is required.

  1. ``` js
  2. import {StatusMessage} from '@inkjs/ui';

  4. <StatusMessage variant="success">
  5. New version is deployed to production
  6. </StatusMessage>

  8. <StatusMessage variant="error">
  9.   Failed to deploy a new version of this app
  10. </StatusMessage>

  12. <StatusMessage variant="warning">
  13.     Health checks aren't configured
  14. </StatusMessage>

  16. <StatusMessage variant="info">
  17.     This version is already deployed
  18. </StatusMessage>
  19. ```

undefined

Alert


Documentation

Alertis used to focus user's attention to important messages.

  1. ``` js
  2. import {Alert} from '@inkjs/ui';

  4. <Alert variant="success">
  5.     A new version of this CLI is available
  6. </Alert>

  8. <Alert variant="error">
  9.     Your license is expired
  10. </Alert>

  12. <Alert variant="warning">
  13.     Current version of this CLI has been deprecated
  14. </Alert>

  16. <Alert variant="info">
  17.     API won't be available tomorrow night
  18. </Alert>
  19. ```

undefined

Unordered list


Documentation

UnorderedListis used to show lists of items.

  1. ``` js
  2. import {UnorderedList} from '@inkjs/ui';

  4. <UnorderedList>
  5. <UnorderedList.Item>
  6.   <Text>Red</Text>
  7. </UnorderedList.Item>

  9. <UnorderedList.Item>
  10.   <Text>Green</Text>

  12.   <UnorderedList>
  13.    <UnorderedList.Item>
  14.     <Text>Light</Text>
  15.    </UnorderedList.Item>

  17.    <UnorderedList.Item>
  18.     <Text>Dark</Text>
  19.    </UnorderedList.Item>
  20.   </UnorderedList>
  21. </UnorderedList.Item>

  23. <UnorderedList.Item>
  24.   <Text>Blue</Text>
  25. </UnorderedList.Item>
  26. </UnorderedList>;
  27. ```

undefined

Ordered list


Documentation

OrderedListis used to show lists of numbered items.

  1. ``` js
  2. import {OrderedList} from '@inkjs/ui';

  4. <OrderedList>
  5. <OrderedList.Item>
  6.   <Text>Red</Text>
  7. </OrderedList.Item>

  9. <OrderedList.Item>
  10.   <Text>Green</Text>

  12.   <OrderedList>
  13.    <OrderedList.Item>
  14.     <Text>Light</Text>
  15.    </OrderedList.Item>

  17.    <OrderedList.Item>
  18.     <Text>Dark</Text>
  19.    </OrderedList.Item>
  20.   </OrderedList>
  21. </OrderedList.Item>

  23. <OrderedList.Item>
  24.   <Text>Blue</Text>
  25. </OrderedList.Item>
  26. </OrderedList>;
  27. ```

undefined

Theming


All component have their styles defined in a theme, which is accessible to components via React context. Ink UI ships with a default theme and it can be customized or replaced with a different theme altogether.

Let's get a quick look on how to customize a Spinner's component theme. Here's how it looks by default:

undefined spinner.gif

First, look up component's default theme, which will give an overview which parts does this component consist of. Documentation of each component includes a link to component's theme.tsfile on top. In the case of Spinner, it's source/components/spinner/theme.ts .

Here's the part we care about:

  1. ``` tsx
  2. const theme = {
  3. styles: {
  4.   container: (): BoxProps => ({
  5.    gap: 1,
  6.   }),
  7.   frame: (): TextProps => ({
  8.    color: 'blue',
  9.   }),
  10.   label: (): TextProps => ({}),
  11. },
  12. } satisfies ComponentTheme;

  14. export default theme;
  15. ```

This component theme hints that Spinnerhas 3 parts: container, frame and a label. So to customize the color of the spinner itself, we'd want to change the colorprop returned from the framefunction.

To customize the default theme, use extendThemefunction and make that custom theme available to children components via ThemeProvider.

  1. ``` tsx
  2. import {render, type TextProps} from 'ink';
  3. import {Spinner, ThemeProvider, extendTheme, defaultTheme} from '@inkjs/ui';

  5. const customTheme = extendTheme(defaultTheme, {
  6. components: {
  7.   Spinner: {
  8.    styles: {
  9.     frame: (): TextProps => ({
  10.      color: 'magenta',
  11.     }),
  12.    },
  13.   },
  14. },
  15. });

  17. function Example() {
  18. return (
  19.   <ThemeProvider theme={customTheme}>
  20.    <Spinner label="Loading" />
  21.   </ThemeProvider>
  22. );
  23. }

  25. render(<Example />);
  26. ```

With custom theme applied, Spinnernow renders a magenta spinner, instead of the default blue one.

undefined spinner-theme.gif

There are also cases where styles change based on some condition. For example, StatusMessage changes the color of an icon based on the variantprop.

Here's a sample code from its theme .

  1. ``` ts
  2. const colorByVariant = {
  3. success: 'green',
  4. error: 'red',
  5. warning: 'yellow',
  6. info: 'blue',
  7. };

  9. const theme = {
  10. styles: {
  11.   icon: ({variant}) => ({
  12.    color: colorByVariant[variant],
  13.   }),
  14. },
  15. };
  16. ```

Since each field in stylesobject is a function, it can return different styles based on the props that were passed in or a state of a component.

Component themes can also include configuration for rendering a component in a configobject, that's not related to styling. For example, UnorderedList specifies a marker, which is a character that's rendered before each list item.

Here's a sample code from its theme .

  1. ``` ts
  2. const theme = {
  3. config: () => ({
  4.   marker: '─',
  5. }),
  6. };
  7. ```

undefined

Changing markerto '+'would render this:

undefined

Components shipped in Ink UI automatically read the necessary styles and configuration from a theme. However, if you're adding a new custom component and a theme for it, use useComponentThemehook to access it.

  1. ``` tsx
  2. import React, {render, Text, type TextProps} from 'ink';
  3. import {
  4. ThemeProvider,
  5. defaultTheme,
  6. extendTheme,
  7. useComponentTheme,
  8. type ComponentTheme,
  9. } from '@inkjs/ui';

  11. const customLabelTheme = {
  12. styles: {
  13.   label: (): TextProps => ({
  14.    color: 'green',
  15.   }),
  16. },
  17. } satisfies ComponentTheme;

  19. type CustomLabelTheme = typeof customLabelTheme;

  21. const customTheme = extendTheme(defaultTheme, {
  22. components: {
  23.   CustomLabel: customLabelTheme,
  24. },
  25. });

  27. function CustomLabel() {
  28. const {styles} = useComponentTheme<CustomLabelTheme>('CustomLabel');

  30. return <Text {...styles.label()}>Hello world</Text>;
  31. }

  33. function Example() {
  34. return (
  35.   <ThemeProvider theme={customTheme}>
  36.    <CustomLabel />
  37.   </ThemeProvider>
  38. );
  39. }

  41. render(<Example />);
  42. ```