@blinkk/editor
Version:
Structured content editor with live previews.
29 lines (28 loc) • 1.16 kB
TypeScript
import { DeepObject, Field, FieldConfig, SelectiveEditor, TemplateResult, Types } from '@blinkk/selective-edit';
import { LiveEditorGlobalConfig } from '../editor';
export interface AsideFieldConfig extends FieldConfig {
/**
* Source markdown to be converted to html in the editor.
*/
source: string;
}
export declare class AsideField extends Field {
config: AsideFieldConfig;
constructor(types: Types, config: AsideFieldConfig, globalConfig: LiveEditorGlobalConfig, fieldType?: string);
/**
* Template for determining how to render the field.
*
* @param editor Selective editor used to render the template.
* @param data Data provided to render the template.
*/
template(editor: SelectiveEditor, data: DeepObject): TemplateResult;
/**
* Template for rendering the field structure.
*
* Used for controlling the order that parts of the field are rendered.
*
* @param editor Selective editor used to render the template.
* @param data Data provided to render the template.
*/
templateStructure(editor: SelectiveEditor, data: DeepObject): TemplateResult;
}