@apolitical/component-library 4.5.3 → 4.5.5

package/discussion/components/form/form.type.d.ts

@@ -1,4 +1,4 @@
-import { type ListMembers } from '../../../form';
+import { type ListMembers, ClickMentionFallback } from '../../../form';
 import { DiscussionCreateContentFunction, IDiscussionContent, IMentions } from './../../discussion';
 export interface IDiscussionFormMeta {
     /** Whether the form data is still loading */
@@ -69,6 +69,7 @@ export interface IDiscussionForm {
         handleCancel?: () => void;
         callback?: (args: void) => void;
         listMembers?: ListMembers;
+        clickMentionFallback?: ClickMentionFallback;
         props?: {
             create: {
                 projectNames: ['questions-answers'];

package/discussion/components/post/post.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { type ListMembers } from '../../../form';
+import { type ListMembers, ClickMentionFallback } from '../../../form';
 import { DiscussionCreateContentFunction, DiscussionCreateLikeFunction, DiscussionDeleteLikeFunction, IForceHide, IFullDiscussionContent } from '../../discussion';
 interface PostContent extends IFullDiscussionContent {
     /** The post body */
@@ -41,6 +41,8 @@ interface Props {
         mentions: {
             /** Get data to hydrate mentions */
             listMembers: ListMembers;
+            /** Function to call when clicking mention fallback */
+            clickMentionFallback: ClickMentionFallback;
         };
     };
     /** Optional `href`s for the card to link to */

package/form/components/rich-text-editor/components/editor/mention-popover/mention-popover.d.ts

@@ -1,2 +1,5 @@
-declare const MentionPopover: () => import("react/jsx-runtime").JSX.Element | null;
+import type { ClickMentionFallback } from '../../../../../../form';
+declare const MentionPopover: ({ onFallbackClick, }: {
+    onFallbackClick?: ClickMentionFallback | undefined;
+}) => import("react/jsx-runtime").JSX.Element;
 export default MentionPopover;

package/form/components/rich-text-editor/helpers/mentions/should-show-mentions-popover.d.ts

@@ -1,5 +1,11 @@
 import { Dispatch } from 'react';
 import { BaseEditor } from 'slate';
 import { type ListMembers } from './../../rich-text-editor.types';
-declare const shouldShowMentionsPopover: (editor: BaseEditor, isShowing: boolean, listMembers: ListMembers | undefined, dispatch: Dispatch<any>) => Promise<void>;
+declare const shouldShowMentionsPopover: ({ editor, isShowing, numberOfUsers, listMembers, dispatch, }: {
+    editor: BaseEditor;
+    isShowing: boolean;
+    numberOfUsers: number | null;
+    listMembers: ListMembers | undefined;
+    dispatch: Dispatch<any>;
+}) => Promise<void>;
 export default shouldShowMentionsPopover;

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

@@ -1,5 +1,5 @@
 import type { IMentions } from '../../../discussion/discussion';
-import { ListMembers, ReportError } from './rich-text-editor.types';
+import { ListMembers, ReportError, ClickMentionFallback } from './rich-text-editor.types';
 interface Props {
     /** The id of the rich text editor */
     id?: string;
@@ -18,6 +18,8 @@ interface Props {
     functions?: {
         /** An optional function to get a filtered list of members when the user starts typing a mention */
         listMembers?: ListMembers;
+        /** An optional function to call when the user clicks the mention fallback, e.g. to show an invite modal */
+        clickMentionFallback?: ClickMentionFallback;
         /** An optional event handler, called when the rich text editor is changed */
         onChange?: (value: string) => void;
         /** An optional event handler, called when the rich text editor reports an error */
@@ -35,5 +37,5 @@ interface Props {
         mentions?: IMentions;
     };
 }
-declare const RichTextEditor: ({ id, value, placeholder, maxLength, meta, functions, autoFocus, data, ...props }: Props) => import("react/jsx-runtime").JSX.Element | null;
+declare const RichTextEditor: ({ id, value, placeholder, maxLength, meta, functions, autoFocus, data, ...props }: Props) => import("react/jsx-runtime").JSX.Element;
 export default RichTextEditor;

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

@@ -64,9 +64,11 @@ export interface IMention {
     user: MemberDetailsProps;
 }
 export type ListMembers = ({ id, name }: IListMemberData) => Promise<IMention[]>;
+export type ClickMentionFallback = () => void;
 export interface IMentionPopOver {
     show: boolean;
     selectedUser: number;
     possibleUsers: IMention[];
     position: Range | null;
+    numberOfUsers: number | null;
 }

package/helpers/intl.d.ts

@@ -252,6 +252,7 @@ export declare const checkIntlPathExists: (path: string, language?: {
     richTextEditor_ol_list: string;
     richTextEditor_ul_list: string;
     richTextEditor_block_quote: string;
+    richTextEditor_mention_fallback: string;
     search_label: string;
     search_placeholder: string;
     search_clear: string;