Skip to content

feat: Support replace in prerender head.elements to remove existing tags #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
WBBB0730 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: Support replace in prerender head.elements to remove existing tags #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,12 @@ export async function prerender(data) {
// Sets any additional elements you want injected into the `<head>`:
// <link rel="stylesheet" href="foo.css">
// <meta property="og:title" content="Social media title">
// <meta name="description" content="My cool description">
elements: new Set([
{ type: 'link', props: { rel: 'stylesheet', href: 'foo.css' } },
{ type: 'meta', props: { property: 'og:title', content: 'Social media title' } },
// Use `replace` with a CSS selector to remove existing elements before inserting:
{ type: 'meta', props: { name: 'description', content: 'My cool description' }, replace: 'meta[name="description"]' },
]),
},
};
Expand Down
9 changes: 9 additions & 0 deletions src/plugins/prerender-plugin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -481,6 +481,15 @@ export function prerenderPlugin({ prerenderScript, renderTarget, additionalPrere
}

if (head.elements) {
// Remove existing elements that should be replaced
for (const element of head.elements) {
if (element.replace) {
for (const existing of htmlHead.querySelectorAll(element.replace)) {
existing.remove();
}
}
}

// Inject HTML links at the end of <head> for any stylesheets injected during rendering of the page:
htmlHead.insertAdjacentHTML(
'beforeend',
Expand Down
2 changes: 2 additions & 0 deletions src/plugins/types.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ export interface HeadElement {
type: string;
props: Record<string, string>;
children?: string;
/** CSS selector to find and remove existing elements before inserting this one */
replace?: string;
}

export interface Head {
Expand Down