Skip to content

refactor: relocate composer autocomplete to shared AutocompletePopup #41050

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
ricardogarim wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

refactor: relocate composer autocomplete to shared AutocompletePopup #41050

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 .../views/room/composer/ComposerBoxPopup.tsx → ...ts/AutocompletePopup/ComposerBoxPopup.tsx
View file
Open in desktop
File renamed without changes.
39 changes: 39 additions & 0 deletions apps/meteor/client/components/AutocompletePopup/ComposerPopupOption.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import type { Optional } from '@rocket.chat/core-typings';
import type { ReactNode } from 'react';

export type ComposerPopupOption<T extends { _id: string; sort?: number } = { _id: string; sort?: number }> = {
title?: string;
getItemsFromLocal?: (filter: any) => Promise<T[]>;
getItemsFromServer?: (filter: any) => Promise<T[]>;
blurOnSelectItem?: boolean;
closeOnEsc?: boolean;

trigger?: string;
triggerAnywhere?: boolean;
triggerLength?: number;

suffix?: string;
prefix?: string;

matchSelectorRegex?: RegExp;
preview?: boolean;

getValue: (item: T) => string;

renderItem?: ({ item }: { item: T }) => ReactNode;
disabled?: boolean;
};

export const createMessageBoxPopupConfig = <T extends { _id: string; sort?: number }>(
partial: Optional<ComposerPopupOption<T>, 'getValue'>,
): ComposerPopupOption<T> => {
return {
blurOnSelectItem: true,
closeOnEsc: true,
triggerAnywhere: true,
suffix: ' ',
prefix: partial.prefix ?? partial.trigger ?? ' ',
getValue: (item) => item._id,
...partial,
};
};
4 changes: 2 additions & 2 deletions ...oom/composer/hooks/useComposerBoxPopup.ts → ...ompletePopup/hooks/useComposerBoxPopup.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ import type { MutableRefObject } from 'react';
import { useEffect, useCallback, useState, useRef } from 'react';

import { useComposerBoxPopupQueries } from './useComposerBoxPopupQueries';
import { useChat } from '../../contexts/ChatContext';
import type { ComposerPopupOption } from '../../contexts/ComposerPopupContext';
import { useChat } from '../../../views/room/contexts/ChatContext';
import type { ComposerPopupOption } from '../ComposerPopupOption';

type ComposerBoxPopupImperativeCommands<T> = MutableRefObject<
| {
Expand Down
4 changes: 2 additions & 2 deletions ...poser/hooks/useComposerBoxPopupQueries.ts → ...Popup/hooks/useComposerBoxPopupQueries.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ import { keepPreviousData, useQueries } from '@tanstack/react-query';
import { useEffect, useState } from 'react';

import { useEnablePopupPreview } from './useEnablePopupPreview';
import { slashCommands } from '../../../../../app/utils/client/slashCommand';
import type { ComposerPopupOption } from '../../contexts/ComposerPopupContext';
import { slashCommands } from '../../../../app/utils/client/slashCommand';
import type { ComposerPopupOption } from '../ComposerPopupOption';

export const useComposerBoxPopupQueries = <T extends { _id: string; sort?: number }>(filter: unknown, popup?: ComposerPopupOption<T>) => {
const [counter, setCounter] = useState(0);
Expand Down
2 changes: 1 addition & 1 deletion ...m/composer/hooks/useEnablePopupPreview.ts → ...pletePopup/hooks/useEnablePopupPreview.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { ComposerPopupOption } from '../../contexts/ComposerPopupContext';
import type { ComposerPopupOption } from '../ComposerPopupOption';

export const useEnablePopupPreview = <T extends { _id: string; sort?: number }>(filter: unknown, popup?: ComposerPopupOption<T>) =>
popup && !popup.preview && (popup?.triggerLength ? typeof filter === 'string' && popup.triggerLength - 1 < filter.length : true);
2 changes: 1 addition & 1 deletion apps/meteor/client/views/room/composer/ComposerBoxPopupPreview.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { useEndpoint } from '@rocket.chat/ui-contexts';
import type { ForwardedRef, ReactNode } from 'react';
import { forwardRef, useEffect, useId, useImperativeHandle } from 'react';

import type { ComposerBoxPopupProps } from './ComposerBoxPopup';
import type { ComposerBoxPopupProps } from '../../../components/AutocompletePopup/ComposerBoxPopup';
import { useChat } from '../contexts/ChatContext';

type ComposerBoxPopupPreviewItem = { _id: string; type: 'image' | 'video' | 'audio' | 'text' | 'other'; value: string; sort?: number };
Expand Down
12 changes: 6 additions & 6 deletions apps/meteor/client/views/room/composer/messageBox/MessageBox.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,17 @@ import MessageBoxFormattingToolbar from './MessageBoxFormattingToolbar';
import MessageBoxHint from './MessageBoxHint';
import MessageBoxReplies from './MessageBoxReplies';
import MessageComposerFiles from './MessageComposerFiles';
import { useDraft } from './hooks/useDraft';
import { useMessageBoxAutoFocus } from './hooks/useMessageBoxAutoFocus';
import { useMessageBoxPlaceholder } from './hooks/useMessageBoxPlaceholder';
import { handleSelectionWrapping } from './wrapSelection';
import { createComposerAPI } from '../../../../../app/ui-message/client/messageBox/createComposerAPI';
import type { FormattingButton } from '../../../../../app/ui-message/client/messageBox/messageBoxFormatting';
import { formattingButtons } from '../../../../../app/ui-message/client/messageBox/messageBoxFormatting';
import { getImageExtensionFromMime } from '../../../../../lib/getImageExtensionFromMime';
import ComposerBoxPopup from '../../../../components/AutocompletePopup/ComposerBoxPopup';
import { useComposerBoxPopup } from '../../../../components/AutocompletePopup/hooks/useComposerBoxPopup';
import { useEnablePopupPreview } from '../../../../components/AutocompletePopup/hooks/useEnablePopupPreview';
import { useFormatDateAndTime } from '../../../../hooks/useFormatDateAndTime';
import { useIsFederationEnabled } from '../../../../hooks/useIsFederationEnabled';
import type { ComposerAPI } from '../../../../lib/chats/ChatAPI';
Expand All @@ -38,16 +44,10 @@ import { useFileUpload } from '../../body/hooks/useFileUpload';
import { useChat } from '../../contexts/ChatContext';
import { useComposerPopupOptions } from '../../contexts/ComposerPopupContext';
import { useRoom, useRoomSubscription } from '../../contexts/RoomContext';
import ComposerBoxPopup from '../ComposerBoxPopup';
import ComposerBoxPopupPreview from '../ComposerBoxPopupPreview';
import ComposerUserActionIndicator from '../ComposerUserActionIndicator';
import { useAutoGrow } from '../RoomComposer/hooks/useAutoGrow';
import { useComposerBoxPopup } from '../hooks/useComposerBoxPopup';
import { useEnablePopupPreview } from '../hooks/useEnablePopupPreview';
import { useMessageComposerMergedRefs } from '../hooks/useMessageComposerMergedRefs';
import { useDraft } from './hooks/useDraft';
import { useMessageBoxAutoFocus } from './hooks/useMessageBoxAutoFocus';
import { useMessageBoxPlaceholder } from './hooks/useMessageBoxPlaceholder';

const reducer = (_: unknown, event: FormEvent<HTMLInputElement>): boolean => {
const target = event.target as HTMLInputElement;
Expand Down
39 changes: 1 addition & 38 deletions apps/meteor/client/views/room/contexts/ComposerPopupContext.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,48 +1,11 @@
import type { Optional } from '@rocket.chat/core-typings';
import type { ReactNode } from 'react';
import { useContext, createContext } from 'react';

export type ComposerPopupOption<T extends { _id: string; sort?: number } = { _id: string; sort?: number }> = {
title?: string;
getItemsFromLocal?: (filter: any) => Promise<T[]>;
getItemsFromServer?: (filter: any) => Promise<T[]>;
blurOnSelectItem?: boolean;
closeOnEsc?: boolean;

trigger?: string;
triggerAnywhere?: boolean;
triggerLength?: number;

suffix?: string;
prefix?: string;

matchSelectorRegex?: RegExp;
preview?: boolean;

getValue: (item: T) => string;

renderItem?: ({ item }: { item: T }) => ReactNode;
disabled?: boolean;
};
import type { ComposerPopupOption } from '../../../components/AutocompletePopup/ComposerPopupOption';

export type ComposerPopupContextValue = ComposerPopupOption[];

export const ComposerPopupContext = createContext<ComposerPopupContextValue | undefined>(undefined);

export const createMessageBoxPopupConfig = <T extends { _id: string; sort?: number }>(
partial: Optional<ComposerPopupOption<T>, 'getValue'>,
): ComposerPopupOption<T> => {
return {
blurOnSelectItem: true,
closeOnEsc: true,
triggerAnywhere: true,
suffix: ' ',
prefix: partial.prefix ?? partial.trigger ?? ' ',
getValue: (item) => item._id,
...partial,
};
};

export const useComposerPopupOptions = () => {
const composerPopupContext = useContext(ComposerPopupContext);
if (!composerPopupContext) {
Expand Down
3 changes: 2 additions & 1 deletion apps/meteor/client/views/room/providers/ComposerPopupProvider.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import { useTranslation } from 'react-i18next';
import { hasAtLeastOnePermission } from '../../../../app/authorization/client';
import { emoji } from '../../../../app/emoji/client';
import { slashCommands } from '../../../../app/utils/client';
import { createMessageBoxPopupConfig } from '../../../components/AutocompletePopup/ComposerPopupOption';
import { cannedResponsesQueryKeys } from '../../../lib/queryKeys';
import { Messages, Subscriptions } from '../../../stores';
import ComposerBoxPopupCannedResponse from '../composer/ComposerBoxPopupCannedResponse';
Expand All @@ -24,7 +25,7 @@ import ComposerBoxPopupSlashCommand from '../composer/ComposerBoxPopupSlashComma
import ComposerBoxPopupUser from '../composer/ComposerBoxPopupUser';
import type { ComposerBoxPopupUserProps } from '../composer/ComposerBoxPopupUser';
import type { ComposerPopupContextValue } from '../contexts/ComposerPopupContext';
import { ComposerPopupContext, createMessageBoxPopupConfig } from '../contexts/ComposerPopupContext';
import { ComposerPopupContext } from '../contexts/ComposerPopupContext';
import useCannedResponsesQuery from './hooks/useCannedResponsesQuery';
import { normalizeUsername } from '../../../../lib/utils/normalizeUsername';
import { pipe } from '../../../lib/cachedStores/pipe';
Expand Down
Loading