diff --git a/en/application-dev/Readme-EN.md b/en/application-dev/Readme-EN.md index 32d357ba419d3cde2750011141449e2129133a5d..623145619dbee26958ac53e7bce4ed40e213b860 100644 --- a/en/application-dev/Readme-EN.md +++ b/en/application-dev/Readme-EN.md @@ -15,6 +15,7 @@ - Development Fundamentals - [Application Package Structure Configuration File (FA Model)](quick-start/package-structure.md) - [Application Package Structure Configuration File (Stage Model)](quick-start/stage-structure.md) + - [Resource File Categories](quick-start/basic-resource-file-categories.md) - [SysCap](quick-start/syscap.md) - Development - [Ability Development](ability/Readme-EN.md) @@ -42,6 +43,9 @@ - [Component Reference (TypeScript-based Declarative Development Paradigm)](reference/arkui-ts/Readme-EN.md) - [Component Reference (JavaScript-based Web-like Development Paradigm)](reference/arkui-js/Readme-EN.md) - APIs - - [JS and TS APIs](reference/apis/Readme-EN.md) + - [JS and TS APIs](reference/apis/Readme-EN.md) + - Native APIs + - [Standard Libraries](reference/native-lib/third_party_libc/musl.md) + - [Node_API](reference/native-lib/third_party_napi/napi.md) - Contribution - [How to Contribute](../contribute/documentation-contribution.md) diff --git a/en/application-dev/media/public_sys-resources/icon-caution.gif b/en/application-dev/media/public_sys-resources/icon-caution.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/en/application-dev/media/public_sys-resources/icon-caution.gif differ diff --git a/en/application-dev/media/public_sys-resources/icon-danger.gif b/en/application-dev/media/public_sys-resources/icon-danger.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/en/application-dev/media/public_sys-resources/icon-danger.gif differ diff --git a/en/application-dev/media/public_sys-resources/icon-note.gif b/en/application-dev/media/public_sys-resources/icon-note.gif new file mode 100644 index 0000000000000000000000000000000000000000..6314297e45c1de184204098efd4814d6dc8b1cda Binary files /dev/null and b/en/application-dev/media/public_sys-resources/icon-note.gif differ diff --git a/en/application-dev/media/public_sys-resources/icon-notice.gif b/en/application-dev/media/public_sys-resources/icon-notice.gif new file mode 100644 index 0000000000000000000000000000000000000000..86024f61b691400bea99e5b1f506d9d9aef36e27 Binary files /dev/null and b/en/application-dev/media/public_sys-resources/icon-notice.gif differ diff --git a/en/application-dev/media/public_sys-resources/icon-tip.gif b/en/application-dev/media/public_sys-resources/icon-tip.gif new file mode 100644 index 0000000000000000000000000000000000000000..93aa72053b510e456b149f36a0972703ea9999b7 Binary files /dev/null and b/en/application-dev/media/public_sys-resources/icon-tip.gif differ diff --git a/en/application-dev/media/public_sys-resources/icon-warning.gif b/en/application-dev/media/public_sys-resources/icon-warning.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/en/application-dev/media/public_sys-resources/icon-warning.gif differ diff --git a/en/application-dev/napi/Readme-EN.md b/en/application-dev/napi/Readme-EN.md index b34a02ddc209ad3c0c4feec76bce3247fbdb5b27..280efd8afa5fa845dab0d607ed94b33e2a75e6d3 100644 --- a/en/application-dev/napi/Readme-EN.md +++ b/en/application-dev/napi/Readme-EN.md @@ -2,6 +2,7 @@ - [Using Native APIs in Application Projects](napi-guidelines.md) - [Drawing Development](drawing-guidelines.md) -- [Native Window Development](native_window-guidelines.md) - [Raw File Development](rawfile-guidelines.md) +- [Native Window Development](native-window-guidelines.md) + diff --git a/en/application-dev/napi/native_window-guidelines.md b/en/application-dev/napi/native-window-guidelines.md similarity index 100% rename from en/application-dev/napi/native_window-guidelines.md rename to en/application-dev/napi/native-window-guidelines.md diff --git a/en/application-dev/reference/native-lib/Readme-EN.md b/en/application-dev/reference/native-lib/Readme-EN.md index 536c57df0429482b768daa51775f5bb8bede353a..4a6d86ae4beb3d6bd93521604ec6ffbd36795389 100644 --- a/en/application-dev/reference/native-lib/Readme-EN.md +++ b/en/application-dev/reference/native-lib/Readme-EN.md @@ -1,6 +1,9 @@ # Standard Libraries Supported by Native APIs -- [Standard Libraries](third_party_libc/musl.md) - [Node_API](third_party_napi/napi.md) - [libuv](third_party_libuv/libuv.md) -- [Native API Symbols Not Exported](third_party_libc/musl-peculiar-symbol.md) \ No newline at end of file +- [Standard Libraries](third_party_libc/musl.md) +- Appendix +- [Native API Symbols Not Exported](third_party_libc/musl-peculiar-symbol.md) + - [EGL Symbols Exported from Native APIs](third_party_opengl/egl-symbol.md) + - [OpenGL ES 3.0 Symbols Exported from Native APIs](third_party_opengl/openglesv3-symbol.md) \ No newline at end of file diff --git a/en/application-dev/reference/third_party_opengl/egl-symbol.md b/en/application-dev/reference/native-lib/third_party_opengl/egl-symbol.md similarity index 100% rename from en/application-dev/reference/third_party_opengl/egl-symbol.md rename to en/application-dev/reference/native-lib/third_party_opengl/egl-symbol.md diff --git a/en/application-dev/reference/third_party_opengl/openglesv3-symbol.md b/en/application-dev/reference/native-lib/third_party_opengl/openglesv3-symbol.md similarity index 100% rename from en/application-dev/reference/third_party_opengl/openglesv3-symbol.md rename to en/application-dev/reference/native-lib/third_party_opengl/openglesv3-symbol.md diff --git a/en/application-dev/ui/Readme-EN.md b/en/application-dev/ui/Readme-EN.md index 13407b26339b0a31cb928ab8ebfe39d86ea02ed9..8c41acc214947881abfc99bc2ec6b59ca55b7662 100644 --- a/en/application-dev/ui/Readme-EN.md +++ b/en/application-dev/ui/Readme-EN.md @@ -4,74 +4,72 @@ - TypeScript-based Declarative Development Paradigm - [Overview](ui-ts-overview.md) - Framework Overview - - File Organization - - [Directory Structure](ts-framework-directory.md) - - [Rules for Accessing Application Code Files](ts-framework-file-access-rules.md) - - ["js" Tag](ts-framework-js-tag.md) - - Resource Management - - [Resource File Categories](ui-ts-basic-resource-file-categories.md) - - [Accessing Resources](ts-resource-access.md) - - [Pixel Units](ts-pixel-units.md) + - File Organization + - [Directory Structure](ts-framework-directory.md) + - [Rules for Accessing Application Code Files](ts-framework-file-access-rules.md) + - ["js" Tag](ts-framework-js-tag.md) + - Resource Management + - [Resource File Categories](ui-ts-basic-resource-file-categories.md) + - [Accessing Resources](ts-resource-access.md) + - [Pixel Units](ts-pixel-units.md) - Declarative Syntax - - [Overview](ts-syntax-intro.md) - - General UI Description Specifications - - [Basic Concepts](ts-general-ui-concepts.md) - - Declarative UI Description Specifications - - [Configuration Without Parameters](ts-parameterless-configuration.md) - - [Configuration with Mandatory Parameters](ts-configuration-with-mandatory-parameters.md) - - - [Attribute Configuration](ts-attribution-configuration.md) - - [Event Configuration](ts-event-configuration.md) - - [Child Component Configuration](ts-child-component-configuration.md) - - Componentization - - [@Component](ts-component-based-component.md) - - [@Entry](ts-component-based-entry.md) - - [@Preview](ts-component-based-preview.md) - - [@Builder](ts-component-based-builder.md) - - [@Extend](ts-component-based-extend.md) - - [@CustomDialog](ts-component-based-customdialog.md) - - [@Styles](ts-component-based-styles.md) - - About UI State Management - - [Basic Concepts](ts-ui-state-mgmt-concepts.md) - - Managing Component States - - [@State](ts-component-states-state.md) - - [@Prop](ts-component-states-prop.md) - - [@Link](ts-component-states-link.md) - - Managing Application States - - [AppStorage](ts-application-states-appstorage.md) - - [PersistentStorage](ts-application-states-apis-persistentstorage.md) - - [Environment](ts-application-states-apis-environment.md) - - Managing Other States - - [@Observed and @ObjectLink](ts-other-states-observed-objectlink.md) - - [@Consume and @Provide](ts-other-states-consume-provide.md) - - [@Watch](ts-other-states-watch.md) - - About Rendering Control Syntax - - [if/else](ts-rending-control-syntax-if-else.md) - - [ForEach](ts-rending-control-syntax-foreach.md) - - [LazyForEach](ts-rending-control-syntax-lazyforeach.md) - - About @Component - - [build Function](ts-function-build.md) - - [Initialization of Custom Components' Member Variables](ts-custom-component-initialization.md) - - [Custom Component Lifecycle Callbacks](ts-custom-component-lifecycle-callbacks.md) - - [Component Creation and Re-initialization](ts-component-creation-re-initialization.md) - - [About Syntactic Sugar](ts-syntactic-sugar.md) + - [Overview](ts-syntax-intro.md) + - General UI Description Specifications + - [Basic Concepts](ts-general-ui-concepts.md) + - Declarative UI Description Specifications + - [Configuration Without Parameters](ts-parameterless-configuration.md) + - [Configuration with Mandatory Parameters](ts-configuration-with-mandatory-parameters.md) + - [Attribute Configuration](ts-attribution-configuration.md) + - [Event Configuration](ts-event-configuration.md) + - [Child Component Configuration](ts-child-component-configuration.md) + - Componentization + - [@Component](ts-component-based-component.md) + - [@Entry](ts-component-based-entry.md) + - [@Preview](ts-component-based-preview.md) + - [@Builder](ts-component-based-builder.md) + - [@Extend](ts-component-based-extend.md) + - [@CustomDialog](ts-component-based-customdialog.md) + - [@Styles](ts-component-based-styles.md) + - About UI State Management + - [Basic Concepts](ts-ui-state-mgmt-concepts.md) + - Managing Component States + - [@State](ts-component-states-state.md) + - [@Prop](ts-component-states-prop.md) + - [@Link](ts-component-states-link.md) + - Managing Application States + - [AppStorage](ts-application-states-appstorage.md) + - [PersistentStorage](ts-application-states-apis-persistentstorage.md) + - [Environment](ts-application-states-apis-environment.md) + - Managing Other States + - [@Observed and @ObjectLink](ts-other-states-observed-objectlink.md) + - [@Consume and @Provide](ts-other-states-consume-provide.md) + - [@Watch](ts-other-states-watch.md) + - About Rendering Control Syntax + - [if/else](ts-rending-control-syntax-if-else.md) + - [ForEach](ts-rending-control-syntax-foreach.md) + - [LazyForEach](ts-rending-control-syntax-lazyforeach.md) + - About @Component + - [build Function](ts-function-build.md) + - [Initialization of Custom Components' Member Variables](ts-custom-component-initialization.md) + - [Custom Component Lifecycle Callbacks](ts-custom-component-lifecycle-callbacks.md) + - [Component Creation and Re-initialization](ts-component-creation-re-initialization.md) + - [About Syntactic Sugar](ts-syntactic-sugar.md) - Common Component Development Guidelines - - [Button](ui-ts-basic-components-button.md) - - [Web](ui-ts-components-web.md) + - [Button](ui-ts-basic-components-button.md) + - [Web](ui-ts-components-web.md) - Common Layout Development Guidelines - - [Flex Layout](ui-ts-layout-flex.md) - - [Grid Layout](ui-ts-layout-grid-container.md) - - [Media Query](ui-ts-layout-mediaquery.md) + - [Flex Layout](ui-ts-layout-flex.md) + - [Grid Layout](ui-ts-layout-grid-container.md) + - [Media Query](ui-ts-layout-mediaquery.md) - Experiencing the Declarative UI - - [Creating a Declarative UI Project](ui-ts-creating-project.md) - - [Getting to Know Components](ui-ts-components.md) - - [Creating a Simple Page](ui-ts-creating-simple-page.md) + - [Creating a Declarative UI Project](ui-ts-creating-project.md) + - [Getting to Know Components](ui-ts-components.md) + - [Creating a Simple Page](ui-ts-creating-simple-page.md) - Defining Page Layout and Connection - - [Building a Food Data Model](ui-ts-building-data-model.md) - - [Building a Food Category List Layout](ui-ts-building-category-list-layout.md) - - [Building a Food Category Grid Layout](ui-ts-building-category-grid-layout.md) - - [Implementing Page Redirection and Data Transmission](ui-ts-page-redirection-data-transmission.md) - + - [Building a Food Data Model](ui-ts-building-data-model.md) + - [Building a Food Category List Layout](ui-ts-building-category-list-layout.md) + - [Building a Food Category Grid Layout](ui-ts-building-category-grid-layout.md) + - [Implementing Page Redirection and Data Transmission](ui-ts-page-redirection-data-transmission.md) - JavaScript-based Web-like Development Paradigm - [Overview](ui-js-overview.md) - Framework diff --git a/en/application-dev/website.md b/en/application-dev/website.md index 69c3b77653cc9351de9e2e58c2ee12aebeabbafe..25b2c449c0df4bc64478eadb7591639cc4d04865 100644 --- a/en/application-dev/website.md +++ b/en/application-dev/website.md @@ -11,7 +11,6 @@ - Development Fundamentals - [Application Package Structure Configuration File (FA Model)](quick-start/package-structure.md) - [Application Package Structure Configuration File (Stage Model)](quick-start/stage-structure.md) - - [Resource File Categories](quick-start/basic-resource-file-categories.md) - [SysCap](quick-start/syscap.md) - Development - Ability Development @@ -43,12 +42,11 @@ - [Rules for Accessing Application Code Files](ui/ts-framework-file-access-rules.md) - ["js" Tag](ui/ts-framework-js-tag.md) - Resource Access - - [Accessing Application Resources](ui/ts-application-resource-access.md) - - [Accessing System Resources](ui/ts-system-resource-access.md) - - [Media Resource Types](ui/ts-media-resource-type.md) + - [Resource File Categories](ui/ui-ts-basic-resource-file-categories.md) + - [Accessing Application Resources](ui/ts-resource-access.md) - [Pixel Units](ui/ts-pixel-units.md) - - [Types](ui/ts-types.md) - Declarative Syntax + - [Overview](ui/ts-syntax-intro.md) - General UI Description Specifications - [Basic Concepts](ui/ts-general-ui-concepts.md) @@ -180,11 +178,11 @@ - [Custom Components](ui/ui-js-custom-components.md) - Common Event and Notification - [Common Event and Notification Overview](notification/notification-brief.md) - - Common Event - - [Common Event Development](notification/common-event.md) - - Notification - - [Notification Development](notification/notification.md) - - Debugging Tools + - [Common Event Development](notification/common-event.md) + - [Notification Development](notification/notification-guidelines.md) + - Agent-Powered Scheduled Reminder + - [Agent-Powered Scheduled Reminder Overview](notification/background-agent-scheduled-reminder-overview.md) + - [Agent-Powered Scheduled Reminder Development](notification/background-agent-scheduled-reminder-guide.md) - [Debugging Assistant Usage](notification/assistant-guidelines.md) - Window Manager - Window @@ -212,6 +210,10 @@ - Image - [Image Development](media/image.md) - Security + - Access Control + - [Access Control Overview](security/accesstoken-overview.md) + - [Access Control Development](security/accesstoken-guidelines.md) + - [Permission List](security/permission-list.md) - User Authentication - [User Authentication Overview](security/userauth-overview.md) - [User Authentication Development](security/userauth-guidelines.md) @@ -220,9 +222,6 @@ - [HUKS Development](security/huks-guidelines.md) - hapsigner - [hapsigner Guide](security/hapsigntool-guidelines.md) - - Access Control - - [Access Control Overview](security/accesstoken-overview.md) - - [Access Control Development](security/accesstoken-guidelines.md) - Connectivity - Network Management - [Network Management Overview](connectivity/net-mgmt-overview.md) @@ -250,15 +249,13 @@ - Distributed Data Object - [Distributed Data Object Overview](database/database-distributedobject-overview.md) - [Distributed Data Object Development](database/database-distributedobject-guidelines.md) - - Agent-Powered Scheduled Reminders - - [Agent-Powered Scheduled Reminder Overview](background-agent-scheduled-reminder/background-agent-scheduled-reminder-overview.md) - - [Agent-Powered Scheduled Reminder Development](background-agent-scheduled-reminder/background-agent-scheduled-reminder-guide.md) - - Background Task Management - - [Background Task Management Overview](background-task-management/background-task-overview.md) - - [Background Task Management Development](background-task-management/background-task-dev-guide.md) - - Work Scheduler - - [Work Scheduler Overview](work-scheduler/work-scheduler-overview.md) - - [Work Scheduler Development](work-scheduler/work-scheduler-dev-guide.md) + - Task Management + - Background Task Management + - [Background Task Management Overview](background-task-management/background-task-overview.md) + - [Background Task Management Development](background-task-management/background-task-dev-guide.md) + - Work Scheduler + - [Work Scheduler Overview](task-management/work-scheduler-overview.md) + - [Work Scheduler Development](task-management/work-scheduler-dev-guide.md) - Device - USB Service - [USB Service Overview](device/usb-overview.md) @@ -292,7 +289,10 @@ - [Internationalization Development (i18n)](internationalization/i18n-guidelines.md) - Native APIs - [Using Native APIs in Application Projects](napi/napi-guidelines.md) -- Tools + - [Drawing Development](napi/drawing-guidelines.md) + - [Raw File Development](napi/rawfile-guidelines.md) + - [NativeWindow Development](napi/native-window-guidelines.md) +- Tools - [DevEco Studio (OpenHarmony) User Guide](quick-start/deveco-studio-user-guide-for-openharmony.md) - Hands-On Tutorials - [Samples](https://gitee.com/openharmony/app_samples/blob/master/README.md) @@ -562,8 +562,8 @@ - [@ohos.application.formError](reference/apis/js-apis-formerror.md) - [@ohos.application.formHost](reference/apis/js-apis-formhost.md) - [@ohos.application.formInfo](reference/apis/js-apis-formInfo.md) - - [@ohos.application.missionManager](reference/apis/js-apis-missionManager.md) - [@ohos.application.formProvider](reference/apis/js-apis-formprovider.md) + - [@ohos.application.missionManager](reference/apis/js-apis-missionManager.md) - [@ohos.ability.particleAbility](reference/apis/js-apis-particleAbility.md) - [@ohos.application.ServiceExtensionAbility](reference/apis/js-apis-service-extension-ability.md) - [@ohos.application.StartOptions](reference/apis/js-apis-application-StartOptions.md) @@ -575,19 +575,23 @@ - [AbilityContext](reference/apis/js-apis-ability-context.md) - [abilityDelegator](reference/apis/js-apis-application-abilityDelegator.md) - [abilityDelegatorArgs](reference/apis/js-apis-application-abilityDelegatorArgs.md) + - [AbilityManager](reference/apis/js-apis-abilityManager.md) - [abilityMonitor](reference/apis/js-apis-application-abilityMonitor.md) - [AbilityRunningInfo](reference/apis/js-apis-abilityrunninginfo.md) - [AbilityStageContext](reference/apis/js-apis-abilitystagecontext.md) - [Context](reference/apis/js-apis-application-context.md) + - [ExtensionAbilityContext](reference/apis/js-apis-extension-ability-context.md) + - [ExtensionAbilityInfo](reference/apis/js-apis-extensionAbilityInfo.md) - [ExtensionContext](reference/apis/js-apis-extension-context.md) - [ExtensionRunningInfo](reference/apis/js-apis-extensionrunninginfo.md) - [FormExtensionContext](reference/apis/js-apis-formextensioncontext.md) + - [MissionInfo](reference/apis/js-apis-application-missionInfo.md) - [MissionSnapshot](reference/apis/js-apis-application-MissionSnapshot.md) - [PermissionRequestResult](reference/apis/js-apis-permissionrequestresult.md) - [ProcessRunningInfo](reference/apis/js-apis-processrunninginfo.md) + - [ServiceExtAbilityContext](reference/apis/js-apis-serviceExtAbilityContext.md) - [ServiceExtensionContext](reference/apis/js-apis-service-extension-context.md) - [shellCmdResult](reference/apis/js-apis-application-shellCmdResult.md) - - [AbilityStageContext](reference/apis/js-apis-abilityStageContext.md) - Common Event and Notification - [@ohos.commonEvent](reference/apis/js-apis-commonEvent.md) - [@ohos.events.emitter](reference/apis/js-apis-emitter.md) @@ -598,6 +602,14 @@ - [@ohos.bundle](reference/apis/js-apis-Bundle.md) - [@ohos.bundleState ](reference/apis/js-apis-deviceUsageStatistics.md) - [@ohos.zlib](reference/apis/js-apis-zlib.md) + - [AbilityInfo](reference/apis/js-apis-bundle-AbilityInfo.md) + - [ApplicationInfo](reference/apis/js-apis-bundle-ApplicationInfo.md) + - [BundleInfo](reference/apis/js-apis-bundle-BundleInfo.md) + - [CustomizeData](reference/apis/js-apis-bundle-CustomizeData.md) + - [ExtensionAbilityInfo](reference/apis/js-apis-bundle-ExtensionAbilityInfo.md) + - [HapModuleInfo](reference/apis/js-apis-bundle-HapModuleInfo.md) + - [Metadata](reference/apis/js-apis-bundle-Metadata.md) + - [ModuleInfo](reference/apis/js-apis-bundle-ModuleInfo.md) - UI Page - [@ohos.animator](reference/apis/js-apis-animator.md) - [@ohos.mediaquery](reference/apis/js-apis-mediaquery.md) @@ -611,7 +623,6 @@ - [webgl2](reference/apis/js-apis-webgl2.md) - Media - [@ohos.multimedia.audio](reference/apis/js-apis-audio.md) - - [@ohos.multimedia.camera](reference/apis/js-apis-camera.md) - [@ohos.multimedia.image](reference/apis/js-apis-image.md) - [@ohos.multimedia.media](reference/apis/js-apis-media.md) - [@ohos.multimedia.medialibrary](reference/apis/js-apis-medialibrary.md) @@ -635,7 +646,6 @@ - [@ohos.data.distributedData](reference/apis/js-apis-distributed-data.md) - [@ohos.data.distributedDataObject](reference/apis/js-apis-data-distributedobject.md) - [@ohos.data.rdb](reference/apis/js-apis-data-rdb.md) - - [@ohos.settings](reference/apis/js-apis-settings.md) - [@ohos.data.storage](reference/apis/js-apis-data-storage.md) - [resultSet](reference/apis/js-apis-data-resultset.md) - File Management @@ -643,6 +653,7 @@ - [@ohos.environment](reference/apis/js-apis-environment.md) - [@ohos.fileio](reference/apis/js-apis-fileio.md) - [@ohos.fileManager](reference/apis/js-apis-filemanager.md) + - [@ohos.securityLabel](reference/apis/js-apis-securityLabel.md) - [@ohos.statfs](reference/apis/js-apis-statfs.md) - [@ohos.storageStatistics](reference/apis/js-apis-storage-statistics.md) - [@ohos.volumeManager](reference/apis/js-apis-volumemanager.md) @@ -657,12 +668,15 @@ - Network Management - [@ohos.net.connection](reference/apis/js-apis-net-connection.md) - [@ohos.net.http](reference/apis/js-apis-http.md) - - [@ohos.request](reference/apis/js-apis-request.md) - [@ohos.net.socket](reference/apis/js-apis-socket.md) - [@ohos.net.webSocket](reference/apis/js-apis-webSocket.md) + - [@ohos.request](reference/apis/js-apis-request.md) - Connectivity - [@ohos.bluetooth](reference/apis/js-apis-bluetooth.md) - [@ohos.connectedTag](reference/apis/js-apis-connectedTag.md) + - [@ohos.nfc.cardEmulation](reference/apis/js-apis-cardEmulation.md) + - [@ohos.nfc.controller](reference/apis/js-apis-nfcController.md) + - [@ohos.nfc.tag](reference/apis/js-apis-nfcTag.md) - [@ohos.rpc](reference/apis/js-apis-rpc.md) - [@ohos.wifi](reference/apis/js-apis-wifi.md) - [@ohos.wifiext](reference/apis/js-apis-wifiext.md) @@ -681,6 +695,7 @@ - [@ohos.screenLock](reference/apis/js-apis-screen-lock.md) - [@ohos.systemTime](reference/apis/js-apis-system-time.md) - [@ohos.wallpaper](reference/apis/js-apis-wallpaper.md) + - [console](reference/apis/js-apis-logs.md) - [Timer](reference/apis/js-apis-timer.md) - Device Management - [@ohos.batteryInfo ](reference/apis/js-apis-battery-info.md) @@ -695,6 +710,7 @@ - [@ohos.power](reference/apis/js-apis-power.md) - [@ohos.runningLock](reference/apis/js-apis-runninglock.md) - [@ohos.sensor](reference/apis/js-apis-sensor.md) + - [@ohos.settings](reference/apis/js-apis-settings.md) - [@ohos.systemParameter](reference/apis/js-apis-system-parameter.md) - [@ohos.thermal](reference/apis/js-apis-thermal.md) - [@ohos.update](reference/apis/js-apis-update.md) @@ -751,4 +767,3 @@ - [@system.sensor](reference/apis/js-apis-system-sensor.md) - [@system.storage](reference/apis/js-apis-system-storage.md) - [@system.vibrator](reference/apis/js-apis-system-vibrate.md) - - [console](reference/apis/js-apis-logs.md) \ No newline at end of file diff --git a/en/device-dev/kernel/Readme-EN.md b/en/device-dev/kernel/Readme-EN.md index b7b289d4c0a9814fed92f8829618077b7588f2ad..95febb036584eac502f0d68923f2cac2f0a43fe2 100644 --- a/en/device-dev/kernel/Readme-EN.md +++ b/en/device-dev/kernel/Readme-EN.md @@ -19,13 +19,13 @@ - [Software Timer](kernel-mini-basic-soft.md) - Extended Components - [C++ Support](kernel-mini-extend-support.md) - - [PUP](kernel-mini-extend-cpup.md) + - [CPUP](kernel-mini-extend-cpup.md) - [Dynamic Loading](kernel-mini-extend-dynamic-loading.md) - - [File System](kernel-mini-extend-file.md) + - File System - [FAT](kernel-mini-extend-file-fat.md) - [LittleFS](kernel-mini-extend-file-lit.md) - Kernel Debugging - - [Memory Debugging](kernel-mini-memory-debug.md) + - Memory Debugging - [Memory Information Statistics](kernel-mini-memory-debug-mes.md) - [Memory Leak Check](kernel-mini-memory-debug-det.md) - [Memory Corruption Check](kernel-mini-memory-debug-cet.md) @@ -52,25 +52,25 @@ - Memory Management - [Heap Memory Management](kernel-small-basic-memory-heap.md) - [Physical Memory Management](kernel-small-basic-memory-physical.md) - - [Virtual Memory Management](kernel-small-basic-memory-virtual.md) - - [Virtual-to-Physical Mapping](kernel-small-basic-inner-reflect.md) + - [Virtual Memory Management](kernel-small-basic-memory-virtual.md) + - [Virtual-to-Physical Mapping](kernel-small-basic-inner-reflect.md) - Kernel Communication Mechanisms - [Event](kernel-small-basic-trans-event.md) - - [Semaphore](kernel-small-basic-trans-semaphore.md) - - [Mutex](kernel-small-basic-trans-mutex.md) + - [Semaphore](kernel-small-basic-trans-semaphore.md) + - [Mutex](kernel-small-basic-trans-mutex.md) - [Queue](kernel-small-basic-trans-queue.md) - [RW Lock](kernel-small-basic-trans-rwlock.md) - [Futex](kernel-small-basic-trans-user-mutex.md) - [Signal](kernel-small-basic-trans-user-signal.md) - [Time Management](kernel-small-basic-time.md) - - [Software Timer](kernel-small-basic-softtimer.md) - - [Atomic Operation](kernel-small-basic-atomic.md) + - [Software Timer](kernel-small-basic-softtimer.md) + - [Atomic Operation](kernel-small-basic-atomic.md) - Extension Components - [System Call](kernel-small-bundles-system.md) - [Dynamic Loading and Linking](kernel-small-bundles-linking.md) - [Virtual Dynamic Shared Object](kernel-small-bundles-share.md) - [LiteIPC](kernel-small-bundles-ipc.md) - - [File Systems](kernel-small-bundles-fs.md) + - File Systems - [Virtual File System](kernel-small-bundles-fs-virtual.md) - Supported File Systems - [FAT](kernel-small-bundles-fs-support-fat.md) @@ -160,7 +160,7 @@ - [Working Principles](kernel-small-debug-user-function.md) - Usage - [Available APIs](kernel-small-debug-user-guide-api.md) - - [How to Use](kernel-small-debug-user-guide-use.md) + - How to Use - [Calling APIs](kernel-small-debug-user-guide-use-api.md) - [Using the CLI](kernel-small-debug-user-guide-use-cli.md) - [Typical Memory Problems](kernel-small-debug-user-faqs.md) diff --git a/en/device-dev/kernel/public_sys-resources/icon-caution.gif b/en/device-dev/kernel/public_sys-resources/icon-caution.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/en/device-dev/kernel/public_sys-resources/icon-caution.gif differ diff --git a/en/device-dev/kernel/public_sys-resources/icon-danger.gif b/en/device-dev/kernel/public_sys-resources/icon-danger.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/en/device-dev/kernel/public_sys-resources/icon-danger.gif differ diff --git a/en/device-dev/kernel/public_sys-resources/icon-note.gif b/en/device-dev/kernel/public_sys-resources/icon-note.gif new file mode 100644 index 0000000000000000000000000000000000000000..6314297e45c1de184204098efd4814d6dc8b1cda Binary files /dev/null and b/en/device-dev/kernel/public_sys-resources/icon-note.gif differ diff --git a/en/device-dev/kernel/public_sys-resources/icon-notice.gif b/en/device-dev/kernel/public_sys-resources/icon-notice.gif new file mode 100644 index 0000000000000000000000000000000000000000..86024f61b691400bea99e5b1f506d9d9aef36e27 Binary files /dev/null and b/en/device-dev/kernel/public_sys-resources/icon-notice.gif differ diff --git a/en/device-dev/kernel/public_sys-resources/icon-tip.gif b/en/device-dev/kernel/public_sys-resources/icon-tip.gif new file mode 100644 index 0000000000000000000000000000000000000000..93aa72053b510e456b149f36a0972703ea9999b7 Binary files /dev/null and b/en/device-dev/kernel/public_sys-resources/icon-tip.gif differ diff --git a/en/device-dev/kernel/public_sys-resources/icon-warning.gif b/en/device-dev/kernel/public_sys-resources/icon-warning.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/en/device-dev/kernel/public_sys-resources/icon-warning.gif differ diff --git a/en/device-dev/quick-start/Readme-EN.md b/en/device-dev/quick-start/Readme-EN.md index 2afa83a8d1a6e0ea5e79f97018044f86e1be3a1f..fbc9be315ede9a6f23b2b7dba92c0d2df7be9b46 100644 --- a/en/device-dev/quick-start/Readme-EN.md +++ b/en/device-dev/quick-start/Readme-EN.md @@ -19,9 +19,8 @@ - [Burning](quickstart-ide-lite-steps-hi3516-burn.md) - [Running](quickstart-ide-lite-steps-hi3516-running.md) - Appendix - - Introduction to Development Boards - - [Introduction to the Hi3861 Development Board](quickstart-ide-lite-introduction-hi3861.md) - - [Introduction to the Hi3516 Development Board](quickstart-ide-lite-introduction-hi3516.md) + - [Introduction to the Hi3861 Development Board](quickstart-ide-lite-introduction-hi3861.md) + - [Introduction to the Hi3516 Development Board](quickstart-ide-lite-introduction-hi3516.md) - Getting Started with Mini and Small Systems (Installation Package Mode) - [Mini and Small System Overview](quickstart-lite-overview.md) - [Environment Preparation](quickstart-lite-env-setup.md) @@ -67,9 +66,8 @@ - [Burning](quickstart-ide-standard-running-rk3568-burning.md) - [Running](quickstart-ide-standard-running-rk3568-running.md) - Appendix - - Introduction to Development Boards - - [Introduction to the Hi3516 Development Board](quickstart-ide-standard-board-introduction-hi3516.md) - - [Introduction to the RK3568 Development Board](quickstart-ide-standard-board-introduction-rk3568.md) + - [Introduction to the Hi3516 Development Board](quickstart-ide-standard-board-introduction-hi3516.md) + - [Introduction to the RK3568 Development Board](quickstart-ide-standard-board-introduction-rk3568.md) - Getting Started with Standard System (Installation Package Mode) - [Standard System Overview](quickstart-standard-overview.md) - [Setting Up Environments for Standard System](quickstart-standard-env-setup.md) diff --git a/zh-cn/application-dev/database/database-mdds-overview.md b/zh-cn/application-dev/database/database-mdds-overview.md index e7deb637988db378e9e6bf20e32df1f6e408d4a7..43e5b331ba150ee646bdd7cfe44ffc1351965cb8 100644 --- a/zh-cn/application-dev/database/database-mdds-overview.md +++ b/zh-cn/application-dev/database/database-mdds-overview.md @@ -9,65 +9,69 @@ ## 基本概念 -- **KV数据模型** - “KV数据模型”是“Key-Value数据模型”的简称，“Key-Value”即“键-值”；其数据以键值对的形式进行组织、索引和存储。 +### KV数据模型 - KV数据模型适合不涉及过多数据关系和业务关系的业务数据存储，比SQL数据库存储拥有更好的读写性能，同时因其在分布式场景中降低了解决数据库版本兼容问题的复杂度，和数据同步过程中冲突解决的复杂度而被广泛使用。分布式数据库也是基于KV数据模型，对外提供KV类型的访问接口。 +“KV数据模型”是“Key-Value数据模型”的简称，“Key-Value”即“键-值”；其数据以键值对的形式进行组织、索引和存储。 -- **分布式数据库事务性** - 分布式数据库事务支持本地事务（和传统数据库的事务概念一致）和同步事务。同步事务是指在设备之间同步数据时，以本地事务为单位进行同步，一次本地事务的修改要么都同步成功，要么都同步失败。 +KV数据模型适合不涉及过多数据关系和业务关系的业务数据存储，比SQL数据库存储拥有更好的读写性能，同时因其在分布式场景中降低了解决数据库版本兼容问题的复杂度，和数据同步过程中冲突解决的复杂度而被广泛使用。分布式数据库也是基于KV数据模型，对外提供KV类型的访问接口。 -- **分布式数据库一致性** - 在分布式场景中一般会涉及多个设备，组网内设备之间看到的数据是否一致称为分布式数据库的一致性。分布式数据库一致性可以分为**强一致性**、**弱一致性**和**最终一致性**。 +### 分布式数据库事务性 - - **强一致性**：是指某一设备成功增、删、改数据后，组网内设备对该数据的读取操作都将得到更新后的值。 - - **弱一致性**：是指某一设备成功增、删、改数据后，组网内设备可能读取到本次更新数据，也可能读取不到，不能保证在多长时间后每个设备的数据一定是一致的。 - - **最终一致性**：是指某一设备成功增、删、改数据后，组网内设备可能读取不到本次更新数据，但在某个时间窗口之后组网内设备的数据能够达到一致状态。 +分布式数据库事务支持本地事务（和传统数据库的事务概念一致）和同步事务。同步事务是指在设备之间同步数据时，以本地事务为单位进行同步，一次本地事务的修改要么都同步成功，要么都同步失败。 - 强一致性对分布式数据的管理要求非常高，在服务器的分布式场景可能会遇到。因为移动终端设备的不常在线、以及无中心的特性，分布式数据服务不支持强一致性，只支持最终一致性。 +### 分布式数据库一致性 -- **分布式数据库同步** - 底层通信组件完成设备发现和认证，会通知上层应用程序（包括分布式数据服务）设备上线。收到设备上线的消息后分布式数据服务可以在两个设备之间建立加密的数据传输通道，利用该通道在两个设备之间进行数据同步。 +在分布式场景中一般会涉及多个设备，组网内设备之间看到的数据是否一致称为分布式数据库的一致性。分布式数据库一致性可以分为**强一致性**、**弱一致性**和**最终一致性**。 - 分布式数据服务提供了两种同步方式：**手动同步**和**自动同步**。 +- **强一致性**：是指某一设备成功增、删、改数据后，组网内设备对该数据的读取操作都将得到更新后的值。 +- **弱一致性**：是指某一设备成功增、删、改数据后，组网内设备可能读取到本次更新数据，也可能读取不到，不能保证在多长时间后每个设备的数据一定是一致的。 +- **最终一致性**：是指某一设备成功增、删、改数据后，组网内设备可能读取不到本次更新数据，但在某个时间窗口之后组网内设备的数据能够达到一致状态。 - - **手动同步**：由应用程序调用sync接口来触发，需要指定同步的设备列表和同步模式。同步模式分为PULL_ONLY（将远端数据拉到本端）、PUSH_ONLY（将本端数据推送到远端）和PUSH_PULL（将本端数据推送到远端同时也将远端数据拉取到本端）。内部接口支持按条件过滤同步，将符合条件的数据同步到远端。 - - **自动同步**：包括全量同步和按条件订阅同步。全量同步由分布式数据库自动将本端数据推送到远端，同时也将远端数据拉取到本端来完成数据同步，同步时机包括设备上线、应用程序更新数据等，应用不需要主动调用sync接口；内部接口支持按条件订阅同步，将远端符合订阅条件的数据自动同步到本端。 +强一致性对分布式数据的管理要求非常高，在服务器的分布式场景可能会遇到。因为移动终端设备的不常在线、以及无中心的特性，分布式数据服务不支持强一致性，只支持最终一致性。 -- **单版本分布式数据库** - 单版本是指数据在本地保存是以单个KV条目为单位的方式保存，对每个Key最多只保存一个条目项，当数据在本地被用户修改时，不管它是否已经被同步出去，均直接在这个条目上进行修改。同步也以此为基础，按照它在本地被写入或更改的顺序将当前最新一次修改逐条同步至远端设备。 +### 分布式数据库同步 -- **设备协同分布式数据库** - 设备协同分布式数据库建立在单版本分布式数据库之上，对应用程序存入的KV数据中的Key前面拼接了本设备的DeviceID标识符，这样能保证每个设备产生的数据严格隔离，底层按照设备的维度管理这些数据，设备协同分布式数据库支持以设备的维度查询分布式数据，但是不支持修改远端设备同步过来的数据。 +底层通信组件完成设备发现和认证，会通知上层应用程序（包括分布式数据服务）设备上线。收到设备上线的消息后分布式数据服务可以在两个设备之间建立加密的数据传输通道，利用该通道在两个设备之间进行数据同步。 -- **分布式数据库冲突解决策略** - 分布式数据库多设备提交冲突场景，在给提交冲突做合并的过程中，如果多个设备同时修改了同一数据，则称这种场景为数据冲突。数据冲突采用默认冲突解决策略（Last-write-wins），基于提交时间戳，取时间戳较大的提交数据，当前不支持定制冲突解决策略。 +分布式数据服务提供了两种同步方式：**手动同步**和**自动同步**。 -- **数据库Schema化管理与谓词查询** - 单版本数据库支持在创建和打开数据库时指定Schema，数据库根据Schema定义感知KV记录的Value格式，以实现对Value值结构的检查，并基于Value中的字段实现索引建立和谓词查询。 +- **手动同步**：由应用程序调用sync接口来触发，需要指定同步的设备列表和同步模式。同步模式分为PULL_ONLY（将远端数据拉到本端）、PUSH_ONLY（将本端数据推送到远端）和PUSH_PULL（将本端数据推送到远端同时也将远端数据拉取到本端）。内部接口支持按条件过滤同步，将符合条件的数据同步到远端。 +- **自动同步**：包括全量同步和按条件订阅同步。全量同步由分布式数据库自动将本端数据推送到远端，同时也将远端数据拉取到本端来完成数据同步，同步时机包括设备上线、应用程序更新数据等，应用不需要主动调用sync接口；内部接口支持按条件订阅同步，将远端符合订阅条件的数据自动同步到本端。 -- **分布式数据库备份能力** - 提供分布式数据库备份能力，业务通过设置backup属性为true，可以触发分布式数据服务每日备份。当分布式数据库发生损坏，分布式数据服务会删除损坏数据库，并且从备份数据库中恢复上次备份的数据。如果不存在备份数据库，则创建一个新的数据库。同时支持加密数据库的备份能力。 +### 单版本分布式数据库 + +单版本是指数据在本地保存是以单个KV条目为单位的方式保存，对每个Key最多只保存一个条目项，当数据在本地被用户修改时，不管它是否已经被同步出去，均直接在这个条目上进行修改。同步也以此为基础，按照它在本地被写入或更改的顺序将当前最新一次修改逐条同步至远端设备。 + +### 设备协同分布式数据库 + +设备协同分布式数据库建立在单版本分布式数据库之上，对应用程序存入的KV数据中的Key前面拼接了本设备的DeviceID标识符，这样能保证每个设备产生的数据严格隔离，底层按照设备的维度管理这些数据，设备协同分布式数据库支持以设备的维度查询分布式数据，但是不支持修改远端设备同步过来的数据。 + +### 分布式数据库冲突解决策略 + +分布式数据库多设备提交冲突场景，在给提交冲突做合并的过程中，如果多个设备同时修改了同一数据，则称这种场景为数据冲突。数据冲突采用默认冲突解决策略（Last-write-wins），基于提交时间戳，取时间戳较大的提交数据，当前不支持定制冲突解决策略。 + +### 数据库Schema化管理与谓词查询 + +单版本数据库支持在创建和打开数据库时指定Schema，数据库根据Schema定义感知KV记录的Value格式，以实现对Value值结构的检查，并基于Value中的字段实现索引建立和谓词查询。 + +### 分布式数据库备份能力 + +提供分布式数据库备份能力，业务通过设置backup属性为true，可以触发分布式数据服务每日备份。当分布式数据库发生损坏，分布式数据服务会删除损坏数据库，并且从备份数据库中恢复上次备份的数据。如果不存在备份数据库，则创建一个新的数据库。同时支持加密数据库的备份能力。 ## 运作机制 分布式数据服务支撑OpenHarmony系统上应用程序数据库数据分布式管理，支持数据在相同帐号的多端设备之间相互同步，为用户在多端设备上提供一致的用户体验，分布式数据服务包含五部分： -- **服务接口** - 分布式数据服务提供专门的数据库创建、数据访问、数据订阅等接口给应用程序调用，接口支持KV数据模型，支持常用的数据类型，同时确保接口的兼容性、易用性和可发布性。 +- **服务接口：** 分布式数据服务提供专门的数据库创建、数据访问、数据订阅等接口给应用程序调用，接口支持KV数据模型，支持常用的数据类型，同时确保接口的兼容性、易用性和可发布性。 -- **服务组件** - 服务组件负责服务内元数据管理、权限管理、加密管理、备份和恢复管理以及多用户管理等、同时负责初始化底层分布式DB的存储组件、同步组件和通信适配层。 +- **服务组件：** 服务组件负责服务内元数据管理、权限管理、加密管理、备份和恢复管理以及多用户管理等、同时负责初始化底层分布式DB的存储组件、同步组件和通信适配层。 -- **存储组件** - 存储组件负责数据的访问、数据的缩减、事务、快照、数据库加密，以及数据合并和冲突解决等特性。 +- **存储组件：** 存储组件负责数据的访问、数据的缩减、事务、快照、数据库加密，以及数据合并和冲突解决等特性。 -- **同步组件** - 同步组件连结了存储组件与通信组件，其目标是保持在线设备间的数据库数据一致性，包括将本地产生的未同步数据同步给其他设备，接收来自其他设备发送过来的数据，并合并到本地设备中。 +- **同步组件：** 同步组件连结了存储组件与通信组件，其目标是保持在线设备间的数据库数据一致性，包括将本地产生的未同步数据同步给其他设备，接收来自其他设备发送过来的数据，并合并到本地设备中。 -- **通信适配层** - 通信适配层负责调用底层公共通信层的接口完成通信管道的创建、连接，接收设备上下线消息，维护已连接和断开设备列表的元数据，同时将设备上下线信息发送给上层同步组件，同步组件维护连接的设备列表，同步数据时根据该列表，调用通信适配层的接口将数据封装并发送给连接的设备。 +- **通信适配层：** 通信适配层负责调用底层公共通信层的接口完成通信管道的创建、连接，接收设备上下线消息，维护已连接和断开设备列表的元数据，同时将设备上下线信息发送给上层同步组件，同步组件维护连接的设备列表，同步数据时根据该列表，调用通信适配层的接口将数据封装并发送给连接的设备。 应用程序通过调用分布式数据服务接口实现分布式数据库创建、访问、订阅功能，服务接口通过操作服务组件提供的能力，将数据存储至存储组件，存储组件调用同步组件实现将数据同步，同步组件使用通信适配层将数据同步至远端设备，远端设备通过同步组件接收数据，并更新至本端存储组件，通过服务接口提供给应用程序使用。 @@ -83,6 +87,7 @@ - 分布式数据服务的数据模型仅支持KV数据模型，不支持外键、触发器等关系型数据库中的功能。 - 分布式数据服务支持的KV数据模型规格： + - 设备协同数据库，针对每条记录，Key的长度≤896 Byte，Value的长度<4 MB。 - 单版本数据库，针对每条记录，Key的长度≤1 KB，Value的度<4 MB。 - 每个应用程序最多支持同时打开16个分布式数据库。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md index 46d2d4093c991311dc2853f5675a7bbf38167463..7212f93fb6eed2d9c28ec42413db86c3dc222b4f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md +++ b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md @@ -596,16 +596,15 @@ KVStore数据库类型枚举。 数据库的安全级别枚举。 -**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core | 名称 | 值 | 说明 | | --- | ---- | ----------------------- | -| NO_LEVEL | 0 | 表示数据库不设置安全级别。 | -| S0 | 1 | 表示数据库的安全级别为公共级别。 | -| S1 | 2 | 表示数据库的安全级别为低级别，当数据泄露时会产生较低影响。例如，包含壁纸等系统数据的数据库。 | -| S2 | 3 | 表示数据库的安全级别为中级别，当数据泄露时会产生较大影响。例如，包含录音、视频等用户生成数据或通话记录等信息的数据库。 | -| S3 | 5 | 表示数据库的安全级别为高级别，当数据泄露时会产生重大影响。例如，包含用户运动、健康、位置等信息的数据库。 | -| S4 | 6 | 表示数据库的安全级别为关键级别，当数据泄露时会产生严重影响。例如，包含认证凭据、财务数据等信息的数据库。 | +| NO_LEVEL | 0 | 表示数据库不设置安全级别。
**系统能力：** SystemCapability.DistributedDataManager.KVStore.DistributedKVStore | +| S0 | 1 | 表示数据库的安全级别为公共级别。
**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core | +| S1 | 2 | 表示数据库的安全级别为低级别，当数据泄露时会产生较低影响。例如，包含壁纸等系统数据的数据库。
**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core | +| S2 | 3 | 表示数据库的安全级别为中级别，当数据泄露时会产生较大影响。例如，包含录音、视频等用户生成数据或通话记录等信息的数据库。
**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core | +| S3 | 5 | 表示数据库的安全级别为高级别，当数据泄露时会产生重大影响。例如，包含用户运动、健康、位置等信息的数据库。
**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core | +| S4 | 6 | 表示数据库的安全级别为关键级别，当数据泄露时会产生严重影响。例如，包含认证凭据、财务数据等信息的数据库。
**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core | ## Constants diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkboxgroup.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkboxgroup.md index 649e80e27b5cc1b229767dc628437644f52c35fe..9b7b588d64e4f56a1b3ed976a02f8791272ea8df 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkboxgroup.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkboxgroup.md @@ -6,25 +6,21 @@ > > 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - ## 子组件 无 ## 接口 -CheckboxGroup( option?: {group?: string} ) +CheckboxGroup( options?: {group?: string} ) 创建多选框群组，可以控制群组内的Checkbox全选或者不全选，相同group的Checkbox和CheckboxGroup为同一群组。 **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ----- | ------ | ---- | ---- | ----- | -| group | string | 否 | - | 群组名称。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ------ | -------- | ---- | ---------- | +| group | string | 否 | 群组名称。 | ## 属性 @@ -50,7 +46,7 @@ CheckboxGroup的选中状态或群组内的Checkbox的选中状态发生变化 | 名称 | 参数类型 | 描述 | | ------ | ------------------- | -------------- | | name | Array<string> | checkBox名称。 | -| status | selectStatus | 选中状态。 | +| status | SelectStatus | 选中状态。 | ## SelectStatus枚举说明 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-gauge.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-gauge.md index 0353f790214dc946241653120f9447ca12153b45..ea8cce2af4c9619c7d21012fe458baf430d3f1e5 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-gauge.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-gauge.md @@ -6,10 +6,6 @@ > > 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - ## 子组件 无 @@ -20,21 +16,21 @@ Gauge(options:{value: number, min?: number, max?: number}) **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ----- | ------ | ---- | ---- | --------- | -| value | number | 是 | - | 当前数据值。 | -| min | number | 否 | 0 | 当前数据段最小值。 | -| max | number | 否 | 100 | 当前数据段最大值。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ------ | -------- | ---- | ---------------------------------- | +| value | number | 是 | 当前数据值。 | +| min | number | 否 | 当前数据段最小值。
默认值：0 | +| max | number | 否 | 当前数据段最大值。
默认值：100 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ----------- | ---------------------------------------- | ---- | --------------------------- | -| value | number | 0 | 设置当前数据图表的值。 | -| startAngle | number | -150 | 设置起始角度位置，时钟0点为0度，顺时针方向为正角度。 | -| endAngle | number | 150 | 设置终止角度位置，时钟0点为0度，顺时针方向为正角度。 | -| colors | Array<ColorStop> | - | 设置图表的颜色，支持分段颜色设置。 | -| strokeWidth | [Length](ts-types.md#length) | - | 设置环形图表的环形厚度。 | +| 名称 | 参数类型 | 描述 | +| ----------- | ---------------------------------------- | --------------------------- | +| value | number | 设置当前数据图表的值。
默认值：0 | +| startAngle | number | 设置起始角度位置，时钟0点为0度，顺时针方向为正角度。
默认值：-150 | +| endAngle | number | 设置终止角度位置，时钟0点为0度，顺时针方向为正角度。
默认值：150 | +| colors | Array<ColorStop> | 设置图表的颜色，支持分段颜色设置。 | +| strokeWidth | [Length](ts-types.md#length) | 设置环形图表的环形厚度。 | ## ColorStop diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-navigation.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-navigation.md index 037c063d2da5df9fda5aa055909b8236f3d58c87..144aa0933d300740fc14ddbcb1f91e1442f8191f 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-navigation.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-navigation.md @@ -7,11 +7,6 @@ Navigation组件一般作为Page页面的根容器，通过属性设置来展示 > 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 可以包含子组件。 @@ -26,32 +21,32 @@ Navigation() ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------------- | ---------------------------------------- | ------------------------ | ---------------------------------------- | -| title | string \| [CustomBuilder](ts-types.md#custombuilder8)8+ | - | 页面标题。 | -| subtitle | string | - | 页面副标题。 | -| menus | Array8+ | - | 页面右上角菜单。 | -| titleMode | NavigationTitleMode | NavigationTitleMode.Free | 页面标题栏显示模式。 | -| toolBar | object \| [CustomBuilder](ts-types.md#custombuilder8)8+ | - | 设置工具栏内容。
items: 工具栏所有项。 | -| hideToolBar | boolean | false | 设置隐藏/显示工具栏：
true: 隐藏工具栏。
false: 显示工具栏。 | -| hideTitleBar | boolean | false | 隐藏标题栏。 | -| hideBackButton | boolean | false | 隐藏返回键。 | +| 名称 | 参数类型 | 描述 | +| -------------- | ---------------------------------------- | ---------------------------------------- | +| title | string \| [CustomBuilder](ts-types.md#custombuilder8)8+ | 页面标题。 | +| subtitle | string | 页面副标题。 | +| menus | Array8+ | 页面右上角菜单。 | +| titleMode | NavigationTitleMode | 页面标题栏显示模式。
默认值：NavigationTitleMode.Free | +| toolBar | object \| [CustomBuilder](ts-types.md#custombuilder8)8+ | 设置工具栏内容。
items: 工具栏所有项。 | +| hideToolBar | boolean | 设置隐藏/显示工具栏：
默认值：false
true: 隐藏工具栏。
false: 显示工具栏。 | +| hideTitleBar | boolean | 隐藏标题栏。
默认值：false | +| hideBackButton | boolean | 隐藏返回键。
默认值：false | ## NavigationMenuItem类型说明 -| 名称 | 类型 | 必填 | 默认值 | 描述 | -| ------ | ----------------------- | ---- | ---- | --------------- | -| value | string | 是 | - | 菜单栏单个选项的显示文本。 | -| icon | string | 否 | - | 菜单栏单个选项的图标资源路径。 | -| action | () => void | 否 | - | 当前选项被选中的事件回调。 | +| 名称 | 类型 | 必填 | 描述 | +| ------ | ----------------------- | ---- | ------------------------------ | +| value | string | 是 | 菜单栏单个选项的显示文本。 | +| icon | string | 否 | 菜单栏单个选项的图标资源路径。 | +| action | () => void | 否 | 当前选项被选中的事件回调。 | ## Object类型说明 -| 名称 | 类型 | 必填 | 默认值 | 描述 | -| ------ | ----------------------- | ---- | ---- | --------------- | -| value | string | 是 | - | 工具栏单个选项的显示文本。 | -| icon | string | 否 | - | 工具栏单个选项的图标资源路径。 | -| action | () => void | 否 | - | 当前选项被选中的事件回调。 | +| 名称 | 类型 | 必填 | 描述 | +| ------ | ----------------------- | ---- | ------------------------------ | +| value | string | 是 | 工具栏单个选项的显示文本。 | +| icon | string | 否 | 工具栏单个选项的图标资源路径。 | +| action | () => void | 否 | 当前选项被选中的事件回调。 | ## NavigationTitleMode枚举说明 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-progress.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-progress.md index d3bb6d270cd9121caad6d58b2791c8cff2e001d7..aad55d704e49a0701d278c725713dd829aff01dc 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-progress.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-progress.md @@ -7,11 +7,6 @@ > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 无 @@ -25,12 +20,12 @@ Progress(options: {value: number, total?: number, style?: ProgressStyle, type?: **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| -------------------------- | ------------- | ---- | -------------------- | --------------------------------------------------- | -| value | number | 是 | - | 指定当前进度值。 | -| total | number | 否 | 100 | 指定进度总长。 | -| type8+ | ProgressType | 否 | ProgressType.Linear | 指定进度条类型。 | -| styledeprecated | ProgressStyle | 否 | ProgressStyle.Linear | 指定进度条样式。
该参数从API Version8开始废弃。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| -------------------------- | ------------- | ---- | ------------------------------------------------------------ | +| value | number | 是 | 指定当前进度值。 | +| total | number | 否 | 指定进度总长。
默认值：100 | +| type8+ | ProgressType | 否 | 指定进度条类型。
默认值：ProgressType.Linear | +| styledeprecated | ProgressStyle | 否 | 指定进度条类型。
该参数从API Version8开始废弃，建议使用type替代。
默认值：ProgressStyle.Linear | ## ProgressType枚举说明 @@ -54,11 +49,11 @@ Progress(options: {value: number, total?: number, style?: ProgressStyle, type?: ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ------------------ | ------------------------------------------------------------ | ------ | ------------------------------------------------------------ | -| value | number | - | 设置当前进度值。 | -| color | [ResourceColor](ts-types.md#resourcecolor8) | - | 设置进度条前景色。 | -| style8+ | {
strokeWidth?: [Length](ts-types.md#length),
scaleCount?: number,
scaleWidth?: [Length](ts-types.md#length)
} | - | 定义组件的样式。
strokeWidth: 设置进度条宽度。
scaleCount: 设置环形进度条总刻度数。
scaleWidth: 设置环形进度条刻度粗细。
刻度粗细大于进度条宽度时，刻度粗细为系统默认粗细。 | +| 名称 | 参数类型 | 描述 | +| ------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| value | number | 设置当前进度值。 | +| color | [ResourceColor](ts-types.md#resourcecolor8) | 设置进度条前景色。 | +| style8+ | {
strokeWidth?: [Length](ts-types.md#length),
scaleCount?: number,
scaleWidth?: [Length](ts-types.md#length)
} | 定义组件的样式。
strokeWidth: 设置进度条宽度。
scaleCount: 设置环形进度条总刻度数。
scaleWidth: 设置环形进度条刻度粗细。
刻度粗细大于进度条宽度时，刻度粗细为系统默认粗细。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-radio.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-radio.md index 69f29e9fcfe7d2007303043336c5f4a0d76875ac..015c324810f97d9dd986bdbe722525d610bb9bae 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-radio.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-radio.md @@ -7,11 +7,6 @@ > 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 无 @@ -23,23 +18,23 @@ Radio(options: {value: string, group: string}) **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ----- | ------ | ---- | ---- | ----------------------------------- | -| value | string | 是 | - | 当前单选框的值。 | -| group | string | 是 | - | 当前单选框的所属群组名称，相同group的Radio只能有一个被选中。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ------ | -------- | ---- | ------------------------------------------------------------ | +| value | string | 是 | 当前单选框的值。 | +| group | string | 是 | 当前单选框的所属群组名称，相同group的Radio只能有一个被选中。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ------- | ------- | ----- | ----------- | -| checked | boolean | false | 设置单选框的选中状态。 | +| 名称 | 参数类型 | 描述 | +| ------- | -------- | ---------------------------------------- | +| checked | boolean | 设置单选框的选中状态。
默认值：false | ## 事件 -| 名称 | 功能描述 | -| ---------------------------------------- | ---------------------------------------- | -| onChange(callback: (isChecked: boolean) => void) | 单选框选中状态改变时触发回调。
-isChecked为true时，代表选中。
-isChecked为false时，代表未选中。 | +| 名称 | 功能描述 | +| ------------------------------------------------ | ------------------------------------------------------------ | +| onChange(callback: (isChecked: boolean) => void) | 单选框选中状态改变时触发回调。
- isChecked为true时，代表选中。
- isChecked为false时，代表未选中。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md index 1f1038d5d03cea38ae18d0dd9f701a4a6d1aa9dd..95e7221fd461c629737bae93c0f0e6bb711de982 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md @@ -6,10 +6,6 @@ > > 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - ## 子组件 无 @@ -20,21 +16,21 @@ Search(options?: { value?: string; placeholder?: string; icon?: string; controll **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ----------- | ---------------- | ---- | ---- | ---------------------------------------- | -| value | string | 否 | - | 搜索文本值。 | -| placeholder | string | 否 | - | 无输入时的提示文本。 | -| icon | string | 否 | - | 搜索图标路径，默认使用系统搜索图标，支持的图标格式: svg, jpg和png。 | -| controller | SearchController | 否 | - | 控制器。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ----------- | ---------------- | ---- | ------------------------------------------------------------ | +| value | string | 否 | 搜索文本值。 | +| placeholder | string | 否 | 无输入时的提示文本。 | +| icon | string | 否 | 搜索图标路径，默认使用系统搜索图标，支持的图标格式: svg, jpg和png。 | +| controller | SearchController | 否 | 控制器。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ---------------- | ------------------------------------------- | ------ | ------------------------------------------ | -| searchButton | string | 无 | 搜索框末尾搜索按钮文本值，默认无搜索按钮。 | -| placeholderColor | [ResourceColor](ts-types.md#resourcecolor8) | - | 设置placeholder颜色。 | -| placeholderFont | [Font](ts-types.md#font) | - | 设置placeholder文本样式。 | -| textFont | [Font](ts-types.md#font) | - | 设置搜索框内文本样式。 | +| 名称 | 参数类型 | 描述 | +| ---------------- | ------------------------------------------- | ------------------------------------------ | +| searchButton | string | 搜索框末尾搜索按钮文本值，默认无搜索按钮。 | +| placeholderColor | [ResourceColor](ts-types.md#resourcecolor8) | 设置placeholder颜色。 | +| placeholderFont | [Font](ts-types.md#font) | 设置placeholder文本样式。 | +| textFont | [Font](ts-types.md#font) | 设置搜索框内文本样式。 | ## 事件 @@ -62,9 +58,9 @@ caretPosition(value: number): void **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ----- | ------ | ---- | ---- | ----------------- | -| value | number | 是 | - | 从字符串开始到光标所在位置的长度。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ------ | -------- | ---- | ---------------------------------- | +| value | number | 是 | 从字符串开始到光标所在位置的长度。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md index 6a725256acbcf522cc04af70fd41c790bb1bdd3d..32263cb14021ec5000ac04c828a264b88227b34e 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md @@ -7,11 +7,6 @@ > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 无 @@ -19,23 +14,23 @@ ## 接口 -Span(content: string | Resource) +Span(value: string | Resource) **参数:** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ------- | ---------------------------------------- | ---- | ------ | ---------- | -| content | string\|[Resource](ts-types.md#resource) | 是 | - | 文本内容。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ------ | ---------------------------------------------------- | ---- | ---------- | +| value | string \| [Resource](ts-types.md#resource) | 是 | 文本内容。 | ## 属性 通用属性方法仅支持通用文本样式，不支持触摸热区设置。 -| 名称 | 参数类型 | 默认值 | 描述 | -| ---------- | ---------------------------------------- | ---------------------------------------- | -------------- | -| decoration | {
type: [TextDecorationType](ts-appendix-enums.md#textdecorationtype枚举说明),
color?: [ResourceColor](ts-types.md#resourcecolor8)
} | {
type: TextDecorationType.None
color：Color.Black
} | 设置文本装饰线样式及其颜色。 | -| letterSpacing | number \| string | - | 设置文本字符间距。 | -| textCase | [TextCase](ts-appendix-enums.md#textcase枚举说明) | Normal | 设置文本大小写。 | +| 名称 | 参数类型 | 描述 | +| ---------- | ---------------------------------------- | -------------- | +| decoration | {
type: [TextDecorationType](ts-appendix-enums.md#textdecorationtype枚举说明),
color?: [ResourceColor](ts-types.md#resourcecolor8)
} | 设置文本装饰线样式及其颜色。
默认值：{
type: TextDecorationType.None
color：Color.Black
} | +| letterSpacing | number \| string | 设置文本字符间距。 | +| textCase | [TextCase](ts-appendix-enums.md#textcase枚举说明) | 设置文本大小写。
默认值：Normal | ## 事件 @@ -43,6 +38,7 @@ Span(content: string | Resource) 通用事件仅支持点击事件。 > **说明：** +> > 由于Span组件无尺寸信息，因此点击事件返回的ClickEvent对象的target属性无效。 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md index 46310bdef3e2a623b58deda098c1273d814f17e5..b79b655518acbd8c42c6425d063ac053de89baff 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md @@ -7,11 +7,6 @@ > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 可以包含[Span](ts-basic-components-span.md)子组件。 @@ -23,24 +18,24 @@ Text(content?: string | Resource) **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ------- | ------------------------------------------ | ---- | ------ | ------------------------------------------------------------ | -| content | string \| [Resource](ts-types.md#resource) | 否 | '' | 文本内容。包含子组件Span时不生效，显示Span内容，并且此时text组件的样式不生效。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ------- | ------------------------------------------ | ---- | ------------------------------------------------------------ | +| content | string \| [Resource](ts-types.md#resource) | 否 | 文本内容。包含子组件Span时不生效，显示Span内容，并且此时text组件的样式不生效。
默认值：' ' | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| textAlign | [TextAlign](ts-appendix-enums.md#textalign) | TextAlign.Start | 设置多行文本的文本对齐方式。 | -| textOverflow | {overflow: [TextOverflow](ts-appendix-enums.md#textoverflow)} | {overflow: TextOverflow.Clip} | 设置文本超长时的显示方式。
**说明：**
文本截断是按字截断。例如，英文以单词为最小单位进行截断，若需要以字母为单位进行截断，可在字母间添加零宽空格：\u200B。 | -| maxLines | number | Infinity | 设置文本的最大行数。 | -| lineHeight | string \| number \| [Resource](ts-types.md#resource) | - | 设置文本的文本行高，设置值不大于0时，不限制文本行高，自适应字体大小，Length为number类型时单位为fp。 | -| decoration | {
type: [TextDecorationType](ts-appendix-enums.md#textdecorationtype),
color?: [ResourceColor](ts-types.md#resourcecolor8)
} | {
type: TextDecorationType.None,
color：Color.Black
} | 设置文本装饰线样式及其颜色。 | -| baselineOffset | number \| string | - | 设置文本基线的偏移量。 | -| letterSpacing | number \| string | - | 设置文本字符间距。 | -| minFontSize | number \| string \| [Resource](ts-types.md#resource) | - | 设置文本最小显示字号。 | -| maxFontSize | number \| string \| [Resource](ts-types.md#resource) | - | 设置文本最大显示字号。 | -| textCase | [TextCase](ts-appendix-enums.md#textcase) | TextCase.Normal | 设置文本大小写。 | +| 名称 | 参数类型 | 描述 | +| -------------- | ---------------------------------------- | ---------------------------------------- | +| textAlign | [TextAlign](ts-appendix-enums.md#textalign) | 设置多行文本的文本对齐方式。
默认值：TextAlign.Start | +| textOverflow | {overflow: [TextOverflow](ts-appendix-enums.md#textoverflow)} | 设置文本超长时的显示方式。
默认值：{overflow: TextOverflow.Clip}
**说明：**
文本截断是按字截断。例如，英文以单词为最小单位进行截断，若需要以字母为单位进行截断，可在字母间添加零宽空格：\u200B。 | +| maxLines | number | 设置文本的最大行数。
默认值：Infinity | +| lineHeight | string \| number \| [Resource](ts-types.md#resource) | 设置文本的文本行高，设置值不大于0时，不限制文本行高，自适应字体大小，Length为number类型时单位为fp。 | +| decoration | {
type: [TextDecorationType](ts-appendix-enums.md#textdecorationtype),
color?: [ResourceColor](ts-types.md#resourcecolor8)
} | 设置文本装饰线样式及其颜色。
默认值：{
type: TextDecorationType.None,
color：Color.Black
} | +| baselineOffset | number \| string | 设置文本基线的偏移量。 | +| letterSpacing | number \| string | 设置文本字符间距。 | +| minFontSize | number \| string \| [Resource](ts-types.md#resource) | 设置文本最小显示字号。 | +| maxFontSize | number \| string \| [Resource](ts-types.md#resource) | 设置文本最大显示字号。 | +| textCase | [TextCase](ts-appendix-enums.md#textcase) | 设置文本大小写。
默认值：TextCase.Normal | > **说明：** diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md index 6e3b78cf19a4dc2883bba20da0b8d152eb37b370..1c35376c8ab894c623cdc696b826eb554bd2a2f6 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md @@ -7,11 +7,6 @@ > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 无 @@ -23,32 +18,32 @@ TextArea(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: Tex **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ----------------------- | ---------------------------------------- | ---- | ---- | -------------- | -| placeholder | [ResourceStr](ts-types.md#resourcestr8) | 否 | - | 无输入时的提示文本。 | -| text | [ResourceStr](ts-types.md#resourcestr8) | 否 | - | 设置输入框当前的文本内容。 | -| controller8+ | [TextAreaController](#textareacontroller8) | 否 | - | 设置TextArea控制器。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ----------------------- | ---------------------------------------- | ---- | -------------- | +| placeholder | [ResourceStr](ts-types.md#resourcestr8) | 否 | 无输入时的提示文本。 | +| text | [ResourceStr](ts-types.md#resourcestr8) | 否 | 设置输入框当前的文本内容。 | +| controller8+ | [TextAreaController](#textareacontroller8) | 否 | 设置TextArea控制器。 | ## 属性 除支持通用属性外，还支持以下属性： -| 名称 | 参数类型 | 默认值 | 描述 | -| ------------------------ | ------------------------------------------------------------ | ------ | ------------------------------------------------------------ | -| placeholderColor | [ResourceColor](ts-types.md#resourcecolor8) | - | 设置placeholder文本颜色。 | -| placeholderFont | [Font](ts-types.md#font) | - | 设置placeholder文本样式：
- size: 设置文本尺寸，Length为number类型时，使用fp单位。
- weight: 设置文本的字体粗细，number类型取值[100, 900]，取值间隔为100，默认为400，取值越大，字体越粗。
- family: 设置文本的字体列表。使用多个字体，使用','进行分割，优先级按顺序生效，例如：'Arial, sans-serif'。
- style: 设置文本的字体样式。 | -| textAlign | [TextAlign](ts-appendix-enums.md#textalign) | Start | 设置文本水平对齐方式。 | -| caretColor | [ResourceColor](ts-types.md#resourcecolor8) | - | 设置输入框光标颜色。 | -| inputFilter8+ | {
value: [ResourceStr](ts-types.md#resourcestr8)8+,
error?: (value: string) => void
} | - | 通过正则表达式设置输入过滤器。满足表达式的输入允许显示，不满足的输入被忽略。仅支持单个字符匹配，不支持字符串匹配。例如：^(?=.\*\d)(?=.\*[a-z])(?=.\*[A-Z]).{8,10}$，不支持过滤8到10位的强密码。
- value：设置正则表达式。
- error：正则匹配失败时，返回被忽略的内容。 | +| 名称 | 参数类型 | 描述 | +| ------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| placeholderColor | [ResourceColor](ts-types.md#resourcecolor8) | 设置placeholder文本颜色。 | +| placeholderFont | [Font](ts-types.md#font) | 设置placeholder文本样式：
- size: 设置文本尺寸，Length为number类型时，使用fp单位。
- weight: 设置文本的字体粗细，number类型取值[100, 900]，取值间隔为100，默认为400，取值越大，字体越粗。
- family: 设置文本的字体列表。使用多个字体，使用','进行分割，优先级按顺序生效，例如：'Arial, sans-serif'。
- style: 设置文本的字体样式。 | +| textAlign | [TextAlign](ts-appendix-enums.md#textalign) | 设置文本水平对齐方式。
默认值：TextAlign.Start | +| caretColor | [ResourceColor](ts-types.md#resourcecolor8) | 设置输入框光标颜色。 | +| inputFilter8+ | {
value: [ResourceStr](ts-types.md#resourcestr8)8+,
error?: (value: string) => void
} | 通过正则表达式设置输入过滤器。满足表达式的输入允许显示，不满足的输入被忽略。仅支持单个字符匹配，不支持字符串匹配。例如：^(?=.\*\d)(?=.\*[a-z])(?=.\*[A-Z]).{8,10}$，不支持过滤8到10位的强密码。
- value：设置正则表达式。
- error：正则匹配失败时，返回被忽略的内容。 | ## 事件 -| 名称 | 功能描述 | -| ---------------------------------------- | ---------------------------------------- | -| onChange(callback: (value: string) => void) | 输入发生变化时，触发回调。 | -| onCopy8+(callback:(value: string) => void) | 长按输入框内部区域弹出剪贴板后，点击剪切板复制按钮，触发回调。
value：复制的文本内容。 | -| onCut8+(callback:(value: string) => void) | 长按输入框内部区域弹出剪贴板后，点击剪切板剪切按钮，触发回调。
value：剪切的文本内容。 | -| onPaste8+(callback:(value: string) => void) | 长按输入框内部区域弹出剪贴板后，点击剪切板粘贴按钮，触发回调。
value：粘贴的文本内容。 | +| 名称 | 功能描述 | +| ------------------------------------------------------------ | ------------------------------------------------------------ | +| onChange(callback: (value: string) => void) | 输入发生变化时，触发回调。 | +| onCopy8+(callback:(value: string) => void) | 长按输入框内部区域弹出剪贴板后，点击剪切板复制按钮，触发回调。
- value：复制的文本内容。 | +| onCut8+(callback:(value: string) => void) | 长按输入框内部区域弹出剪贴板后，点击剪切板剪切按钮，触发回调。
- value：剪切的文本内容。 | +| onPaste8+(callback:(value: string) => void) | 长按输入框内部区域弹出剪贴板后，点击剪切板粘贴按钮，触发回调。
- value：粘贴的文本内容。 | ## TextAreaController8+ @@ -69,9 +64,9 @@ caretPosition(value: number): void **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ----- | ------ | ---- | ---- | ------------------- | -| value | number | 是 | - | 从字符串开始到光标所在位置的字符长度。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ------ | -------- | ---- | -------------------------------------- | +| value | number | 是 | 从字符串开始到光标所在位置的字符长度。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md index 4b762cda550d778132eeb398752b8d0b5fe8a03e..1d2f8efdfa245cee7b4c943dac6dcc2071200e7a 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md @@ -7,11 +7,6 @@ > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 无 @@ -23,25 +18,25 @@ TextInput(value?:{placeholder?: [ResourceStr](ts-types.md#resourcestr8), text?: **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ----------------------- | ---------------------------------------- | ---- | ---- | --------------- | -| placeholder | [ResourceStr](ts-types.md#resourcestr8) | 否 | - | 无输入时的提示文本。 | -| text | [ResourceStr](ts-types.md#resourcestr8) | 否 | - | 设置输入框当前的文本内容。 | -| controller8+ | [TextInputController](#textinputcontroller8) | 否 | - | 设置TextInput控制器。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ----------------------- | ---------------------------------------- | ---- | --------------- | +| placeholder | [ResourceStr](ts-types.md#resourcestr8) | 否 | 无输入时的提示文本。 | +| text | [ResourceStr](ts-types.md#resourcestr8) | 否 | 设置输入框当前的文本内容。 | +| controller8+ | [TextInputController](#textinputcontroller8) | 否 | 设置TextInput控制器。 | ## 属性 除支持通用属性外，还支持以下属性： -| 名称 | 参数类型 | 默认值 | 描述 | -| ----------------------------- | ------------------------------------------------------------ | ----------------- | ------------------------------------------------------------ | -| type | InputType | InputType.Normal | 设置输入框类型。 | -| placeholderColor | [ResourceColor](ts-types.md#resourcecolor8) | - | 设置placeholder颜色。 | -| placeholderFont | [Font](ts-types.md#font) | - | 设置placeholder文本样式：
- size: 设置文本尺寸，Length为number类型时，使用fp单位。
- weight: 设置文本的字体粗细，number类型取值[100, 900]，取值间隔为100，默认为400，取值越大，字体越粗。
- family: 设置文本的字体列表。使用多个字体，使用','进行分割，优先级按顺序生效。例如：'Arial, sans-serif'。
- style: 设置文本的字体样式。 | -| enterKeyType | EnterKeyType | EnterKeyType.Done | 设置输入法回车键类型。 | -| caretColor | [ResourceColor](ts-types.md#resourcecolor8) | - | 设置输入框光标颜色。 | -| maxLength | number | - | 设置文本的最大输入字符数。 | -| inputFilter8+ | {
value: [ResourceStr](ts-types.md#resourcestr8)8+,
error?: (value: string) => void
} | - | 正则表达式，满足表达式的输入允许显示，不满足正则表达式的输入被忽略。仅支持单个字符匹配，不支持字符串匹配。例如：^(?=.\*\d)(?=.\*[a-z])(?=.\*[A-Z]).{8,10}$，8到10位的强密码不支持过滤。
- value：设置正则表达式。
- error：正则匹配失败时，返回被忽略的内容。 | +| 名称 | 参数类型 | 描述 | +| ----------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | +| type | InputType | 设置输入框类型。
默认值：InputType.Normal | +| placeholderColor | [ResourceColor](ts-types.md#resourcecolor8) | 设置placeholder颜色。 | +| placeholderFont | [Font](ts-types.md#font) | 设置placeholder文本样式：
- size: 设置文本尺寸，Length为number类型时，使用fp单位。
- weight: 设置文本的字体粗细，number类型取值[100, 900]，取值间隔为100，默认为400，取值越大，字体越粗。
- family: 设置文本的字体列表。使用多个字体，使用','进行分割，优先级按顺序生效。例如：'Arial, sans-serif'。
- style: 设置文本的字体样式。 | +| enterKeyType | EnterKeyType | 设置输入法回车键类型。
默认值：EnterKeyType.Done | +| caretColor | [ResourceColor](ts-types.md#resourcecolor8) | 设置输入框光标颜色。 | +| maxLength | number | 设置文本的最大输入字符数。 | +| inputFilter8+ | {
value: [ResourceStr](ts-types.md#resourcestr8)8+,
error?: (value: string) => void
} | 正则表达式，满足表达式的输入允许显示，不满足正则表达式的输入被忽略。仅支持单个字符匹配，不支持字符串匹配。例如：^(?=.\*\d)(?=.\*[a-z])(?=.\*[A-Z]).{8,10}$，8到10位的强密码不支持过滤。
- value：设置正则表达式。
- error：正则匹配失败时，返回被忽略的内容。 | ## EnterKeyType枚举说明 @@ -90,9 +85,9 @@ caretPosition(value: number): void **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ----- | ------ | ---- | ---- | ---------------------------------------- | -| value | number | 是 | - | 设置输入光标的位置。
value：从字符串开始到光标所在位置的字符长度。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ------ | -------- | ---- | ------------------------------------------------------------ | +| value | number | 是 | 设置输入光标的位置。
value：从字符串开始到光标所在位置的字符长度。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textpicker.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textpicker.md index 7b8e7fc87f81f2e8f04cb580de47dc9085018675..33d9d449208361ec6c1ee2ba3e7e34245390015c 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textpicker.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textpicker.md @@ -7,11 +7,6 @@ > 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 无 @@ -25,17 +20,17 @@ TextPicker(options?: {range: string[] | [Resource](ts-types.md#resource), select **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| -------- | -------- | ---- | ----- | --------------- | -| range | string[] \| [Resource](ts-types.md#resource) | 是 | - | 选择器的数据选择范围。 | -| selected | number | 否 | 0 | 选中项在数组中的index值。 | -| value | string | 否 | 第一个元素值 | 选中项的值，优先级低于selected。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| -------- | -------- | ---- | --------------- | +| range | string[] \| [Resource](ts-types.md#resource) | 是 | 选择器的数据选择范围。 | +| selected | number | 否 | 选中项在数组中的index值。
默认值：0 | +| value | string | 否 | 选中项的值，优先级低于selected。
默认值：第一个元素值 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ----------------------- | ---------------- | ------ | -------------------------- | -| defaultPickerItemHeight | number \| string | - | 默认Picker内容项元素高度。 | +| 名称 | 参数类型 | 描述 | +| ----------------------- | ---------------- | -------------------------- | +| defaultPickerItemHeight | number \| string | 默认Picker内容项元素高度。 | ## 事件 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md index 240e6c31690e49873829c8b1c115ad8c62d323bc..72f4fa886e2e872d1486b6978b057603494b7778 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md @@ -4,31 +4,25 @@ > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 接口 -LongPressGesture(options?: { fingers?: number, repeat?: boolean, duration?: number }) +LongPressGesture(value?: { fingers?: number, repeat?: boolean, duration?: number }) **参数：** - | 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | fingers | number | 否 | 1 | 触发长按的最少手指数，最小为1指， 最大取值为10指。 | - | repeat | boolean | 否 | false | 是否连续触发事件回调。 | - | duration | number | 否 | 500 | 触发长按的最短时间，单位为毫秒（ms）。 | - +| 参数名称 | 参数类型 | 必填 | 参数描述 | +| -------- | -------- | ---- | ------------------------------------------------------------ | +| fingers | number | 否 | 触发长按的最少手指数，最小为1指， 最大取值为10指。
默认值：1 | +| repeat | boolean | 否 | 是否连续触发事件回调。
默认值：false | +| duration | number | 否 | 最小触发长按的时间，单位为毫秒（ms）。
默认值：500 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onAction((event?: [GestureEvent](ts-gesture-settings.md)) => void) | LongPress手势识别成功回调。 | -| onActionEnd((event?: [GestureEvent](ts-gesture-settings.md)) => void) | LongPress手势识别成功，手指抬起后触发回调。 | -| onActionCancel(event: () => void) | LongPress手势识别成功，接收到触摸取消事件触发回调。 | +| 名称 | 功能描述 | +| ------------------------------------------------------------ | --------------------------------------------------- | +| onAction(event: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | LongPress手势识别成功回调。 | +| onActionEnd(event: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | LongPress手势识别成功，手指抬起后触发回调。 | +| onActionCancel(event: () => void) | LongPress手势识别成功，接收到触摸取消事件触发回调。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md index 1d810cf405b2c758fe151fa88544868d48e8aa8e..cc9e5454901204c10a0d132a1e62a62a3f13f3ab 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md @@ -1,25 +1,22 @@ # PanGesture +用于触发拖动手势事件，滑动的最小距离为5vp时拖动手势识别成功。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 接口 -PanGesture(options?: { fingers?: number, direction?: PanDirection, distance?: number } | [PanGestureOptions](#pangestureoptions)) +PanGesture(value?: { fingers?: number, direction?: PanDirection, distance?: number } | [PanGestureOptions](#pangestureoptions)) **参数：** - | 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | fingers | number | 否 | 1 | 触发拖动的最少手指数，最小为1指， 最大取值为10指。 | - | direction | PanDirection | 否 | PanDirection.All | 触发拖动的手势方向，此枚举值支持逻辑与(&)和逻辑或（\|）运算。 | - | distance | number | 否 | 5.0 | 最小拖动识别距离，单位为vp。
**说明：**
> tab滑动与该拖动手势事件同时存在时，可将distance值设为1，使拖动更灵敏，避免造成事件错乱。 | +| 参数名称 | 参数类型 | 必填 | 参数描述 | +| --------- | ------------ | ---- | ------------------------------------------------------------ | +| fingers | number | 否 | 触发拖动的最少手指数，最小为1指， 最大取值为10指。
默认值：1 | +| direction | PanDirection | 否 | 触发拖动的手势方向，此枚举值支持逻辑与(&)和逻辑或（\|）运算。
默认值：PanDirection.All | +| distance | number | 否 | 最小拖动识别距离，单位为vp。
默认值：5.0
**说明：**
> tab滑动与该拖动手势事件同时存在时，可将distance值设为1，使拖动更灵敏，避免造成事件错乱。 | ## PanDirection枚举说明 @@ -58,10 +55,10 @@ PanGestureOptions(options?: { fingers?: number, direction?: PanDirection, distan | 名称 | 功能描述 | | -------- | -------- | -| onActionStart(callback: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pan手势识别成功回调。 | -| onActionUpdate(callback: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pan手势移动过程中回调。 | -| onActionEnd(callback: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pan手势识别成功，手指抬起后触发回调。 | -| onActionCancel(callback: () => void) | Pan手势识别成功，接收到触摸取消事件触发回调。 | +| onActionStart(event: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pan手势识别成功回调。 | +| onActionUpdate(event: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pan手势移动过程中回调。 | +| onActionEnd(event: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pan手势识别成功，手指抬起后触发回调。 | +| onActionCancel(event: () => void) | Pan手势识别成功，接收到触摸取消事件触发回调。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md index 9b71bd3d53acef438a11632a872786845c6c41b7..d9127d6d716188129a0beb4e1f88ed35dda82148 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md @@ -4,31 +4,25 @@ > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 接口 -PinchGesture(options?: { fingers?: number, distance?: number }) +PinchGesture(value?: { fingers?: number, distance?: number }) **参数：** - | 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | fingers | number | 否 | 2 | 触发捏合的最少手指数, 最小为2指，最大为5指。 | - | distance | number | 否 | 3.0 | 最小识别距离，单位为vp。 | - +| 参数名称 | 参数类型 | 必填 | 参数描述 | +| -------- | -------- | ---- | ------------------------------------------------------------ | +| fingers | number | 否 | 触发捏合的最少手指数, 最小为2指，最大为5指。
默认值：2 | +| distance | number | 否 | 最小识别距离，单位为vp。
默认值：3.0 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onActionStart((event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pinch手势识别成功回调。 | -| onActionUpdate((event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pinch手势移动过程中回调。 | -| onActionEnd((event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pinch手势识别成功，手指抬起后触发回调。 | -| onActionCancel(event: () => void) | Pinch手势识别成功，接收到触摸取消事件触发回调。 | +| 名称 | 功能描述 | +| ------------------------------------------------------------ | ----------------------------------------------- | +| onActionStart(event:(event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pinch手势识别成功回调。 | +| onActionUpdate(event:(event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pinch手势移动过程中回调。 | +| onActionEnd(event:(event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pinch手势识别成功，手指抬起后触发回调。 | +| onActionCancel(event: () => void) | Pinch手势识别成功，接收到触摸取消事件触发回调。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md index 423403653600c4e9f7bb8ece19513c7fe8c6bd7c..2438f474128d9f66883484bb39bc6745367355d1 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md @@ -4,31 +4,25 @@ > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 接口 -RotationGesture(options?: { fingers?: number, angle?: number }) +RotationGesture(value?: { fingers?: number, angle?: number }) **参数：** - | 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | fingers | number | 否 | 2 | 触发旋转的最少手指数, 最小为2指，最大为5指。 | - | angle | number | 否 | 1.0 | 触发旋转手势的最小改变度数，单位为deg。 | - +| 参数名称 | 参数类型 | 必填 | 参数描述 | +| -------- | -------- | ---- | ------------------------------------------------------------ | +| fingers | number | 否 | 触发旋转的最少手指数, 最小为2指，最大为5指。
默认值：2 | +| angle | number | 否 | 触发旋转手势的最小改变度数，单位为度数。
默认值：1.0 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onActionStart((event?: [GestureEvent](ts-gesture-settings.md)) => void) | Rotation手势识别成功回调。 | -| onActionUpdate((event?: [GestureEvent](ts-gesture-settings.md)) => void) | Rotation手势移动过程中回调。 | -| onActionEnd((event?: [GestureEvent](ts-gesture-settings.md)) => void) | Rotation手势识别成功，手指抬起后触发回调。 | -| onActionCancel(event: () => void) | Rotation手势识别成功，接收到触摸取消事件触发回调。 | +| 名称 | 功能描述 | +| ------------------------------------------------------------ | -------------------------------------------------- | +| onActionStart(event: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | Rotation手势识别成功回调。 | +| onActionUpdate(event: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | Rotation手势移动过程中回调。 | +| onActionEnd(event: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | Rotation手势识别成功，手指抬起后触发回调。 | +| onActionCancel(event: () => void) | Rotation手势识别成功，接收到触摸取消事件触发回调。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md index 191414d1ab44fb1227e1cdc9c73f8fd671432d8c..9c7c53050b9077afa4df1898d2ae92abe281c430 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md @@ -4,11 +4,6 @@ > 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 接口 SwipeGesture(value?: { fingers?: number; direction?: SwipeDirection; speed?: number }) @@ -35,7 +30,7 @@ SwipeGesture(value?: { fingers?: number; direction?: SwipeDirection; speed?: num | 名称 | 功能描述 | | -------- | -------- | -| onAction(callback:(event?: [GestureEvent](ts-gesture-settings.md)) => void) | 滑动手势识别成功回调。 | +| onAction(event:(event?: [GestureEvent](ts-gesture-settings.md)) => void) | 滑动手势识别成功回调。 | ![zh-cn_image_0000001231374559](figures/zh-cn_image_0000001231374661.png) diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md index 21e18a8c72a40bea2e59101c035fb54a7e3f8eaa..b21fd010632a8cb75f46d635d557c0f32e8abdc8 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md @@ -4,28 +4,22 @@ > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 接口 -TapGesture(options?: { count?: number, fingers?: number }) +TapGesture(value?: { count?: number, fingers?: number }) **参数：** - | 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | count | number | 否 | 1 | 识别的连续点击次数。如果设置小于1，会被转化为默认值。
>  **说明：**
> 如配置多击，上一次抬起和下一次按下的超时时间为300毫秒（ms）。 | - | fingers | number | 否 | 1 | 触发点击的最少手指数，最小为1指， 最大为10指。
>  **说明：**
> 1. 当配置多指时，第一根手指按下后300毫秒（ms）内未有足够的手指数按下，手势识别失败。
> 2. 实际点击手指数超过配置值，手势识别失败。 | - +| 参数名称 | 参数类型 | 必填 | 参数描述 | +| -------- | -------- | ---- | ------------------------------------------------------------ | +| count | number | 否 | 识别的连续点击次数。如果设置小于1，会被转化为默认值。
默认值：1
>  **说明：**
> 如配置多击，上一次抬起和下一次按下的超时时间为300毫秒（ms）。 | +| fingers | number | 否 | 触发点击的最少手指数，最小为1指， 最大为10指。
默认值：1
>  **说明：**
> 1. 当配置多指时，第一根手指按下后300毫秒（ms）内未有足够的手指数按下，手势识别失败。
> 2. 实际点击手指数超过配置值，手势识别失败。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onAction((event?: [GestureEvent](ts-gesture-settings.md)) => void) | Tap手势识别成功回调。 | +| 名称 | 功能描述 | +| ------------------------------------------------------------ | --------------------- | +| onAction(event: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | Tap手势识别成功回调。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-tabcontent.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-tabcontent.md index 13ceeecf8af610e54a3e0e67403df739059ebfd6..2e49627ae5042a02a8ccbcc23710e38ece7b49e2 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-tabcontent.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-tabcontent.md @@ -7,11 +7,6 @@ > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 支持单个子组件。 @@ -28,7 +23,7 @@ TabContent() | 名称 | 参数类型 | 默认值 | 描述 | | ------ | ------------------------------------------------------------ | ------ | ------------------------------------------------------------ | -| tabBar | string \| [Resource](ts-types.md#resource) \| {
icon?: string \| [Resource](ts-types.md#resource),
text?: string \| [Resource](ts-types.md#resource)
}
\| [CustomBuilder](ts-types.md#custombuilder8)8+ | - | 设置TabBar上显示内容。
CustomBuilder: 构造器，内部可以传入组件（API8版本以上适用）。
>  **说明：**
> 如果icon采用svg格式图源，则要求svg图源删除其自有宽高属性值。如采用带有自有宽高属性的svg图源，icon大小则是svg本身内置的宽高属性值大小。 | +| tabBar | string \| [Resource](ts-types.md#resource) \| {
icon?: string \| [Resource](ts-types.md#resource),
text?: string \| [Resource](ts-types.md#resource)
}
\| [CustomBuilder](ts-types.md#custombuilder8)8+ | - | 设置TabBar上显示内容。
CustomBuilder: 构造器，内部可以传入组件（API8版本以上适用）。
**说明：**
如果icon采用svg格式图源，则要求svg图源删除其自有宽高属性值。如采用带有自有宽高属性的svg图源，icon大小则是svg本身内置的宽高属性值大小。 | > **说明：** > - TabContent组件不支持设置通用宽度属性，其宽度默认撑满Tabs父组件。 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-tabs.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-tabs.md index 3d57780417811d75a9bee3d98e1754ad6d8e763c..a6c008d453e8f8bfacae8b91b5a66f344b2f0d9c 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-tabs.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-tabs.md @@ -7,11 +7,6 @@ > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 包含子组件[TabContent](ts-container-tabcontent.md)。 @@ -19,7 +14,7 @@ ## 接口说明 -Tabs(value: {barPosition?: BarPosition, index?: number, controller?: [TabsController](#tabscontroller)}) +Tabs(value?: {barPosition?: BarPosition, index?: number, controller?: [TabsController](#tabscontroller)}) **参数：** diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-media-components-video.md b/zh-cn/application-dev/reference/arkui-ts/ts-media-components-video.md index 2ebe1ba22ebfdf25bfd8133f271111f47a8798d8..1a1d6e4b6767a22f03971a22f5d6e7d8ce7d9652 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-media-components-video.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-media-components-video.md @@ -1,10 +1,11 @@ # Video -> **说明：** -> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 - 视频播放组件。 +> **说明：** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 + ## 权限列表 使用网络视频时，需要在config或者module.json对应的"abilities"中添加网络使用权限ohos.permission.INTERNET。 @@ -27,7 +28,7 @@ ## 接口 - Video(value: {src?: string | Resource, currentProgressRate?: number | string | PlaybackSpeed, previewUri?: string | PixelMap | Resource, controller?: VideoController}) +Video(value: {src?: string | Resource, currentProgressRate?: number | string | PlaybackSpeed, previewUri?: string | PixelMap | Resource, controller?: VideoController}) **参数：** @@ -68,10 +69,10 @@ | onPause(event:() => void) | 暂停时触发该事件。 | | onFinish(event:() => void) | 播放结束时触发该事件。 | | onError(event:() => void) | 播放失败时触发该事件。 | -| onPrepared(callBack:(event?: { duration: number }) => void) | 视频准备完成时触发该事件，通过duration可以获取视频时长，单位为s。
- duration: 视频的时长。 | -| onSeeking(callBack:(event?: { time: number }) => void) | 操作进度条过程时上报时间信息，单位为s。 | -| onSeeked(callBack:(event?: { time: number }) => void) | 操作进度条完成后，上报播放时间信息，单位为s。 | -| onUpdate(callBack:(event?: { time: number }) => void) | 播放进度变化时触发该事件，单位为s，更新时间间隔为250ms。 | +| onPrepared(callback:(event?: { duration: number }) => void) | 视频准备完成时触发该事件，通过duration可以获取视频时长，单位为s。
- duration: 视频的时长。 | +| onSeeking(callback:(event?: { time: number }) => void) | 操作进度条过程时上报时间信息，单位为s。 | +| onSeeked(callback:(event?: { time: number }) => void) | 操作进度条完成后，上报播放时间信息，单位为s。 | +| onUpdate(callback:(event?: { time: number }) => void) | 播放进度变化时触发该事件，单位为s，更新时间间隔为250ms。 | ## VideoController diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-background.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-background.md index 869a5aa65625c4fd9b61e5dd27f1022c6ba8e6a9..123a5f48d8d9ba221c339b662e0b71861edd0d89 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-background.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-background.md @@ -1,26 +1,21 @@ # 背景设置 -> **说明：** -> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 - - 设置组件的背景色。 - -## 权限列表 - -无 +> **说明：** +> +> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| backgroundColor | Color | - | 设置组件的背景色。 | -| backgroundImage | src: string,
repeat?: [ImageRepeat](ts-appendix-enums.md#imagerepeat) | - | src参数：图片地址，支持网络图片资源和本地图片资源地址(不支持svg类型的图片)。
repeat参数：设置背景图片的重复样式，默认不重复。 | -| backgroundImageSize | {
width?: Length,
height?: Length
} \| [ImageSize](ts-appendix-enums.md#imagesize) | Auto | 设置背景图像的高度和宽度。当输入为{width: Length, height: Length}对象时，如果只设置一个属性，则第二个属性保持图片原始宽高比进行调整。默认保持原图的比例不变。 | -| backgroundImagePosition | {
x?: Length,
y?: Length
} \| [Alignment](ts-appendix-enums.md#alignment) | {
x: 0,
y: 0
} | 设置背景图在组件中显示位置。 | +| 名称 | 参数类型 | 描述 | +| -------- | -------- | -------- | +| backgroundColor | [ResourceColor](ts-types.md#resourcecolor) | 设置组件的背景色。 | +| backgroundImage | src: [ResourceStr](ts-types.md#resourcestr),
repeat?: [ImageRepeat](ts-appendix-enums.md#imagerepeat) | src：图片地址，支持网络图片资源和本地图片资源地址(不支持svg类型的图片)。
repeat：设置背景图片的重复样式，默认不重复。 | +| backgroundImageSize | {
width?: [Length](ts-types.md#length),
height?: [Length](ts-types.md#length)
} \| [ImageSize](ts-appendix-enums.md#imagesize) | 设置背景图像的高度和宽度。当输入为{width: Length, height: Length}对象时，如果只设置一个属性，则第二个属性保持图片原始宽高比进行调整。默认保持原图的比例不变。
默认值：ImageSize.Auto | +| backgroundImagePosition | {
x?: [Length](ts-types.md#length),
y?: [Length](ts-types.md#length)
} \| [Alignment](ts-appendix-enums.md#alignment) | 设置背景图在组件中显示位置。
{
x: 0,
y: 0
} | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-border.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-border.md index 3a50b531df13f3ec7d1ea5582da3cc6078c2818c..9a1b22fd75740e1ee7cb8a44dc0eadb323d9d46c 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-border.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-border.md @@ -1,27 +1,22 @@ # 边框设置 -> **说明：** -> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 - - 设置组件边框样式。 - -## 权限列表 - -无 +> **说明：** +> +> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| border | {
width?: Length,
color?: Color,
radius?: Length,
style?: [BorderStyle](ts-appendix-enums.md#borderstyle)
} | - | 统一边框样式设置接口。 | -| borderStyle | [BorderStyle](ts-appendix-enums.md#borderstyle) |  BorderStyle.Solid | 设置元素的边框样式。 | -| borderWidth | Length | 0 | 设置元素的边框宽度。 | -| borderColor | Color | - | 设置元素的边框颜色。 | -| borderRadius | Length | 0 | 设置元素的边框圆角半径。 | +| 名称 | 参数类型 | 描述 | +| -------- | -------- | -------- | +| border | {
width?: [Length](ts-types.md#length),
color?: [ResourceColor](ts-types.md#resourcecolor),
radius?: [Length](ts-types.md#length),
style?: [BorderStyle](ts-appendix-enums.md#borderstyle)
} | 统一边框样式设置接口。 | +| borderStyle | [BorderStyle](ts-appendix-enums.md#borderstyle) | 设置元素的边框样式。
默认值：BorderStyle.Solid | +| borderWidth | [Length](ts-types.md#length) | 设置元素的边框宽度。 | +| borderColor | [ResourceColor](ts-types.md#resourcecolor) | 设置元素的边框颜色。 | +| borderRadius | [Length](ts-types.md#length) | 设置元素的边框圆角半径。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-menu.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-menu.md index 447edde654f97fd91f34e5708e9ed9bbbc4b3e9a..3c65b9b1f6591b2b12571864b3ae51444c8d091c 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-menu.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-menu.md @@ -5,24 +5,19 @@ > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ---------------------------- | ------------------------------------------------------------ | ------ | ------------------------------------------------------------ | -| bindMenu | Array8+ | - | 给组件绑定菜单，点击后弹出菜单。弹出菜单项支持文本和自定义两种功能。 | -| bindContextMenu8+ | content: [CustomBuilder](ts-types.md#custombuilder8)
responseType: [ResponseType](ts-appendix-enums.md#responsetype8) | - | 给组件绑定菜单，触发方式为长按或者右键点击，弹出菜单项需要自定义。 | +| 名称 | 参数类型 | 描述 | +| ---------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | +| bindMenu | Array8+ | content: [CustomBuilder](ts-types.md#custombuilder8)
responseType: [ResponseType](ts-appendix-enums.md#responsetype8) | 给组件绑定菜单，触发方式为长按或者右键点击，弹出菜单项需要自定义。 | ## MenuItem -| 名称 | 类型 | 描述 | -| ------ | ----------------------- | ----------- | -| value | string | 菜单项文本。 | +| 名称 | 类型 | 描述 | +| ------ | ----------------------- | ---------------------- | +| value | string | 菜单项文本。 | | action | () => void | 点击菜单项的事件回调。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-opacity.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-opacity.md index 44e5d0785420e0b501daee22dcb22b20ad1a548f..04cf60d25ddc9558e4c1e944b455532fe762d49c 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-opacity.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-opacity.md @@ -7,17 +7,12 @@ > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ------- | ------ | ---- | ---------------------------------- | -| opacity | number | 1 | 元素的不透明度，取值范围为0到1，1表示为不透明，0表示为完全透明。 | +| 名称 | 参数类型 | 描述 | +| ------- | ---------------------------------------------------- | ------------------------------------------------------------ | +| opacity | number \| [Resource](ts-types.md#resource) | 元素的不透明度，取值范围为0到1，1表示为不透明，0表示为完全透明。
默认值：1 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-polymorphic-style.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-polymorphic-style.md index 44c2a17684ecdd23ab19b72b29f4699d354b8f1a..f3ddeacc02f67ef3bb7ab370f5493acd4c3fac5b 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-polymorphic-style.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-polymorphic-style.md @@ -1,30 +1,27 @@ # 多态样式 -> **说明：** -> 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 - - 设置组件不同状态下的样式。 - -## 权限列表 - -无 +> **说明：** +> +> 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ----------- | ----------- | ---- | ------------ | -| stateStyles | StateStyles | - | 设置组件不同状态的样式。 | +| 名称 | 参数类型 | 描述 | +| ----------- | ----------- | ------------------------ | +| stateStyles | StateStyles | 设置组件不同状态的样式。 | ## StateStyles接口说明 -| 名称 | 类型 | 必填 | 默认值 | 描述 | -| -------- | ----------- | ---- | ---- | ---------- | -| normal | ()=>void | 否 | - | 组件无状态时的样式。 | -| pressed | ()=>void | 否 | - | 组件按下状态的样式。 | -| disabled | ()=>void | 否 | - | 组件禁用状态的样式。 | +| 名称 | 类型 | 必填 | 描述 | +| -------- | ---- | ---- | -------------------- | +| normal | any | 否 | 组件无状态时的样式。 | +| pressed | any | 否 | 组件按下状态的样式。 | +| disabled | any | 否 | 组件禁用状态的样式。 | +| focused | any | 否 | 组件获焦状态的样式。 | +| clicked | any | 否 | 组件点击状态的样式。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-popup.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-popup.md index 4d81ce020ef1e3f91d4ea69fcdc5907966711673..ae882e08ac4b44096bf99dfcb21a15446866ac7a 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-popup.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-popup.md @@ -5,39 +5,34 @@ > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - -## 属性 - - -| 名称 | 参数类型 | 默认值 | 描述 | -| --------- | ---------------------------------------- | ---- | ---------------------------------------- | -| bindPopup | show: boolean,
popup: PopupOptions\| CustomPopupOptions | - | 给组件绑定Popup，点击弹出弹窗。
show: 创建页面弹窗提示是否默认显示，默认值为false。
popup: 配置当前弹窗提示的参数。 | - -## PopupOptions类型接口说明 - -| 名称 | 类型 | 必填 | 默认值 | 描述 | -| --------------- | ---------------------------------------- | ---- | ----- | ---------------------------------------- | -| message | string | 是 | - | 弹窗信息内容。 | -| placementOnTop | boolean | 否 | false | 是否在组件上方显示，默认值为false。 | -| primaryButton | {
value: string,
action: () => void
} | 否 | - | 第一个按钮。
value: 弹窗里主按钮的文本。
action: 点击主按钮的回调函数。 | -| secondaryButton | {
value: string,
action: () => void
} | 否 | - | 第二个按钮。
value: 弹窗里辅助按钮的文本。
action: 点击辅助按钮的回调函数。 | -| onStateChange | (isVisible: boolean) => void | 否 | - | 弹窗状态变化事件回调，参数isVisible为弹窗当前的显示状态。 | - -## CustomPopupOptions8+类型接口说明 - -| 名称 | 类型 | 必填 | 默认值 | 描述 | -| ------------- | ---------------------------------------------- | ---- | ---------------- | ------------------------------------------------------------ | -| builder | () => any | 是 | - | 提示气泡内容的构造器。 | -| placement | [Placement](ts-appendix-enums.md#placement8) | 否 | Placement.Bottom | 气泡组件优先显示的位置，当前位置显示不下时，会自动调整位置。 | -| maskColor | [Color](ts-appendix-enums.md#color) | 否 | - | 提示气泡遮障层的颜色。 | -| popupColor | [Color](ts-appendix-enums.md#color) | 否 | - | 提示气泡的颜色。 | -| enableArrow | boolean | 否 | true | 是否显示箭头，只有上、下方向的气泡会显示箭头。 | -| autoCancel | boolean | 否 | true | 页面有操作时，是否自动关闭气泡 | -| onStateChange | (isVisible: boolean) => void | 否 | - | 弹窗状态变化事件回调，参数为弹窗当前的显示状态。 | +## 接口 + + +| 名称 | 参数类型 | 描述 | +| --------- | ------------------------------------------------------------ | ------------------------------------------------------------ | +| bindPopup | show: boolean,
popup: PopupOptions\| CustomPopupOptions8+ | 给组件绑定Popup，点击弹出弹窗。
show: 创建页面弹窗提示是否默认显示，默认值为false。
popup: 配置当前弹窗提示的参数。 | + +## PopupOptions类型说明 + +| 名称 | 类型 | 必填 | 描述 | +| --------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| message | string | 是 | 弹窗信息内容。 | +| placementOnTop | boolean | 否 | 是否在组件上方显示，默认值为false。 | +| primaryButton | {
value: string,
action: () => void
} | 否 | 第一个按钮。
value: 弹窗里主按钮的文本。
action: 点击主按钮的回调函数。 | +| secondaryButton | {
value: string,
action: () => void
} | 否 | 第二个按钮。
value: 弹窗里辅助按钮的文本。
action: 点击辅助按钮的回调函数。 | +| onStateChange | (event:{isVisible: boolean }) => void | 否 | 弹窗状态变化事件回调，参数isVisible为弹窗当前的显示状态。 | + +## CustomPopupOptions8+类型说明 + +| 名称 | 类型 | 必填 | 描述 | +| ------------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ | +| builder | [CustomBuilder](ts-types.md#custombuilder8) | 是 | 提示气泡内容的构造器。 | +| placement | [Placement](ts-appendix-enums.md#placement8) | 否 | 气泡组件优先显示的位置，当前位置显示不下时，会自动调整位置。
默认值：Placement.Bottom | +| maskColor | [ResourceColor](ts-types.md#resourcecolor) | 否 | 提示气泡遮障层的颜色。 | +| popupColor | [ResourceColor](ts-types.md#resourcecolor) | 否 | 提示气泡的颜色。 | +| enableArrow | boolean | 否 | 是否显示箭头，只有上、下方向的气泡会显示箭头。
默认值：true | +| autoCancel | boolean | 否 | 页面有操作时，是否自动关闭气泡
默认值：true | +| onStateChange | (event:{isVisible: boolean }) => void | 否 | 弹窗状态变化事件回调，参数为弹窗当前的显示状态。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-size.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-size.md index 474f34717426e12263e2d5cbaeb61354744465ec..ff5c7cccc7a293ad4ae0c0856e4f63501a9c16ab 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-size.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-size.md @@ -5,23 +5,18 @@ > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 属性 -| 名称 | 参数说明 | 默认值 | 描述 | -| -------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| width | Length | - | 设置组件自身的宽度，缺省时使用元素自身内容需要的宽度。 | -| height | Length | - | 设置组件自身的高度，缺省时使用元素自身内容需要的高度。 | -| size | {
width?: Length,
height?: Length
} | - | 设置高宽尺寸。 | -| padding | {
top?: Length,
right?: Length,
bottom?: Length,
left?: Length
} \| Length | 0 | 设置内边距属性。
参数为Length类型时，四个方向内边距同时生效。 | -| margin | {
top?: Length,
right?: Length,
bottom?: Length,
left?: Length
}
\| Length | 0 | 设置外边距属性。
参数为Length类型时，四个方向外边距同时生效。 | -| constraintSize | {
minWidth?: Length,
maxWidth?: Length,
minHeight?: Length,
maxHeight?: Length
} | {
minWidth: 0,
maxWidth: Infinity,
minHeight: 0,
maxHeight: Infinity
} | 设置约束尺寸，组件布局时，进行尺寸范围限制。 | -| layoutWeight | number | 0 | 容器尺寸确定时，元素与兄弟节点主轴布局尺寸按照权重进行分配，忽略本身尺寸设置，表示自适应占满剩余空间。
>  **说明：**
> 仅在Row/Column/Flex布局中生效。 | +| 名称 | 参数说明 | 描述 | +| -------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | +| width | [Length](ts-types.md#length) | 设置组件自身的宽度，缺省时使用元素自身内容需要的宽度。 | +| height | [Length](ts-types.md#length) | 设置组件自身的高度，缺省时使用元素自身内容需要的高度。 | +| size | {
width?: [Length](ts-types.md#length),
height?: [Length](ts-types.md#length)
} | 设置高宽尺寸。 | +| padding | [Padding](ts-types.md#padding) \| [Length](ts-types.md#length) | 设置内边距属性。
参数为Length类型时，四个方向内边距同时生效。
默认值：0 | +| margin | [Margin](ts-types.md#margin) \| [Length](ts-types.md#length) | 设置外边距属性。
参数为Length类型时，四个方向外边距同时生效。
默认值：0 | +| constraintSize | {
minWidth?: [Length](ts-types.md#length),
maxWidth?: [Length](ts-types.md#length),
minHeight?: [Length](ts-types.md#length),
maxHeight?: [Length](ts-types.md#length)
} | 设置约束尺寸，组件布局时，进行尺寸范围限制。
默认值：
{
minWidth: 0,
maxWidth: Infinity,
minHeight: 0,
maxHeight: Infinity
} | +| layoutWeight | number \| string | 容器尺寸确定时，元素与兄弟节点主轴布局尺寸按照权重进行分配，忽略本身尺寸设置，表示自适应占满剩余空间。
默认值：0
**说明：**
仅在Row/Column/Flex布局中生效。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-touch-target.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-touch-target.md index 2043171acbda94af034e0b4bac847e9a902ea05a..700349d0a0cefe05271e1c2995ecf99dad61b2a0 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-touch-target.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-touch-target.md @@ -1,37 +1,35 @@ # 触摸热区设置 +适用于支持通用点击事件、通用触摸事件、通用手势处理的组件。 + > **说明：** > > 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -适用于支持通用点击事件、通用触摸事件、通用手势处理的组件。 - - -## 权限列表 - -无 - - ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| responseRegion | Array<Rectangle> \| Rectangle | {
x：0,
y：0,
width：'100%',
height：'100%'
} | 设置一个或多个触摸热区，包括位置和大小。
>  **说明：**
> -百分比是相对于组件本身来度量的。
> -x和y可以设置正负值百分比。当x设置为'100%'时表示热区往右偏移组件本身宽度大小，当x设置为'-100%'时表示热区往左偏移组件本身宽度大小。当y设置为'100%'时表示热区往下偏移组件本身高度大小，当y设置为'-100%'时表示热区往上偏移组件本身高度大小。
> -width和height只能设置正值百分比。width：'100%'表示热区宽度设置为该组件本身的宽度。比如组件本身宽度是100vp，那么'100%'表示热区宽度也为100vp。height：'100%'表示热区高度设置为该组件本身的高度。 | +| 名称 | 参数类型 | 描述 | +| -------------- | --------------------------------------------- | ------------------------------------------------------------ | +| responseRegion | Array<Rectangle> \| Rectangle | 设置一个或多个触摸热区，包括位置和大小。
默认值：
{
x：0,
y：0,
width：'100%',
height：'100%'
} | ### Rectangle对象说明 -| 名称 | 类型 | 必填 | 默认值 | 描述 | -| ------ | ------ | ---- | ---- | ------------------ | -| x | Length | 否 | 0vp | 触摸点相对于组件本身左边沿的X坐标。 | -| y | Length | 否 | 0vp | 触摸点相对于组件本身左边沿的Y坐标。 | -| width | Length | 否 | 100% | 触摸热区范围的宽度。 | -| height | Length | 否 | 100% | 触摸热区范围的高度。 | +| 名称 | 类型 | 必填 | 默认值 | 描述 | +| ------ | ---------------------------- | ---- | ------ | --------------------------------------------------- | +| x | [Length](ts-types.md#length) | 否 | 0vp | 触摸点相对于组件本身左边沿的X坐标。
默认值：0vp | +| y | [Length](ts-types.md#length) | 否 | 0vp | 触摸点相对于组件本身左边沿的Y坐标。
默认值：0vp | +| width | [Length](ts-types.md#length) | 否 | 100% | 触摸热区范围的宽度。
默认值：100% | +| height | [Length](ts-types.md#length) | 否 | 100% | 触摸热区范围的高度。
默认值：100% | > **说明：** > - > 当x和y都设置为正值时，表示组件的触摸热区的范围整体往组件本身右下角偏移，偏移的大小可通过数值来设置。 + > x和y可以设置正负值百分比。当x设置为'100%'时表示热区往右偏移组件本身宽度大小，当x设置为'-100%'时表示热区往左偏移组件本身宽度大小。当y设置为'100%'时表示热区往下偏移组件本身高度大小，当y设置为'-100%'时表示热区往上偏移组件本身高度大小。 + > + > width和height只能设置正值百分比。width：'100%'表示热区宽度设置为该组件本身的宽度。比如组件本身宽度是100vp，那么'100%'表示热区宽度也为100vp。height：'100%'表示热区高度设置为该组件本身的高度。 + > + > 百分比是相对于组件本身来度量的。 ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md index 8bfa7a8329c9ef79129b3c60b80df0e2826d7f3a..6f8902fb7626655e717ca8742fc90f2a564eeacb 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md @@ -5,26 +5,22 @@ > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 事件 -| 名称 | 支持冒泡 | 功能描述 | -| ---------------------------------------- | ---- | --------------------------------- | -| onClick(callback: (event?: ClickEvent) => void) | 否 | 点击动作触发该方法调用，event参数见ClickEvent介绍。 | +| 名称 | 支持冒泡 | 功能描述 | +| ------------------------------------------------------------ | -------- | --------------------------------------------------- | +| onClick(event: (event?: ClickEvent) => void) | 否 | 点击动作触发该方法调用，event参数见ClickEvent介绍。 | ## ClickEvent对象说明 -| 属性名称 | 类型 | 描述 | -| ------------------- | -------------------------------- | ------------------- | -| screenX | number | 点击点相对于设备屏幕左边沿的X坐标。 | -| screenY | number | 点击点相对于设备屏幕上边沿的Y坐标。 | -| x | number | 点击点相对于被点击元素左边沿的X坐标。 | -| y | number | 点击点相对于被点击元素上边沿的Y坐标。 | -| target8+ | [EventTarget](#eventtarget8对象说明) | 被点击元素对象。 | -| timestamp | number | 事件时间戳。 | +| 属性名称 | 类型 | 描述 | +| ---------------------- | ------------------------------------ | ------------------------------------- | +| screenX | number | 点击点相对于设备屏幕左边沿的X坐标。 | +| screenY | number | 点击点相对于设备屏幕上边沿的Y坐标。 | +| x | number | 点击点相对于被点击元素左边沿的X坐标。 | +| y | number | 点击点相对于被点击元素上边沿的Y坐标。 | +| target8+ | [EventTarget](#eventtarget8对象说明) | 被点击元素对象。 | +| timestamp8+ | number | 事件时间戳。 | +| source8+ | [SourceType](ts-gesture-settings.md) | 事件输入设备。 | ## EventTarget8+对象说明 | 名称 | 参数类型 | 描述 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-touch.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-touch.md index b2adb7038492f42217cd274f57849c9bf1d1f8dd..9f94105c21c5eee879c1ce401df723112bfe6086 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-touch.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-touch.md @@ -5,16 +5,11 @@ > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 事件 -| 名称 | 是否冒泡 | 功能描述 | -| ---------------------------------------- | ---- | ---------------------------------------- | -| onTouch(callback: (event?: TouchEvent) => void) | 是 | 触摸动作触发该方法调用，event参数见[TouchEvent](#touchevent对象说明)介绍。 | +| 名称 | 是否冒泡 | 功能描述 | +| ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | +| onTouch(event: (event?: TouchEvent) => void) | 是 | 触摸动作触发该方法调用，event参数见[TouchEvent](#touchevent对象说明)介绍。 | ## TouchEvent对象说明 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-mouse-key.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-mouse-key.md index 9a73043eda3ae1f349c5910ad4dfa4fd96805b7b..2264ace64b057a1b55edc3d52c4e84d8a28d0fa6 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-mouse-key.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-mouse-key.md @@ -5,17 +5,12 @@ > 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 事件 -| 名称 | 支持冒泡 | 描述 | -| ---------------------------------------- | ---- | ---------------------------------------- | -| onHover(callback: (isHover?: boolean) => void) | 否 | 鼠标进入或退出组件时触发该回调。
isHover：表示鼠标是否悬浮在组件上，鼠标进入时为true, 退出时为false。 | -| onMouse(callback: (event?: MouseEvent) => void) | 是 | 当前组件被鼠标按键点击时或者鼠标在组件上移动时，触发该回调，event参数包含触发事件时的时间戳、鼠标按键、动作、点击触点在整个屏幕上的坐标和点击触点相对于当前组件的坐标。 | +| 名称 | 支持冒泡 | 描述 | +| ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | +| onHover(event: (isHover: boolean) => void) | 否 | 鼠标进入或退出组件时触发该回调。
isHover：表示鼠标是否悬浮在组件上，鼠标进入时为true, 退出时为false。 | +| onMouse(event: (event?: MouseEvent) => void) | 是 | 当前组件被鼠标按键点击时或者鼠标在组件上移动时，触发该回调，event参数包含触发事件时的时间戳、鼠标按键、动作、点击触点在整个屏幕上的坐标和点击触点相对于当前组件的坐标。 | ## MouseEvent对象说明 diff --git a/zh-cn/application-dev/task-management/background-task-dev-guide.md b/zh-cn/application-dev/task-management/background-task-dev-guide.md index 63abf1638eea80de283fb1f4d7cc63faad2cd907..759b2ad28acb52e66fd1317e4310f1897b6bbaf8 100644 --- a/zh-cn/application-dev/task-management/background-task-dev-guide.md +++ b/zh-cn/application-dev/task-management/background-task-dev-guide.md @@ -195,7 +195,7 @@ import featureAbility from '@ohos.ability.featureAbility'; import wantAgent from '@ohos.wantAgent'; import rpc from "@ohos.rpc"; -function startBackgroundRunning() { +function startContinuousTask() { let wantAgentInfo = { // 点击通知后，将要执行的动作列表 wants: [ @@ -223,7 +223,7 @@ function startBackgroundRunning() { }); } -function stopBackgroundRunning() { +function stopContinuousTask() { backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext()).then(() => { console.info("Operation stopBackgroundRunning succeeded"); }).catch((err) => { @@ -231,6 +231,13 @@ function stopBackgroundRunning() { }); } +async function processAsyncJobs() { + // 此处执行具体的长时任务。 + + // 长时任务执行完，调用取消接口，释放资源。 + stopContinuousTask(); +} + let mMyStub; class MyStub extends rpc.RemoteObject { @@ -262,9 +269,9 @@ export default { onStart(want) { console.info('ServiceAbility onStart'); mMyStub = new MyStub("ServiceAbility-test"); - startBackgroundRunning(); - // 此处执行后台具体的长时任务。 - stopBackgroundRunning(); + // 在执行后台长时任前，调用申请接口。 + startContinuousTask(); + processAsyncJobs(); }, onStop() { console.info('ServiceAbility onStop');