Add splash screen for iOS PWA

2026-02-14 03:26:13 +01:00 · 2024-02-04 11:17:53 -05:00
parent 6dd631b03a
commit 10fd69404a
2 changed files with 100 additions and 0 deletions
--- a/src/app/apple-pwa-splash.tsx
+++ b/src/app/apple-pwa-splash.tsx
@@ -0,0 +1,98 @@
+'use client'
+import { useEffect } from 'react'
+
+export function ApplePwaSplash({
+  icon,
+  color,
+}: {
+  icon: string
+  color?: string
+}) {
+  useEffect(() => {
+    iosPWASplash(icon, color)
+  }, [icon, color])
+
+  return null
+}
+
+/*!
+ * ios-pwa-splash <https://github.com/avadhesh18/iosPWASplash>
+ *
+ * Copyright (c) 2023, Avadhesh B.
+ * Released under the MIT License.
+ */
+function iosPWASplash(icon: string, color = 'white') {
+  // Check if the provided 'icon' is a valid URL
+  if (typeof icon !== 'string' || icon.length === 0) {
+    throw new Error('Invalid icon URL provided')
+  }
+
+  // Calculate the device's width and height
+  const deviceWidth = screen.width
+  const deviceHeight = screen.height
+  // Calculate the pixel ratio
+  const pixelRatio = window.devicePixelRatio || 1
+  // Create two canvases and get their contexts to draw landscape and portrait splash screens.
+  const canvas = document.createElement('canvas')
+  const canvas2 = document.createElement('canvas')
+  const ctx = canvas.getContext('2d')!
+  const ctx2 = canvas2.getContext('2d')!
+
+  // Create an image element for the icon
+  const iconImage = new Image()
+
+  iconImage.onerror = function () {
+    throw new Error('Failed to load icon image')
+  }
+
+  iconImage.src = icon
+  // Load the icon image, make sure it is served from the same domain (ideal size 512pxX512px). If not then set the proper CORS headers on the image and uncomment the next line.
+  //iconImage.crossOrigin="anonymous"
+  iconImage.onload = function () {
+    // Calculate the icon size based on the device's pixel ratio
+    const iconSizew = iconImage.width / (3 / pixelRatio)
+    const iconSizeh = iconImage.height / (3 / pixelRatio)
+
+    canvas.width = deviceWidth * pixelRatio
+    canvas2.height = canvas.width
+    canvas.height = deviceHeight * pixelRatio
+    canvas2.width = canvas.height
+    ctx.fillStyle = color
+    ctx2.fillStyle = color
+    ctx.fillRect(0, 0, canvas.width, canvas.height)
+    ctx2.fillRect(0, 0, canvas2.width, canvas2.height)
+
+    // Calculate the position to center the icon
+    const x = (canvas.width - iconSizew) / 2
+    const y = (canvas.height - iconSizeh) / 2
+    const x2 = (canvas2.width - iconSizew) / 2
+    const y2 = (canvas2.height - iconSizeh) / 2
+    // Draw the icon with the calculated size
+    ctx.drawImage(iconImage, x, y, iconSizew, iconSizeh)
+    ctx2.drawImage(iconImage, x2, y2, iconSizew, iconSizeh)
+    const imageDataURL = canvas.toDataURL('image/png')
+    const imageDataURL2 = canvas2.toDataURL('image/png')
+
+    // Create the first startup image <link> tag (splash screen)
+
+    const appleTouchStartupImageLink = document.createElement('link')
+    appleTouchStartupImageLink.setAttribute('rel', 'apple-touch-startup-image')
+    appleTouchStartupImageLink.setAttribute(
+      'media',
+      'screen and (orientation: portrait)',
+    )
+    appleTouchStartupImageLink.setAttribute('href', imageDataURL)
+    document.head.appendChild(appleTouchStartupImageLink)
+
+    // Create the second startup image <link> tag (splash screen)
+
+    const appleTouchStartupImageLink2 = document.createElement('link')
+    appleTouchStartupImageLink2.setAttribute('rel', 'apple-touch-startup-image')
+    appleTouchStartupImageLink2.setAttribute(
+      'media',
+      'screen and (orientation: landscape)',
+    )
+    appleTouchStartupImageLink2.setAttribute('href', imageDataURL2)
+    document.head.appendChild(appleTouchStartupImageLink2)
+  }
+}
--- a/src/app/layout.tsx
+++ b/src/app/layout.tsx
@@ -1,3 +1,4 @@
+import { ApplePwaSplash } from '@/app/apple-pwa-splash'
 import { ProgressBar } from '@/components/progress-bar'
 import { ThemeProvider } from '@/components/theme-provider'
 import { ThemeToggle } from '@/components/theme-toggle'
@@ -65,6 +66,7 @@ export default function RootLayout({
 }) {
  return (
    <html lang="en" suppressHydrationWarning>
+      <ApplePwaSplash icon="/logo-with-text.png" color="#027756" />
      <body className="pt-16 min-h-[100dvh] flex flex-col items-stretch bg-slate-50 bg-opacity-30 dark:bg-background">
        <ThemeProvider
          attribute="class"