# @jill64/svelte-ogp
> ๐ผ๏ธ Quick OGP configuration for SvelteKit
Latest version **2.0.3** (published 2025-05-18) ยท MIT license ยท 0 weekly downloads
> **Deprecated.** This package is deprecated.
## Install
```sh
npm install @jill64/svelte-ogp
pnpm add @jill64/svelte-ogp
yarn add @jill64/svelte-ogp
bun add @jill64/svelte-ogp
```
## Health
**Score 10/100 (F)** โ status: deprecated.
Negative: deprecated.
## Facts
| | |
|---|---|
| Version | 2.0.3 |
| Published | 2025-05-18 |
| First published | 2023-11-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 15 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | jill64 |
| Maintainers | jill64 |
| Keywords | og-image, ogp, sveltekit |
## Links
- npm: https://www.npmjs.com/package/@jill64/svelte-ogp
- Repository: https://github.com/jill64/svelte-ogp
- Homepage: https://github.com/jill64/svelte-ogp#readme
- Issues: https://github.com/jill64/svelte-ogp/issues
- npm.io page: https://npm.io/package/@jill64/svelte-ogp
## Dependencies (1)
- [@jill64/svelte-html](https://npm.io/package/@jill64/svelte-html.md) 2.0.1
## Alternatives
- [exif-parser](https://npm.io/package/exif-parser.md) โ 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) โ 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) โ 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) โ 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) โ 316.0K weekly downloads
## Recent versions
- 2.0.3 (latest) โ 2025-05-18
- 2.0.2 โ 2025-01-18
- 2.0.1 โ 2024-12-30
- 2.0.0 โ 2024-12-30
- 1.2.2 โ 2024-12-30
- 1.2.1 โ 2024-12-30
- 1.2.0 โ 2024-12-30
- 1.1.40 โ 2024-12-30
- 1.1.39 โ 2024-12-29
- 1.1.38 โ 2024-12-10
- 1.1.37 โ 2024-11-25
- 1.1.36 โ 2024-11-18
- 1.1.35 โ 2024-10-07
- 1.1.34 โ 2024-09-25
- 1.1.33 โ 2024-09-25
- โฆ 41 more at https://npm.io/package/@jill64/svelte-ogp/versions
## README
# @jill64/svelte-ogp
๐ผ๏ธ Quick OGP configuration for SvelteKit
## [Demo](https://svelte-ogp.jill64.dev)
It provides serval typed properties and default values according to [The Open Graph protocol](https://ogp.me) and [Twitter Cards](https://developer.twitter.com/en/docs/tweets/optimize-with-cards/guides/getting-started).
## Quick Example
```svelte
```
โ
```html
```
[Full Type Definition](./src/lib/OGP.svelte)
## SSR
To add a `prefix` attribute to the html delivered by the server, put the following in `hooks.server.js`.
```js
// hooks.server.js
export { attach as handle } from '@jill64/svelte-ogp'
```
## Advanced Properties
The value of `prefix` is bound as an attribute of the `html` tag.
You can bind it to a `meta` tag by passing the value to `custom_properties` or `custom_names`.
```svelte
```
โ
```html
```
## Structured Properties
In edge cases, multiple additional properties or arrays may be required.
`custom_properties` and `custom_names` interpret the following structured objects and output them as serialized `meta` tags.
```js
const custom_properties_1 = {
'og:image:width': 300
}
const custom_properties_2 = {
og: {
image: {
width: 300
}
}
}
const custom_properties_3 = {
og: [
{
image: [
{
width: [300]
}
]
}
]
}
```
These are all interpreted as follows
```html
```
This allows for the following notations
```svelte
```
โ
```html
```
## License
[MIT](LICENSE)
---
_Source: https://npm.io/package/@jill64/svelte-ogp ยท Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._