# blessed-circle

> Draw a circle in your terminal using blessed.

Latest version **1.0.0** (published 2017-04-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install blessed-circle
pnpm add blessed-circle
yarn add blessed-circle
bun add blessed-circle
```

## 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 | 2017-04-22 |
| First published | 2017-04-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | MatthieuLemoine |
| Maintainers | matthieulemoine |
| Keywords | circle, blessed, terminal |

## Links

- npm: https://www.npmjs.com/package/blessed-circle
- Repository: https://github.com/MatthieuLemoine/blessed-circle
- Homepage: https://github.com/MatthieuLemoine/blessed-circle#readme
- Issues: https://github.com/MatthieuLemoine/blessed-circle/issues
- npm.io page: https://npm.io/package/blessed-circle

## Dependencies (1)

- [drawille-canvas-blessed-contrib](https://npm.io/package/drawille-canvas-blessed-contrib.md) ^0.1.3

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2017-04-22
- 0.0.1 — 2017-04-22

## README

# blessed-circle

:art: Draw a circle or a disk in your terminal using [blessed](https://github.com/chjj/blessed).

![Circle](examples/circle.png)
![Disk](examples/disk.png)

## Install

```
npm i -S blessed-circle
```

You also need to have blessed installed locally as it's a peerDependency.

## Usage

```javascript
// Create blessed screen
const screen = blessed.screen();

const circle = new Circle({
  top      : 'center',
  left     : 'center',
  diameter : 100,
  color    : 'white',
});

// Disk
const disk = new Circle({
  top      : 'center',
  left     : 'center',
  diameter : 100,
  color    : 'white',
  fill     : true,
});
```

## API

- ```new Circle(opts)```
  - ```diameter``` : circle size
  - ```color```    : circle color
  - ```fill```     : flag to draw a disk instead of a circle
  - All ```blessed.Element``` [properties](https://github.com/chjj/blessed#element-from-node)


## Credits

- [blessed](https://github.com/chjj/blessed)
- [blessed-contrib](https://github.com/yaronn/blessed-contrib#donut) and its donut widget

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