Skip to content

A Svelte component that accepts props for common meta tags that allows overriding metadata specifically for Open Graph & Twitter sharing.

Notifications You must be signed in to change notification settings

jessebenjamin1/svelte-seo-component

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 

Repository files navigation

Svelte SEO Component

This is a component which can be used to set common meta tags in the head of pages in a Svelte app.

You can set a default title, description, and image in the component itself. When using the component. It is recommended to always pass title and description as props to avoid duplicate titles and metadescriptions. These props will set title & description meta tags, as well as associated Open Graph & Twitter tags.

This component also accepts Open Graph- & Twitter-specific props that will override the generic title and description values if passed.

The logic of the component assumes that the default value for image and alt are set for a global default sharing image. I recommend adding your default share image to the static folder in Sveltekit projects - that's why all of the image props include static in their path.

Here's an example of a very standard instance of the component, assuming that all of the default values have been changed to be relevant to the project:

<SEO
	title="About Page | MDSvex Starter Blog"
	description="This is a starter Sveltekit blog with support for MDSvex & image optimisation via Vite ImageTools."
	slug="/about/"
/>

If you really wanted to, you could have different titles, descriptions, and images for Search Engines, Facebook, and Twitter 🤷 Here's what that would look like:

<SEO
	title="Manually Set Title | Website Name"
	ogTitle="Facebook Title | Website Name"
	twitterTitle="Twitter Title | Website Name"
	description="I'm a manually set meta description."
	ogDescription="I will override the og:description tag."
	twitterDescription="I will override the twitter:description tag."
	image="/static/iWillSetOgAndTwitterImageTags.jpg"
	ogImage="/static/iWillOverrideOgImageTag.jpg"
	ogImageAlt="manual alt text for OG image"
	twitterImage="/static/iWillOverrideTwitterImageTag.jpg"
	twitterImageAlt="manual alt text for Twitter image"
	slug="/"
/>

About

A Svelte component that accepts props for common meta tags that allows overriding metadata specifically for Open Graph & Twitter sharing.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages