From 7c18ee24937b3749f006eeb0bf63cafc5c2e253f Mon Sep 17 00:00:00 2001 From: "ester.zhou" Date: Wed, 10 Aug 2022 14:08:18 +0800 Subject: [PATCH] update docs Signed-off-by: ester.zhou --- .../arkui-ts/ts-container-refresh.md | 4 +- en/application-dev/ui/ts-syntactic-sugar.md | 62 +++++++++---------- 2 files changed, 33 insertions(+), 33 deletions(-) diff --git a/en/application-dev/reference/arkui-ts/ts-container-refresh.md b/en/application-dev/reference/arkui-ts/ts-container-refresh.md index 92aa736e68..948635c445 100644 --- a/en/application-dev/reference/arkui-ts/ts-container-refresh.md +++ b/en/application-dev/reference/arkui-ts/ts-container-refresh.md @@ -22,7 +22,7 @@ Refresh\(value: \{refreshing: boolean, offset?: Length, friction?: number | stri | Name| Value Type| Mandatory| Default Value| Description| | -------- | -------- | -------- | -------- | -------- | - | refreshing | boolean | Yes| - | Whether the current component is being refreshed.| + | refreshing | boolean | Yes| - | Whether the current component is being refreshed.
This parameter can be used with [$$](../../ui/ts-syntactic-sugar.md) for two-way binding of variables. | | offset | Length | No| 16 | Distance to the top of the parent component from the **** component that comes to rest after a successful pull-down gesture.| | friction | number \| string | No| 62 | Coefficient of friction, which indicates the **** component's sensitivity to the pull-down gesture. The value ranges from 0 to 100.
- **0** indicates that the **\** component is not sensitive to the pull-down gesture.
- **100** indicates that the **\** component is highly sensitive to the pull-down gesture.
- A larger value indicates a more sensitive response of the **\** component to the pull-down gesture.| @@ -59,7 +59,7 @@ struct RefreshExample { build() { Column() { - Refresh({refreshing: this.isRefreshing, offset: 120, friction: 100}) { + Refresh({refreshing: $$this.isRefreshing, offset: 120, friction: 100}) { Text('Pull Down and refresh: ' + this.counter) .fontSize(30) .margin(10) diff --git a/en/application-dev/ui/ts-syntactic-sugar.md b/en/application-dev/ui/ts-syntactic-sugar.md index cd3a802070..223c3eb0bf 100644 --- a/en/application-dev/ui/ts-syntactic-sugar.md +++ b/en/application-dev/ui/ts-syntactic-sugar.md @@ -8,7 +8,7 @@ A decorator @Decorator can decorate a class, structure, or class attribute. Mult In the example below, the elements decorated by @Component take on the form of a component, and the variables decorated by @State can be used to represent states. -``` +```ts @Component struct MyComponent { @State count: number = 0 @@ -18,7 +18,7 @@ struct MyComponent { Multiple decorators can be defined on a single line, as shown below: -``` +```ts @Entry @Component struct MyComponent { } ``` @@ -26,7 +26,7 @@ Multiple decorators can be defined on a single line, as shown below: However, you are advised to define the decorators on multiple lines, as shown below: -``` +```ts @Entry @Component struct MyComponent { @@ -36,30 +36,29 @@ struct MyComponent { ### Supported Decorators - | Decorator | Decorates... | Description | +| Decorator | Decorates... | Description | | -------- | -------- | -------- | -| @Component | struct | The decorated structure has the component-based capability. The build method must be implemented to update the UI. | -| @Entry | struct | The decorated component is used as the entry of a page. The component is rendered and displayed when the page is loaded. | -| @Preview | struct | Custom components decorated by @Preview can be previewed in the Previewer of DevEco Studio. When the page is loaded, the custom components decorated by @Preview are created and displayed. | -| @Builder | Methods | In the decorated method, you can use the declarative UI description to quickly generate multiple layouts in a custom component. | -| @Extend | Methods | This decorator adds new attribute functions to a preset component, allowing you to quickly define and reuse the custom style of the component. | -| @CustomDialog | struct | This decorator is used to decorate custom pop-up dialog boxes. | -| @State | Primitive data types, classes, and arrays | If the decorated state data is modified, the build method of the component will be called to update the UI. | -| @Prop | Primitive data types | This decorator is used to establish one-way data binding between the parent and child components. When the data associated with the parent component is modified, the UI of the current component is updated. | -| @Link | Primitive data types, classes, and arrays | This decorator is used to establish two-way data binding between the parent and child components. The internal state data of the parent component is used as the data source. Any changes made to one component will be reflected to the other. | -| @Observed | Classes | This decorator is used to indicate that the data changes in the class will be managed by the UI page. | -| @ObjectLink | Objects of @Observed decorated classes | When the decorated state variable is modified, the parent and sibling components that have the state variable will be notified for UI re-rendering. | -| @Consume | Primitive data types, classes, and arrays | When the @Consume decorated variable detects the update of the @Provide decorated variable, the re-rendering of the current custom component is triggered. | -| @Provide | Primitive data types, classes, and arrays | As the data provider, @Provide can update the data of child nodes and trigger page rendering. | -| @Watch | Variables decorated by @State, @Prop, @Link, @ObjectLink, @Provide, @Consume, @StorageProp, or @StorageLink | This decorator is used to listen for the changes of the state variables. The application can register a callback method through @Watch. | +| @Component | struct | The decorated structure has the component-based capability. The build method must be implemented to update the UI. | +| @Entry | struct | The decorated component is used as the entry of a page. The component is rendered and displayed when the page is loaded. | +| @Preview | struct | Custom components decorated by @Preview can be previewed in the Previewer of DevEco Studio. When the page is loaded, the custom components decorated by @Preview are created and displayed. | +| @Builder | Methods | In the decorated method, you can use the declarative UI description to quickly generate multiple layouts in a custom component. | +| @Extend | Methods | This decorator adds new attribute functions to a preset component, allowing you to quickly define and reuse the custom style of the component. | +| @CustomDialog | struct | This decorator is used to decorate custom pop-up dialog boxes. | +| @State | Primitive data types, classes, and arrays | If the decorated state data is modified, the build method of the component will be called to update the UI. | +| @Prop | Primitive data types | This decorator is used to establish one-way data binding between the parent and child components. When the data associated with the parent component is modified, the UI of the current component is updated. | +| @Link | Primitive data types, classes, and arrays | This decorator is used to establish two-way data binding between the parent and child components. The internal state data of the parent component is used as the data source. Any changes made to one component will be reflected to the other. | +| @Observed | Classes | This decorator is used to indicate that the data changes in the class will be managed by the UI page. | +| @ObjectLink | Objects of @Observed decorated classes | When the decorated state variable is modified, the parent and sibling components that have the state variable will be notified for UI re-rendering. | +| @Consume | Primitive data types, classes, and arrays | When the @Consume decorated variable detects the update of the @Provide decorated variable, the re-rendering of the current custom component is triggered. | +| @Provide | Primitive data types, classes, and arrays | As the data provider, @Provide can update the data of child nodes and trigger page rendering. | +| @Watch | Variables decorated by @State, @Prop, @Link, @ObjectLink, @Provide, @Consume, @StorageProp, or @StorageLink | This decorator is used to listen for the changes of the state variables. The application can register a callback method through @Watch. | ## Chain Call -You can configure the UI structure and its attributes and events and separate them with a dot(.) to implement chain call. +You can configure the UI structure and its attributes and events and separate them with a dot (.) to implement chain call. - -``` +```ts Column() { Image('1.jpg') .alt('error.jpg') @@ -73,8 +72,7 @@ Column() { Components can be implemented based on structs. Components cannot inherit from each other. The structs implemented components can be created and destroyed more quickly than class implemented components. - -``` +```ts @Component struct MyComponent { @State data: string = '' @@ -87,10 +85,10 @@ struct MyComponent { ## Instantiating a struct Without the new Keyword -You can omit the new keyword when instantiating a struct. +You can omit the **new** keyword when instantiating a struct. -``` +```ts // Definition @Component struct MyComponent { @@ -114,7 +112,7 @@ new Column() { TypeScript has the following restrictions on generators: -- Expressions can be used only in character strings (${expression}), if conditions, ForEach parameters, and component parameters. +- Expressions can be used only in character strings (**${expression}**), if conditions, ForEach parameters, and component parameters. - No expressions should cause any application state variables (@State, @Link, and @Prop) to change. Otherwise, undefined and potentially unstable framework behavior may occur. @@ -125,11 +123,11 @@ None of the above restrictions apply to anonymous function implementations of ev Incorrect: -``` +```ts build() { let a: number = 1 // invalid: variable declaration not allowed Column() { - Text('Hello ${this.myName.toUpperCase()}') // ok. + Text(`Hello ${this.myName.toUpperCase()}`) // ok. ForEach(this.arr.reverse(), ..., ...) // invalid: Array.reverse modifies the @State array variable in place } buildSpecial() // invalid: no function calls @@ -137,13 +135,15 @@ build() { } ``` -## $$ +## Two-Way Binding of Variables $$ supports two-way binding for simple variables and @State, @Link, and @Prop decorated variables. -Currently, $$ supports only the rendering between the show parameter of the bindPopup attribute and the @State decorated variable, and the checked attribute of the component. +Currently, $$ supports only the rendering between the **show** parameter of the **[bindPopup](../reference/arkui-ts/ts-universal-attributes-popup.md)** attribute and the @State decorated variable, the **checked** attribute of the **\** component, and the **refreshing** parameter of the **\** component. -``` + +```ts +// xxx.ets @Entry @Component struct bindPopup { -- GitLab