Aller au contenu principal

Référence de l’API

<SchemaEditor /> — Propriété​

PropriétéTypeValeur par défautDescription
valuestringobligatoireContenu de l’éditeur
onChange(value: string) => void—Appelé lors d’une modification du contenu
language"json" | "yaml" | "javascript"obligatoireLangage du contenu
schemaJsonSchema—JSON Schema utilisé pour la complétion et les diagnostics (json/yaml)
snippetsstring[]—Chaînes de code pour la complétion par texte fantôme en JavaScript
theme"light" | "dark""light"Thème visuel
readOnlybooleanfalseDésactive l’édition
placeholderstring—Texte indicatif lorsque le contenu est vide
showDiagnosticsbooleantrueAffiche la barre d’état des diagnostics
enableInlineSuggestionsbooleantrueActive le texte fantôme
enableCompletionbooleantrueActive la fenêtre de complétion
diagnosticsDebounceMsnumber250Délai d’attente des diagnostics après les modifications

Exports du noyau (@powerduck/schema-editor)​

FonctionDescription
resolveSchemas(document)Résout les pointeurs $ref dans un document de schéma
validateSchema(data, schema)Valide les données par rapport à un schéma
generateSample(schema)Génère des données d’exemple depuis un JSON Schema
getCompletionItems(model, position)Récupère les suggestions de complétion à la position du curseur

Types​

import type { SchemaEditorProps } from "@powerduck/schema-editor/react";