跳到主要内容

Composer 消息输入

受控草稿、发送、停止和继续,适用于聊天页与独立输入区。

内部复用 Design 的 Textarea surface="plain" contentAlignment="center",保留自然行高和至少 44 的输入触达区域。文字留白使用 space[3];header 与输入共用同一个卡片表面,并以细分隔线衔接。场景提供底部提示和安全区,不在库内写入应用文案或重复键盘避让。

交互示例​

交互示例加载中…

用法​

import { useState } from 'react';
import { Composer } from '@unif/react-native-chat';

function InputDemo() {
const [text, setText] = useState('');
return (
<Composer
value={text}
onChangeText={setText}
primaryAction={{ kind: 'send', onPress: (value) => console.log(value) }}
/>
);
}

行为与接入​

value 与 onChangeText 共同维护受控草稿。空值未聚焦时,文字与操作按钮在同一行;聚焦或有文字后,操作区移到文字下方。两种布局始终使用同一个 Textarea,切换不会重建输入或清空文字。更多入口容器的原生层级在展开和收起之间保持稳定,以保留输入焦点。

发送使用图标按钮并交付原文,是否清空由调用方决定。仅有空白时默认隐藏发送,附件单独发送可设置 allowEmpty。primaryAction.kind 使用 send、stop、resume 或 busy;label 是对应图标的可访问名称,busy 只展示等待状态。resume 使用继续图标并交付 onPress,任务状态与恢复逻辑仍由宿主管理;禁用或忙碌不触发恢复。

扩展操作通过 actions 提供,点击加号先让当前输入失焦、收起键盘,再打开输入区上方的竖向菜单;受控草稿保留。菜单卡与菜单行复用 Design 的 ActionMenuContent presentation="popover",Composer 管理定位、开关和外部点击区域。选择操作时先收起菜单,再调用原 ChatAction.onPress;禁用、忙碌或无名称操作不交付事件。再次点击加号、点击外部区域、触碰输入或聚焦时也收起菜单。

语音的采集与权限处理由 voice 回调交给应用;聆听区域只呈现外部状态与文字,不生成音量、追加草稿或自动发送。

输入表面默认 card,通过 Design GlassLayer 提供统一玻璃表面、圆角、描边和阴影;浅色原生降级通过 Design useNativeSurfaceStyles 使用统一输入底色、细边框与阴影。plain 交给外层提供表面,不增加玻璃层。内部使用 Design Textarea 的 plain 表面,保留文字内间距,不叠加第二层底色或焦点描边。材质和平台降级由 Design 处理,Composer 根容器保留菜单溢出空间;切换表面不会重建输入或改变草稿。

minInputHeight 与 maxInputHeight 是 Textarea 整体高度,包含其文字内间距。最小高度默认 44;默认上限为四行文字预算加 plain 上下内间距:round(type.body × 1.4) × 4 × fontScale + 2 × space[3],且不小于最小高度。应用字号只缩放文字预算一次;显式高度按提供的布局单位使用,超过上限在输入内部滚动。

页面负责键盘避让与安全区。header 和 footer 是输入前后的内容位置;独立于卡片的常驻说明由外层组合。onHeightChange 交付整个 Composer 的实测高度,ref 仅提供 focus() 与 blur()。

聆听区保留五条装饰波形、转录文字及取消/停止图标。波形遵守减少动画设置,卸载停止本组件动画;它不读取音频、启动录音或改变外部语音状态。

空输入的聚焦展开与收起沿用原生布局动画,减少动态效果时直接切换;两者均保留原 Textarea 实例。扩展操作禁用或忙碌只影响对应菜单项,加号仍可打开菜单查看状态并保持普通图标颜色;整个 Composer 禁用或进入语音活动状态时才禁用入口并收起菜单。

starting 仍按外部状态显示准备与取消区域。finishing 保留停止图标的位置但禁用它,只允许取消;不会再次交付 onStop。

surface="plain" 的附件区采用8点上边距和左右内边距、4点下边距,不绘制分隔线,适合宿主的圆角或玻璃容器。输入区图片可组合 Attachments layout="preview";组件仍只交付原附件的预览和移除事件。

surface="plain" 的收起状态去掉额外上下留白,输入及操作仍保留至少44点触达高度。展开时保留输入区内边距。

API​

查看完整 TypeScript 类型

以下内容由包根公开类型生成,与当前源码保持一致。

import type { ComponentType } from 'react';

import type { IconProps } from '@unif/react-native-icons';

import type { ReactNode } from 'react';

import type { StyleProp, ViewStyle } from 'react-native';

import type { TextFieldHandle } from '@unif/react-native-design';

import type { ChatAction } from '@unif/react-native-chat';

export interface ComposerSendAction {
kind: 'send';
onPress(value: string): void;
allowEmpty?: boolean;
disabled?: boolean;
/** 图标按钮的可访问名称,默认“发送”。 */
label?: string;
}

export interface ComposerStopAction {
kind: 'stop';
onPress(): void;
disabled?: boolean;
label?: string;
}

export interface ComposerResumeAction {
kind: 'resume';
onPress(): void;
disabled?: boolean;
label?: string;
}

export interface ComposerBusyAction {
kind: 'busy';
label?: string;
}

export type ComposerPrimaryAction =
| ComposerSendAction
| ComposerStopAction
| ComposerResumeAction
| ComposerBusyAction;

export type ComposerVoiceStatus =
'idle' | 'starting' | 'listening' | 'finishing';

export interface ComposerVoiceControl {
status: ComposerVoiceStatus;
transcript?: string;
disabled?: boolean;
onStart(): void;
onStop(): void;
onCancel(): void;
}

export interface ComposerProps {
value: string;
onChangeText(value: string): void;
primaryAction: ComposerPrimaryAction;
editable?: boolean;
disabled?: boolean;
placeholder?: string;
inputAccessibilityLabel?: string;
actions?: readonly ChatAction[];
voice?: ComposerVoiceControl;
header?: ReactNode;
footer?: ReactNode;
/** card 提供统一玻璃表面;plain 由外层提供表面,内部 Textarea 均不单独绘制表面。 */
surface?: 'card' | 'plain';
/** Textarea 整体最小高度(含内间距),默认 44,不低于最小触达高度。 */
minInputHeight?: number;
/** Textarea 整体最大高度;默认四行文字预算加 plain 内间距,随应用字号变化。 */
maxInputHeight?: number;
onFocusChange?(focused: boolean): void;
onHeightChange?(height: number): void;
style?: StyleProp<ViewStyle>;
testID?: string;
}

export type ComposerHandle = TextFieldHandle;