Interface DataApi

Data API to control in- and output to an instance of CKEditor 5.

interface DataApi {
getData(options?): string;
setData(data, options?): void;
}

Implemented by

Index

Methods

getData setData

Methods

getData

getData(options?): string
Gets the data from an instance of CKEditor 5.
Parameters
- Optional options: {
  [key: string]: unknown;
  } & DataContextOptions
  options for getting the data
Returns string
the data or some signal for invalid data, if supported by implementation
- Defined in packages/ckeditor5-data-facade/src/DataApi.ts:22

setData

setData(data, options?): void
Sets the data at an instance of CKEditor 5.
Parameters
- data: string | Record<string, string>
  data to set
- Optional options: {
  [key: string]: unknown;
  } & DataContextOptions
  options for setting the data
Returns void
- Defined in packages/ckeditor5-data-facade/src/DataApi.ts:14