diff --git a/api/arkui/FrameNode.d.ts b/api/arkui/FrameNode.d.ts index cbc125790be69c179b4004636c27de499ed20cdf..8eef4b80c5526a07991e39d420e9d78fe1746bb8 100644 --- a/api/arkui/FrameNode.d.ts +++ b/api/arkui/FrameNode.d.ts @@ -29,6 +29,13 @@ import { ComponentContent } from './ComponentContent'; import { UIContext } from '@ohos.arkui.UIContext'; import { UICommonEvent, UIGestureEvent, CommonAttribute } from './component/common' import { ListOptions, ListAttribute } from './component/list' +import { ListItemOptions, ListItemAttribute } from './component/listItem' +import { ListItemGroupOptions, ListItemGroupAttribute } from './component/listItemGroup' +import { Scroller, ScrollAttribute } from './component/scroll' +import { GridLayoutOptions, GridAttribute } from './component/grid' +import { GridItemOptions, GridItemAttribute } from './component/gridItem' +import { WaterFlowOptions, WaterFlowAttribute } from './component/waterFlow' +import { FlowItemAttribute } from './component/flowItem' /*** endif */ /** * Layout constraint, include the max size, the min size and the reference size for children to calculate percent. @@ -1218,6 +1225,43 @@ export declare namespace typeNode { */ type Scroll = TypedFrameNode; + /** + * Define the Scroll type of FrameNode. + * + * @extends TypedFrameNode + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + abstract class ScrollFrameNode extends TypedFrameNode { + /** + * Initialize FrameNode. + * + * @param { Scroller } [scroller] - a controller for scrollable container components. + * @returns { ScrollAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + abstract initialize(scroller?: Scroller): ScrollAttribute; + } + + /** + * Define the FrameNode type for Scroll. + * + * @typedef { ScrollFrameNode } Scroll + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + type Scroll = ScrollFrameNode; + /** * Create a FrameNode of Scroll type. * @@ -1228,7 +1272,18 @@ export declare namespace typeNode { * @atomicservice * @since 12 */ - function createNode(context: UIContext, nodeType: 'Scroll'): Scroll; + /** + * Create a FrameNode of Scroll type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'Scroll' } nodeType - node type. + * @returns { Scroll } - Return Scroll type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 + */ + export function createNode(context: UIContext, nodeType: 'Scroll'): Scroll; /** * Get the attribute instance of FrameNode to set attributes. @@ -1478,6 +1533,43 @@ export declare namespace typeNode { */ type ListItem = TypedFrameNode; + /** + * Define the ListItem type of FrameNode. + * + * @extends TypedFrameNode + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + abstract class ListItemFrameNode extends TypedFrameNode { + /** + * Initialize FrameNode. + * + * @param { ListItemOptions | string } [value] - list item options + * @returns { ListItemAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + abstract initialize(value?: ListItemOptions | string): ListItemAttribute; + } + + /** + * Define the FrameNode type for ListItem. + * + * @typedef { ListItemFrameNode } ListItem + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + type ListItem = ListItemFrameNode; + /** * Create a FrameNode of ListItem type. * @@ -1488,7 +1580,18 @@ export declare namespace typeNode { * @atomicservice * @since 12 */ - function createNode(context: UIContext, nodeType: 'ListItem'): ListItem; + /** + * Create a FrameNode of ListItem type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'ListItem' } nodeType - node type. + * @returns { ListItem } - Return ListItem type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 + */ + export function createNode(context: UIContext, nodeType: 'ListItem'): ListItem; /** * Define the FrameNode type for TextInput. @@ -1547,6 +1650,43 @@ export declare namespace typeNode { */ type ListItemGroup = TypedFrameNode; + /** + * Define the ListItemGroup type of FrameNode. + * + * @extends TypedFrameNode + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + abstract class ListItemGroupFrameNode extends TypedFrameNode { + /** + * Initialize FrameNode. + * + * @param { ListItemGroupOptions } [options] - list item group options + * @returns { ListItemGroupAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + abstract initialize(options?: ListItemGroupOptions): ListItemGroupAttribute; + } + + /** + * Define the FrameNode type for ListItemGroup. + * + * @typedef { ListItemGroupFrameNode } ListItemGroup + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + type ListItemGroup = ListItemGroupFrameNode; + /** * Create a FrameNode of ListItemGroup type. * @@ -1557,7 +1697,18 @@ export declare namespace typeNode { * @atomicservice * @since 12 */ - function createNode(context: UIContext, nodeType: 'ListItemGroup'): ListItemGroup; + /** + * Create a FrameNode of ListItemGroup type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'ListItemGroup' } nodeType - node type. + * @returns { ListItemGroup } - Return ListItemGroup type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 + */ + export function createNode(context: UIContext, nodeType: 'ListItemGroup'): ListItemGroup; /** * Define the FrameNode type for WaterFlow. @@ -1570,6 +1721,43 @@ export declare namespace typeNode { */ type WaterFlow = TypedFrameNode; + /** + * Define the WaterFlow type of FrameNode. + * + * @extends TypedFrameNode + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + abstract class WaterFlowFrameNode extends TypedFrameNode { + /** + * Initialize FrameNode. + * + * @param { WaterFlowOptions } [options] - water flow options. + * @returns { WaterFlowAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + abstract initialize(options?: WaterFlowOptions): WaterFlowAttribute; + } + + /** + * Define the FrameNode type for WaterFlow. + * + * @typedef { WaterFlowFrameNode } WaterFlow + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + type WaterFlow = WaterFlowFrameNode; + /** * Create a FrameNode of WaterFlow type. * @@ -1580,7 +1768,18 @@ export declare namespace typeNode { * @atomicservice * @since 12 */ - function createNode(context: UIContext, nodeType: 'WaterFlow'): WaterFlow; + /** + * Create a FrameNode of WaterFlow type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'WaterFlow' } nodeType - node type. + * @returns { WaterFlow } - Return WaterFlow type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 + */ + export function createNode(context: UIContext, nodeType: 'WaterFlow'): WaterFlow; /** * Define the FrameNode type for FlowItem. @@ -1593,6 +1792,42 @@ export declare namespace typeNode { */ type FlowItem = TypedFrameNode; + /** + * Define the FlowItem type of FrameNode. + * + * @extends TypedFrameNode + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + abstract class FlowItemFrameNode extends TypedFrameNode { + /** + * Initialize FrameNode. + * + * @returns { FlowItemAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + abstract initialize(): FlowItemAttribute; + } + + /** + * Define the FrameNode type for FlowItem. + * + * @typedef { FlowItemFrameNode } FlowItem + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + type FlowItem = FlowItemFrameNode; + /** * Create a FrameNode of FlowItem type. * @@ -1603,7 +1838,18 @@ export declare namespace typeNode { * @atomicservice * @since 12 */ - function createNode(context: UIContext, nodeType: 'FlowItem'): FlowItem; + /** + * Create a FrameNode of FlowItem type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'FlowItem' } nodeType - node type. + * @returns { FlowItem } - Return FlowItem type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 + */ + export function createNode(context: UIContext, nodeType: 'FlowItem'): FlowItem; /** * Define the FrameNode type for XComponent. @@ -1988,6 +2234,44 @@ export declare namespace typeNode { */ type Grid = TypedFrameNode; + /** + * Define the Grid type of FrameNode. + * + * @extends TypedFrameNode + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + abstract class GridFrameNode extends TypedFrameNode { + /** + * Initialize FrameNode. + * + * @param { Scroller } [scroller] - a controller for scrollable container components. + * @param { GridLayoutOptions } [layoutOptions] - grid options. + * @returns { GridAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + abstract initialize(scroller?: Scroller, layoutOptions?: GridLayoutOptions): GridAttribute; + } + + /** + * Define the FrameNode type for Grid. + * + * @typedef { GridFrameNode } Grid + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + type Grid = GridFrameNode; + /** * Create a FrameNode of Grid type. * @@ -1998,7 +2282,18 @@ export declare namespace typeNode { * @atomicservice * @since 14 */ - function createNode(context: UIContext, nodeType: 'Grid'): Grid; + /** + * Create a FrameNode of Grid type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'Grid' } nodeType - node type. + * @returns { Grid } - Return Grid type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since arkts{ '1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 + */ + export function createNode(context: UIContext, nodeType: 'Grid'): Grid; /** * Define the FrameNode type for GridItem. @@ -2011,6 +2306,43 @@ export declare namespace typeNode { */ type GridItem = TypedFrameNode; + /** + * Define the GridItem type of FrameNode. + * + * @extends TypedFrameNode + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + abstract class GridItemFrameNode extends TypedFrameNode { + /** + * Initialize FrameNode. + * + * @param { GridItemOptions } [options] - grid item options. + * @returns { GridItemAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + abstract initialize(options?: GridItemOptions): GridItemAttribute; + } + + /** + * Define the FrameNode type for GridItem. + * + * @typedef { GridItemFrameNode } GridItem + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + type GridItem = GridItemFrameNode; + /** * Create a FrameNode of GridItem type. * @@ -2021,7 +2353,18 @@ export declare namespace typeNode { * @atomicservice * @since 14 */ - function createNode(context: UIContext, nodeType: 'GridItem'): GridItem; + /** + * Create a FrameNode of GridItem type. + * + * @param { UIContext } context - uiContext used to create the FrameNode. + * @param { 'GridItem' } nodeType - node type. + * @returns { GridItem } - Return GridItem type FrameNode. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since arkts{ '1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 + */ + export function createNode(context: UIContext, nodeType: 'GridItem'): GridItem; } /** * Used for lazy loading of typeNode.