A collection of common interactive command line user interfaces.
type Theme, makeTheme)message option isn't transformed by the core anymore - options are now passed through as-is to the prompt.usePagination now requires pageSize to be passed in. The size of the pages should inform the help shown on the screen, and keeping this information in 2 areas leave a change the default value will mistmatch.New features!
required prompt config. Makes sure at least one choice is selected.validate prompt config. Provide a function that'll validate the user selection with any logic you want (like enforcing a min or max selection amount.) Please use this config with parsimony since complicated validation scheme can lead to sub-optimal UX!loop: false option. (This feature was available on inquirer, but not ported to new prompts yet)loop: false option. (This feature was available on inquirer, but not ported to new prompts yet)useMemo hook.useEffect body. See #1307validate config; but it was rarely used. It's been removed and prompts relying on it are expected to handle it on their own (no default value.) The types were updated accordingly and will raise issue if you're using typescript.AsyncPromptConfig, it's been deprecated in favour of PromptConfig
- import type { AsyncPromptConfig } from '@inquirer/core';
+ import type { PromptConfig } from '@inquirer/core';
- type Config = AsyncPromptConfig & { custom: 'value' };
+ type Config = PromptConfig<{ custom: 'value' }>;
Note: Old interface works for now, but is marked as deprecated.