react-thumbnail-generator
TypeScript icon, indicating that this package has built-in type declarations

3.3.0 • Public • Published

💻 react-thumbnail-generator


Simply create a thumbnail generator for your project 🚀


🌟 CONTRIBUTORS 🌟


Storybook Demo Page

Click on the icon.

Video 📷

Default


Picture


Features 😁

  • Optimized for browsers. Limited availability on mobile.
  • Download thumbnail images
  • Resize the canvas
  • Fill the background with colors or pictures
  • Select a blur effect
  • Select font family, textAlign, size, stroke, color, angle, lineHeight
  • Drag and Drop text on the canvas
  • Add custom web font families
  • Select the modal button and its location
  • Choose the image type (png, jpg, webp, svg)
  • Support TypeScript and Next(v13)

Top Icons Feature

스크린샷 2023-02-27 오후 9 53 09

  • 1: Background Picture
  • 2: Text Align (start, center, end)
  • 2: Background Color
  • 3: Font Color
  • 4: Font Stroke Color
  • 5: Blur Effect

How to use React 😊

STEP 1️⃣

  • Install Package
yarn add react-thumbnail-generator
or
npm install react-thumbnail-generator

STEP 2️⃣

  • Add <ThumbnailGenerator> component.
  • ThumbnailGenerator is automatically rendered as a document.body child by default using Portal.
import ThumbnailGenerator from 'react-thumbnail-generator';
import iconImage from '../assets/colorImage.png';

const App = () => {
  return (
    <ThumbnailGenerator
      iconSize="medium"
      // Through this property, you can specify the size of the button icon.
      // However, if you are inserting a custom button icon, this option is meaningless.

      iconPosition={[0, 20, 20, 0]}
      // Through this property, you can specify the position of the button icon.
      // [top, right, bottom, left]

      modalPosition='right'
      // Through this property, you can specify the position of the thumbnail generator.
      
      additionalFontFamily={['Noto Sans', ...]}
      // You can add the font of your choice to your project, but that font must already applied to your project.

      isFullWidth={true}
      // Setting this property to true will make the thumbnail generator full-width.

      isDefaultOpen={false}
      // Setting this property to true will open the thumbnail generator by default.
    />
  )
}

How to add Web fonts 😊

STEP 1️⃣

  • Add a web font. public/index.html
  • or CSS fontFamily
<!DOCTYPE html>
<html lang="en">
  <head>
    <!-- ... -->
    <!-- Add a web font -->
    <link rel="preconnect" href="https://fonts.googleapis.com" />
    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
    <link
      href="https://fonts.googleapis.com/css2?family=Zeyada&display=swap"
      rel="stylesheet"
    />
  </head>
  <body>
    <div id="root"></div>
  </body>
</html>

STEP 2️⃣

  • Enter font names in array form in the AdditionalFontFamily option
import ThumbnailGenerator from 'react-thumbnail-generator';
import iconImage from '../assets/colorImage.png';

const App = () => {
  return (
    <ThumbnailGenerator 
      additionalFontFamily={["Zeyada"]} // (*)
    />
  )
}

API 📄

  • iconPosition
    • Optional
    • Sequence: [top, right, bottom, left]
    • Default: [0, 20, 20, 0]
    • Type:[number, number, number, number]
  • modalPosition
    • Optional
    • Default: right
    • Type:left | right | center
  • iconSize
    • Optional
    • Default: medium
    • Type: small | medium | large
  • additionalFontFamily
    • Optional
    • Type: string[]
  • isFullWidth
    • Optional
    • Default: false
    • Type: boolean
  • isDefaultOpen
    • Optional
    • Default: false
    • Type: boolean

Reference


Versions

Current Tags

VersionDownloads (Last 7 Days)Tag
3.3.06latest

Version History

VersionDownloads (Last 7 Days)Published
3.3.06
3.2.083
3.1.10
3.1.00
3.0.40
3.0.30
3.0.20
3.0.10
3.0.00
2.10.10
2.10.00
2.9.50
2.9.40
2.9.30
2.9.21
2.9.10
2.9.00
2.8.00
2.7.10
2.7.00
2.6.60
0.2.00
2.6.50
2.6.40
2.6.30
2.6.21
2.6.10
2.6.00
2.5.00
2.4.40
2.4.30
2.4.20
2.4.10
2.4.00
2.3.10
2.3.00
2.2.01
2.1.10
2.0.20
2.0.10
2.0.00
1.2.00
1.1.30
1.1.20
1.1.10
1.1.00
1.0.90
1.0.80
1.0.70
1.0.60
1.0.50
1.0.40
1.0.30
1.0.20
1.0.10
1.0.00
0.1.180
0.1.170
0.1.160
0.1.150
0.1.140
0.1.130
0.1.120
0.1.111
0.1.100
0.1.90
0.1.80
0.1.70
0.1.60
0.1.50
0.1.30
0.1.20
0.1.10

Package Sidebar

Install

npm i react-thumbnail-generator

Weekly Downloads

93

Version

3.3.0

License

MIT

Unpacked Size

827 kB

Total Files

59

Last publish

Collaborators

  • ssi02014