https://github.com/matthieulemoine/blessed-circle

:art: Draw a circle in your terminal using blessed.
https://github.com/matthieulemoine/blessed-circle

blessed nodejs terminal

Last synced: 2 months ago
JSON representation

:art: Draw a circle in your terminal using blessed.

• Host: GitHub
• URL: https://github.com/matthieulemoine/blessed-circle
• Owner: MatthieuLemoine
• Created: 2017-04-22T17:25:39.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-04-22T19:18:34.000Z (about 9 years ago)
• Last Synced: 2025-06-07T06:19:04.292Z (about 1 year ago)
• Topics: blessed, nodejs, terminal
• Language: JavaScript
• Homepage:
• Size: 71.3 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

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

const Circle = require('blessed-circle');

// 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