Implement AddEditorListenerHook + Fix some bugs with types

This commit is contained in:
Eric NGUYEN 2022-09-23 13:49:22 +02:00
parent 3a7c60bd1c
commit 6de2c23989
2 changed files with 61 additions and 4 deletions

View file

@ -9,6 +9,7 @@
public constructor(componentInfo: KnockoutComponentTypes.ComponentInfo, params: any) { public constructor(componentInfo: KnockoutComponentTypes.ComponentInfo, params: any) {
super(componentInfo, params); super(componentInfo, params);
this._hooks = {};
} }
/** /**
@ -67,7 +68,7 @@
* @param history Whole history of the editor * @param history Whole history of the editor
* @param callback (optional) * @param callback (optional)
*/ */
public SetEditorState(history: .IHistoryState[], callback?: (state: IEditorState) => void) { public SetEditorState(history: IHistoryState[], callback?: (state: IEditorState) => void) {
const eventType = 'setEditorState'; const eventType = 'setEditorState';
this.AddEventListener(callback, eventType); this.AddEventListener(callback, eventType);
const component = this.GetEditorComponent(); const component = this.GetEditorComponent();
@ -80,7 +81,7 @@
* @param editorState Editor state to revive * @param editorState Editor state to revive
* @param callback Callback with the revived state * @param callback Callback with the revived state
*/ */
public ReviveEditorState(editorState: .IEditorState, callback: (state: IEditorState) => void) { public ReviveEditorState(editorState: IEditorState, callback: (state: IEditorState) => void) {
const eventType = 'reviveEditorState'; const eventType = 'reviveEditorState';
this.AddEventListener(callback, eventType); this.AddEventListener(callback, eventType);
const component = this.GetEditorComponent(); const component = this.GetEditorComponent();
@ -93,7 +94,7 @@
* @param history History to revive * @param history History to revive
* @param callback Callback with the revived state * @param callback Callback with the revived state
*/ */
public ReviveHistory(history: .IHistoryState[], callback: (state: IHistoryState[]) => void) { public ReviveHistory(history: IHistoryState[], callback: (state: IHistoryState[]) => void) {
const eventType = 'reviveHistory'; const eventType = 'reviveHistory';
this.AddEventListener(callback, eventType); this.AddEventListener(callback, eventType);
const component = this.GetEditorComponent(); const component = this.GetEditorComponent();
@ -105,7 +106,7 @@
* @param historyState New history state to append * @param historyState New history state to append
* @param callback * @param callback
*/ */
public AppendNewHistoryState(historyState: .IHistoryState, callback?: (state: IEditorState) => void) { public AppendNewHistoryState(historyState: IHistoryState, callback?: (state: IEditorState) => void) {
const eventType = 'appendNewState'; const eventType = 'appendNewState';
this.AddEventListener(callback, eventType); this.AddEventListener(callback, eventType);
this.GetEditorComponent().dispatchEvent(new CustomEvent(eventType, { detail: historyState })); this.GetEditorComponent().dispatchEvent(new CustomEvent(eventType, { detail: historyState }));
@ -261,6 +262,39 @@
}; };
root.addEventListener(eventType, listener); root.addEventListener(eventType, listener);
} }
private static EDITOR_LISTENER_TYPE = 'editorListener';
private _hooks: Record<string, (e: CustomEvent) => void>;
/**
* Add a hook to the editor state change.
* After every time an action is perform on the editor, the callback will be called
* @param callback Callback to add that listen to the event
*/
public AddEditorListenerHook(hookId: string, callback: (state: IEditorState) => void): void {
const root = this.GetRootComponent();
const customEvent = (e: CustomEvent) => {
callback(e.detail);
}
if (this._hooks[hookId] !== undefined) {
console.error(`HookId is already occupied. Please use a different HookId: ${hookId}`);
return;
}
this._hooks[hookId] = customEvent;
root.addEventListener(SVGLayoutDesigner.EDITOR_LISTENER_TYPE, customEvent);
}
/**
* Remove a hook to the editor state change.
* @param callback Callback to remove that listen to the event
*/
public RemoveEditorListenerHook(hookId): void {
const root = this.GetRootComponent();
root.removeEventListener(SVGLayoutDesigner.EDITOR_LISTENER_TYPE, this._hooks[hookId]);
delete this._hooks[hookId];
}
} }
ko.components.register('svg-layout-designer', { ko.components.register('svg-layout-designer', {

View file

@ -152,6 +152,23 @@ function UseCustomEvents(
}); });
} }
function UseEditorListener(
root: Element | Document,
history: IHistoryState[],
historyCurrentStep: number,
configuration: IConfiguration
): void {
useEffect(() => {
const editorState: IEditorState = {
history,
historyCurrentStep,
configuration
};
const event = new CustomEvent('editorListener', { detail: editorState });
root.dispatchEvent(event);
});
}
/** /**
* Return a macro function to use both setHistory * Return a macro function to use both setHistory
* and setHistoryCurrentStep at the same time * and setHistoryCurrentStep at the same time
@ -186,6 +203,12 @@ export function Editor(props: IEditorProps): JSX.Element {
editorRef, editorRef,
setNewHistory setNewHistory
); );
UseEditorListener(
props.root,
history,
historyCurrentStep,
props.configuration
);
// Context Menu // Context Menu
const menuActions = new Map(); const menuActions = new Map();