Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

splash-screen-generator

1.0.0 • Public • Published

splash-screen-generator

Generates splash screens for your PWA's!

Installation

$ npm install splash-screen-generator

Usage

const ssg = require('splash-screen-generator')
 
ssg(ssg.formats.ios, {
    // folder where to store the generated files
    destination: './splash',
    
    // Default size of the logo respect with the canvas
    // default .3
    logoScale: .5,
    
    // splash background color
    backgroundColor: '#27BAB4',
    
    // location of the logo
    logo: './logo.png',
    
    // rel: 'apple-touch-startup-image',
    
    rotate: false // defaults to true
  }).then(metaHead => {
    // t.true(Array.isArray(metaHead))
    console.log(metaHead)
  })
  
/*
  ...
  { href: '/splash/i-pad-retina-portrait-768-1024@1x.png',
    media: '(device-width: 768px) and (device-height: 1024px) and (-webkit-device-pixel-ratio: 1) and (orientation: portrait)',
    rel: 'apple-touch-startup-image' },
  ...
]
*/ 

Use it with Nuxt

// nuxt.config.js
module.exports = {
  ...
  head: {
    link: ssg(ssg.formats.ios, {
      destination: './client/static/splash',
      backgroundColor: '#27BAB4',
      logo: './client/static/logo.png',
    })
  }
  ... 
}

TODO

  • Add more formats
  • Add position support for logo

Install

npm i splash-screen-generator

DownloadsWeekly Downloads

0

Version

1.0.0

License

MIT

Unpacked Size

879 kB

Total Files

41

Last publish

Collaborators

  • avatar