提交 db74822a 编写于 作者: E ester.zhou

Update docs (9739)

Signed-off-by: Nester.zhou <ester.zhou@huawei.com>
上级 9d66e5f2
...@@ -28,10 +28,10 @@ Defines and shows the action sheet. ...@@ -28,10 +28,10 @@ Defines and shows the action sheet.
| confirm | {<br>value: string \| [Resource](ts-types.md#resource),<br>action: () =&gt; void<br>} | No | Text content of the confirm button and callback upon button clicking.<br>Default value:<br>**value**: button text.<br>**action**: callback upon button clicking.| | confirm | {<br>value: string \| [Resource](ts-types.md#resource),<br>action: () =&gt; void<br>} | No | Text content of the confirm button and callback upon button clicking.<br>Default value:<br>**value**: button text.<br>**action**: callback upon button clicking.|
| cancel | () =&gt; void | No | Callback invoked when the dialog box is closed after the overlay is clicked. | | cancel | () =&gt; void | No | Callback invoked when the dialog box is closed after the overlay is clicked. |
| alignment | [DialogAlignment](ts-methods-custom-dialog-box.md#dialogalignment) | No | Alignment mode of the dialog box in the vertical direction.<br>Default value: **DialogAlignment.Default**| | alignment | [DialogAlignment](ts-methods-custom-dialog-box.md#dialogalignment) | No | Alignment mode of the dialog box in the vertical direction.<br>Default value: **DialogAlignment.Default**|
| offset | {<br>dx: Length,<br>dy: Length<br>} | No | Offset of the dialog box relative to the alignment position.{<br>dx: 0,<br>dy: 0<br>} | | offset | {<br>dx: Length,<br>dy: Length<br>} | No | Offset of the dialog box relative to the alignment position.<br/>Default value: **{<br>dx: 0,<br>dy: 0<br>}** |
| sheets | Array&lt;SheetInfo&gt; | Yes | Options in the dialog box. Each option supports the image, text, and callback.| | sheets | Array&lt;SheetInfo&gt; | Yes | Options in the dialog box. Each option supports the image, text, and callback.|
## SheetInfo parameters ## SheetInfo
| Name| Type | Mandatory| Description | | Name| Type | Mandatory| Description |
| ------ | ------------------------------------------------------------ | ---- | ----------------- | | ------ | ------------------------------------------------------------ | ---- | ----------------- |
......
...@@ -17,7 +17,7 @@ Shared element transition can be used for transition between pages, for example, ...@@ -17,7 +17,7 @@ Shared element transition can be used for transition between pages, for example,
## Example ## Example
The example implements the custom transition of a shared image during redirection from one page to another, which is triggered by a click on the image. The example implements the custom transition of a shared image during redirection from one page to another, which is triggered by a click on the image.
```ts ```ts
// xxx.ets // xxx.ets
......
# UI Development # UI Development
- [ArkUI Overview](arkui-overview.md) - [ArkUI Overview](arkui-overview.md)
- TypeScript-based Declarative Development Paradigm - UI Development with eTS-based Declarative Development Paradigm
- [Overview](ui-ts-overview.md) - [Overview](ui-ts-overview.md)
- Framework Overview - Framework Overview
- File Organization - File Organization
- [Directory Structure](ts-framework-directory.md) - [Directory Structure](ts-framework-directory.md)
- [Rules for Accessing Application Code Files](ts-framework-file-access-rules.md) - [Rules for Accessing Application Code Files](ts-framework-file-access-rules.md)
- ["js" Tag](ts-framework-js-tag.md)
- Resource Management - Resource Management
- [Resource File Categories](ui-ts-basic-resource-file-categories.md) - [Resource File Categories](ui-ts-basic-resource-file-categories.md)
- [Accessing Resources](ts-resource-access.md) - [Resource Access](ts-resource-access.md)
- [Pixel Units](ts-pixel-units.md) - [Pixel Units](ts-pixel-units.md)
- Declarative Syntax - Declarative Syntax
- [Overview](ts-syntax-intro.md) - [About Usage of UI Description Specifications](ts-syntax-intro.md)
- General UI Description Specifications - About General UI Description Specifications
- [Basic Concepts](ts-general-ui-concepts.md) - [Basic Concepts](ts-general-ui-concepts.md)
- Declarative UI Description Specifications - Declarative UI Description Specifications
- [Configuration Without Parameters](ts-parameterless-configuration.md) - [Configuration Without Parameters](ts-parameterless-configuration.md)
- [Configuration with Mandatory Parameters](ts-configuration-with-mandatory-parameters.md) - [Configuration with Mandatory Parameters](ts-configuration-with-mandatory-parameters.md)
- [Attribute Configuration](ts-attribution-configuration.md)
- [Attribute Configuration](ts-attribution-configuration.md)
- [Event Configuration](ts-event-configuration.md) - [Event Configuration](ts-event-configuration.md)
- [Child Component Configuration](ts-child-component-configuration.md) - [Child Component Configuration](ts-child-component-configuration.md)
- Componentization - Componentization
...@@ -46,21 +44,21 @@ ...@@ -46,21 +44,21 @@
- [@Observed and @ObjectLink](ts-other-states-observed-objectlink.md) - [@Observed and @ObjectLink](ts-other-states-observed-objectlink.md)
- [@Consume and @Provide](ts-other-states-consume-provide.md) - [@Consume and @Provide](ts-other-states-consume-provide.md)
- [@Watch](ts-other-states-watch.md) - [@Watch](ts-other-states-watch.md)
- About Rendering Control Syntax - Rendering Control Syntax
- [if/else](ts-rending-control-syntax-if-else.md) - [if/else](ts-rending-control-syntax-if-else.md)
- [ForEach](ts-rending-control-syntax-foreach.md) - [ForEach](ts-rending-control-syntax-foreach.md)
- [LazyForEach](ts-rending-control-syntax-lazyforeach.md) - [LazyForEach](ts-rending-control-syntax-lazyforeach.md)
- About @Component - About Componentization
- [build Function](ts-function-build.md) - [build Function](ts-function-build.md)
- [Initialization of Custom Components' Member Variables](ts-custom-component-initialization.md) - [Initialization of Custom Components' Member Variables](ts-custom-component-initialization.md)
- [Custom Component Lifecycle Callbacks](ts-custom-component-lifecycle-callbacks.md) - [Custom Component Lifecycle Callbacks](ts-custom-component-lifecycle-callbacks.md)
- [Component Creation and Re-initialization](ts-component-creation-re-initialization.md) - [Examples: Component Creation and Re-initialization](ts-component-creation-re-initialization.md)
- [About Syntactic Sugar](ts-syntactic-sugar.md) - [About Syntactic Sugar](ts-syntactic-sugar.md)
- Common Component Development Guidelines - Common Component Development Guidelines
- [Button](ui-ts-basic-components-button.md) - [Button](ui-ts-basic-components-button.md)
- [Web](ui-ts-components-web.md) - [Web](ui-ts-components-web.md)
- Common Layout Development Guidelines - Common Layout Development Guidelines
- [Flex Layout](ui-ts-layout-flex.md) - [Flexible Layout](ui-ts-layout-flex.md)
- [Grid Layout](ui-ts-layout-grid-container.md) - [Grid Layout](ui-ts-layout-grid-container.md)
- [Media Query](ui-ts-layout-mediaquery.md) - [Media Query](ui-ts-layout-mediaquery.md)
- Experiencing the Declarative UI - Experiencing the Declarative UI
...@@ -74,9 +72,9 @@ ...@@ -74,9 +72,9 @@
- [Implementing Page Redirection and Data Transmission](ui-ts-page-redirection-data-transmission.md) - [Implementing Page Redirection and Data Transmission](ui-ts-page-redirection-data-transmission.md)
- [Recommendations for Improving Performance](ts-performance-improvement-recommendation.md) - [Recommendations for Improving Performance](ts-performance-improvement-recommendation.md)
- JavaScript-based Web-like Development Paradigm - UI Development with JavaScript-compatible Web-like Development Paradigm
- [Overview](ui-js-overview.md) - [Overview](ui-js-overview.md)
- Framework - Framework Overview
- [File Organization](js-framework-file.md) - [File Organization](js-framework-file.md)
- ["js" Tag](js-framework-js-tag.md) - ["js" Tag](js-framework-js-tag.md)
- [app.js](js-framework-js-file.md) - [app.js](js-framework-js-file.md)
...@@ -100,14 +98,14 @@ ...@@ -100,14 +98,14 @@
- [Defining Gesture Events](ui-js-building-ui-event.md) - [Defining Gesture Events](ui-js-building-ui-event.md)
- [Defining Page Routes](ui-js-building-ui-routes.md) - [Defining Page Routes](ui-js-building-ui-routes.md)
- Common Component Development Guidelines - Common Component Development Guidelines
- Container Components - Container Component Development
- [List Development](ui-js-components-list.md) - [List Development](ui-js-components-list.md)
- [Dialog Development](ui-js-components-dialog.md) - [Dialog Development](ui-js-components-dialog.md)
- [Form Development](ui-js-components-form.md) - [Form Development](ui-js-components-form.md)
- [Stepper Development](ui-js-components-stepper.md) - [Stepper Development](ui-js-components-stepper.md)
- [Tabs Development](ui-js-component-tabs.md) - [Tabs Development](ui-js-component-tabs.md)
- [Swiper Development](ui-js-components-swiper.md) - [Swiper Development](ui-js-components-swiper.md)
- Basic Components - Basic Component Development
- [Text Development](ui-js-components-text.md) - [Text Development](ui-js-components-text.md)
- [Input Development](ui-js-components-input.md) - [Input Development](ui-js-components-input.md)
- [Button Development](ui-js-components-button.md) - [Button Development](ui-js-components-button.md)
...@@ -128,8 +126,8 @@ ...@@ -128,8 +126,8 @@
- [CanvasRenderingContext2D](ui-js-components-canvasrenderingcontext2d.md) - [CanvasRenderingContext2D](ui-js-components-canvasrenderingcontext2d.md)
- [Path2D](ui-js-components-path2d.md) - [Path2D](ui-js-components-path2d.md)
- [OffscreenCanvas](ui-js-components-offscreencanvas.md) - [OffscreenCanvas](ui-js-components-offscreencanvas.md)
- [Grid-container Development](ui-js-components-grid.md) - [Grid Container Development](ui-js-components-grid.md)
- Svg - SVG Development
- [Basics](ui-js-components-svg-overview.md) - [Basics](ui-js-components-svg-overview.md)
- [Graph Drawing](ui-js-components-svg-graphics.md) - [Graph Drawing](ui-js-components-svg-graphics.md)
- [Path Drawing](ui-js-components-svg-path.md) - [Path Drawing](ui-js-components-svg-path.md)
......
# Directory Structure # Directory Structure
The following figure shows the typical directory structure of the eTS module (entry/src/main) for an application with feature abilities (FAs). The following figure shows the typical directory structure of the **ets** module (in **entry/src/main**) for an application with feature abilities (FAs).
![en-us_image_0000001222967752](figures/en-us_image_0000001222967752.png) ![en-us_image_0000001222967752](figures/en-us_image_0000001222967752.png)
Functions of the files are as follows: The **ets** directory contains the following files:
- The Extended TypeScript (eTS) files that end with the .ets extension describe the UI layouts, styles, event interactions, and page logics. **.ets** files: Extended TypeScript (eTS) files that describe the UI layouts, styles, event interactions, and page logics.
Functions of the folders and files are as follows: Functions of the folders and files are as follows:
- The **app.ets** file manages global application logics and lifecycles. - The **app.ets** file manages global application logics and lifecycles.
- The **pages** directory stores all component pages. - The **pages** directory stores all pages.
- The **common** directory stores common code files, such as files of custom components and public methods.
> **NOTE**
>
> - For details about the **resources** directory in **src/main**, see [Resource File Categories](ui-ts-basic-resource-file-categories.md).
>- TypeScript and JavaScript files can be imported as page files.
"js" tag configuration:
- The **common** directory stores common code files, such as custom components and public methods. Configure the **"js"** tag in the configuration file of your application. The **"js"** tag contains the instance name, page route, and window configuration information.
> **NOTE** > **NOTE**
> >
> - The **resources** directory is located in **src/main**. For details about this directory, see [Resource File Categories](ui-ts-basic-resource-file-categories.md). > For details about the **"js"** tag in the FA model, see [Table 22 Internal structure of the js attribute](../quick-start/package-structure.md#internal-structure-of-the-js-attribute).
> >
> - TypeScript and JavaScript files can be imported as page files. > For details about the **"js"** tag in the stage model, see [Table 3 Internal structure of the module tag](../quick-start/stage-structure.md#internal-structure-of-the-module-tag).
# "js" Tag
Configure the "js" tag in the **config.json** file of your application. The "js" tag contains the instance name, page route, and window configuration information.
| Tag | Type | Default Value | Mandatory | Description |
| -------- | -------- | -------- | -------- | -------- |
| name | string | default | Yes | Name of the eTS instance. |
| pages | Array | - | Yes | Page route information. For details, see ["pages"](#pages). |
| window | Object | - | No | Window configuration information. For details, see ["window"](#window). |
| mode | Object | - | No | Running type and syntax style of the JS component. For details, see ["mode"](#mode). |
## pages
The "pages" defines the route information of each page's entry component. Each page consists of the page path and page name. The following is an example:
```json
{
"pages": [
"pages/index",
"pages/detail"
]
}
```
> **NOTE**
> - The first page in the "pages" list is the home page of the application.
>
> - The page name must not be a component name, for example, Text.ets or Button.ets.
>
> - Each page file must contain the [page entry component](../ui/ts-component-based-entry.md) (with the @Entry decoration).
## window
The "window" configures the view window. The following attributes can be configured:
| Type | Default Value | Description |
| -------- | -------- | -------- |
| designWidth | - | Logical width of the view. The default value is 720. (The default value is 454 for wearables.) The logical width of the view determines the unit size of lpx. For example, if designWidth is 720 and the view width is 1440 physical pixels, 1 lpx is 2 physical pixels. For details, see [lpx](../ui/ts-pixel-units.md). |
```json
{
...
"window": {
"designWidth": 720
}
...
}
```
## mode
The "mode" configures the running type and syntax style of a JS component. The following attributes are supported:
| Type | Default Value | Description |
| -------- | -------- | -------- |
| type | - | Running type of the JS component. The options are as follows:<br/>- pageAbility: Run the JS component in ability mode.<br/>- form: Run the JS component as a service widget. |
| syntax | - | Syntax type of the JS component. The options are as follows:<br/>- hml: compiled in the .hml, .css, or .js style.<br/>- ets: compiled in the declarative syntax style. |
> **NOTE**
> If type is set to form, syntax cannot be ets.
## Example
config.json:
```json
{
"app": {
"bundleName": "com.example.player",
"version": {
"code": 1,
"name": "1.0"
},
"vendor": "example"
},
"module": {
"js": [{
"name": "default",
"pages": [
"pages/index",
"pages/detail"
],
"window": {
"designWidth": 720
},
"mode": {
"type": "pageAbility",
"syntax": "ets"
},
}],
"abilities": [{
...
}]
}
}
```
# Accessing Application Resources # Resource Access
## Accessing Application Resources ## Accessing Application Resources
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册