Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/levp/sqrup
Surround text with a rectangle and draw attention to it.
https://github.com/levp/sqrup
Last synced: about 1 month ago
JSON representation
Surround text with a rectangle and draw attention to it.
- Host: GitHub
- URL: https://github.com/levp/sqrup
- Owner: levp
- Created: 2018-11-02T15:12:49.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2018-11-04T16:34:32.000Z (about 6 years ago)
- Last Synced: 2024-04-24T20:03:08.432Z (8 months ago)
- Language: TypeScript
- Homepage:
- Size: 21.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sqrup
Surround text with a rectangle and draw attention to it.
```js
const sqrup = require('sqrup');
const result = sqrup('Hello,\nworld!');
console.log(result);
```
Output:
```
************
* Hello, *
* world! *
************
```
## Install
`npm i sqrup`
## API
Function signature:
```js
function sqrup(text, options)
````
With TypeScript types:
```typescript
function sqrup(text: string | string[], options: string | sqrup.SquareUpOptions): string
```
```typescript
type SquareUpOptions = {
default?: string;
// Sides
left?: string;
right?: string;
top?: string;
bottom?: string;
// Corners
topLeft?: string;
topRight?: string;
bottomLeft?: string;
bottomRight?: string;
// Pad
padLeft?: number;
padRight?: number;
padBottom?: number;
padTop?: number;
}
```
Or you can just take a look at the included `index.d.ts` file.
## Examples
### 1. Use custom character
(Instead of the default asterisk `*`)
```js
sqrup('One,\nTwo,\nThree.', 'x');
```
```
xxxxxxxxxxxx
x One, x
x Two, x
x Three. x
xxxxxxxxxxxx
```
### 2. Control the padding between the text and the square
```js
sqrup('WELCOME\n HOME', {
// defaults:
default: 'o', // '*'
padLeft: 8, // 2
padRight: 8, // 2
padTop: 2, // 0
padBottom: 2, // 0
});
```
```
ooooooooooooooooooooooooo
o o
o o
o WELCOME o
o HOME o
o o
o o
ooooooooooooooooooooooooo
```
### 3. Fine grained customization
```js
sqrup('Look Ma,\n I\'m in a box!', {
// default: ...,
// The `default` option does nothing in this specific scenario
// since all of the edge charactrers are specified individually
// in the options at the bottom.
// Pad
padLeft: 8,
padRight: 2,
padBottom: 0,
padTop: 2,
// All of the following options use the character specifeid
// in the `defeault` if not given any value:
// Sides
left: '▶',
right: '◀',
top: '▼',
bottom: '▲',
// Corners
topLeft: '◢',
topRight: '◣',
bottomLeft: '◥',
bottomRight: '◤',
});
```
```
◢▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼◣
▶ ◀
▶ ◀
▶ Look Ma, ◀
▶ I'm in a box! ◀
◥▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲◤
```
## Defaults
```typescript
type SquareUpOptions = {
default?: string; // '*'
// Pad
padLeft?: number; // 2
padRight?: number; // 2
padBottom?: number; // 0
padTop?: number; // 0
// The following 8 options will all use the value of the `default`
// option if they are not explicitly specified.
// Sides
left?: string; // use `default`
right?: string; // use `default`
top?: string; // use `default`
bottom?: string; // use `default`
// Corners
topLeft?: string; // use `default`
topRight?: string; // use `default`
bottomLeft?: string; // use `default`
bottomRight?: string; // use `default`
}
```
## Extra - How to produce the image at the top
```js
sqrup('\u001b[32msqrup\u001b[39m', {
default: '\u001b[33m*\u001b[39m',
// Sides
left: '\u001b[33m⁑\u001b[39m',
right: '\u001b[33m⁑\u001b[39m',
// Pad
padLeft: 6,
padRight: 6,
padBottom: 2,
padTop: 2,
});
```
## License
[ISC](https://opensource.org/licenses/ISC)