native-input

Provides native input dialogs for better text input experience on mobile devices

Install

npm install native-input
npx cap sync

API

• showNativeInput(...)
• createNativeOverlay(...)
• updateNativeOverlay(...)
• removeNativeOverlay(...)
• isAvailable()
• Interfaces

showNativeInput(...)

showNativeInput(options: NativeInputOptions) => Promise<NativeInputResult>

显示原生输入对话框

| Param | Type | | ------------- | ----------------------------------------------------------------- | | options | NativeInputOptions |

Returns: Promise<NativeInputResult>

createNativeOverlay(...)

createNativeOverlay(options: NativeOverlayOptions) => Promise<{ id: string; }>

创建原生输入框覆盖层

| Param | Type | | ------------- | --------------------------------------------------------------------- | | options | NativeOverlayOptions |

Returns: Promise<{ id: string; }>

updateNativeOverlay(...)

updateNativeOverlay(options: UpdateOverlayOptions) => Promise<void>

更新原生输入框覆盖层

| Param | Type | | ------------- | --------------------------------------------------------------------- | | options | UpdateOverlayOptions |

removeNativeOverlay(...)

removeNativeOverlay(options: { id: string; }) => Promise<void>

移除原生输入框覆盖层

| Param | Type | | ------------- | ---------------------------- | | options | { id: string; } |

isAvailable()

isAvailable() => Promise<{ available: boolean; }>

检查原生输入功能是否可用

Returns: Promise<{ available: boolean; }>

Interfaces

NativeInputResult

| Prop | Type | Description | | --------------- | -------------------- | ----------- | | value | string | 用户输入的文本 | | cancelled | boolean | 是否被取消 |

NativeInputOptions

| Prop | Type | Description | | ----------------------- | ----------------------------------------------------------------------- | ----------- | | title | string | 输入框标题 | | placeholder | string | 输入框提示文本 | | initialValue | string | 初始值 | | inputType | 'number' | 'text' | 'email' | 'password' | 'multiline' | 输入类型 | | confirmButtonText | string | 确认按钮文本 | | cancelButtonText | string | 取消按钮文本 | | maxLength | number | 最大字符数限制 | | multiline | boolean | 是否允许多行输入 | | maxLines | number | 多行输入时的最大行数 |

NativeOverlayOptions

| Prop | Type | Description | | --------------------- | ----------------------------------------------------------------------- | ----------- | | x | number | 输入框位置和尺寸 | | y | number | | | width | number | | | height | number | | | placeholder | string | 输入框提示文本 | | initialValue | string | 初始值 | | inputType | 'number' | 'text' | 'email' | 'password' | 'multiline' | 输入类型 | | maxLength | number | 最大字符数限制 | | multiline | boolean | 是否允许多行输入 | | maxLines | number | 多行输入时的最大行数 | | fontSize | number | 字体大小 | | backgroundColor | string | 背景颜色 | | textColor | string | 文字颜色 | | borderColor | string | 边框颜色 | | borderRadius | number | 边框圆角 |

UpdateOverlayOptions

| Prop | Type | Description | | ----------------- | ------------------- | ----------- | | id | string | 覆盖层ID | | value | string | 新的文本值 | | x | number | 新的位置和尺寸 | | y | number | | | width | number | | | height | number | | | placeholder | string | 新的占位符 |