Skip to content

feat: Add ref API to Composer for programmatic send box focus #5607

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+25 −6
Open

feat: Add ref API to Composer for programmatic send box focus #5607

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33189fc
feat: Add ref API to Composer for programmatic send box focus
Oct 1, 2025
6961f34
Merge branch 'main' into feature/composer-ref-focus-api-clean
OEvgeny Oct 2, 2025
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
31 changes: 25 additions & 6 deletions packages/component/src/Composer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import { singleToArray } from 'botframework-webchat-core';
import classNames from 'classnames';
import MarkdownIt from 'markdown-it';
import PropTypes from 'prop-types';
import React, { memo, useCallback, useMemo, useRef, useState, type ReactNode } from 'react';
import React, { forwardRef, memo, useCallback, useImperativeHandle, useMemo, useRef, useState, type ReactNode } from 'react';
import { Composer as SayComposer } from 'react-say';

import createDefaultAttachmentMiddleware from './Attachment/createMiddleware';
Expand All @@ -27,6 +27,7 @@ import {
import { StyleToEmotionObjectComposer, useStyleToEmotionObject } from './hooks/internal/styleToEmotionObject';
import UITracker from './hooks/internal/UITracker';
import useInjectStyles from './hooks/internal/useInjectStyles';
import useFocus from './hooks/useFocus';
import WebChatUIContext from './hooks/internal/WebChatUIContext';
import { FocusSendBoxScope } from './hooks/sendBoxFocus';
import { ScrollRelativeTranscriptScope } from './hooks/transcriptScrollRelative';
Expand Down Expand Up @@ -60,6 +61,10 @@ import mapMap from './Utils/mapMap';

const { useGetActivityByKey, useReferenceGrammarID, useStyleOptions, useTrackException } = hooks;

export type ComposerRef = {
focusSendBoxInput: () => Promise<void>;
};

function styleSetToEmotionObjects(styleToEmotionObject, styleSet) {
return mapMap(styleSet, (style, key) => (key === 'options' ? style : styleToEmotionObject(style)));
}
Expand Down Expand Up @@ -489,11 +494,25 @@ const InternalComposer = ({
);
};

const Composer = (props: ComposerProps) => (
<WebChatTheme>
<InternalComposer {...props} />
</WebChatTheme>
);
const Composer = forwardRef<ComposerRef, ComposerProps>((props, ref) => {
const focus = useFocus();

useImperativeHandle(
ref,
() => ({
focusSendBoxInput: () => focus('sendBox')
}),
[focus]
);

return (
<WebChatTheme>
<InternalComposer {...props} />
</WebChatTheme>
);
});

Composer.displayName = 'Composer';

Composer.defaultProps = {
...APIComposer.defaultProps,
Expand Down
Loading