Skip to content
react-structuredv0.2.0
On this page
  1. Components
  2. Shared script options
  3. Data types
  4. Compatibility

API Reference

Components, script options, and exported Schema.org types at a glance.

Components

ExportRequired propsAdditional props
Schema (also default export)type, dataShared script options
Graphdata with @graphShared script options
JsonLd, JsonLdScriptComplete dataShared script options
ArticleJsonLddataOptional article type, shared script options
BreadcrumbJsonLddataShared script options
FAQJsonLddataShared script options
OrganizationJsonLddataShared script options
ProductJsonLddataShared script options

Shared script options

OptionTypeDefault
idstringUnset
noncestringUnset
scriptKeyReact KeyUnset
validatebooleantrue (development warnings only)

Data types

  • SchemaType: all supported Schema.org @type names.
  • SchemaThing<T>: the schema-dts entity corresponding to a type.
  • SchemaData<T> and TypedSchemaData<T>: an entity with optional top-level @type.
  • GraphNode: a typed schema-dts Thing.
  • GraphData: a graph with an optional Schema.org context.
  • JsonLdData: a complete WithContext<Thing> or SchemaGraph document.
  • Thing, WithContext, and SchemaGraph: re-exported schema-dts types.

Component prop types and commonly used schema-dts types are also exported from the package root. Use import type when you only need declarations.

Compatibility

React is the only runtime peer dependency (>=16.14). schema-dts supplies declarations. The repository uses Node 24 and pnpm for development; these tooling pins do not add a Next.js runtime requirement to the library.

By

Commune Software