3f8c7fbb7b* Sanitizer features * move to ts, use sanitizer module to clean taintstring * Sanitizer is ready * it works * Code refactored (#476) * Use new features for paste handling * Fix asterix * Add types and some comments * Use any type for deepSanitize method * Make sanitize property static and use apiSettings object * Use sanitize for single-block pasting * Fix comment * little updates * rename sanitize in inline-tools docs * Update pattern handling * Use public getter for available tools * Fix typo
2.7 KiB
CodeX Editor API
Blocks have access to the public methods provided by CodeX Editor API Module. Plugin and Tune Developers can use Editor API as they want.
Api object description
Common API interface.
export interface IAPI {
blocks: IBlocksAPI;
caret: ICaretAPI;
sanitizer: ISanitizerAPI;
toolbar: IToolbarAPI;
}
IBlocksAPI
Methods that working with Blocks
swap(fromIndex, toIndex) - swaps two Blocks by their positions
delete(blockIndex?: Number) - deletes Block with passed index
getCurrentBlockIndex() - current Block index
getBlockByIndex(index: Number) - returns Block with passed index
getBlocksCount() - returns Blocks count
stretchBlock(index: number, status: boolean) - make Block stretched
insertNewBlock() - insert new Block after working place
ISanitizerAPI
clean(taintString, config) - method uses HTMLJanitor to clean taint string.
CodeX Editor provides basic config without attributes, but you can inherit by passing your own config.
If Tool enables inline-tools, we get it's sanitizing rules and merge with your passed custom rules.
Usage:
let taintString = '<div><p style="font-size: 5em;"><b></b>BlockWithText<a onclick="void(0)"></div>'
let customConfig = {
b: true,
p: {
style: true,
},
}
this.api.sanitizer.clean(taintString, customConfig);
IToolbarAPI
Methods that working with Toolbar
open() - Opens toolbar
close() - Closes toolbar, toolbox and blockSettings if they are opened
IEventsAPI
Methods that allows to subscribe on CodeX Editor events
on(eventName: string, callback: Function) - subscribe callback on event
off(eventName: string, callback: Function) - unsubscribe callback from event
emit(eventName: string, data: object) - fires all subscribed callbacks with passed data
IListenerAPI
Methods that allows to work with DOM listener. Useful when you forgot to remove listener. Module collects all listeners and destroys automatically
on(element: HTMLElement, eventType: string, handler: Function, useCapture?: boolean) - add event listener to HTML element
off(element: HTMLElement, eventType: string, handler: Function) - remove event handler from HTML element
Destroy API
If there are necessity to remove CodeX Editor instance from the page you can use destroy() method.
It makes following steps:
- Clear the holder element by setting it`s innerHTML to empty string
- Remove all event listeners related to CodeX Editor
- Delete all properties from instance object and set it`s prototype to
null
After executing the destroy method, editor inctance becomes an empty object. This way you will free occupied JS Heap on your page.