Nuxt/docs/3.api/2.composables/use-head-safe.md

56 lines
1.6 KiB
Markdown
Raw Normal View History

---
title: useHeadSafe
description: The recommended way to provide head data with user input.
links:
- label: Source
icon: i-simple-icons-github
2025-01-21 06:07:34 +00:00
to: https://github.com/unjs/unhead/blob/main/packages/vue/src/composables.ts
size: xs
---
2023-03-14 14:24:41 +00:00
The `useHeadSafe` composable is a wrapper around the [`useHead`](/docs/api/composables/use-head) composable that restricts the input to only allow safe values.
2023-03-14 14:24:41 +00:00
## Usage
2023-07-07 16:24:09 +00:00
You can pass all the same values as [`useHead`](/docs/api/composables/use-head)
2023-03-14 14:24:41 +00:00
```ts
useHeadSafe({
script: [
{ id: 'xss-script', innerHTML: 'alert("xss")' }
],
meta: [
{ 'http-equiv': 'refresh', content: '0;javascript:alert(1)' }
]
})
// Will safely generate
// <script id="xss-script"></script>
// <meta content="0;javascript:alert(1)">
```
::read-more{to="https://unhead.unjs.io/usage/composables/use-head-safe" target="_blank"}
Read more on `unhead` documentation.
::
## Type
```ts
useHeadSafe(input: MaybeComputedRef<HeadSafe>): void
```
2024-12-01 15:30:35 +00:00
The list of allowed values is:
```ts
2025-02-14 07:04:03 +00:00
const WhitelistAttributes = {
htmlAttrs: ['class', 'style', 'lang', 'dir'],
bodyAttrs: ['class', 'style'],
meta: ['name', 'property', 'charset', 'content', 'media'],
noscript: ['textContent'],
style: ['media', 'textContent', 'nonce', 'title', 'blocking'],
script: ['type', 'textContent', 'nonce', 'blocking'],
link: ['color', 'crossorigin', 'fetchpriority', 'href', 'hreflang', 'imagesrcset', 'imagesizes', 'integrity', 'media', 'referrerpolicy', 'rel', 'sizes', 'type'],
}
```
2025-02-14 07:04:03 +00:00
See [SafeInputPlugin](https://github.com/unjs/unhead/blob/main/packages/unhead/src/plugins/safe.ts) for more detailed types.