svead
svead copied to clipboard
spences10
Svead 🍺, a component that allows you to set head meta information, canonical, title, Twitter and Facebook Open Graph tags, and schema.org data.
Svead - Svelte Head Component
Svead, a component that allows you to set head meta information, canonical, title, Twitter and Facebook Open Graph tags.
Also supports JSON-LD for SEO.
Props
It takes the following props:
| Prop | Type | Description | Required |
|---|---|---|---|
| url | string | Full URL of the current page | Yes |
| title | string | Page title | Yes |
| description | string | Page description | Yes |
| website | string | Website URL | Optional |
| authorName | string | Author name | Optional |
| image | string | Open Graph image URL | Optional |
| paymentPointer | string | Web Monetization payment pointer | Optional |
| datePublished | string | Date published in ISO 8601 format | Optional |
| dateModified | string | Date modified in ISO 8601 format | Optional |
| contentType | MainEntityType | Content type of the page | Optional |
| language | string | Language of the page | Optional |
Use it
npm install svead
Import it into your Svelte pages and use:
<script>
import { page } from '$app/stores';
import { Head } from 'svead';
let title = 'This is Svead a Svelte Head Component';
let description =
'Svead, a component that allows you to set head meta information, canonical, title, Twitter and Facebook Open Graph tags.';
let url = $page.url.toString();
</script>
<Head {title} {description} {image} {url} />
Managing the lang Attribute in app.html
The lang attribute in your SvelteKit application is crucial for
specifying the primary language of your content. This attribute is
essential for accessibility and SEO, as it helps search engines and
assistive technologies understand the language of your text.
Default Language Setting
Typically, the lang attribute is set in the app.html file of your
SvelteKit project. Here's a typical example:
<!doctype html>
<html lang="en">
<!-- ... other tags ... -->
</html>
In this snippet, lang="en" sets the language of the document to
English.
Customizing the Language
To customize the language for your application:
-
Static Setting: If your site is primarily in one language, simply replace the
eninlang="en"with the appropriate language code (e.g.,frfor French). -
Dynamic Setting: If your site supports multiple languages and you need to change the language dynamically based on user preferences or other criteria, you'll need to handle this at the server level or through client-side scripting. Here are some strategies:
- Server-Side Rendering (SSR): Adapt your SSR setup to insert the
correct
langattribute based on the request's context or user settings. - Client-Side Script: Use client-side JavaScript to set
document.documentElement.langbased on user interaction or other indicators. This method is less preferred due to potential SEO and user experience implications.
Note on svead Usage
The svead package is designed to enhance your application's SEO and
accessibility through structured data and other optimizations.
However, managing the lang attribute in the app.html file is
outside the scope of svead. As such, you'll need to manage this
attribute as part of your general SvelteKit application setup.
Following the best practices for setting the lang attribute will
complement the enhancements provided by svead.
Packaging for NPM
Scott, this is here for you to remember how to do this 🙃
Although I detailed this in Making npm Packages with SvelteKit I think it's best to put it here as I always come to the README and the instructions are never there! 😅
Publish the project to NPM
# authenticate with npm
npm login
# bump version with npm
npm version 0.0.8
# package with sveltekit
pnpm run package
# publish
npm publish
# push tags to github
git push --tags
Publish @next package
Same procedure except use the --tag flag:
# authenticate with npm
npm login
# bump version with npm
npm version 0.0.13
# package with sveltekit
pnpm run package
# publish with tag
npm publish --tag next
# push tags to github
git push --tags
Move @next package to latest
# authenticate with npm
npm login
# move @next to latest
npm dist-tag add [email protected] latest
pnpm workspaces
To add a package to the web workspace:
pnpm add -D svead --filter web
Contributors ✨
Thanks goes to these wonderful people (emoji key):
 Scott Spence 💻 📖 💡 🚧 ⚠️ |
||||||
Add your contributions
|
||||||
This project follows the all-contributors specification. Contributions of any kind welcome!
spences10