提交 6e41870f 编写于 作者: E esterzhou

update docs (12348)

Signed-off-by: Nesterzhou <ester.zhou@huawei.com>
上级 8c512bd4
...@@ -15,7 +15,7 @@ In ArkTS, you define a custom component by using decorators **@Component** and * ...@@ -15,7 +15,7 @@ In ArkTS, you define a custom component by using decorators **@Component** and *
} }
``` ```
- **build** function: a function that complies with the **Builder** API definition and is used to define the declarative UI description of components. A **build** function must be defined for custom components, and custom constructors are prohibited for custom components. - **build** function: A custom component must implement the **build** function and must implement no constructor. The **build** function meets the definition of the **Builder** API and is used to define the declarative UI description of components.
```ts ```ts
interface Builder { interface Builder {
...@@ -49,9 +49,9 @@ Column() { ...@@ -49,9 +49,9 @@ Column() {
} }
``` ```
### Structs with Mandatory Parameters ### Structs with Parameters
A struct with mandatory parameters is a component whose API definition expects parameters enclosed in the parentheses. You can use constants to assign values to the parameters. A struct with parameters is a component whose API definition expects parameters enclosed in the parentheses. You can use constants to assign values to the parameters.
Sample code: Sample code:
...@@ -61,7 +61,7 @@ Sample code: ...@@ -61,7 +61,7 @@ Sample code:
Image('https://xyz/test.jpg') Image('https://xyz/test.jpg')
``` ```
- Set the mandatory parameter **content** of the **\<Text>** component as follows: - Set the optional parameter **content** of the **\<Text>** component as follows:
```ts ```ts
Text('test') Text('test')
...@@ -83,35 +83,35 @@ Component attributes are configured using an attribute method, which follows the ...@@ -83,35 +83,35 @@ Component attributes are configured using an attribute method, which follows the
```ts ```ts
Text('test') Text('test')
.fontSize(12) .fontSize(12)
``` ```
- Example of configuring multiple attributes at the same time by using the "**.**" operator to implement chain call: - Example of configuring multiple attributes at the same time by using the "**.**" operator to implement chain call:
```ts ```ts
Image('test.jpg') Image('test.jpg')
.alt('error.jpg') .alt('error.jpg')
.width(100) .width(100)
.height(100) .height(100)
``` ```
- Example of passing variables or expressions in addition to constants: - Example of passing variables or expressions in addition to constants:
```ts ```ts
Text('hello') Text('hello')
.fontSize(this.size) .fontSize(this.size)
Image('test.jpg') Image('test.jpg')
.width(this.count % 2 === 0 ? 100 : 200) .width(this.count % 2 === 0 ? 100 : 200)
.height(this.offset + 100) .height(this.offset + 100)
``` ```
- For attributes of built-in components, ArkUI also provides some predefined [enumeration types](../reference/arkui-ts/ts-appendix-enums.md), which you can pass as parameters to methods if they meet the parameter type requirements. For example, you can configure the font color and weight attributes of the **\<Text>** component as follows: - For attributes of built-in components, ArkUI also provides some predefined [enumeration types](../reference/arkui-ts/ts-appendix-enums.md), which you can pass as parameters to methods if they meet the parameter type requirements. For example, you can configure the font color and weight attributes of the **\<Text>** component as follows:
```ts ```ts
Text('hello') Text('hello')
.fontSize(20) .fontSize(20)
.fontColor(Color.Red) .fontColor(Color.Red)
.fontWeight(FontWeight.Bold) .fontWeight(FontWeight.Bold)
``` ```
### Event Configuration ### Event Configuration
...@@ -123,7 +123,7 @@ Events supported by components are configured using event methods, which each fo ...@@ -123,7 +123,7 @@ Events supported by components are configured using event methods, which each fo
```ts ```ts
Button('add counter') Button('add counter')
.onClick(() => { .onClick(() => {
this.counter += 2 this.counter += 2;
}) })
``` ```
...@@ -132,7 +132,7 @@ Events supported by components are configured using event methods, which each fo ...@@ -132,7 +132,7 @@ Events supported by components are configured using event methods, which each fo
```ts ```ts
Button('add counter') Button('add counter')
.onClick(function () { .onClick(function () {
this.counter += 2 this.counter += 2;
}.bind(this)) }.bind(this))
``` ```
...@@ -140,13 +140,13 @@ Events supported by components are configured using event methods, which each fo ...@@ -140,13 +140,13 @@ Events supported by components are configured using event methods, which each fo
```ts ```ts
myClickHandler(): void { myClickHandler(): void {
this.counter += 2 this.counter += 2;
} }
... ...
Button('add counter') Button('add counter')
.onClick(this.myClickHandler) .onClick(this.myClickHandler.bind(this))
``` ```
### Child Component Configuration ### Child Component Configuration
...@@ -158,11 +158,11 @@ For a component that supports child components, for example, a container compone ...@@ -158,11 +158,11 @@ For a component that supports child components, for example, a container compone
```ts ```ts
Column() { Column() {
Text('Hello') Text('Hello')
.fontSize(100) .fontSize(100)
Divider() Divider()
Text(this.myText) Text(this.myText)
.fontSize(100) .fontSize(100)
.fontColor(Color.Red) .fontColor(Color.Red)
} }
``` ```
...@@ -176,10 +176,10 @@ For a component that supports child components, for example, a container compone ...@@ -176,10 +176,10 @@ For a component that supports child components, for example, a container compone
.height(100) .height(100)
Button('click +1') Button('click +1')
.onClick(() => { .onClick(() => {
console.info('+1 clicked!') console.info('+1 clicked!');
}) })
} }
Divider() Divider()
Row() { Row() {
Image('test2.jpg') Image('test2.jpg')
...@@ -187,10 +187,10 @@ For a component that supports child components, for example, a container compone ...@@ -187,10 +187,10 @@ For a component that supports child components, for example, a container compone
.height(100) .height(100)
Button('click +2') Button('click +2')
.onClick(() => { .onClick(() => {
console.info('+2 clicked!') console.info('+2 clicked!');
}) })
} }
Divider() Divider()
Row() { Row() {
Image('test3.jpg') Image('test3.jpg')
...@@ -198,7 +198,7 @@ For a component that supports child components, for example, a container compone ...@@ -198,7 +198,7 @@ For a component that supports child components, for example, a container compone
.height(100) .height(100)
Button('click +3') Button('click +3')
.onClick(() => { .onClick(() => {
console.info('+3 clicked!') console.info('+3 clicked!');
}) })
} }
} }
......
...@@ -142,12 +142,12 @@ The **LengthConstrain** type is used to describe the maximum and minimum lengths ...@@ -142,12 +142,12 @@ The **LengthConstrain** type is used to describe the maximum and minimum lengths
The **Font** type is used to set the text style. The **Font** type is used to set the text style.
| Name | Type | Mandatory | Description | | Name | Type | Mandatory| Description |
| ------ | ---------------------------------------- | ---- | ---------------------------------------- | | ------ | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| size | [Length](#length) | No | Font size. If the value is of the number type, the unit fp is used. | | size | [Length](#length) | No | Font size. If the value is of the number type, the unit fp is used. The value cannot be a percentage.|
| weight | [FontWeight](ts-appendix-enums.md#fontweight) \| number \| string | No | Font weight. For the number type, the value ranges from 100 to 900, at an interval of 100. The default value is **400**. A larger value indicates a larger font weight.| | weight | [FontWeight](ts-appendix-enums.md#fontweight) \| number \| string | No | Font weight. For the number type, the value ranges from 100 to 900, at an interval of 100. The default value is **400**. A larger value indicates a larger font weight.|
| family | string \| [Resource](#resource) | No | Font family of the text. Use commas (,) to separate multiple fonts. The priority of the fonts is the sequence in which they are placed. An example value is **'Arial, sans-serif'**.| | family | string \| [Resource](#resource) | No | Font family of the text. Use commas (,) to separate multiple fonts. The priority of the fonts is the sequence in which they are placed. An example value is **'Arial, sans-serif'**. Currently, only the **'sans-serif'** font is supported.|
| style | [FontStyle](ts-appendix-enums.md#fontstyle) | No | Font style. | | style | [FontStyle](ts-appendix-enums.md#fontstyle) | No | Font style. |
## Area<sup>8+</sup> ## Area<sup>8+</sup>
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册