diff --git a/api/@internal/component/ets/nav_destination.d.ts b/api/@internal/component/ets/nav_destination.d.ts index 4755ea17c176ad0cf92a5bfeb62955be41ea2074..8bc03f36bf786a993e164ed1b8b9b9e7dbdbcc2e 100644 --- a/api/@internal/component/ets/nav_destination.d.ts +++ b/api/@internal/component/ets/nav_destination.d.ts @@ -772,7 +772,7 @@ declare interface NavDestinationTransition { */ declare class NavDestinationAttribute extends CommonMethod { /** - * Navigation title bar + * NavDestination title bar * * @param { string | CustomBuilder | NavDestinationCommonTitle | NavDestinationCustomTitle } value * @returns { NavDestinationAttribute } @@ -780,7 +780,7 @@ declare class NavDestinationAttribute extends CommonMethodDefault value: **false**. + *
**true**: Hide the title bar. + *
**false**: Show the title bar. * @returns { NavDestinationAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -862,7 +865,13 @@ declare class NavDestinationAttribute extends CommonMethodDefault value: **false**. + *
**true**: Hide the title bar. + *
**false**: Show the title bar. * @param { boolean } animated + *
Default value: **false**. + *
**true**: Animate the visibility change. + *
**false**: Do not animate the visibility change. * @returns { NavDestinationAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -1449,6 +1458,8 @@ declare class NavDestinationAttribute extends CommonMethod**NavDestination** component. * @param { boolean } [animated] - Whether to use an animation to show or hide the system status bar. *
Default value: **false**. + *
**true**: Hide/show the system status bar with animation. + *
**false**: Hide/show the system status bar without animation. * @returns { NavDestinationAttribute } Returns the instance of the NavDestinationAttribute. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform diff --git a/api/@internal/component/ets/navigation.d.ts b/api/@internal/component/ets/navigation.d.ts index 50cd9e817d12b7d8896f8c214208703ce9f1d807..2858af5ff416e1d6a9a8e15ecad1c06bb2a684fc 100644 --- a/api/@internal/component/ets/navigation.d.ts +++ b/api/@internal/component/ets/navigation.d.ts @@ -1230,6 +1230,8 @@ declare class NavPathStack { * @param { string } name - Indicates the name of the NavDestination to be pushed. * @param { Object | null | undefined } param - Indicates the detailed parameter of the NavDestination to be pushed. * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported. **false**: The transition animation is not supported. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1274,6 +1276,8 @@ declare class NavPathStack { * @param { Object } param - Indicates the detailed parameter of the NavDestination to be pushed. * @param { Callback } onPop - The callback when next page returns. * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported. **false**: The transition animation is not supported. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1288,6 +1292,8 @@ declare class NavPathStack { * @param { string } name - Indicates the name of the NavDestination to be pushed. * @param { Object } param - Indicates the detailed parameter of the NavDestination to be pushed. * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported. **false**: The transition animation is not supported. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified. @@ -1306,6 +1312,8 @@ declare class NavPathStack { * @param { string } name - Indicates the name of the NavDestination to be pushed. * @param { Object } param - Indicates the detailed parameter of the NavDestination to be pushed. * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported. **false**: The transition animation is not supported. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified. @@ -1329,6 +1337,8 @@ declare class NavPathStack { * @param { Object } param - Indicates the detailed parameter of the NavDestination to be pushed. * @param { import('../api/@ohos.base').Callback } onPop - The callback when next page returns. * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported. **false**: The transition animation is not supported. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified. @@ -1348,6 +1358,8 @@ declare class NavPathStack { * @param { Object } param - Indicates the detailed parameter of the NavDestination to be pushed. * @param { import('../api/@ohos.base').Callback } onPop - The callback when next page returns. * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported. **false**: The transition animation is not supported. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified. @@ -1370,6 +1382,8 @@ declare class NavPathStack { * @param { Object } param - Indicates the detailed parameter of the NavDestination to be pushed. * @param { Callback } onPop - The callback when next page returns. * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported. **false**: The transition animation is not supported. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified. @@ -1391,6 +1405,9 @@ declare class NavPathStack { * * @param { NavPathInfo } info - Indicates the new NavDestination in top of the stack. * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported. + *
**false**: The transition animation is not supported. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 11 @@ -1543,7 +1560,9 @@ declare class NavPathStack { /** * Pops the top NavDestination out of the stack. * - * @param { boolean } [animated] - Indicates whether the transition is animated. Default value is **true**. + * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported.
**false**: The transition animation is not supported. * @returns { NavPathInfo | undefined } Returns the top NavPathInfo if the stack is not empty, otherwise returns undefined. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -1557,7 +1576,9 @@ declare class NavPathStack { * Pops the top NavDestination out of the stack. Invokes the **onPop** callback to pass the page processing result. * * @param { Object } result - The result of the NavDestination. - * @param { boolean } [animated] - Indicates whether the transition is animated. Default value is **true**. + * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported.
**false**: The transition animation is not supported. * @returns { NavPathInfo | undefined } Returns the top NavPathInfo if the stack is not empty, otherwise returns undefined. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -1567,7 +1588,9 @@ declare class NavPathStack { * Pops the top NavDestination out of the stack. Invokes the **onPop** callback to pass the page processing result. * * @param { Object } result - The result of the NavDestination. - * @param { boolean } [animated] - Indicates whether the transition is animated. Default value is **true**. + * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported.
**false**: The transition animation is not supported. * @returns { NavPathInfo | undefined } Returns the top NavPathInfo if the stack is not empty, otherwise returns undefined. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -1691,6 +1714,8 @@ declare class NavPathStack { * * @param { string } name - Indicates the name of the NavDestination to be moved to the top. * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported. **false**: The transition animation is not supported. * @returns { number } Returns the index of the NavDestination if it exists in the stack, otherwise returns -1; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -1949,6 +1974,8 @@ declare class NavPathStack { * * @param { Array } pathStack - The NavPathInfo array. * @param { boolean } [animated] - Indicate whether the operation has animation. + *
Default value: **true**. + *
**true**: The transition animation is supported. **false**: The transition animation is not supported. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -2618,6 +2645,8 @@ declare interface NavigationTitleOptions { * * @type { ?boolean } * @default false + *
**true**: Enable hover effects. + *
**false**: Disable hover effects. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -2762,6 +2791,8 @@ declare interface NavigationToolbarOptions { * * @type { ?boolean } * @default false + *
**true**: Hide the toolbar text. + *
**false**: Show the toolbar text. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice diff --git a/api/@ohos.arkui.advanced.MultiNavigation.d.ets b/api/@ohos.arkui.advanced.MultiNavigation.d.ets index a90ca599fcb99a4aa3fa4131fccf43c179892f3d..361ca5f18352c89a855aa84c9a1801aaf60ba856 100644 --- a/api/@ohos.arkui.advanced.MultiNavigation.d.ets +++ b/api/@ohos.arkui.advanced.MultiNavigation.d.ets @@ -144,6 +144,8 @@ export declare class MultiNavPathStack extends NavPathStack { * * @param { NavPathInfo } info - Indicates the NavDestination to be pushed. * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported. **false**: The transition animation is not supported. * @param { SplitPolicy } [policy] - SplitPolicy of the NavDestination which is currently * pushed in stack. Default splitPolicy is DETAIL_PAGE. * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -173,6 +175,8 @@ export declare class MultiNavPathStack extends NavPathStack { * @param { string } name - Indicates the name of the NavDestination to be pushed. * @param { Object } param - Indicates the detailed parameter of the NavDestination to be pushed. * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported. **false**: The transition animation is not supported. * @param { SplitPolicy } [policy] - SplitPolicy of the NavDestination which is currently * pushed in stack. Default splitPolicy is DETAIL_PAGE. * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -189,6 +193,8 @@ export declare class MultiNavPathStack extends NavPathStack { * @param { Object } param - Indicates the detailed parameter of the NavDestination to be pushed. * @param { base.Callback } [onPop] - The callback when next page returns. * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported. **false**: The transition animation is not supported. * @param { SplitPolicy } [policy] - SplitPolicy of the NavDestination which is currently * pushed in stack. Default splitPolicy is DETAIL_PAGE. * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -205,6 +211,8 @@ export declare class MultiNavPathStack extends NavPathStack { * * @param { NavPathInfo } info - Indicates the new NavDestination in top of the stack. * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported. **false**: The transition animation is not supported. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -232,6 +240,8 @@ export declare class MultiNavPathStack extends NavPathStack { * @param { string } name - Indicates name of the new NavDestination in top of stack. * @param { Object } param - Indicates the detailed parameter of the new NavDestination in top of the stack. * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported. **false**: The transition animation is not supported. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -267,6 +277,8 @@ export declare class MultiNavPathStack extends NavPathStack { * Pop the top NavDestination of the stack. * * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported. **false**: The transition animation is not supported. * @returns { NavPathInfo | undefined } Returns the top NavPathInfo if the stack is not empty, * otherwise returns undefined. * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -282,6 +294,8 @@ export declare class MultiNavPathStack extends NavPathStack { * * @param { Object } [result] - Page Customization processing results. * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported. **false**: The transition animation is not supported. * @returns { NavPathInfo | undefined } Returns the top NavPathInfo if the stack is not empty, * otherwise returns undefined. * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -297,6 +311,8 @@ export declare class MultiNavPathStack extends NavPathStack { * * @param { string } name - Name of the NavDestination. * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported. **false**: The transition animation is not supported. * @returns { number } Returns the index of the NavDestination if it exists in the stack, otherwise returns -1. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -312,6 +328,8 @@ export declare class MultiNavPathStack extends NavPathStack { * @param { string } name - Name of the NavDestination. * @param { Object } result - Page Customization processing results. * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported. **false**: The transition animation is not supported. * @returns { number } Returns the index of the NavDestination if it exists in the stack, otherwise returns -1. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -325,6 +343,8 @@ export declare class MultiNavPathStack extends NavPathStack { * * @param { number } index - The index of NavDestination page. * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported. **false**: The transition animation is not supported. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -338,6 +358,8 @@ export declare class MultiNavPathStack extends NavPathStack { * @param { number } index - The index of NavDestination page. * @param { Object } result - Page Customization processing results. * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported. **false**: The transition animation is not supported. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -351,6 +373,8 @@ export declare class MultiNavPathStack extends NavPathStack { * * @param { string } name - Indicates the name of the NavDestination to be moved to the top. * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported. **false**: The transition animation is not supported. * @returns { number } Returns the index of the NavDestination if it exists in the stack, otherwise returns -1. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -364,6 +388,8 @@ export declare class MultiNavPathStack extends NavPathStack { * * @param { number } index - Indicates the index of the NavDestination to be moved to the top. * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported. **false**: The transition animation is not supported. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -376,6 +402,8 @@ export declare class MultiNavPathStack extends NavPathStack { * stack will be retained. * * @param { boolean } [animated] - Indicates whether the transition is animated. + *
Default value: **true**. + *
**true**: The transition animation is supported. **false**: The transition animation is not supported. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice