diff --git a/en/application-dev/reference/arkui-ts/ts-basic-components-rating.md b/en/application-dev/reference/arkui-ts/ts-basic-components-rating.md index 23d8412098ce01b45180349e2df5849415017eeb..8d8374bcb24d159d219a6a5986b6da872f4f5827 100644 --- a/en/application-dev/reference/arkui-ts/ts-basic-components-rating.md +++ b/en/application-dev/reference/arkui-ts/ts-basic-components-rating.md @@ -1,7 +1,7 @@ # Rating -> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** +> **NOTE**
> This component is supported since API version 7. Updates will be marked with a superscript to indicate their earliest API version. @@ -23,7 +23,7 @@ None Rating(options?: { rating: number, indicator?: boolean }) - Parameters - | Name | Type | Mandatory | Default Value | Description | + | Name | Type | Mandatory | Default Value | Description | | -------- | -------- | -------- | -------- | -------- | | rating | number | Yes | 0 | Value to rate. | | indicator | boolean | No | false | Used only as an indicator and cannot be operated. | @@ -31,7 +31,7 @@ Rating(options?: { rating: number, indicator?: boolean }) ## Attributes - | Name | Type | Default Value | Description | +| Name | Type | Default Value | Description | | -------- | -------- | -------- | -------- | | stars | number | 5 | Total number of stars. | | stepSize | number | 0.5 | Step of an operation. | @@ -40,7 +40,7 @@ Rating(options?: { rating: number, indicator?: boolean }) ## Events - | Name | Description | +| Name | Description | | -------- | -------- | | onChange(callback:(value: number) => void) | Triggered when the rating value changes. | diff --git a/en/application-dev/reference/arkui-ts/ts-basic-components-richtext.md b/en/application-dev/reference/arkui-ts/ts-basic-components-richtext.md index d5d79e4e4fbc004715cac5dd92fce24f5a7f9b6d..4cce2c69ff96f157f8087414f65a5255ecbefff3 100644 --- a/en/application-dev/reference/arkui-ts/ts-basic-components-richtext.md +++ b/en/application-dev/reference/arkui-ts/ts-basic-components-richtext.md @@ -1,6 +1,6 @@ # RichText -> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** +> **NOTE**
> This component is supported since API version 8. Updates will be marked with a superscript to indicate their earliest API version. The **\** component parses and displays HTML text. @@ -19,33 +19,33 @@ RichText\(content:string\) - Parameters - | Name| Type| Mandatory| Default Value| Description| + | Name| Type | Mandatory | Default Value | Description | | -------- | -------- | -------- | -------- | -------- | - | content | string | Yes| - | String in HTML format.| + | content | string | Yes| - | Text string in HTML format. | ## Events -| Name| Description| +| Name | Description| | -------- | -------- | -| onStart() => void | Triggered when web page loading starts.| -| onComplete() => void | Triggered when web page loading is completed.| +| onStart() => void | Triggered when web page loading starts. | +| onComplete() => void | Triggered when web page loading is completed. | ## Supported Tags -| Name| Description| Example| +| Name | Description | Example | | -------- | -------- | -------- | -| \

--\

| Defines six levels of headings in the HTML document. \

defines the most important heading, and \

defines the least important heading.| \

This is an H1 heading\

\

This is an H2 heading\

| -| \

\

| Defines a paragraph.| \

This is a paragraph\

| -| \
| Inserts a newline character.| \

This is a paragraph\
This is a new paragraph\

| -| \
| Defines a thematic break (such as a shift of topic) on an HTML page and creates a horizontal line.| \

This is a paragraph\

\
\

This is a paragraph\

| -| \
\
| Defines a generic container that is generally used to group block-level elements. It allows you to apply CSS styles to multiple elements at the same time.| \
\

This is the heading in a div element\

\
| -| \\ | Displays text in italic style.| \This is in italic style\ | -| \\ | Defines text that should be styled differently or have a non-textual annotation, such as misspelt words or a proper name in Chinese text. It is recommended that you avoid using the \ tag where it could be confused with a hyperlink.| \

\This is an underlined paragraph\\

| -| \ | Used to embed CSS within an HTML document.| \ | -| style | Defines the inline style of an element and is placed inside the tag. Use quotation marks (') to separate the styling text and use semicolons (;) to separate styles, for example, **style='width: 500px;height: 500px;border: 1px solid;margin: 0 auto;'**.| \

This is a heading\

\

This is a paragraph\

| -| \ | Used to embed or reference a client-side script, such as JavaScript.| \ | +| \

--\

| Defines six levels of headings in the HTML document. \

defines the most important heading, and \

defines the least important heading. | \

This is an H1 heading\

\

This is an H2 heading\

| +| \

\

| Defines a paragraph. | \

This is a paragraph\

| +| \
| Inserts a newline character. | \

This is a paragraph\
This is a new paragraph\

| +| \
| Defines a thematic break (such as a shift of topic) on an HTML page and creates a horizontal line. | \

This is a paragraph\

\
\

This is a paragraph\

| +| \
\
| Defines a generic container that is generally used to group block-level elements. It allows you to apply CSS styles to multiple elements at the same time. | \
\

This is the heading in a div element\

\
| +| \\ | Displays text in italic style. | \This is in italic style\ | +| \\ | Defines text that should be styled differently or have a non-textual annotation, such as misspelt words or a proper name in Chinese text. It is recommended that you avoid using the \ tag where it could be confused with a hyperlink. | \

\This is an underlined paragraph\\

| +| \ | Used to embed CSS within an HTML document. | \ | +| style | Defines the inline style of an element and is placed inside the tag. Use quotation marks (') to separate the styling text and use semicolons (;) to separate styles, for example, **style='width: 500px;height: 500px;border: 1px solid;margin: 0 auto;'**. | \

This is a heading\

\

This is a paragraph\

| +| \ | Used to embed or reference a client-side script, such as JavaScript. | \ | ## Example diff --git a/en/application-dev/reference/arkui-ts/ts-basic-components-scrollbar.md b/en/application-dev/reference/arkui-ts/ts-basic-components-scrollbar.md index f07fde18fa2eab1eaec4c4354dfda5eb316ca7be..9e722f408e376dbe2d404d5e917b155d3bfba32f 100644 --- a/en/application-dev/reference/arkui-ts/ts-basic-components-scrollbar.md +++ b/en/application-dev/reference/arkui-ts/ts-basic-components-scrollbar.md @@ -1,7 +1,7 @@ # ScrollBar -> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** +> **NOTE**
> This component is supported since API version 8. Updates will be marked with a superscript to indicate their earliest API version. @@ -23,29 +23,29 @@ This component can contain a single child component. ScrollBar(value: ScrollBarOptions) - ScrollBarOptions parameters - | Name | Type | Mandatory | Default Value | Description | + | Name | Type | Mandatory | Default Value | Description | | -------- | -------- | -------- | -------- | -------- | | scroller | [Scroller](ts-container-scroll.md#scroller) | Yes | - | Scroller, which can be bound to and control scrollable components. | | direction | ScrollBarDirection | No | ScrollBarDirection.Vertical | Scrollbar direction in which scrollable components scroll. | | state | BarState | No | BarState.Auto | Scrollbar state. | - > ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** + > **NOTE**
> The **<ScrollBar>** component defines the behavior style of the scrollable area, and its subnodes define the behavior style of the scrollbar. > > This component is bound to a scrollable component through **scroller**, and can be used to scroll the scrollable component only when their directions are the same. The **<ScrollBar>** component can be bound to only one scrollable component, and vice versa. - ScrollBarDirection enums - | Name | Description | + | Name | Description | | -------- | -------- | | Vertical | Vertical scrollbar. | | Horizontal | Horizontal scrollbar. | - BarState enums - | Name | Description | + | Name | Description | | -------- | -------- | - | On | Always display. | - | Off | Hide. | - | Auto | Display on demand (displays when the screen is touched and disappears after 2s of inactivity). | + | On | Always display the scrollbar. | + | Off | Hide the scrollbar. | + | Auto | Display the scrollbar on demand (for example, display the scrollbar when the screen is touched or hide the scrollbar after 2s of inactivity). | ## Example 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 index 105b4f99b6eba49a341d4524b2bcbc271c9a0505..7cc2a86a241a990021f683baedf8e1f8d354427b 100644 --- a/en/application-dev/reference/arkui-ts/ts-basic-components-search.md +++ b/en/application-dev/reference/arkui-ts/ts-basic-components-search.md @@ -1,6 +1,7 @@ # 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. +> **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. @@ -18,32 +19,32 @@ Search(options?: { value?: string; placeholder?: string; icon?: string; controll - Parameters - | Name| Type| Mandatory| Default Value| Description| + | 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.| + | 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| +| 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) | - | Placeholder text color.| -| placeholderFont | [Font](../../ui/ts-types.md) | - | Placeholder text style.| -| textFont | [Font](../../ui/ts-types.md) | - | Text font for the search text box.| +| 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) | - | Placeholder text color. | +| placeholderFont | [Font](../../ui/ts-types.md) | - | Placeholder text style. | +| textFont | [Font](../../ui/ts-types.md) | - | Text font for the search text box. | ## Events -| Name| Description| +| 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.| +| 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 @@ -61,9 +62,9 @@ Sets the position of the caret. - Parameters - | Name | Type | Mandatory | Default Value | Description | + | 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.| + | value | number | Yes | - | Length from the start of the character string to the position where the caret is located. |