ink-divider/README.md

Divider component for Ink

<!-- # ${\color{gray}\tiny\textrm{──────}}$  ink-divider  ${\color{gray}\tiny\textrm{──────}}$ -->
# ink-divider

[![NPM Downloads](https://img.shields.io/npm/dw/ink-divider?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iMjRweCIgdmlld0JveD0iMCAtOTYwIDk2MCA5NjAiIHdpZHRoPSIyNHB4IiBmaWxsPSIjMDAwMDAwIj48cGF0aCBkPSJNNDgwLTMyMCAyODAtNTIwbDU2LTU4IDEwNCAxMDR2LTMyNmg4MHYzMjZsMTA0LTEwNCA1NiA1OC0yMDAgMjAwWk0xNjAtMTYwdi0yMDBoODB2MTIwaDQ4MHYtMTIwaDgwdjIwMEgxNjBaIi8%2BPC9zdmc%2B&labelColor=FAFAFA&color=212121)](https://www.npmjs.com/package/ink-divider) [![NPM Version](https://img.shields.io/npm/v/ink-divider?logo=npm&logoColor=212121&label=version&labelColor=FAFAFA&color=212121)](https://www.npmjs.com/package/ink-divider)


👩🏼‍🎨 Divider component for [Ink](https://github.com/vadimdemedes/ink).

## 📥 Install

```bash
npm i ink-divider
```

## 🚀 Usage

Here is the basic usage:

```jsx
import { render } from 'ink'
import Divider from 'ink-divider'

render(<Divider title='Title' />)

// ─────────── Title ───────────
```

The `<Divider>` component can also automatically adjust to the width of the container!
We advise you to view this example - [`examples/auto-grow.tsx`](https://github.com/JureSotosek/ink-divider/blob/master/examples/auto-grow.tsx), more examples in the [`examples`](https://github.com/JureSotosek/ink-divider/tree/master/examples) folder

<!-- markdownlint-disable-next-line-->
<img src="media/example.png" alt="example" width="550">

## 🤝 Contributing

Thank you for your interest in helping this project 😎, detailed instructions on contributing are at [CONTRIBUTING.md](CONTRIBUTING.md)

## 📝 License

MIT © [Jure Sotosek](https://github.com/JureSotosek)