Skip to content

@sqlrooms/vega / useVegaChartEditor

Function: useVegaChartEditor()

useVegaChartEditor(__namedParameters): UseVegaChartEditorReturn

Hook for managing Vega chart editor state.

Provides local state management with debounced spec parsing for live preview, and external callbacks for persisting changes.

Parameters

ParameterType
__namedParametersUseVegaChartEditorOptions

Returns

UseVegaChartEditorReturn

Example

tsx
const { state, actions, parsedSpec, canApply } = useVegaChartEditor({
  initialSpec: mySpec,
  initialSql: myQuery,
  onSpecChange: (spec) => saveSpec(spec),
  onSqlChange: (sql) => saveQuery(sql),
});