For AI agents: the complete documentation index is available at /next/zh/llms.txt, the full documentation bundle is available at /next/zh/llms-full.txt, and this page is available as Markdown at /next/zh/ui/components/input.md.
lynx-ui logo
lynx-ui
  • 简体中文
  • Input

    一个适用于 ReactLynx 的无样式输入框组件,提供文本输入和键盘感知基础能力。
    Info

    你可以查看源码来了解它的运行原理,也欢迎大家提 PR 来丰富其能力。

    输入框组件,支持受控、非受控及键盘避让能力,单行输入使用 <Input>,多行输入使用 <TextArea>。

    基础用法

    使用 <Input> 渲染单行输入框,使用 <TextArea> 渲染多行文本域。

    示例

    使输入框抬起以避让键盘

    通过自动调整视图来防止屏幕键盘遮挡输入框

    结构

    Input 和 TextArea 可以独立使用:

    <Input />
    <TextArea />

    当输入框需要在键盘上方保持可见时,使用键盘感知组件:

    <KeyboardAwareRoot>
      <KeyboardAwareResponder>
        <KeyboardAwareTrigger>
          <Input />
        </KeyboardAwareTrigger>
        <KeyboardAwareTrigger>
          <TextArea />
        </KeyboardAwareTrigger>
      </KeyboardAwareResponder>
    </KeyboardAwareRoot>

    组件 API

    Input

    classNameiOSAndroidHarmony
    类型string
    类名
    confirmTypeiOSAndroidHarmony
    类型send | search | go | done | next·默认值'send'
    输入框确认按钮类型
    defaultValueiOSAndroidHarmony
    类型string
    输入框默认值
    idiOSAndroidHarmony
    类型string·默认值'input'
    输入框 id
    inputFilteriOSAndroidHarmony
    类型string
    输入框内容过滤正则表达式
    maxLengthiOSAndroidHarmony
    类型number·默认值140
    输入框最大长度
    onBluriOSAndroidHarmony
    类型(value: string) => void
    输入框失焦事件
    onConfirmiOSAndroidHarmony
    类型(value: string) => void
    输入框确认按钮点击事件
    onFocusiOSAndroidHarmony
    类型(value: string) => void
    输入框聚焦事件
    onInputiOSAndroidHarmony
    类型(value: string, selectionStart: number, selectionEnd: number, isComposing?: boolean) => void
    输入框内容改变事件
    onSelectionChangeiOSAndroidHarmony
    类型(selectionStart: number, selectionEnd: number) => void
    输入框选择范围改变事件
    placeholderiOSAndroidHarmony
    类型string
    输入框占位符
    readonlyiOSAndroidHarmony
    类型boolean·默认值false
    输入框是否可交互
    ref
    类型ForwardedRef<InputRef>
    showSoftInputOnFocusiOSAndroidHarmony
    类型boolean·默认值true
    输入框是否聚焦时显示软键盘
    styleiOSAndroidHarmony
    类型CSSProperties
    样式
    typeiOSAndroidHarmony
    类型number | text | digit | password | tel | email·默认值"text"
    输入框内容类型
    valueiOSAndroidHarmony
    类型string
    输入框受控值

    TextArea

    bouncesiOS
    类型boolean·默认值true
    输入框是否开启 iOS bounces 效果
    classNameiOSAndroidHarmony
    类型string
    类名
    confirmTypeiOSAndroidHarmony
    类型send | search | go | done | next·默认值'send'
    输入框确认按钮类型
    defaultValueiOSAndroidHarmony
    类型string
    输入框默认值
    idiOSAndroidHarmony
    类型string·默认值'input'
    输入框 id
    inputFilteriOSAndroidHarmony
    类型string
    输入框内容过滤正则表达式
    lineSpacingiOSAndroid
    类型number | px | rpx
    输入框行间距
    maxLengthiOSAndroidHarmony
    类型number·默认值140
    输入框最大长度
    maxLinesiOSAndroidHarmony
    类型number·默认值40
    输入框最大输入行数
    onBluriOSAndroidHarmony
    类型(value: string) => void
    输入框失焦事件
    onConfirmiOSAndroidHarmony
    类型(value: string) => void
    输入框确认按钮点击事件
    onFocusiOSAndroidHarmony
    类型(value: string) => void
    输入框聚焦事件
    onInputiOSAndroidHarmony
    类型(value: string, selectionStart: number, selectionEnd: number, isComposing?: boolean) => void
    输入框内容改变事件
    onSelectionChangeiOSAndroidHarmony
    类型(selectionStart: number, selectionEnd: number) => void
    输入框选择范围改变事件
    placeholderiOSAndroidHarmony
    类型string
    输入框占位符
    readonlyiOSAndroidHarmony
    类型boolean·默认值false
    输入框是否可交互
    ref
    类型ForwardedRef<TextAreaRef>
    showSoftInputOnFocusiOSAndroidHarmony
    类型boolean·默认值true
    输入框是否聚焦时显示软键盘
    styleiOSAndroidHarmony
    类型CSSProperties
    样式
    typeiOSAndroidHarmony
    类型number | text | digit | password | tel | email·默认值"text"
    输入框内容类型
    valueiOSAndroidHarmony
    类型string
    输入框受控值

    KeyboardAwareRoot

    androidStatusBarPlusBottomBarHeightAndroid
    类型number·默认值0
    需要设置 Android 状态栏高度和底部导航栏的高度,如果是沉浸式状态栏,则只需传入底部导航栏的高度
    childreniOSAndroidHarmony
    类型ReactNode
    输入框键盘响应组件的子元素
    forceAttachiOSAndroidHarmony
    类型boolean·默认值false
    是否强制吸附到键盘上方

    KeyboardAwareTrigger

    childreniOSAndroidHarmony
    类型ReactNode
    输入框键盘感知组件的子元素
    classNameiOSAndroidHarmony
    类型string
    类名
    offsetiOSAndroidHarmony
    类型number·默认值0
    输入框键盘感知组件的额外偏移量, 单位是 px
    styleiOSAndroidHarmony
    类型CSSProperties
    样式

    KeyboardAwareResponder

    Properties
    androidTouchSlopAndroid
    类型default | paging
    Android 触摸识别模式,当处于支持 'paging' 模式的元件中时,需要开启 'paging' 模式。
    asiOSAndroidHarmony
    类型View | ScrollView·默认值'View'
    输入框键盘响应组件的根元素类型
    bounceableiOSAndroid
    类型boolean
    启用弹性效果
    bounceableOptionsiOSAndroid
    类型boolean | {alwaysBouncing?: boolean, enableBounceEventInFling?: boolean, enableBounces: boolean, endBounceTriggerDistance?: number, estimatedHeight?: number, estimatedWidth?: number, lowerBounceItem?: any, onScrollToBounces?: (e: ScrollToBouncesInfo) => void, singleSidedBounce?: upper | lower | both | iOSBounces | none, startBounceTriggerDistance?: number, upperBounceItem?: any, validAnimationVersion?: boolean}·默认值{ enableBounces: true, singleSidedBounce: "iOSBounces" },
    弹性效果的参数
    childreniOSAndroid
    类型ReactNode
    scroll-view 的子元素。
    classNameiOSAndroidHarmony
    类型string
    类名
    debugLogiOSAndroidHarmony
    类型boolean·默认值false
    显示回弹交互的调试日志。
    enableNewArchiOSAndroidHarmony
    类型boolean·默认值true on Lynx SDK >= 4.3; false otherwise
    启用原生 <scroll-view> 新架构。启用后,bounceableOptions 会在 Android、iOS 和 Harmony 上使用原生回弹。Lynx SDK 4.3 及以上版本默认为 true,更早版本默认为 false。
    enableRTLiOSAndroidHarmony
    类型boolean·默认值false
    是否在 RTL 模式下镜像水平回弹方向。
    enableScrolliOSAndroidHarmony
    类型boolean·默认值true
    启用滚动。
    enableScrollMonitoriOSAndroidHarmony
    类型boolean·默认值false
    启用滚动监控。
    estimatedItemStyleiOSAndroid
    类型CSSProperties
    需要设置 items 的预计高度和宽度。
    experimentalNestedScrollBackwardHarmony
    类型selfOnly | selfFirst | parentFirst | parallel
    适配 Harmony 的嵌套滚动行为。'selfOnly' 表示只自身滚动,不与父组件联动。'selfFirst' 表示自身先滚动,自身滚动到边界以后父组件滚动。'parentFirst' 表示父组件先滚动,父组件滚动到边界以后自身滚动。'parallel' 表示自身和父组件同时滚动。
    experimentalNestedScrollForwardHarmony
    类型selfOnly | selfFirst | parentFirst | parallel
    适配 Harmony 的嵌套滚动行为。'selfOnly' 表示只自身滚动,不与父组件联动。'selfFirst' 表示自身先滚动,自身滚动到边界以后父组件滚动。'parentFirst' 表示父组件先滚动,父组件滚动到边界以后自身滚动。'parallel' 表示自身和父组件同时滚动。
    exposureBottomiOSAndroid
    类型string·默认值'10px'
    曝光屏幕下方边距
    exposureIDiOSAndroidHarmony
    类型string
    用于全局曝光的 exposure-id
    exposureLeftiOSAndroid
    类型string·默认值'10px'
    曝光屏幕左侧边距
    exposureRightiOSAndroid
    类型string·默认值'10px'
    曝光屏幕右侧边距
    exposureSceneiOSAndroidHarmony
    类型string
    用于全局曝光的 exposure-scene
    exposureTopiOSAndroid
    类型string·默认值'10px'
    曝光屏幕上方边距
    firstScreenItemCountiOSAndroid
    类型number·默认值1
    懒加载时预计的第一页项数。剩余的子元素会基于曝光状态完成渲染。当此预估较小时,可能会导致第一屏出现空白现象。
    iOSBouncesiOSAndroid
    类型boolean·默认值true
    开启iOS上的回弹效果。如果想在安卓上使用,请参考bounceableOption。如果设置了bounceableOption,iOSBounces属性将失效。
    lazyiOSAndroid
    类型boolean·默认值true
    启用懒渲染。只有当用户滚动到可见区域时,才会渲染 items,从而减少初始加载时间和内存使用。
    lazyOptionsiOSAndroid
    类型LazyOptions·默认值true
    启用懒渲染。只有当用户滚动到可见区域时,才会渲染 items,从而减少初始加载时间和内存使用。
    main-thread:gestureiOSAndroid
    类型BaseGesture<BaseGestureConfig, GestureChangeEvent>
    如果想使用 gesture API,请传入该属性。
    onUIAppeariOSAndroidHarmony
    类型(e: CommonEvent) => void
    UI 的曝光事件。
    onUIDisappeariOSAndroidHarmony
    类型(e: CommonEvent) => void
    UI 的消失事件。
    ref
    类型ForwardedRef<KeyboardAwareResponderRef>
    sceneiOSAndroid
    类型string
    用于标记懒加载的曝光时机。请确保页面中唯一。
    scrollMonitorTagiOSAndroidHarmony
    类型string·默认值false
    滚动监控的标签。
    scrollOrientationiOSAndroidHarmony
    类型horizontal | vertical·默认值'vertical'
    设置为 'vertical' 为垂直滚动,设置为 'horizontal' 为水平滚动。
    scrollPropagationBehavioriOSAndroid
    类型ScrollPropagationBehaviorOption·默认值'native'
    控制滚动事件是否向父级容器传递。'preventPropagate' 在 iOS 上暂时需与 temporaryBlockScrollClass 和 temporaryBlockScrollTag 配合使用。 Currently, this property has limitations because its full functionality depends on a higher native SDK version: on iOS, propagate only works if both the parent and this component are set to propagate and useRefactorList={true} does not support 'propagate'. On Android, preventPropagate only functions when the parent is x-swiper or x-viewpager-ng.
    scrollviewIdiOSAndroid
    类型string·默认值"scrollview"
    滚动视图的id。
    stickyiOSAndroid
    类型ReactElement<any, string | JSXElementConstructor<any>>
    粘性元素,设计用于 Tabs。
    styleiOSAndroid
    类型CSSProperties
    Styles for KeyboardAwareResponder KeyboardAwareResponder 的样式
    temporaryBlockScrollClassiOS
    类型string·默认值'BDXLynxViewPager'
    当 scrollPropagationBehavior 设为 'preventPropagate' 时,被阻止滚动的容器的具体类名。'preventPropagate' 需与 temporaryBlockScrollClass 和 temporaryBlockScrollTag 配合使用。 This is a temporary props and will be deprecated on new Lynx SDK version.
    temporaryBlockScrollTagiOS
    类型number·默认值0
    用于指定当 scrollPropagationBehavior 设为 'preventPropagate' 时被阻止滚动的原生容器标签(对应 UIView 的 Tag 属性)。该值需由原生容器提供方指定,且 'preventPropagate' 必须与 temporaryBlockScrollClass 和 temporaryBlockScrollTag 配合使用。 This is a temporary props and will be deprecated on new Lynx SDK version.
    temporaryNestedScrollAndroid
    类型boolean
    仅 Android 生效的临时开关,用于控制嵌套滚动冲突;映射到原生属性 'enable-nested-scroll'。Android上默认开启。
    testingiOSAndroid
    类型boolean
    测试模式
    Events
    catchLongPressiOSAndroidHarmony
    类型(e: EventHandler<BaseTouchEvent<Target>> | undefined) => void
    与 onLongPress 相同,但会阻止事件冒泡。
    catchTouchCanceliOSAndroidHarmony
    类型(e: TouchEvent) => void
    与 onTouchCancel 相同,但会阻止事件冒泡。
    catchTouchEndiOSAndroidHarmony
    类型(e: TouchEvent) => void
    与 onTouchEnd 相同,但会阻止事件冒泡。
    catchTouchMoveiOSAndroidHarmony
    类型(e: TouchEvent) => void
    与 onTouchMove 相同,但会阻止事件冒泡。
    catchTouchStartiOSAndroidHarmony
    类型(e: TouchEvent) => void
    与 onTouchStart 相同,但会阻止事件冒泡。
    onContentSizeChangeiOSAndroid
    类型(res: {detail: {scrollHeight: number, scrollWidth: number}}) => void
    滚动内容变化时触发。
    onLayoutChangeiOSAndroidHarmony
    类型(e: EventHandler<LayoutChangeDetailEvent<Target>> | undefined) => void
    当 UI 视口大小改变时发送。
    onLongPressiOSAndroidHarmony
    类型(e: EventHandler<BaseTouchEvent<Target>> | undefined) => void
    当触摸点在 UI 上按住一段时间后发送。
    onScrolliOSAndroid
    类型(e: ScrollEvent) => void
    滚动时触发。
    onScrollEndiOSAndroid
    类型(e: ScrollEndEvent) => void·默认值undefined
    滚动停止时触发。
    onScrollToLoweriOSAndroid
    类型(e: ScrollToLowerEvent) => void·默认值undefined
    滚动到底部时触发。
    onScrollToUpperiOSAndroid
    类型(e: ScrollToUpperEvent) => void·默认值undefined
    滚动到顶部时触发。
    onTapiOSAndroidHarmony
    类型(e: EventHandler<BaseTouchEvent<Target>> | undefined) => void
    当触摸点在 UI 上轻触时发送。
    onTouchCanceliOSAndroidHarmony
    类型(e: TouchEvent) => void
    当触摸事件在完成前被中断或取消时发送。
    onTouchEndiOSAndroidHarmony
    类型(e: TouchEvent) => void
    当触摸点从 UI 上移除时发送。
    onTouchMoveiOSAndroidHarmony
    类型(e: TouchEvent) => void
    当触摸点在 UI 上移动时发送。
    onTouchStartiOSAndroidHarmony
    类型(e: TouchEvent) => void
    当触摸点放置在 UI 上时发送。
    onWheel
    类型(e: CommonEvent) => void
    当 scroll-view 触发滚轮事件时发送。

    InputRef

    bluriOSAndroidHarmony
    类型() => Promise<void>
    释放输入框焦点
    focusiOSAndroidHarmony
    类型() => Promise<void>
    聚焦输入框
    getValueiOSAndroidHarmony
    类型() => Promise<{selectionEnd: number, selectionStart: number, value: string}>
    获取输入框内容
    setSelectionRangeiOSAndroidHarmony
    类型(selectionStart: number, selectionEnd: number) => Promise<void>
    设置输入框选中范围
    setValueiOSAndroidHarmony
    类型(value: string) => Promise<void>
    设置输入框内容

    TextAreaRef

    bluriOSAndroidHarmony
    类型() => Promise<void>
    释放输入框焦点
    focusiOSAndroidHarmony
    类型() => Promise<void>
    聚焦输入框
    getValueiOSAndroidHarmony
    类型() => Promise<{selectionEnd: number, selectionStart: number, value: string}>
    获取输入框内容
    setSelectionRangeiOSAndroidHarmony
    类型(selectionStart: number, selectionEnd: number) => Promise<void>
    设置输入框选中范围
    setValueiOSAndroidHarmony
    类型(value: string) => Promise<void>
    设置输入框内容

    KeyboardAwareResponderRef

    as
    类型() => View | ScrollView
    除非另有说明,本项目采用知识共享署名 4.0 国际许可协议进行许可,代码示例采用 Apache License 2.0 许可协议进行许可。