Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/igeligel/react-in-out-textarea

A simple React.js User Interface Component that is like Google Translate with full TypeScript Support
https://github.com/igeligel/react-in-out-textarea

component converter converter-app frontend google-translate hacktoberfest hacktoberfest2021 library react storybook textarea typescript ui yarn

Last synced: about 5 hours ago
JSON representation

A simple React.js User Interface Component that is like Google Translate with full TypeScript Support

Host: GitHub
URL: https://github.com/igeligel/react-in-out-textarea
Owner: igeligel
License: mit
Created: 2020-09-14T18:43:12.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2024-04-10T21:40:19.000Z (7 months ago)
Last Synced: 2024-04-14T23:52:25.445Z (7 months ago)
Topics: component, converter, converter-app, frontend, google-translate, hacktoberfest, hacktoberfest2021, library, react, storybook, textarea, typescript, ui, yarn
Language: TypeScript
Homepage:
Size: 2.49 MB
Stars: 31
Watchers: 2
Forks: 22
Open Issues: 14
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # react-in-out-textarea

![](https://img.shields.io/github/license/igeligel/react-in-out-textarea) ![](https://img.shields.io/npm/v/react-in-out-textarea) ![](https://img.shields.io/github/workflow/status/igeligel/react-in-out-textarea/CI)

> A simple React.js component that is like Google Translate

![](./docs/showcase.png)

## Features

react-in-out-textarea is a highly customisable React component, for all of your input and output text needs.

Some of the unique features this component offers include:

- Textarea fields for input and output

- Customisable input and output labels

- Selection of input and output types

- Dropdown to show all your labels when they won't fit on one line

- Fully controllable

- Ability to copy the output text to your clipboard

- Minimalistic, visually pleasing style

- Variable content length

## Used by

- [caseconverter.pro](https://caseconverter.pro/app)

## Mentioned In

- [Hacktoberfest and Open Sourcing a React.js Component](https://www.kevinpeters.net/hacktoberfest-and-open-sourcing-a-react-js-component)

## Installation

  Install via NPM

  ```bash

  npm install --save react-in-out-textarea

  # You might want to install react-tooltip if you activate the max length option

  npm install --save react-tooltip

  ```

  Install via yarn

  ```bash

  yarn add react-in-out-textarea

  # You might want to install react-tooltip if you activate the max length option

  yarn add react-tooltip

  ```

## Props

| Name  | Type | Required |  Description |

| --- | --- | --- | --- |

| inValue  | string  | ✔️ | The value that is shown on the left-handed side. |

| outValue  | string  | ✔️ | The value that is shown on the right-handed side. |

| inOptions | array | ✔️ | An array of options filled with names marked true or false |

| onInInput | function | ✔️ | Called to listen to when the text on the left-hand side changes | ✔️ |

| onInOptionsUpdate | function | ✔️ | Updated with new options as the parameter when inOptions language clicked |

| outOptions | array | ✔️ | An array of options filled with names marked true or false and an activeClicked boolean |

| onOutOptionsUpdate | function | ✔️ | Updated with new options as the parameter when outOptions language clicked |

| maxContentLength | number | ❌  | Value that defines the maximum number of characters allowed in the text area. |

| maxContentLengthIndicator | Object | ❌ | An Object describing how the length indicator is shown. |

| onCopy | function | ❌ | A function that is called when you have copied the content of `InOutTextarea`. |

| autoCloseMenuOnOptionSelection | boolean | ❌ | Boolean that defines whether an option menu should self-close after selection. |

## Usage

 React + TypeScript

[CodeSandbox Example](https://codesandbox.io/s/react-in-out-textarea-typescript-react-egi57?file=/src/ExampleComponent.tsx)

Code Example:

```tsx

import React, { useState } from 'react';

import { InOutTextarea, InOptions, OutOptions } from 'react-in-out-textarea';

export const ExampleComponent = () => {

  const [inValue, setInValue] = useState('');

  const [outValue, setOutValue] = useState('');

  const [inOptions, setInOptions] = useState([

    {

      name: 'English',

      active: true,

    },

    {

      name: 'German',

      active: false,

    },

  ]);

  const [outOptions, setOutOptions] = useState([

    {

      name: 'Chinese',

      active: true,

      activeClicked: false,

    },

  ]);

  return (

     {

        setInValue(newValue);

        setOutValue(newValue);

      }}

      inOptions={inOptions}

      onInOptionsUpdate={(newInOptions) => {

        setInOptions(newInOptions);

      }}

      outOptions={outOptions}

      onOutOptionsUpdate={(newOutOptions) => {

        setOutOptions(newOutOptions);

      }}

    />

  );

};

```

  React + Javascript

  [CodeSandbox Example](https://codesandbox.io/s/react-in-out-textarea-javascript-react-kcl37?file=/src/ExampleComponent.js)

  Code Example:

  ```js

  import React, { useState } from "react";

  import { InOutTextarea } from "react-in-out-textarea";

  export const ExampleComponent = () => {

    const [inValue, setInValue] = useState("");

    const [outValue, setOutValue] = useState("");

    const [inOptions, setInOptions] = useState([

      {

        name: "English",

        active: true

      },

      {

        name: "German",

        active: false

      }

    ]);

    const [outOptions, setOutOptions] = useState([

      {

        name: "Chinese",

        active: true,

        activeClicked: false

      }

    ]);

    return (

       {

          setInValue(newValue);

          setOutValue(newValue);

        }}

        inOptions={inOptions}

        onInOptionsUpdate={(newInOptions) => {

          setInOptions(newInOptions);

        }}

        outOptions={outOptions}

        onOutOptionsUpdate={(newOutOptions) => {

          setOutOptions(newOutOptions);

        }}

      />

    );

  };

  ```

## Development

To start developing you need the following tools installed:

- Node.js version 12 - [Download](https://nodejs.org/en/download/)

- yarn - [Download](https://classic.yarnpkg.com/en/docs/install/#mac-stable)

After installing all the tools, you can install all dependencies by using in your terminal

```bash

yarn

```

After that just type:

```bash

yarn storybook

```

And open http://localhost:6006/. That should give you the storybook preview.

## Storybook

> Storybook is an open source tool for developing UI components in isolation for React, Vue, Angular, and more. It makes building stunning UIs organized and efficient.

[Storybook](https://storybook.js.org/) is a tool used here for easy development of components for the web. Since this project uses React.js, the decision for storybook was kind of easy. It makes the development workflow seamless.

Our stories are saved under the [`./stories`](./stories) directory. Feel free to have a look.

## License

The code is licensed under [MIT](./LICENSE).

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
_{Kevin Peters}
💼 💻 🎨 🚇 🚧 💬 👀

    
_Amber
💻

    
_Katie
💻

    
_chorongbali
💻

    
_{Santosh Viswanatham}
💻 🚇

    
_xen0m29
💻

    
_merelj
💻

  

  

    
_{Tom Scott}
💻 📖

    
_aman601
📖

    
_dasshield
💻

    
_{Aashwin Vaish}
💻

    
_{Thomas Siller}
💻

    
_{Gabrijel Golubić}
📖

    
_{Tom Shamp}
💻

  

  

    
_Bink
💻

    
_{Gabriel Paixão}
💻

    
_rohitgeddam
🔧 💻

    
_{G.H.B.Emalsha Rasad}
🔧 📖

    
_{Emma Dawson}
💻

    
_{Sameer Waskar}
📖

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!