A native web component for everything which might go in the <head> of your document.
MIT License
A native web component for everything which might go in the
<head>
of your document.
npm i html-head-component
# or
yarn add html-head-component
In your JavaScript/TypeScript entry point:
import 'html-head-component';
You can also include the web component directly from unpkg.com:
import('https://unpkg.com/html-head-component');
or
<script async src="https://unpkg.com/html-head-component"></script>
Then add the component in your HTML/JSX markup:
The custom component should be placed in the <body>
tag. If you try to place it in the <head>
the browser will explicitly move it in the <body>
and you might experience issues with the rest of the elements in the <head>
.
data
attribute<html-head-component
data='
[
{
"tag": "title",
"content": "Title"
},
{
"tag": "meta",
"name": "author",
"content": "Scriptex"
},
{
"tag": "link",
"rel": "stylesheet",
"href": "./style.css"
}
]
'
></html-head-component>
src
attribute<html-head-component src="./data.json"></html-head-component>
The web component accepts two attributes:
src
which is a valid path to a JSON file containing array of objects.data
which is a valid JSON string which represents an array of objects.Only one of those attributes should be used. If both are used, the src
attribute overwrites the data
attribute.
Each object in the JSON array should have a tag
property which specifies the HTML element which will be rendered.
The rest of the properties in the object specify the attributes and their content in key:value
pairs (attribute
:attribute-content
).
There are several exceptions:
innerHTML
of the <title>
tag.style
tag's content property will be rendered as innerHTML
of the <style>
tag.script
tag's content property will be rendered as innerHTML
of the <script>
tag.noscript
tag's content property will be rendered as innerHTML
of the <noscript>
tag.If you're using React with TypeScript, you need to extends the JSX IntrinsicElements
interface so TypeScript knows that the html-head-component
element exists.
You can do so in a custom.d.ts
file in your project's root folder. Don't forget to add that file in your tsconfig.json
!
declare namespace JSX {
interface IntrinsicElements {
html-head-component: any;
}
}
You can check out the demo usage using data
attribute.
Or
You can check out the demo usage using src
attribute.
Full list of what can go in the <head>
of your document, please check this awesome repository
MIT