react-schemaorg
Version:
Typed Schema.org JSON-LD in React
128 lines (101 loc) • 3.48 kB
Markdown
[](https://www.npmjs.com/package/react-schemaorg) [](https://travis-ci.org/google/react-schemaorg) [](https://coveralls.io/github/google/react-schemaorg?branch=master)
# react-schemaorg
Easily insert valid Schema.org JSON-LD in your React apps.
This library provides `<JsonLd>` for plain React apps, and `helmetJsonLdProp()`
for use with [`<Helmet>`](https://github.com/nfl/react-helmet).
Uses [schema-dts](https://github.com/google/schema-dts) for Schema.org
TypeScript definitions.
Note: This is not an officially supported Google product.
## Usage
Install [`react-schemaorg`](https://www.npmjs.com/package/react-schemaorg) and
your desired version of
[`schema-dts`](https://www.npmjs.com/package/schema-dts):
```sh
npm install schema-dts
npm install react-schemaorg
```
### Plain React Usage
To insert a simple JSON-LD snippet:
```tsx
import { Person } from "schema-dts";
import { JsonLd } from "react-schemaorg";
export function GraceHopper() {
return (
<JsonLd<Person>
item={{
"@context": "https://schema.org",
"@type": "Person",
name: "Grace Hopper",
alternateName: "Grace Brewster Murray Hopper",
alumniOf: {
"@type": "CollegeOrUniversity",
name: ["Yale University", "Vassar College"],
},
knowsAbout: ["Compilers", "Computer Science"],
}}
/>
);
}
```
### Directly creating `<script>` tags (for `next/head` and elsewhere)
Certain `<head>` management libraries require `<script>` tags to be directly
included, rather than wrapped in a component. This includes NextJS's
`next/head`, and `react-helmet`. With these, we can use the `jsonLdScriptProps`
export to do the same thing:
```tsx
import { Person } from "schema-dts";
import { jsonLdScriptProps } from "react-schemaorg";
import Head from "next/head";
export default function MyPage() {
return (
<Head>
<script
{...jsonLdScriptProps<Person>({
"@context": "https://schema.org",
"@type": "Person",
name: "Grace Hopper",
alternateName: "Grace Brewster Murray Hopper",
alumniOf: {
"@type": "CollegeOrUniversity",
name: ["Yale University", "Vassar College"],
},
knowsAbout: ["Compilers", "Computer Science"],
})}
/>
</Head>
);
}
```
### [React Helmet](https://github.com/nfl/react-helmet) Usage
To set JSON-LD in React Helmet, you need to pass it to the `script={[...]}` prop
array in the `Helmet` component:
```tsx
import { Person } from "schema-dts";
import { helmetJsonLdProp } from "react-schemaorg";
import { Helmet } from "react-helmet";
<Helmet
script={[
helmetJsonLdProp<Person>({
"@context": "https://schema.org",
"@type": "Person",
name: "Grace Hopper",
alternateName: "Grace Brewster Murray Hopper",
alumniOf: {
"@type": "CollegeOrUniversity",
name: ["Yale University", "Vassar College"],
},
knowsAbout: ["Compilers", "Computer Science"],
}),
]}
/>;
```
## Developers
Use NPM to install dependencies:
```sh
npm install
```
Use tsc to build:
```sh
tsc
```
To contribute changes, see [the CONTRIBUTING.md file](./CONTRIBUTING.md).