@silexlabs/grapesjs-symbols
Version:
Symbols for GrapesJS
37 lines • 1.55 kB
TypeScript
import { Editor, Component } from 'grapesjs';
export declare const cmdAdd = "symbols:add";
export declare const cmdRemove = "symbols:remove";
export declare const cmdUnlink = "symbols:unlink";
export declare const cmdCreate = "symbols:create";
export declare const cmdList = "symbols:list";
export default function (editor: Editor): void;
export declare function displayError(editor: Editor, title: string, message: string): void;
/**
* Create a new symbol
* @param options.component - the component which will become the first instance of the symbol
* @returns {Symbol}
*/
export declare function _addSymbol(editor: Editor, _: any, { component, label, icon }: {
component?: Component;
label?: string;
icon?: string;
}): import("grapesjs").SymbolInfo | null;
/**
* Delete a symbol
* @param {symbolId: string} - object containing the symbolId
*/
export declare function _removeSymbol(editor: Editor, _: any, { symbolId }: {
symbolId: string;
}): void;
export declare function _unlinkSymbolInstance(editor: Editor, _: any, { component }: {
component: Component;
}): void;
/**
* @param {{index, indexEl, method}} pos Where to insert the component, as [defined by the Sorter](https://github.com/artf/grapesjs/blob/0842df7c2423300f772e9e6cdc88c6ae8141c732/src/utils/Sorter.js#L871)
*/
export declare function _createSymbolInstance(editor: Editor, _: any, { symbol, pos, target }: {
symbol: Component;
pos: any;
target: HTMLElement | Component;
}): Component | null;
//# sourceMappingURL=SymbolsCommands.d.ts.map