ink-ui

โŒจ๏ธ FooterHints

Wrapped keyboard shortcut hints for interactive screens.

<FooterHints> renders consistent keyboard shortcut help for interactive terminal screens.

import { FooterHints } from "@kud/ink-ui";
import type { Hint } from "@kud/ink-ui";

๐Ÿ”ง Props

PropTypeDescription
hintsHint[]Tuples of key label and meaning

๐Ÿ’ก Examples

<FooterHints
  hints={[
    ["โ†‘โ†“", "navigate"],
    ["โ†ต", "select"],
    ["q", "quit"],
  ]}
/>

On this page