# @overbool/poster

> A beautiful canvas poster

Latest version **1.0.1** (published 2018-10-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install @overbool/poster
pnpm add @overbool/poster
yarn add @overbool/poster
bun add @overbool/poster
```

## 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.1 |
| Published | 2018-10-12 |
| First published | 2018-10-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 3.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Overbool |
| Maintainers | overbool |
| Keywords | canvas, poster, gulp, js, javascript |

## Links

- npm: https://www.npmjs.com/package/@overbool/poster
- Homepage: https://github.com/overbool/poster
- npm.io page: https://npm.io/package/@overbool/poster

## Dependencies (8)

- [gulp](https://npm.io/package/gulp.md) ^3.9.1
- [@babel/core](https://npm.io/package/@babel/core.md) ^7.1.2
- [gulp-concat](https://npm.io/package/gulp-concat.md) ^2.6.1
- [gulp-header](https://npm.io/package/gulp-header.md) ^2.0.5
- [gulp-uglify](https://npm.io/package/gulp-uglify.md) ^3.0.1
- [@babel/register](https://npm.io/package/@babel/register.md) ^7.0.0
- [@babel/preset-env](https://npm.io/package/@babel/preset-env.md) ^7.1.0
- [@babel/preset-es2015](https://npm.io/package/@babel/preset-es2015.md) ^7.0.0-beta.53

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.0.1 (latest) — 2018-10-12
- 1.0.0 — 2018-10-12

## README

# Poster

Poster is a standalone JavaScript poster-generating micro-library. [Check out a Demo](https://overbool.github.io/poster/).

![screenshot](https://raw.githubusercontent.com/overbool/poster/master/images/screenshot.png)

## Quick start

Several quick start options are available:

* Clone the repo: git clone https://github.com/overbool/poster.git
* Install with npm: npm install poster

## What's included

```
./
├── LICENSE
├── README.md
├── dist
│   ├── poster.js
│   └── poster.min.js
├── gulpfile.babel.js
├── images
│   ├── dream.png
│   ├── home.jpg
│   └── mountain.jpg
├── index.html
├── package.json
└── src
    └── poster.js
```

## Usage

Using Poster is simple.

```js
// html
<div class="poster"></div>

// js
poster.init({
  banner: './images/dream.png',
  selector: '.poster',
  title: '...',
  content: '...',
  logo: '...',
  description: '...',
  callback: function(container) {...}
})
```

More config:

```js
// html
<div class="poster"></div>

// js
poster.init({
    banner: './images/mountain.jpg',
    selector: '.poster',
    title: '...',
    titleStyle: {
      font: 'bold italic 50px Arial',
      color: 'rgba(66, 66, 66, 1)'
    },
    content: '...',
    contentStyle: {
      font: 'italic 24px Arial',
      lineHeight: 1.2,
      position: 'center',
      color: 'rgba(88, 88, 88, 1)'
    },
    logo: '...',
    logoStyle: {
      color: 'rgba(0, 0, 120, 1)'
    },
    description: '...',
    callback: function(container) {...}
  })
```

## License
[MIT license](./LICENSE)

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