メインコンテンツまでスキップ

API リファレンス

<SchemaEditor /> — プロパティ​

プロパティ型既定値説明
valuestring必須エディターの内容
onChange(value: string) => void—内容の変更時に呼び出す
language"json" | "yaml" | "javascript"必須コンテンツの言語
schemaJsonSchema—補完と診断に使用する JSON Schema(json/yaml)
snippetsstring[]—JavaScript のゴースト補完に使うスニペット文字列
theme"light" | "dark""light"表示テーマ
readOnlybooleanfalse編集を無効にする
placeholderstring—空のときに表示するプレースホルダーテキスト
showDiagnosticsbooleantrue診断ステータスバーを表示する
enableInlineSuggestionsbooleantrueゴーストテキストを有効にする
enableCompletionbooleantrue補完ポップアップを有効にする
diagnosticsDebounceMsnumber250診断のデバウンス遅延

コアのエクスポート (@powerduck/schema-editor)​

関数説明
resolveSchemas(document)スキーマドキュメント内の $ref ポインターを解決する
validateSchema(data, schema)スキーマに対してデータを検証する
generateSample(schema)JSON Schema からサンプルデータを生成する
getCompletionItems(model, position)カーソル位置での補完候補を取得する

型​

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