diff --git a/api/@internal/component/ets/search.d.ts b/api/@internal/component/ets/search.d.ts index 7ce15eae7e18c0e50cba817f21cf6610371e20d4..f6d9dac4ca0f64c2e2bcf31459c2ec356a86fbd1 100644 --- a/api/@internal/component/ets/search.d.ts +++ b/api/@internal/component/ets/search.d.ts @@ -1882,7 +1882,7 @@ declare class SearchAttribute extends CommonMethod { */ /** * Define custom keyboard. - * + * *

NOTE: *
When a custom keyboard is set, activating the text box opens the specified custom component, * instead of the system input method. @@ -1906,7 +1906,30 @@ declare class SearchAttribute extends CommonMethod { * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ - customKeyboard(value: CustomBuilder, options?: KeyboardOptions): SearchAttribute; + /** + * Define custom keyboard. + * + *

NOTE: + *
When a custom keyboard is set, activating the text box opens the specified custom component, + * instead of the system input method. + *
The custom keyboard's height can be set through the height attribute of the custom component's root node, + * and its width is fixed at the default value. + *
The custom keyboard is presented by overlaying the original screen. + *
It is not compressed or lifted if avoid mode is not enabled or avoidance is not needed for the text box. + *
The custom keyboard cannot obtain the focus, but it blocks gesture events. + *
By default, the custom keyboard is closed when the input component loses the focus. + *
You can also use the stopEditing API to close the keyboard. + *
When a custom keyboard is set, the text box does not support camera input, even when the device supports. + *
When setting a custom keyboard, you can bind the onKeyPrelme event to prevent input from the physical keyboard. + *

+ * + * @param { CustomBuilder | ComponentContent | undefined } value - Set up a custom keyboard of Search + * @param { KeyboardOptions | undefined } [options] - Indicates the custom keyboard options of Search + * @returns { SearchAttribute } returns the instance of the SearchAttribute. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 21 + */ + default customKeyboard(value: CustomBuilder | ComponentContent | undefined, options?: KeyboardOptions | undefined): this; /** * Called when the text decoration of the text is set. diff --git a/api/@internal/component/ets/text_area.d.ts b/api/@internal/component/ets/text_area.d.ts index 5367dcb957f4d052d85780bf7b5f47e1330e7e7a..e71d52009d6e4bcf29347424f4a06150ffb372fd 100644 --- a/api/@internal/component/ets/text_area.d.ts +++ b/api/@internal/component/ets/text_area.d.ts @@ -1674,7 +1674,7 @@ declare class TextAreaAttribute extends CommonMethod { */ /** * Define custom keyboard of the text area. - * + * *

NOTE: *
When a custom keyboard is set, activating the text box opens the specified custom component, * instead of the system input method. @@ -1698,7 +1698,30 @@ declare class TextAreaAttribute extends CommonMethod { * @since arkts {'1.1':'12','1.2':'20'} * @arkts 1.1&1.2 */ - customKeyboard(value: CustomBuilder, options?: KeyboardOptions): TextAreaAttribute; + /** + * Define custom keyboard of the text area. + * + *

NOTE: + *
When a custom keyboard is set, activating the text box opens the specified custom component, + * instead of the system input method. + *
The custom keyboard's height can be set through the height attribute of the custom component's root node, + * and its width is fixed at the default value. + *
The custom keyboard is presented by overlaying the original screen, + * which is not compressed or lifted if avoid mode is not enabled or avoidance is not needed for the text box. + *
The custom keyboard cannot obtain the focus, but it blocks gesture events. + *
By default, the custom keyboard is closed when the input component loses the focus. + *
You can also use the TextAreaController.stopEditing API to close the keyboard. + *
When a custom keyboard is set, the text box does not support camera input, even when the device supports. + *
When setting a custom keyboard, you can bind the onKeyPrelme event to prevent input from the physical keyboard. + *

+ * + * @param { CustomBuilder | ComponentContent | undefined } value - Set up a custom keyboard of TextArea + * @param { KeyboardOptions | undefined } [options] - Indicates the custom keyboard options of TextArea + * @returns { TextAreaAttribute } returns the instance of the TextAreaAttribute. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 21 + */ + default customKeyboard(value: CustomBuilder | ComponentContent | undefined, options?: KeyboardOptions | undefined): this; /** * Called when the text decoration of the text is set. diff --git a/api/@internal/component/ets/text_input.d.ts b/api/@internal/component/ets/text_input.d.ts index a4a7cf14adcd400ccfadf94ee25454798eacf9c1..05f229b3fd8de750529c17dc7694383274d56855 100644 --- a/api/@internal/component/ets/text_input.d.ts +++ b/api/@internal/component/ets/text_input.d.ts @@ -2920,7 +2920,30 @@ declare class TextInputAttribute extends CommonMethod { * @since arkts {'1.1':'12','1.2':'20'} * @arkts 1.1&1.2 */ - customKeyboard(value: CustomBuilder, options?: KeyboardOptions): TextInputAttribute; + /** + * Define custom keyboard of the text input. + * + * *

NOTE: + *
When a custom keyboard is set, activating the text box opens the specified custom component, + * instead of the system input method. + *
The custom keyboard's height can be set through the height attribute of the custom component's root node, + * and its width is fixed at the default value. + *
The custom keyboard is presented by overlaying the original screen, + * which is not compressed or lifted if avoid mode is not enabled or avoidance is not needed for the text box. + *
The custom keyboard cannot obtain the focus, but it blocks gesture events. + *
By default, the custom keyboard is closed when the input component loses the focus. + *
You can also use the TextInputController.stopEditing API to close the keyboard. + *
When a custom keyboard is set, the text box does not support camera input, even when the device supports. + *
When setting a custom keyboard, you can bind the onKeyPrelme event to prevent input from the physical keyboard. + *

+ * + * @param { CustomBuilder | ComponentContent | undefined } value - Set up a custom keyboard of TextInput + * @param { KeyboardOptions | undefined } [options] - Indicates the custom keyboard options of TextInput + * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 21 + */ + default customKeyboard(value: CustomBuilder | ComponentContent | undefined, options?: KeyboardOptions | undefined): this; /** * Show the counter when the number of characters entered exceeds the threshold through InputCounterOptions.