JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 307804
  • Score
    100M100P100Q182022F
  • License MIT

Text input component for Ink

Package Exports

  • ink-text-input

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ink-text-input) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ink-text-input Build Status

Text input component for Ink.

Install

$ npm install --save ink-text-input

Usage

const {h, Component} = require('ink');
const TextInput = require('ink-text-input');

class SearchQuery extends Component {
    constructor() {
        super();

        this.state = {
            query: ''
        };

        this.handleChange = this.handleChange.bind(this);
        this.handleSubmit = this.handleSubmit.bind(this);
    }

    render(props, state) {
        return (
            <div>
                Enter your query:

                <TextInput
                    value={state.query}
                    onChange={this.handleChange}
                    onSubmit={this.handleSubmit}
                />
            </div>
        );
    }

    handleChange(value) {
        this.setState({
            query: value
        });
    }

    handleSubmit(value) {
        // query submitted
    }
}

mount(<SearchQuery/>);

Note: For <TextInput> to be able to receive keypress events, process.stdin must be in raw mode. As a result, default behavior like Ctrl+C is disabled, so you must handle that manually.

Use this snippet to enable keypress events:

readline.emitKeypressEvents(process.stdin);
process.stdin.setRawMode(true);

Props

value

Type: string

Value to display in a text input.

placeholder

Type: string

Text to display when value is empty.

onChange

Type: function

Function to call when value updates.

onSubmit

Type: function

Function to call when user presses Enter.

License

MIT © Vadim Demedes