capacitor-native-input-dialog
Version:
Capacitor plugin for native input dialogs with enhanced text input experience on mobile devices
364 lines • 9.16 kB
JSON
{
"api": {
"name": "NativeInputPlugin",
"slug": "nativeinputplugin",
"docs": "",
"tags": [],
"methods": [
{
"name": "showNativeInput",
"signature": "(options: NativeInputOptions) => Promise<NativeInputResult>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "NativeInputOptions"
}
],
"returns": "Promise<NativeInputResult>",
"tags": [],
"docs": "显示原生输入对话框",
"complexTypes": [
"NativeInputResult",
"NativeInputOptions"
],
"slug": "shownativeinput"
},
{
"name": "createNativeOverlay",
"signature": "(options: NativeOverlayOptions) => Promise<{ id: string; }>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "NativeOverlayOptions"
}
],
"returns": "Promise<{ id: string; }>",
"tags": [],
"docs": "创建原生输入框覆盖层",
"complexTypes": [
"NativeOverlayOptions"
],
"slug": "createnativeoverlay"
},
{
"name": "updateNativeOverlay",
"signature": "(options: UpdateOverlayOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "UpdateOverlayOptions"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "更新原生输入框覆盖层",
"complexTypes": [
"UpdateOverlayOptions"
],
"slug": "updatenativeoverlay"
},
{
"name": "removeNativeOverlay",
"signature": "(options: { id: string; }) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "{ id: string; }"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "移除原生输入框覆盖层",
"complexTypes": [],
"slug": "removenativeoverlay"
},
{
"name": "isAvailable",
"signature": "() => Promise<{ available: boolean; }>",
"parameters": [],
"returns": "Promise<{ available: boolean; }>",
"tags": [],
"docs": "检查原生输入功能是否可用",
"complexTypes": [],
"slug": "isavailable"
}
],
"properties": []
},
"interfaces": [
{
"name": "NativeInputResult",
"slug": "nativeinputresult",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "value",
"tags": [],
"docs": "用户输入的文本",
"complexTypes": [],
"type": "string"
},
{
"name": "cancelled",
"tags": [],
"docs": "是否被取消",
"complexTypes": [],
"type": "boolean"
}
]
},
{
"name": "NativeInputOptions",
"slug": "nativeinputoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "title",
"tags": [],
"docs": "输入框标题",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "placeholder",
"tags": [],
"docs": "输入框提示文本",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "initialValue",
"tags": [],
"docs": "初始值",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "inputType",
"tags": [],
"docs": "输入类型",
"complexTypes": [],
"type": "'number' | 'text' | 'email' | 'password' | 'multiline' | undefined"
},
{
"name": "confirmButtonText",
"tags": [],
"docs": "确认按钮文本",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "cancelButtonText",
"tags": [],
"docs": "取消按钮文本",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "maxLength",
"tags": [],
"docs": "最大字符数限制",
"complexTypes": [],
"type": "number | undefined"
},
{
"name": "multiline",
"tags": [],
"docs": "是否允许多行输入",
"complexTypes": [],
"type": "boolean | undefined"
},
{
"name": "maxLines",
"tags": [],
"docs": "多行输入时的最大行数",
"complexTypes": [],
"type": "number | undefined"
}
]
},
{
"name": "NativeOverlayOptions",
"slug": "nativeoverlayoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "x",
"tags": [],
"docs": "输入框位置和尺寸",
"complexTypes": [],
"type": "number"
},
{
"name": "y",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "number"
},
{
"name": "width",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "number"
},
{
"name": "height",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "number"
},
{
"name": "placeholder",
"tags": [],
"docs": "输入框提示文本",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "initialValue",
"tags": [],
"docs": "初始值",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "inputType",
"tags": [],
"docs": "输入类型",
"complexTypes": [],
"type": "'number' | 'text' | 'email' | 'password' | 'multiline' | undefined"
},
{
"name": "maxLength",
"tags": [],
"docs": "最大字符数限制",
"complexTypes": [],
"type": "number | undefined"
},
{
"name": "multiline",
"tags": [],
"docs": "是否允许多行输入",
"complexTypes": [],
"type": "boolean | undefined"
},
{
"name": "maxLines",
"tags": [],
"docs": "多行输入时的最大行数",
"complexTypes": [],
"type": "number | undefined"
},
{
"name": "fontSize",
"tags": [],
"docs": "字体大小",
"complexTypes": [],
"type": "number | undefined"
},
{
"name": "backgroundColor",
"tags": [],
"docs": "背景颜色",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "textColor",
"tags": [],
"docs": "文字颜色",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "borderColor",
"tags": [],
"docs": "边框颜色",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "borderRadius",
"tags": [],
"docs": "边框圆角",
"complexTypes": [],
"type": "number | undefined"
}
]
},
{
"name": "UpdateOverlayOptions",
"slug": "updateoverlayoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "id",
"tags": [],
"docs": "覆盖层ID",
"complexTypes": [],
"type": "string"
},
{
"name": "value",
"tags": [],
"docs": "新的文本值",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "x",
"tags": [],
"docs": "新的位置和尺寸",
"complexTypes": [],
"type": "number | undefined"
},
{
"name": "y",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "number | undefined"
},
{
"name": "width",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "number | undefined"
},
{
"name": "height",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "number | undefined"
},
{
"name": "placeholder",
"tags": [],
"docs": "新的占位符",
"complexTypes": [],
"type": "string | undefined"
}
]
}
],
"enums": [],
"typeAliases": [],
"pluginConfigs": []
}