Zum Hauptinhalt springen

API-Referenz

<SchemaEditor /> — Prop​

PropTypStandardwertBeschreibung
valuestringerforderlichInhalt des Editors
onChange(value: string) => void—Wird bei Inhaltsänderungen aufgerufen
language"json" | "yaml" | "javascript"erforderlichSprache des Inhalts
schemaJsonSchema—JSON Schema für Vervollständigung und Diagnosen (json/yaml)
snippetsstring[]—Snippet-Strings für die Ghost-Text-Vervollständigung in JavaScript
theme"light" | "dark""light"Darstellungsthema
readOnlybooleanfalseDeaktiviert die Bearbeitung
placeholderstring—Platzhaltertext bei leerem Inhalt
showDiagnosticsbooleantrueZeigt die Diagnose-Statusleiste an
enableInlineSuggestionsbooleantrueAktiviert Ghost-Text
enableCompletionbooleantrueAktiviert das Vervollständigungsfenster
diagnosticsDebounceMsnumber250Entprellverzögerung für Diagnosen

Exporte des Kernmoduls (@powerduck/schema-editor)​

FunktionBeschreibung
resolveSchemas(document)Löst $ref-Verweise in einem Schemadokument auf
validateSchema(data, schema)Validiert Daten anhand eines Schemas
generateSample(schema)Erzeugt Beispieldaten aus einem JSON Schema
getCompletionItems(model, position)Liefert Vervollständigungseinträge an der Cursorposition

Typen​

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