# terminal-io

> A react terminal tool

Latest version **1.0.14** (published 2022-11-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install terminal-io
pnpm add terminal-io
yarn add terminal-io
bun add terminal-io
```

## 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.14 |
| Published | 2022-11-10 |
| First published | 2022-11-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 31.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Salih Kesepara |
| Maintainers | salihkesepara |
| Keywords | terminal, react, terminal.io, tool |

## Links

- npm: https://www.npmjs.com/package/terminal-io
- Repository: https://github.com/salihkesepara/terminal-io
- Homepage: https://salihkesepara.com
- Issues: https://github.com/salihkesepara/terminal-io/issues
- npm.io page: https://npm.io/package/terminal-io

## 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.14 (latest) — 2022-11-10
- 1.0.13 — 2022-11-10

## README

# terminal-io

This is a terminal for React web apps.

## Installation

### 1- Create a new react app

`npx create-react-app my-terminal-project`
`cd my-terminal-project`

### 2- Install terminal-io

`npm i terminal-io` or `yarn add terminal-io`

### 3- Update your body style

```css
/* src/index.css */

body {
  padding: 16px;
  margin: 0;
  background: #211d1b;
}
```

### 4- Add terminal-io into your project

update `App.js` and add these codes

```js
// src/App.js

import "./index.css";
import Terminal from "terminal-io";
import React from "react";

const App = () => {
  const commands = [
    { name: "summary", value: () => <p>This is summary text</p> },
  ];
  return <Terminal commands={commands} />;
};

export default App;
```

### 5- Run the project

`npm run start` or `yarn start`

### 6- Go to localhost server

http://localhost:3000/

## Events

| Event      | Description                             |
| ---------- | :-------------------------------------- |
| onEnter    | When the user presses the enter         |
| onDidMount | When the component install successfully |

## Props

| Prop        | Description                                                                 |
| ----------- | :-------------------------------------------------------------------------- |
| initialData | This data will add the command line automatically when the component loaded |
| commands    | All command list                                                            |

### Demo

https://salihkesepara.com

### Realworl example

https://github.com/salihkesepara/salihkeseparacom

### License

MIT

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