atom-modal-views/README.md

NPM Package Template

[![Actions Status](https://github.com/UziTech/atom-modal-views/workflows/tests/badge.svg)](https://github.com/UziTech/atom-modal-views/actions)
[![Dependency Status](https://david-dm.org/UziTech/atom-modal-views.svg)](https://david-dm.org/UziTech/atom-modal-views)

# atom-modal-views

Modal Input Views for Atom packages

## InputView

Single line input view

### Usage

```js
const { InputView } = require("atom-modal-views");

const inputView = new InputView({
	title: "Title text",
	description: "Description can use **markdown**",
	placeholder: "placeholder text",
	value: "initial value",
});

const value = await inputView.getInput();
```

![image](https://user-images.githubusercontent.com/97994/114631440-32fc2900-9c82-11eb-92c1-15943fe882cc.png)

### Options

| Name        | Default | Description                                  |
|:------------|:-------:|:---------------------------------------------|
| title       |   `""`  | Title inside `<h1>` tag                      |
| description |   `""`  | Description can contain markdown             |
| placeholder |   `""`  | Placeholder text to show when input is empty |
| value       |   `""`  | The initial value                            |