# @reason-ink/ink-text-input

Latest version **1.0.0** (published 2020-05-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @reason-ink/ink-text-input
pnpm add @reason-ink/ink-text-input
yarn add @reason-ink/ink-text-input
bun add @reason-ink/ink-text-input
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2020-05-21 |
| First published | 2020-05-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 65 |
| Author | Hyeseong Kim |
| Maintainers | cometkim |
| Keywords | reasonml, react, ink, cli |

## Links

- npm: https://www.npmjs.com/package/@reason-ink/ink-text-input
- Repository: https://github.com/cometkim/reason-ink
- Homepage: https://github.com/cometkim/reason-ink#readme
- Issues: https://github.com/cometkim/reason-ink/issues
- npm.io page: https://npm.io/package/@reason-ink/ink-text-input

## Dependencies (1)

- [ink-text-input](https://npm.io/package/ink-text-input.md) ^3.2.2

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2020-05-21

## README

# ReScript Ink

[![npm](https://img.shields.io/npm/v/rescript-ink)](https://www.npmjs.com/package/rescript-ink)
[![license](https://img.shields.io/github/license/cometkim/rescript-ink)](#license)

[ReScript](https://rescript-lang.org) bindings for [Ink](https://github.com/vadimdemedes/ink)

Let's build interactive & sound CLI with React and ReScript!

## Features

### Core

Core:

- [x] render
- [x] ref & measureElement

Components:

- [x] Box
- [x] Text
- [x] Newline
- [x] Spacer
- [x] Static
- [x] Transform

Hooks:

- [x] useApp
- [x] useInput
- [x] useFocus
- [x] useFocusManager
- [x] useStdin
- [x] useStdout
- [x] useStderr

Do you find any missing APIs? [Let me know](https://github.com/cometkim/rescript-ink/issues/new)!

### :dancers: Community components bindings

- [@rescript-ink/ink-big-text](./packages/ink-big-text) ([ink-big-text](https://github.com/sindresorhus/ink-big-text))
- [@rescript-ink/ink-spinner](./packages/ink-spinner) ([ink-spinner](https://github.com/vadimdemedes/ink-spinner))
- [@rescript-ink/ink-text-input](./packages/ink-text-input) ([ink-text-iput](https://github.com/vadimdemedes/ink-text-input))
- [@rescript-ink/ink-link](./packages/ink-link) ([ink-link](https://github.com/sindresorhus/ink-link))

## Requirements

- Ink v3.0.0 or higher
- ReScript v9.1.0 or higher

## Install

```bash
yarn add rescript-ink @rescript/react \
  # You can install additional community bindings \
  @reason-ink/ink-big-text
```

Add it to your `bsconfig.json`

```diff
  "bs-dependencies": [
+   "rescript-ink",
+   "@rescript/react",
+   "@reason-ink/ink-big-text
  ]
```

## Example

```res
open Ink;

// Community bindings have `InkCommunity_` prefix.
module BigText = InkCommunity_BigText;

module App = {
  @react.component
  let make = () => {
    <Box display=#flex justifyContent=#center>
      <BigText text="Hello, Reason-Ink!"/>
    </Box>
  };
};

let {waitUntilExit} = render(<App />, ~exitOnCtrlC=true, ());
waitUntilExit()->ignore;
```

See more in [examples](./examples)

## Contributing

Any feedbacks & contributions are welcome!

See more details in [CONTRIBUTING](./CONTRIBUTING.md)

## License

MIT

---
_Source: https://npm.io/package/@reason-ink/ink-text-input · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
