# shareimage > Generate Social Media Preview Images from templates. Latest version **5.1.0** (published 2023-03-18) · MIT license · 0 weekly downloads ## Install ```sh npm install shareimage pnpm add shareimage yarn add shareimage bun add shareimage ``` ## Health **Score 40/100 (D)** — status: abandoned. Positive: has types; esm support; no vulnerabilities; high maintenance score. Warnings: low downloads. Negative: abandoned. ## Facts | | | |---|---| | Version | 5.1.0 | | Published | 2023-03-18 | | First published | 2021-09-09 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 2 | | Unpacked size | 142.3 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 5 | | Author | Zype Inc. | | Maintainers | rmalakar | ## Links - npm: https://www.npmjs.com/package/shareimage - Repository: https://github.com/Zype-Z/ShareImage.js - Homepage: https://github.com/Zype-Z/ShareImage.js#readme - Issues: https://github.com/Zype-Z/ShareImage.js/issues - npm.io page: https://npm.io/package/shareimage ## Dependencies (2) - [canvas](https://npm.io/package/canvas.md) ^2.9.3 - [typescript](https://npm.io/package/typescript.md) ^4.8.3 ## Recent versions - 5.1.0 (latest) — 2023-03-18 - 1.0.0-beta.0 (beta) — 2021-09-09 - 5.0.0 — 2022-12-13 - 1.4.6 — 2021-09-22 - 1.4.5 — 2021-09-22 - 1.4.4 — 2021-09-13 - 1.4.3 — 2021-09-13 - 1.4.2 — 2021-09-13 - 1.4.1 — 2021-09-13 - 1.4.0 — 2021-09-13 - 1.3.3 — 2021-09-11 - 1.3.2 — 2021-09-11 - 1.3.1 — 2021-09-11 - 1.3.0 — 2021-09-11 - 1.2.1 — 2021-09-10 - … 4 more at https://npm.io/package/shareimage/versions ## README # ShareImage ![Card](https://shimg.zype.cf/v1/image?title=Generate%20Social%20Share%20Images%20Dynamically!&cloudName=zype&imagePublicID=ShareImage/Docs-Card) ## Installation There is currently 2 Langauges Supported: **Python** and **Node.js** And there is a **API** available to use with your project! ### API (Beta) The API is currently in beta and may have some issues. The domain of the API is https://shimg.zype.cf/v1 Currently, the V2 of ShareImage is only available for the Node.JS Library (with CommonJS, ESM and TypeScript support) #### Endpoints There is currently only one endpoint available: ##### GET `/image` It needs Query Params in the following format: https://shimg.zype.cf/v1/image?paramName=paramValue The paramaters are as same as **Node.js** Params! ### Python To Install ShareImage in Python with *PIP* Run: ```sh pip install ShareImage ``` ### Node.js To Install ShareImage in Node.js with *NPM* Run: ```sh npm i shareimage --save ``` Or, with *Yarn*: ```sh yarn add shareimage ``` ## Usage Using ShareImage is a bit different across Languages. ### Python Use the Following Code to Generate a Image and print it's URL in Python: ```py from ShareImage import ShareImage image = ShareImage( title = "My Test Image", cloudName = "myCloud", imagePublicId = "myFolder/myImage" ) print(image) ``` ### Node.js Use the Following Code to Generate a Image and output it's URL in Node.js (ES6): ```js import * as ShareImage from 'shareimage'; const image = await ShareImage.generateImage( "/path/to/image.png", "My awesome title", { type: "datauri" } ) console.log(image) ``` ## Parameters There are only 2 Required Parameters and several optional params. ### Required Parameters | Parameter | Type | Description | | :-------------: | :----: | :-------------------------------------------: | | `src` | String | URL/Buffer of the Image | | `title` | String | Title of the Image | ### Optional Parameters #### `output` Object (3rd parameter) | Parameter | Type | Default | Description | | :-------: | :---: | :-----: | :-----------------------------------------------------------------------------------------------------------------------------------------------------: | | `type` | String | `base64` | The format of the output. Can be `buffer`, `datauri`, `base64`, or `file` (Save the file in FS). This option is necessary but comes with default value. | | `options` | Object | `{}` | This option is necessary if `type` is set to `file`. The structure of the `options` Object is `{options: {file: {path: "/file/to/output.png"}}}` | #### `props` Object (4th parameter) | Parameter | Type | Default | Description | | :------------------: | :-----: | :------------------------: | :----------------------------------------------------------------: | | `tagline` | String | None | Tagline of Website or Tags of Post | | `titleFont` |ShareFont| `sirin-stencil` | Font of Title | | `titleExtraConfig` | String | `''` | Extra Title Config | | `taglineExtraConfig` | String | `''` | Extra Config of Tagline | | `taglineFont` |ShareFont| arial | Font of Tagline | | `imageWidth` | Number | 1280 | Width of Image | | `imageHeight` | Number | 669 | Height of Image | | `textAreaWidth` | Number | 760 | Width of TextArea | | `textLeftOffset` | Number | 480 | Left Offset of Text | | `titleGravity` | String | `south_west` | Gravity of Title | | `taglineGravity` | String | `north_west` | Gravity of Tagline | | `titleLeftOffset` | Number | None | Left Offset of Title | | `taglineLeftOffset` | Number | None | Left Offset of Tagline | | `titleBottomOffset` | Number | 254 | Bottom Offset of Title | | `taglineTopOffset` | Number | 445 | Top Offset of Tagline | | `textColor` | String | `000000` | Color of Text | | `titleColor` | String | None | Color of Title (If not provided `textColor` will be used instead | | `taglineColor` | String | None | Color of Tagline (If not provided `textColor` will be used instead | | `titleFontSize` | Number | 64 | Font Size of Title | | `taglineFontSize` | Number | 48 | Font Size of Tagline | **Note**: If you don't provide Tagline, Parameters with `tagline` Prefix will be ignored. We may add more Customization to **ShareImage** in the Future. ## Sponsors We have been sponsored by **Vercel**, **MacStadium**. Vercel gave us free **Pro Plan** access to host the documentation and other websites. MacStadium gave us free **Mac Mini Server** to host the API and for builds. [![Powered By Vercel](https://res.cloudinary.com/zype/image/upload/ShareImage/powered-by-vercel.png)](https://vercel.com/?utm_source=zypeoss&utm_campaign=oss) --- _Source: https://npm.io/package/shareimage · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._