https://github.com/simonleclere/placeholder-img-generator
A nodeJS placeholder image generator. Uses canvas & nice-color-palette.
https://github.com/simonleclere/placeholder-img-generator
Last synced: 2 months ago
JSON representation
A nodeJS placeholder image generator. Uses canvas & nice-color-palette.
- Host: GitHub
- URL: https://github.com/simonleclere/placeholder-img-generator
- Owner: SimonLeclere
- Created: 2020-09-25T17:03:02.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-10-04T17:37:14.000Z (over 3 years ago)
- Last Synced: 2024-04-23T14:43:54.296Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 1.6 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Welcome to placeholder-img-generator 👋
A simple nodeJS module for creating placeholders images using canvas.
https://www.npmjs.com/package/placeholder-img-generator
## Install
```sh
npm i placeholder-img-generator
```
## Usage
* ### braids(options)
Allows you to generate a placeholder made up of several ribbons that intersect with pretty shadows. Code adapted from [this article](http://rectangleworld.com/blog/archives/733)
Options :
```js
{
width: Number,
height: Number,
bgColor: String,
crossingProbability: Number,
stringThickness: Number
}
```
Example :
```js
const fs = require('fs')
const generator = require('placeholder-img-generator');
generator.braids().then((buffer) => {
fs.writeFile(`./braids.png`, buffer, () => {
console.log('finished generating!')
});
})
```
* ### cellularAutomata(options)
Allows to generate a placeholder formed by a pattern of several squares of colors. Code adapted from [generativeartistry.com](https://generativeartistry.com/)
Options :
```js
{
width: Number,
height: Number,
colors: Array,
}
```
Example :
```js
const fs = require('fs')
const generator = require('placeholder-img-generator');
generator.cellularAutomata().then((buffer) => {
fs.writeFile(`./cellularAutomata.png`, buffer, () => {
console.log('finished generating!')
});
})
```
* ### circlePacking(options)
Generates a placeholder formed by a pattern of several circles. Code adapted from [generativeartistry.com](https://generativeartistry.com/)
Options :
```js
{
width: Number,
height: Number,
colors: Array
}
```
Example :
```js
const fs = require('fs')
const generator = require('placeholder-img-generator');
generator.circlePacking().then((buffer) => {
fs.writeFile(`./circlePacking.png`, buffer, () => {
console.log('finished generating!')
});
})
```
* ### color(options)
generates an image of a solid color drawn at random.
Options :
```js
{
width: Number,
height: Number,
color: String
}
```
Example :
```js
const generator = require('placeholder-img-generator');
generator.color().then((buffer) => {
fs.writeFile(`./color.png`, buffer, () => {
console.log('finished generating!')
});
})
```
* ### cubicDisarray(options)
Generates a placeholder formed by several squares in disorder. Code adapted from [generativeartistry.com](https://generativeartistry.com/)
Options :
```js
{
width: Number,
height: Number,
colors: Array
}
```
Example :
```js
const generator = require('placeholder-img-generator');
generator.cubicDisarray().then((buffer) => {
fs.writeFile(`./cubicDisarray.png`, buffer, () => {
console.log('finished generating!')
});
})
```
* ### gradient(options)
Generates a cool gradient placeholder
Options :
```js
{
width: Number,
height: Number,
}
```
Example :
```js
const generator = require('placeholder-img-generator');
generator.gradient().then((buffer) => {
fs.writeFile(`./gradient.png`, buffer, () => {
console.log('finished generating!')
});
})
```
* ### hypnoticSquares(options)
Generates a cool placeholder with hypnotic squares.
Options :
```js
{
width: Number,
height: Number,
colors: Array
}
```
Example :
```js
const generator = require('placeholder-img-generator');
generator.hypnoticSquares().then((buffer) => {
fs.writeFile(`./hypnoticSquares.png`, buffer, () => {
console.log('finished generating!')
});
})
```
* ### joyDivision(options)
Generates a placeholder composed of several small randomly generated waves. Code adapted from [generativeartistry.com](https://generativeartistry.com/)
Options :
```js
{
width: Number,
height: Number,
colors: Array
}
```
Example :
```js
const generator = require('placeholder-img-generator');
generator.joyDivision().then((buffer) => {
fs.writeFile(`./joyDivision.png`, buffer, () => {
console.log('finished generating!')
});
})
```
* ### matrix(options)
Generates a placeholder composed of several green characters cascades as in the film matrix.
Options :
```js
{
width: Number,
height: Number,
}
```
Example :
```js
const generator = require('placeholder-img-generator');
generator.matrix().then((buffer) => {
fs.writeFile(`./matrix.png`, buffer, () => {
console.log('finished generating!')
});
})
```
* ### mondrian(options)
Generates a placeholder looking like Mondrian's works. Code adapted from [generativeartistry.com](https://generativeartistry.com/)
Options :
```js
{
width: Number,
height: Number,
colors: Array
}
```
Example :
```js
const generator = require('placeholder-img-generator');
generator.mondrian().then((buffer) => {
fs.writeFile(`./mondrian.png`, buffer, () => {
console.log('finished generating!')
});
})
```
* ### noise(options)
Generates an image filled with digital noise
Options :
```js
{
width: Number,
height: Number,
opacity: Number
}
```
Example :
```js
const generator = require('placeholder-img-generator');
generator.noise().then((buffer) => {
fs.writeFile(`./noise.png`, buffer, () => {
console.log('finished generating!')
});
})
```
* ### pollock(options)
Generates a placeholder looking like Pollock's work. Code inspired by [@curator_machine](https://twitter.com/curator_machine)
Options :
```js
{
width: Number,
height: Number,
}
```
Example :
```js
const generator = require('placeholder-img-generator');
generator.pollock().then((buffer) => {
fs.writeFile(`./pollock.png`, buffer, () => {
console.log('finished generating!')
});
})
```
* ### tiledLines(options)
Generates a placeholder composed of several lines forming a kind of random maze. Code adapted from [generativeartistry.com](https://generativeartistry.com/)
Options :
```js
{
width: Number,
height: Number,
colors: Array
}
```
Example :
```js
const generator = require('placeholder-img-generator');
generator.tiledLines().then((buffer) => {
fs.writeFile(`./tiledLines.png`, buffer, () => {
console.log('finished generating!')
});
})
```
* ### triangularMesh(options)
Generates a placeholder composed of triangles that together form a patern. Code adapted from [generativeartistry.com](https://generativeartistry.com/)
Options :
```js
{
width: Number,
height: Number,
gap: Number,
colors: Array
}
```
Example :
```js
const generator = require('placeholder-img-generator');
generator.triangularMesh().then((buffer) => {
fs.writeFile(`./triangularMesh.png`, buffer, () => {
console.log('finished generating!')
});
})
```
* ### unDeuxTrois(options)
Generates a placeholder composed of more or less organized lines. Code adapted from [generativeartistry.com](https://generativeartistry.com/)
Options :
```js
{
width: Number,
height: Number,
colors: Array
}
```
Example :
```js
const generator = require('placeholder-img-generator');
generator.unDeuxTrois().then((buffer) => {
fs.writeFile(`./unDeuxTrois.png`, buffer, () => {
console.log('finished generating!')
});
})
```
## Author
👤 **Simon Leclere**
* Github: [@SimonLeclere](https://github.com/SimonLeclere)
## 🤝 Contributors
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/SimonLeclere/Quora-Data-Scraper/issues).
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Copyright © 2020 [Simon Leclere](https://github.com/SimonLeclere).
This project is [MIT](https://github.com/SimonLeclere/placeholder-img-generator/blob/master/LICENSE) licensed.
***
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_