@apolitical/component-library 5.4.0-beta.3 → 5.4.0-beta.5

package/form/components/rich-text-editor/rich-text-editor.types.d.ts

@@ -2,9 +2,17 @@ import { BaseElement, BaseText, Descendant, Point, Range } from 'slate';
 import type { IListMemberData, IMentions, IDiscussionFormFns } from '../../../discussion';
 import type { MemberDetailsProps } from '../../../user';
 import type { IEnrichedUrlData } from '../../../navigation';
+interface IRTEData {
+    /** Optional mentions */
+    mentions?: IMentions;
+    /** Optional data about the first link, to be displayed in the EnrichedUrl component */
+    link?: IEnrichedUrlData | false | undefined;
+}
 interface IRTEFunctions extends IDiscussionFormFns {
     /** An optional event handler, called when the rich text editor is changed */
     onChange?: (value: string, data?: false | IEnrichedUrlData) => void;
+    /** An optional event handler, called when the data in the rich text editor is changed. This is used to keep data state up-to-date, when the onChange isn't likely to have been called, e.g. when a link preview resolves */
+    onChangeData?: (data: IRTEData) => void;
     /** An optional function to call when a mention is inserted */
     onMention?: (value?: IListMemberData) => void;
     /** An optional event handler, called when the rich text editor reports an error */
@@ -33,12 +41,7 @@ export interface IRTEProps {
     /**  Optional aria error message */
     'aria-errormessage'?: string;
     /** Optional data for the editor */
-    data?: {
-        /** Optional mentions */
-        mentions?: IMentions;
-        /** Optional data about the first link, to be displayed in the EnrichedUrl component */
-        link?: IEnrichedUrlData;
-    };
+    data?: IRTEData;
 }
 export interface IRTEInitialState {
     editorKey: string | null;