feat(example): demo site uses all Visor opts

binzcodes · binzcodes · commit 92e7728cf3cb · 2024-10-26T11:48:39.000+01:00
diff --git a/.changeset/shy-peaches-rescue.md b/.changeset/shy-peaches-rescue.md
@@ -0,0 +1,5 @@
+---
+"example-site": patch
+---
+
+Add missing param options to `<Visor />` in Layout
diff --git a/examples/example-site/public/social.png b/examples/example-site/public/social.png
diff --git a/examples/example-site/src/layouts/Layout.astro b/examples/example-site/src/layouts/Layout.astro
@@ -2,12 +2,28 @@
 import {Visor} from '@binz/visor';
 import logoSvgSrc from '../images/Logo.svg';
 
+const SITE_NAME = 'Example Site';
+
 interface Props {
   title: string;
+  description: string;
+  socialImagePath?: string;
+  socialImageAltText?: string;
+  keywords?: string[];
 }
 
-const { title: pageTitle } = Astro.props;
+const {
+  title: pageTitle,
+  description,
+  socialImagePath: socialImage = '/social.png',
+  socialImageAltText = pageTitle,
+  keywords,
+} = Astro.props;
+
 const canonicalUrl = Astro.url;
+
+const title = `${pageTitle} | ${SITE_NAME}`;
+
 ---
 <!doctype html>
 <html lang="en">
@@ -17,13 +33,20 @@ const canonicalUrl = Astro.url;
       twitterHandle: "@joe_blogs"
     }}
     canonicalURL={canonicalUrl}
-    description="Built with visor"
-    defaultKeywords={[]}
+    description={description}
+    defaultKeywords={[ SITE_NAME, 'example' ]}
+    keywords={keywords}
     siteName="Example Site"
     siteFaviconSvg={logoSvgSrc}
-    socialImagePath="/social.jpg"
-    title={pageTitle}
-		pwa
+    siteLocale="en_US"
+    siteTwitterHandle="@example_dot_com"
+    socialImagePath={socialImage}
+    socialImageAltText={socialImageAltText}
+		socialTwitterCardType='summary_large_image'
+    siteThemeColour={'#883aea'}
+		contentType='website'
+    title={title}
+    pwa
   />
 	<body>
 		<slot />
diff --git a/examples/example-site/src/pages/index.astro b/examples/example-site/src/pages/index.astro
@@ -3,7 +3,7 @@ import Layout from '../layouts/Layout.astro';
 import Card from '../components/Card.astro';
 ---
 
-<Layout title="Welcome to Astro.">
+<Layout title="Welcome to Visor." description='Visor demo landing page'>
 	<main>
 		<svg
 			class="astro-a"

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"example-site": patch
 +---
++
 +Add missing param options to `<Visor />` in Layout