Last active
December 18, 2024 09:31
-
-
Save ryanflorence/ec1849c6d690cfbffcb408ecd633e069 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
import type { V2_HtmlMetaDescriptor, V2_MetaFunction } from "@remix-run/node"; | |
export const mergeMeta = ( | |
overrideFn: V2_MetaFunction, | |
appendFn?: V2_MetaFunction, | |
): V2_MetaFunction => { | |
return arg => { | |
// get meta from parent routes | |
let mergedMeta = arg.matches.reduce((acc, match) => { | |
return acc.concat(match.meta || []); | |
}, [] as V2_HtmlMetaDescriptor[]); | |
// replace any parent meta with the same name or property with the override | |
let overrides = overrideFn(arg); | |
for (let override of overrides) { | |
let index = mergedMeta.findIndex( | |
meta => | |
("name" in meta && | |
"name" in override && | |
meta.name === override.name) || | |
("property" in meta && | |
"property" in override && | |
meta.property === override.property) || | |
("title" in meta && "title" in override), | |
); | |
if (index !== -1) { | |
mergedMeta.splice(index, 1, override); | |
} | |
} | |
// append any additional meta | |
if (appendFn) { | |
mergedMeta = mergedMeta.concat(appendFn(arg)); | |
} | |
return mergedMeta; | |
}; | |
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
import { mergeMeta } from "./merge-meta"; | |
export const meta = mergeMeta( | |
// these will override the parent meta | |
({ data }) => { | |
return [{ title: data.project.name }]; | |
}, | |
// these will be appended to the parent meta | |
({ matches }) => { | |
return [{ name: "author", content: "Ryan Florence" }]; | |
}, | |
); | |
// both functions get the same arguments as a normal meta function |
For those that may be having issues with mergeMeta
not being typed with the supplied loader, it's quite possible you may need to update references to the old V2_MetaFunction
in mergeMeta
with just MetaFunction
(this fixed the issue for me in a Remix V2 app).
@ryanflorence Wondering if you have thoughts on how to get this utility to work when upgrading to React Router V7? Using in the same way as before seems to type data
as unknown
.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
@ryanflorence how about merge handle, does the same logic work too?