Skip to content
Select input component for Ink
Branch: master
Clone or download
Latest commit fc3e7d3 Mar 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
media
src Add optional item key to be specified (#14) Mar 14, 2019
.editorconfig init Aug 9, 2017
.gitattributes
.gitignore
.npmrc init Aug 9, 2017
.travis.yml
license init Aug 9, 2017
package.json
readme.md Add optional item key to be specified (#14) Mar 14, 2019
test.js

readme.md

ink-select-input Build Status

Select input component for Ink

Install

$ npm install ink-select-input

Usage

import React from 'react';
import {render} from 'ink';
import SelectInput from 'ink-select-input';

const Demo = () => {
	const handleSelect = item => {
		// `item` = { label: 'First', value: 'first' }
	};

	const items = [{
		label: 'First',
		value: 'first'
	}, {
		label: 'Second',
		value: 'second'
	}, {
		label: 'Third',
		value: 'third'
	}];

	return <SelectInput items={items} onSelect={handleSelect}/>
};

render(<Demo/>);

Props

items

Type: array
Default: []

Items to display in a list. Each item must be an object and have label and value props, it may also optionally have a key prop. If no key prop is provided, value will be used as the item key.

focus

Type: boolean
Default: true

Listen to user's input. Useful in case there are multiple input components at the same time and input must be "routed" to a specific component.

initialIndex

Type: number Default: 0

Index of initially-selected item in items array.

onSelect

Type: function

Function to call when user selects an item. Item object is passed to that function as an argument.

indicatorComponent

Type: Component

Custom component to override the default indicator component.

itemComponent

Type: Component

Custom component to override the default item component.

limit

Type: number

Number of items to display.

License

MIT © Vadim Demedes

You can’t perform that action at this time.