Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/makinox/makinox-image-creator
An image creator
https://github.com/makinox/makinox-image-creator
creator image library typescript
Last synced: 21 days ago
JSON representation
An image creator
- Host: GitHub
- URL: https://github.com/makinox/makinox-image-creator
- Owner: makinox
- Created: 2021-06-19T21:54:47.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-07-14T01:51:14.000Z (over 2 years ago)
- Last Synced: 2024-04-15T02:18:42.833Z (9 months ago)
- Topics: creator, image, library, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@makinox/image-creator
- Size: 147 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @makinox/image-creator
A library to create images.
## Used
- Typescript
Link to [image-creator!](https://image-creator.jesusbossa.dev/)
## Example
```ts
import CreateImage from './script/creation';
CreateImage({ filePath: './test.png', extraLogo: './src/assets/B.svg' }).then((created) => console.log({ created }));
```
## Create image options
### width
> Change canvas width
Type: `number`
Default: `1200`
### height
> Change canvas height
Type: `number`
Default: `1200`
### backgroundColor
> Change canvas background color
Type: `string | CanvasGradient | CanvasPattern`
Default: `#000`
### titleFontStyle
> Change properties of the title
Type: `string`
Default: `bold 70pt Open Sans`
### textAlign
> Change the alignment of the canvas texts
Type: `CanvasTextAlign`
Default: `center`
### textTitle
> Change the title of the canvas
Type: `string`
Default: `Hello, World!`
### titleFillStyle
> Change color of the title background
Type: `string | CanvasGradient | CanvasPattern`
Default: `#047788`
### titleColor
> Change color of the title
Type: `string | CanvasGradient | CanvasPattern`
Default: `#fff`
### subTextColor
> Change color of the sub text
Type: `string | CanvasGradient | CanvasPattern`
Default: `#fff`
### subTextFontStyle
> Change properties of the sub text
Type: `string`
Default: `bold 30pt Open sans`
### subText
> Change the sub text
Type: `string`
Default: `image-creator.jesusbossa.dev`
### extraLogo
> Set a logo
Type: `string`
### filePath
> Set the path of the created file
Type: `string`
## Available Scripts
In the project directory, you can run:
### `yarn start`
Runs the app in the development mode.