From 8d85b2f12358a4ce27c4f2dcff68c44a94f3e65b Mon Sep 17 00:00:00 2001 From: "ester.zhou" Date: Wed, 23 Mar 2022 19:11:37 +0800 Subject: [PATCH] add doc Signed-off-by: ester.zhou --- .../arkui-ts/ts-basic-components-search.md | 101 ++++++++++++++++++ 1 file changed, 101 insertions(+) create mode 100644 en/application-dev/reference/arkui-ts/ts-basic-components-search.md diff --git a/en/application-dev/reference/arkui-ts/ts-basic-components-search.md b/en/application-dev/reference/arkui-ts/ts-basic-components-search.md new file mode 100644 index 0000000000..9c8bf2237d --- /dev/null +++ b/en/application-dev/reference/arkui-ts/ts-basic-components-search.md @@ -0,0 +1,101 @@ +# Search + +> ![](public_sys-resources/icon-note.gif) **NOTE** This component is supported since API version 8. Updates will be marked with a superscript to indicate their earliest API version. + +The **\** component provides an input area for users to search. + +## Required Permissions + +None + +## Child Components + +None + +## APIs + +Search(options?: { value?: string; placeholder?: string; icon?: string; controller?: SearchController }) + +- Parameters + + | Name| Type| Mandatory| Default Value| Description| + | -------- | -------- | -------- | -------- | -------- | + | value | string | No| - | Text input in the search text box.| + | placeholder | string | No | - | Text displayed when there is no input.| + | icon | string | No| - | Path to the search icon. By default, the system search icon is used. The supported icon formats are svg, jpg, and png.| + | controller | SearchController | No| - | Controller.| + + +## Attributes + +| Name| Type| Default Value| Description| +| -------- | -------- | -------- | -------- | +| searchButton | string | –| Text on the search button located next to the search text box. By default, there is no search button.| +| placeholderColor | [ResourceColor](../../ui/ts-types.md#ResourceColor) | - | Placeholder text color.| +| placeholderFont | [Font](../../ui/ts-types.md#Font) | - | Placeholder text style.| +| textFont | [Font](../../ui/ts-types.md#Font) | - | Text font for the search text box.| + +## Events + +| Name| Description| +| -------- | -------- | +| onSubmit(callback: (value: string) => void) | Triggered when users click the search icon or the search button, or tap the search button on a soft keyboard.
-**value**: current text input.| +| onChange(callback: (value: string) => void) | Triggered when the input in the text box changes.
-**value**: current text input.| +| onCopy(callback: (value: string) => void) | Triggered when data is copied to the pasteboard.
-**value**: text copied.| +| onCut(callback: (value: string) => void) | Triggered when data is cut from the pasteboard.
-**value**: text cut.| +| onPaste(callback: (value: string) => void) | Triggered when data is pasted from the pasteboard.
-**value**: text pasted.| + +## SearchController + +Defines the controller of the **\** component. + +#### Objects to Import +``` +controller: SearchController = new SearchController() +``` +#### caretPosition + +creatPosition(value: number): viod + +Sets the position of the caret. + +- Parameters + + | Name | Type | Mandatory | Default Value | Description | + | ---- | ------ | ---- | ---- | --------------------- | + | value | number | Yes | - | Length from the start of the character string to the position where the caret is located.| + + + +## Example + +``` +@Entry +@Component +struct SearchExample { + @State changevalue: string = '' + @State submitvalue: string = '' + controller: SearchController = new SearchController() + + build() { + Flex({ direction: FlexDirection.Row, justifyContent: FlexAlign.Center, alignItems: ItemAlign.Center }) { + Text(this.submitvalue) + Text(this.changevalue) + Search({value: '', placeholder: 'Type to search', controller: this.controller}) + .searchButton('Search') + .width(400) + .height(35) + .backgroundColor(Color.White) + .placeholderColor(Color.Grey) + .placeholderFont({ size: 50, weight: 10, family: 'serif', style: FontStyle.Normal }) + .onSubmit((value: string) => { + this.submitvalue = value + }) + .onChange((value: string) => { + this.changevalue = value + }) + .margin({ top: 30 }) + } + } +} +``` -- GitLab