BreadcrumbList builder

Le builder BreadcrumbList crée une entité BreadcrumbList, injecte son @type, valide les données de manière synchrone et rejette les propriétés inconnues.

Import

// Astro — shown first when Astro is selected
import { BreadcrumbList } from '@unschema-graph/astro';

// Svelte 5
import { BreadcrumbList } from '@unschema-graph/svelte';

// Core / Node.js
import { BreadcrumbList } from '@unschema-graph/core';
import { BreadcrumbListSchema } from '@unschema-graph/core';

Le schéma Zod BreadcrumbListSchema est également exporté pour la composition et la validation avancées.

Types TypeScript

import {
  BreadcrumbListSchema,
  type SchemaInput,
  type SchemaOutput,
} from '@unschema-graph/core';

type BreadcrumbListInput = SchemaInput<typeof BreadcrumbListSchema>;
type BreadcrumbListOutput = SchemaOutput<typeof BreadcrumbListSchema, 'BreadcrumbList'>;

Propriétés d’entrée

Propriété	Type d’entrée	Obligatoire	Valeur par défaut / contraintes
@id	string	Non	non-empty
itemListElement	Array	Oui	—

Les alias ci-dessus restent la référence exacte, notamment pour les objets imbriqués. Le builder accepte aussi une configuration de validation en second argument et possède une sortie dont le @type vaut toujours BreadcrumbList.

Exemple minimal

import { BreadcrumbList } from '@unschema-graph/core';

const entity = BreadcrumbList({
  "itemListElement": [
    {
      "name": "Home",
      "item": "/"
    },
    {
      "name": "Guides",
      "item": "/guides/"
    },
    {
      "name": "Current page"
    }
  ]
});

Sortie

{
  "@type": "BreadcrumbList",
  "itemListElement": [
    {
      "@type": "ListItem",
      "position": 1,
      "name": "Home",
      "item": "/"
    },
    {
      "@type": "ListItem",
      "position": 2,
      "name": "Guides",
      "item": "/guides/"
    },
    {
      "@type": "ListItem",
      "position": 3,
      "name": "Current page"
    }
  ]
}

Relations et recettes

• Builders liés : Article, BlogPosting, NewsArticle, Recipe
• Utilisé par : Blog et média
• Sources externes : Schema.org BreadcrumbList · Google Search Central

Erreurs fréquentes

• Passer une propriété inconnue au builder strict.
• Utiliser une donnée source privée d’une propriété obligatoire.
• Supposer qu’un Schema.org valide garantit un affichage dans la recherche.

Validation

Utilisez BreadcrumbList.safeParse(input) pour les données externes. Pour une extension Schema.org non encore modélisée, validez d’abord l’entité puis utilisez withAdditionalProperties(). N’ajoutez jamais une propriété inventée au builder.