): SearchAttribute;
/**
* Called when using the Clipboard menu
*
* @param { function } callback
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Called when using the Clipboard menu
*
* @param { function } callback
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Called when using the Clipboard menu
*
* @param { function } callback
* Executed when a paste operation is performed.
* { string } value - The text content to be pasted.
* { PasteEvent } event - The user-defined paste event.
* @returns { SearchAttribute } returns the instance of the SearchAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Called when using the Clipboard menu.
*
* Anonymous Object Rectification.
* @param { OnPasteCallback } callback - Executed when a paste operation is performed.Callback used to return the pasted text content.
* @returns { SearchAttribute } Returns the instance of the SearchAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
onPaste(callback: OnPasteCallback): SearchAttribute;
/**
* Called when the copy option is set.
*
* @param { CopyOptions } value
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Called when the copy option is set.
*
* @param { CopyOptions } value
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Called when the copy option is set.
*
* NOTE:
*
If this attribute is set to CopyOptions.None, the text can only be pasted;
* all other actions, such as copying, cutting, and sharing, are disabled.
*
Dragging is not allowed when CopyOptions.None is set.
*
*
* @param { CopyOptions } value - Default value is CopyOptions.LocalDevice.
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
copyOption(value: CopyOptions): SearchAttribute;
/**
* Called when the input of maximum text length is set.
*
* @param { number } value
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Called when the input of maximum text length is set.
*
* NOTE:
*
By default, there is no maximum number of characters.
*
When the maximum number is reached, no more characters can be entered.
*
*
* @param { number } value
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
/**
* Called when the input of maximum text length is set.
*
* NOTE:
*
By default, there is no maximum number of characters.
*
When the maximum number is reached, no more characters can be entered.
*
*
* @param { number } value
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.1&1.2
*/
maxLength(value: number): SearchAttribute;
/**
* Called when the text align is set.
*
* @param { TextAlign } value
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Called when the text align is set.
*
* @param { TextAlign } value
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Called when the text align is set.
*
* NOTE:
*
Currently, the following alignment modes are supported: Start, Center, and End.
*
*
* @param { TextAlign } value - Default value is TextAlign.Start.
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
textAlign(value: TextAlign): SearchAttribute;
/**
* Sets whether request keyboard or not when on focus.
*
* @param { boolean } value
* @returns { SearchAttribute } Returns the instance of the SearchAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Sets whether request keyboard or not when on focus.
*
* NOTE:
*
Since API version 10, the Search component brings up the keyboard by default when it obtains focus.
*
*
* @param { boolean } value - Default value is true.
* @returns { SearchAttribute } Returns the instance of the SearchAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
enableKeyboardOnFocus(value: boolean): SearchAttribute;
/**
* Controls whether the selection menu pops up.
*
* @param { boolean } value
* @returns { SearchAttribute } returns the instance of the SearchAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Controls whether the selection menu pops up.
*
* NOTE:
*
true: Tapping, long-pressing, double-tapping, triple-tapping,
* or right-clicking the text box will not trigger the system text selection menu.
*
false: Tapping, long-pressing, double-tapping, triple-tapping,
* or right-clicking the text box will trigger the system text selection menu.
*
*
* @param { boolean } value - Default value is false.
* @returns { SearchAttribute } returns the instance of the SearchAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
selectionMenuHidden(value: boolean): SearchAttribute;
/**
* Called when the minimum font size of the font is set.
*
* NOTE:
*
For the string type, numeric string values with optional units, for example, "10" or "10fp", are supported.
*
For the setting to take effect, this attribute must be used together with maxFontSize or layout constraint settings.
*
When the adaptive font size is used, the fontSize settings do not take effect.
*
*
* @param { number | string | Resource } value - The unit is fp.
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
minFontSize(value: number | string | Resource): SearchAttribute;
/**
* Called when the maximum font size of the font is set.
*
* NOTE:
*
For the string type, numeric string values with optional units, for example, "10" or "10fp", are supported.
*
For the setting to take effect, this attribute must be used together with minFontSize or layout constraint settings.
*
When the adaptive font size is used, the fontSize settings do not take effect.
*
*
* @param { number | string | Resource } value - The unit is fp.
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
maxFontSize(value: number | string | Resource): SearchAttribute;
/**
* Called when the minimum font scale of the font is set.
* Value range: [0, 1]
*
* NOTE:
*
The undefined type is supported.
*
A value less than 0 is handled as 0.
*
A value greater than 1 is handled as 1.
*
Abnormal values are ineffective by default.
*
*
* @param { Optional } scale
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 18
*/
/**
* Called when the minimum font scale of the font is set.
* Value range: [0, 1]
*
* NOTE:
*
The undefined type is supported.
*
A value less than 0 is handled as 0.
*
A value greater than 1 is handled as 1.
*
Abnormal values are ineffective by default.
*
*
* @param { Optional } scale
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.1&1.2
*/
minFontScale(scale: Optional): SearchAttribute;
/**
* Called when the maximum font scale of the font is set.
* Value range: [1, +∞)
*
* NOTE:
*
The undefined type is supported.
*
A value less than 1 is handled as 1.
*
Abnormal values are ineffective by default.
*
*
* @param { Optional } scale
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 18
*/
/**
* Called when the maximum font scale of the font is set.
* Value range: [1, +∞)
*
* NOTE:
*
The undefined type is supported.
*
A value less than 1 is handled as 1.
*
Abnormal values are ineffective by default.
*
*
* @param { Optional } scale
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.1&1.2
*/
maxFontScale(scale: Optional): SearchAttribute;
/**
* Define custom keyboard.
*
* @param { CustomBuilder } value
* @returns { SearchAttribute } returns the instance of the SearchAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
/**
* Define custom keyboard.
*
* @param { CustomBuilder } value
* @returns { SearchAttribute } returns the instance of the SearchAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* 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 } value - Set up a custom keyboard of Search
* @param { KeyboardOptions } [options] - Indicates the custom keyboard options of Search
* @returns { SearchAttribute } returns the instance of the SearchAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
customKeyboard(value: CustomBuilder, options?: KeyboardOptions): SearchAttribute;
/**
* Called when the text decoration of the text is set.
*
* @param { TextDecorationOptions } value - Default value is { type: TextDecorationType.None, color: Color.Black, style: TextDecorationStyle.SOLID }.
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
decoration(value: TextDecorationOptions): SearchAttribute;
/**
* Called when the distance between text fonts is set.
*
* NOTE:
*
If the value specified is a percentage or 0, the default value is used.
*
For the string type, numeric string values with optional units, for example, "10" or "10fp", are supported.
*
If the value specified is a negative value, the text is compressed.
*
A negative value too small may result in the text being compressed to 0 and no content being displayed.
*
*
* @param { number | string | Resource } value - The unit is fp.
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
letterSpacing(value: number | string | Resource): SearchAttribute;
/**
* Called when the line height of the font is set.
*
* NOTE:
*
If the value is less than or equal to 0, the line height is not limited and the font size is adaptive.
*
If the value is of the number type, the unit fp is used.
*
*
* @param { number | string | Resource } value
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
lineHeight(value: number | string | Resource): SearchAttribute;
/**
* Called when the search type is set.
*
* @param { SearchType } value
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Called when the search type is set.
*
* @param { SearchType } value - Default value is SearchType.Normal.
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
type(value: SearchType): SearchAttribute;
/**
* Set font feature.
*
* @param { string } value - The fontFeature.
* normal | ,
* where = [ | on | off ], like: "ss01" 0
* the values of reference to doc of search component
* number of can be single or multiple, and separated by comma ','.
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
fontFeature(value: string): SearchAttribute;
/**
* Get text value information when about to input.
*
* NOTE:
*
It returns true if the text is inserted; returns false otherwise.
*
This callback is not triggered for pre-edit or candidate word operations.
*
It is available only for system input methods.
*
*
* @param { Callback } callback - The triggered function when text content is about to insert.
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
onWillInsert(callback: Callback): SearchAttribute;
/**
* Get text value information when completed input.
*
* NOTE:
*
It is available only for system input methods.
*
*
* @param { Callback } callback - The triggered function when text content has been inserted.
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
onDidInsert(callback: Callback): SearchAttribute;
/**
* Get text value information when about to delete.
*
* NOTE:
*
It returns true if the text is deleted; returns false otherwise.
*
This callback is not invoked for text preview.
*
It is available only for system input methods.
*
*
* @param { Callback } callback - The triggered function when text content is about to delete.
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
onWillDelete(callback: Callback): SearchAttribute;
/**
* Get text value information when the deletion has been completed
*
* NOTE:
*
It is available only for system input methods.
*
*
* @param { Callback } callback - The triggered function when text content has been deleted.
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
onDidDelete(callback: Callback): SearchAttribute;
/**
* Called before the search component attach the InputMethod.
*
* @param { Callback } callback - The triggered function before attach the InputMethod.
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
onWillAttachIME(callback: Callback): SearchAttribute;
/**
* Set the custom text menu.
* Sets the extended options of the custom context menu on selection,
* including the text content, icon, and callback.
*
* @param { EditMenuOptions } editMenu - Customize text menu options.
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
editMenuOptions(editMenu: EditMenuOptions): SearchAttribute;
/**
* Define the preview text mode of the text input.
*
* NOTE:
*
Preview text is in a temporary state and does not support text interception.
*
As such, it does not trigger onWillInsert, onDidInsert, onWillDelete, or onDidDelete callbacks.
*
*
* @param { boolean } enable - Indicates the preview text mode.Default value is true.
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
enablePreviewText(enable: boolean): SearchAttribute;
/**
* Enable or disable haptic feedback.
*
* NOTE:
*
To enable haptic feedback,
* you must declare the ohos.permission.VIBRATE permission under requestPermissions in the module.json5 file of the project.
*
* "requestPermissions": [
* {
* "name": "ohos.permission.VIBRATE",
* }
* ]
*
*
*
* @param { boolean } isEnabled - Default value is true, set false to disable haptic feedback.
* @returns { SearchAttribute } returns the instance of the SearchAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'13', '1.2':'20'}
* @arkts 1.1&1.2
*/
enableHapticFeedback(isEnabled: boolean): SearchAttribute;
/**
* Set text mode of automatic case mode switching.
*
* @param { AutoCapitalizationMode } mode - Automatic case mode switching.
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'20', '1.2':'20'}
* @arkts 1.1&1.2
*/
autoCapitalizationMode(mode: AutoCapitalizationMode): SearchAttribute;
/**
* Set the text with half leading.
*
* @param { Optional } halfLeading - Default value is false.The value true means that half leading is enabled, and false means the opposite.
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
halfLeading(halfLeading: Optional): SearchAttribute;
/**
* Set whether stop backPressed callback event or not.
*
* @param { Optional } isStopped - Default value is true, set false to trigger the latest callback event.
* @returns { SearchAttribute } returns the instance of the SearchAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since arkts {'1.1':'15', '1.2':'20'}
* @arkts 1.1&1.2
*/
stopBackPress(isStopped: Optional): SearchAttribute;
/**
* Get text value information when about to change.
*
* NOTE:
*
This callback is triggered after onWillInsert and onWillDelete, but before onDidInsert and onDidDelete.
*
*
* @param { Callback } callback - The triggered function when text content is about to change.
* Returning true allows the change to proceed, while returning false cancels the change.
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'15', '1.2':'20'}
* @arkts 1.1&1.2
*/
onWillChange(callback: Callback): SearchAttribute;
/**
* Set the keyboard appearance.
*
* @param { Optional } appearance - Default value is KeyboardAppearance.NONE_IMMERSIVE
* @returns { SearchAttribute } returns the instance of the SearchAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since arkts {'1.1':'15', '1.2':'20'}
* @arkts 1.1&1.2
*/
keyboardAppearance(appearance: Optional): SearchAttribute;
/**
* Set the stroke width.
*
* @param { Optional } width - indicates the stroke width.
* @returns { SearchAttribute } returns the instance of the SearchAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
strokeWidth(width: Optional): SearchAttribute;
/**
* Set the stroke color.
*
* @param { Optional } color - indicates the stroke color.
* @returns { SearchAttribute } returns the instance of the SearchAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
strokeColor(color: Optional): SearchAttribute;
/**
* Whether to enable automatic spacing between Chinese and Latin characters.
*
* @param { Optional } enabled - The default value is false, indicates the flag whether to enable automatic spacing.
* @returns { SearchAttribute } returns the instance of the SearchAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
enableAutoSpacing(enabled: Optional): SearchAttribute;
}
/**
* Defines Search Component.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Defines Search Component.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Defines Search Component.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
declare const Search: SearchInterface;
/**
* Defines Search Component instance.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Defines Search Component instance.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Defines Search Component instance.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
declare const SearchInstance: SearchAttribute;