From 6287b97c7debb04e11085195537643dfbace1621 Mon Sep 17 00:00:00 2001 From: wangshengwen333 Date: Sun, 1 Jun 2025 17:04:40 +0800 Subject: [PATCH] =?UTF-8?q?=E6=8F=90=E4=BA=A4=E5=B8=83=E5=B1=80=E7=BB=84?= =?UTF-8?q?=E4=BB=B6=E7=9A=84sdk=E9=83=A8=E5=88=86=E7=9A=84=E4=BF=AE?= =?UTF-8?q?=E6=94=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: wangshengwen333 --- api/@internal/component/ets/blank.d.ts | 51 --- api/@internal/component/ets/column.d.ts | 146 +------ api/@internal/component/ets/column_split.d.ts | 89 ---- api/@internal/component/ets/divider.d.ts | 82 ---- api/@internal/component/ets/grid_col.d.ts | 195 --------- api/@internal/component/ets/grid_row.d.ts | 401 ----------------- api/@internal/component/ets/row.d.ts | 157 +------ api/@internal/component/ets/row_split.d.ts | 44 -- api/@internal/component/ets/stack.d.ts | 68 +-- api/arkui/BlankModifier.d.ts | 92 +++- api/arkui/ColumnModifier.d.ts | 130 +++++- api/arkui/ColumnSplitModifier.d.ts | 91 +++- api/arkui/DividerModifier.d.ts | 131 +++++- api/arkui/GridColModifier.d.ts | 118 ++++- api/arkui/GridRowModifier.d.ts | 105 ++++- api/arkui/RowModifier.d.ts | 133 +++++- api/arkui/RowSplitModifier.d.ts | 91 +++- api/arkui/StackModifier.d.ts | 106 ++++- api/arkui/component/blank.d.ets | 46 ++ api/arkui/component/column.d.ets | 138 ++++++ api/arkui/component/columnSplit.d.ets | 89 ++++ api/arkui/component/divider.d.ets | 84 ++++ api/arkui/component/gridCol.d.ets | 192 +++++++++ api/arkui/component/gridRow.d.ets | 403 ++++++++++++++++++ api/arkui/component/row.d.ets | 127 ++++++ api/arkui/component/rowSplit.d.ets | 44 ++ api/arkui/component/stack.d.ets | 79 ++++ 27 files changed, 2181 insertions(+), 1251 deletions(-) create mode 100644 api/arkui/component/blank.d.ets create mode 100644 api/arkui/component/column.d.ets create mode 100644 api/arkui/component/columnSplit.d.ets create mode 100644 api/arkui/component/divider.d.ets create mode 100644 api/arkui/component/gridCol.d.ets create mode 100644 api/arkui/component/gridRow.d.ets create mode 100644 api/arkui/component/row.d.ets create mode 100644 api/arkui/component/rowSplit.d.ets create mode 100644 api/arkui/component/stack.d.ets diff --git a/api/@internal/component/ets/blank.d.ts b/api/@internal/component/ets/blank.d.ts index 80958fccc9..72e36bb156 100644 --- a/api/@internal/component/ets/blank.d.ts +++ b/api/@internal/component/ets/blank.d.ts @@ -18,11 +18,6 @@ * @kit ArkUI */ -/*** if arkts 1.2 */ -import { CommonMethod } from './common'; -import { ResourceColor } from './units'; -/*** endif */ - /** * Create Blank. * @@ -47,17 +42,6 @@ import { ResourceColor } from './units'; * @form * @since 10 */ -/** - * Create Blank. - * - * @interface BlankInterface - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ interface BlankInterface { /** * The minimum size of the blank fill assembly on the container spindle. @@ -86,18 +70,6 @@ interface BlankInterface { * @form * @since 10 */ - /** - * The minimum size of the blank fill assembly on the container spindle. - * - * @param { number | string } min - * @returns { BlankAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ (min?: number | string): BlankAttribute; } @@ -125,17 +97,6 @@ interface BlankInterface { * @form * @since 10 */ -/** - * Inheritance CommonMethod Set Styles - * - * @extends CommonMethod - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ declare class BlankAttribute extends CommonMethod { /** * color: set color. @@ -164,18 +125,6 @@ declare class BlankAttribute extends CommonMethod { * @form * @since 10 */ - /** - * color: set color. - * - * @param { ResourceColor } value - * @returns { BlankAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ color(value: ResourceColor): BlankAttribute; } diff --git a/api/@internal/component/ets/column.d.ts b/api/@internal/component/ets/column.d.ts index 02be253b69..38060cd12e 100644 --- a/api/@internal/component/ets/column.d.ts +++ b/api/@internal/component/ets/column.d.ts @@ -18,25 +18,6 @@ * @kit ArkUI */ -/*** if arkts 1.2 */ -import { PointLightStyle, Optional, CommonMethod } from './common'; -import { HorizontalAlign, FlexAlign } from './enums'; -import { Resource } from './../../global/resource'; -/*** endif */ - -/** - * Defines the space property with string, number and resource unit. - * - * @typedef { string | number | Resource } SpaceType - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'18','1.2':'20'} - * @arkts 1.1&1.2 - */ -declare type SpaceType = string | number | Resource; - /** * Column constructor options. * @@ -45,8 +26,7 @@ declare type SpaceType = string | number | Resource; * @crossplatform * @form * @atomicservice - * @since arkts {'1.1':'14','1.2':'20'} - * @arkts 1.1&1.2 + * @since 10 */ interface ColumnOptions { /** @@ -73,46 +53,9 @@ interface ColumnOptions { * @form * @since 10 */ - /** - * Vertical layout element spacing. - * - * @type { ?(string | number) } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ space?: string | number; } -/** - * Column constructor options. - * - * @interface ColumnOptionsV2 - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'18','1.2':'20'} - * @arkts 1.1&1.2 - */ -interface ColumnOptionsV2 { - /** - * Vertical layout element spacing. - * - * @type { ?SpaceType } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'18','1.2':'20'} - * @arkts 1.1&1.2 - */ - space?: SpaceType; -} - /** * Defines the Column Component. * @@ -145,8 +88,7 @@ interface ColumnOptionsV2 { * @crossplatform * @form * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ interface ColumnInterface { /** @@ -195,32 +137,7 @@ interface ColumnInterface { * @atomicservice * @since 11 */ - /** - * Set the options. - * - * @param { ColumnOptions } [options] - column options - * @returns { ColumnAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'14','1.2':'20'} - * @arkts 1.1&1.2 - */ (options?: ColumnOptions): ColumnAttribute; - /** - * Set the options. - * - * @param { ColumnOptions | ColumnOptionsV2 } [options] - column options - * @returns { ColumnAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'18','1.2':'20'} - * @arkts 1.1&1.2 - */ - (options?: ColumnOptions | ColumnOptionsV2): ColumnAttribute; } /** @@ -247,17 +164,6 @@ interface ColumnInterface { * @form * @since 10 */ -/** - * Defines the Column component attribute functions. - * - * @extends CommonMethod - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ declare class ColumnAttribute extends CommonMethod { /** * Sets the alignment format of the subassembly in the horizontal direction. @@ -286,18 +192,6 @@ declare class ColumnAttribute extends CommonMethod { * @form * @since 10 */ - /** - * Sets the alignment format of the subassembly in the horizontal direction. - * - * @param { HorizontalAlign } value - * @returns { ColumnAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ alignItems(value: HorizontalAlign): ColumnAttribute; /** @@ -327,43 +221,7 @@ declare class ColumnAttribute extends CommonMethod { * @form * @since 10 */ - /** - * Sets the alignment format of the subassembly in the vertical direction. - * - * @param { FlexAlign } value - * @returns { ColumnAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ justifyContent(value: FlexAlign): ColumnAttribute; - /** - * Defines the PointLight - * - * @param { PointLightStyle } value - The point light style. - * @returns { ColumnAttribute } The attribute of the column. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @systemapi - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ - pointLight(value: PointLightStyle): ColumnAttribute; - /** - * Called when the Main-Axis's direction is set reversed or not - * - * @param { Optional } isReversed - If the main axis is reversed. - * @returns { ColumnAttribute } The attribute of the column. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 - */ - reverse(isReversed: Optional): ColumnAttribute; } /** diff --git a/api/@internal/component/ets/column_split.d.ts b/api/@internal/component/ets/column_split.d.ts index 4ad3617ad8..9e0b5c1665 100644 --- a/api/@internal/component/ets/column_split.d.ts +++ b/api/@internal/component/ets/column_split.d.ts @@ -18,11 +18,6 @@ * @kit ArkUI */ -/*** if arkts 1.2 */ -import { Dimension } from './units'; -import { CommonMethod } from './common'; -/*** endif */ - /** * Defines the ColumnSplit component. * @@ -38,16 +33,6 @@ import { CommonMethod } from './common'; * @crossplatform * @since 10 */ -/** - * Defines the ColumnSplit component. - * - * @interface ColumnSplitInterface - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ interface ColumnSplitInterface { /** * Layout the subassemblies vertically and insert a horizontal divider line between each subassemblies. @@ -64,16 +49,6 @@ interface ColumnSplitInterface { * @crossplatform * @since 10 */ - /** - * Layout the subassemblies vertically and insert a horizontal divider line between each subassemblies. - * - * @returns { ColumnSplitAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ (): ColumnSplitAttribute; } @@ -85,16 +60,6 @@ interface ColumnSplitInterface { * @crossplatform * @since 10 */ -/** - * Provides an interface for the style of a divider including start margin and end margin - * - * @interface ColumnSplitDividerStyle - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ interface ColumnSplitDividerStyle { /** * Define the start margin of the divider @@ -105,17 +70,6 @@ interface ColumnSplitDividerStyle { * @crossplatform * @since 10 */ - /** - * Define the start margin of the divider - * - * @type { ?Dimension } - * @default 0 - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ startMargin?: Dimension; /** @@ -127,17 +81,6 @@ interface ColumnSplitDividerStyle { * @crossplatform * @since 10 */ - /** - * Define the end margin of the divider - * - * @type { ?Dimension } - * @default 0 - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ endMargin?: Dimension; } @@ -156,16 +99,6 @@ interface ColumnSplitDividerStyle { * @crossplatform * @since 10 */ -/** - * Defines the ColumnSplit component attribute functions. - * - * @extends CommonMethod - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ declare class ColumnSplitAttribute extends CommonMethod { /** * Indicates whether the split line can be dragged. The default value is false. @@ -184,17 +117,6 @@ declare class ColumnSplitAttribute extends CommonMethod { * @crossplatform * @since 10 */ - /** - * Indicates whether the split line can be dragged. The default value is false. - * - * @param { boolean } value - * @returns { ColumnSplitAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ resizeable(value: boolean): ColumnSplitAttribute; /** @@ -206,17 +128,6 @@ declare class ColumnSplitAttribute extends CommonMethod { * @crossplatform * @since 10 */ - /** - * Called when the ColumnSplit split line style is set. - * @param { ColumnSplitDividerStyle | null } value - indicates the style of the indicator. - * if value is set to null, the value of startMargin and endMargin is set to 0.0 by default. - * @returns { ColumnSplitAttribute } the attribute of the ColumnSplit - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ divider(value: ColumnSplitDividerStyle | null): ColumnSplitAttribute; } diff --git a/api/@internal/component/ets/divider.d.ts b/api/@internal/component/ets/divider.d.ts index 8bb2561434..184ee13e2e 100644 --- a/api/@internal/component/ets/divider.d.ts +++ b/api/@internal/component/ets/divider.d.ts @@ -48,17 +48,6 @@ import { LineCapStyle } from './enums'; * @form * @since 10 */ -/** - * Provides a divider component to separate different content blocks/content elements. - * - * @interface DividerInterface - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ interface DividerInterface { /** * Return Divider. @@ -84,17 +73,6 @@ interface DividerInterface { * @form * @since 10 */ - /** - * Return Divider. - * - * @returns { DividerAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ (): DividerAttribute; } @@ -122,17 +100,6 @@ interface DividerInterface { * @form * @since 10 */ -/** - * Defines the Divider attribute functions. - * - * @extends CommonMethod - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ declare class DividerAttribute extends CommonMethod { /** * Indicates whether to use a horizontal splitter or a vertical splitter. @@ -164,19 +131,6 @@ declare class DividerAttribute extends CommonMethod { * @form * @since 10 */ - /** - * Indicates whether to use a horizontal splitter or a vertical splitter. - * The options are as follows: false: horizontal splitter; true: vertical splitter. - * - * @param { boolean } value - * @returns { DividerAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ vertical(value: boolean): DividerAttribute; /** @@ -206,18 +160,6 @@ declare class DividerAttribute extends CommonMethod { * @form * @since 10 */ - /** - * Sets the color of the divider line. - * - * @param { ResourceColor } value - * @returns { DividerAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ color(value: ResourceColor): DividerAttribute; /** @@ -247,18 +189,6 @@ declare class DividerAttribute extends CommonMethod { * @form * @since 10 */ - /** - * Sets the width of the dividing line. - * - * @param { number | string } value - * @returns { DividerAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ strokeWidth(value: number | string): DividerAttribute; /** @@ -288,18 +218,6 @@ declare class DividerAttribute extends CommonMethod { * @form * @since 10 */ - /** - * Sets the end style of the split line. The default value is Butt. - * - * @param { LineCapStyle } value - * @returns { DividerAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ lineCap(value: LineCapStyle): DividerAttribute; } diff --git a/api/@internal/component/ets/grid_col.d.ts b/api/@internal/component/ets/grid_col.d.ts index 5889c45d0d..e2d2e975cf 100644 --- a/api/@internal/component/ets/grid_col.d.ts +++ b/api/@internal/component/ets/grid_col.d.ts @@ -18,10 +18,6 @@ * @kit ArkUI */ -/*** if arkts 1.2 */ -import { CommonMethod } from './common'; -/*** endif */ - /** * Defines the option in number unit of grid-container child component. * @@ -39,17 +35,6 @@ import { CommonMethod } from './common'; * @form * @since 10 */ -/** - * Defines the option in number unit of grid-container child component. - * - * @interface GridColColumnOption - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ declare interface GridColColumnOption { /** * Grid Col Column Option xs @@ -68,17 +53,6 @@ declare interface GridColColumnOption { * @form * @since 10 */ - /** - * Grid Col Column Option xs - * - * @type { ?number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ xs?: number, /** @@ -98,17 +72,6 @@ declare interface GridColColumnOption { * @form * @since 10 */ - /** - * Grid Col Column Option sm - * - * @type { ?number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ sm?: number, /** @@ -128,17 +91,6 @@ declare interface GridColColumnOption { * @form * @since 10 */ - /** - * Grid Col Column Option md - * - * @type { ?number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ md?: number, /** @@ -158,17 +110,6 @@ declare interface GridColColumnOption { * @form * @since 10 */ - /** - * Grid Col Column Option lg - * - * @type { ?number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ lg?: number, /** @@ -188,17 +129,6 @@ declare interface GridColColumnOption { * @form * @since 10 */ - /** - * Grid Col Column Option xl - * - * @type { ?number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ xl?: number, /** @@ -218,17 +148,6 @@ declare interface GridColColumnOption { * @form * @since 10 */ - /** - * Grid Col Column Option xxl - * - * @type { ?number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ xxl?: number, } @@ -249,17 +168,6 @@ declare interface GridColColumnOption { * @form * @since 10 */ -/** - * Defines the options of grid-container child component. - * - * @interface GridColOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ declare interface GridColOptions { /** * Sets the span of current gird-container item. @@ -278,17 +186,6 @@ declare interface GridColOptions { * @form * @since 10 */ - /** - * Sets the span of current gird-container item. - * - * @type { ?(number | GridColColumnOption) } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ span?: number | GridColColumnOption; /** @@ -308,17 +205,6 @@ declare interface GridColOptions { * @form * @since 10 */ - /** - * Sets the offset of current gird-container item. - * - * @type { ?(number | GridColColumnOption) } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ offset?: number | GridColColumnOption; /** @@ -338,17 +224,6 @@ declare interface GridColOptions { * @form * @since 10 */ - /** - * Sets the order of current gird-container item. - * - * @type { ?(number | GridColColumnOption) } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ order?: number | GridColColumnOption; } @@ -369,17 +244,6 @@ declare interface GridColOptions { * @form * @since 10 */ -/** - * Defines the the new version of grid-container child component. - * - * @interface GridColInterface - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ interface GridColInterface { /** * Defines the constructor of GridContainer. @@ -400,18 +264,6 @@ interface GridColInterface { * @form * @since 10 */ - /** - * Defines the constructor of GridContainer. - * - * @param { GridColOptions } option - * @returns { GridColAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ (option?: GridColOptions): GridColAttribute; } @@ -432,17 +284,6 @@ interface GridColInterface { * @form * @since 10 */ -/** - * Defines the GridContainer attribute functions. - * - * @extends CommonMethod - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ declare class GridColAttribute extends CommonMethod { /** * Sets the span of current gird-container item. @@ -463,18 +304,6 @@ declare class GridColAttribute extends CommonMethod { * @form * @since 10 */ - /** - * Sets the span of current gird-container item. - * - * @param { number | GridColColumnOption } value - * @returns { GridColAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ span(value: number | GridColColumnOption): GridColAttribute; /** @@ -496,18 +325,6 @@ declare class GridColAttribute extends CommonMethod { * @form * @since 10 */ - /** - * Sets the offset of current gird-container item. - * - * @param { number | GridColColumnOption } value - * @returns { GridColAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ gridColOffset(value: number | GridColColumnOption): GridColAttribute; /** @@ -529,18 +346,6 @@ declare class GridColAttribute extends CommonMethod { * @form * @since 10 */ - /** - * Sets the order of current gird-container item. - * - * @param { number | GridColColumnOption } value - * @returns { GridColAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ order(value: number | GridColColumnOption): GridColAttribute; } diff --git a/api/@internal/component/ets/grid_row.d.ts b/api/@internal/component/ets/grid_row.d.ts index a5ea02dc10..fa3b37ded4 100644 --- a/api/@internal/component/ets/grid_row.d.ts +++ b/api/@internal/component/ets/grid_row.d.ts @@ -18,12 +18,6 @@ * @kit ArkUI */ -/*** if arkts 1.2 */ -import { ItemAlign } from './enums'; -import { CommonMethod } from './common'; -import { Length } from './units'; -/*** endif */ - /** * Defines the option in length unit of grid-row component. * @@ -41,17 +35,6 @@ import { Length } from './units'; * @form * @since 10 */ -/** - * Defines the option in length unit of grid-row component. - * - * @interface GridRowSizeOption - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ declare interface GridRowSizeOption { /** * Grid Row Size Option xs, select xs gutter size based on gridRow current breakpoint @@ -70,17 +53,6 @@ declare interface GridRowSizeOption { * @form * @since 10 */ - /** - * Grid Row Size Option xs, select xs gutter size based on gridRow current breakpoint - * - * @type { ?Length } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ xs?: Length, /** @@ -100,17 +72,6 @@ declare interface GridRowSizeOption { * @form * @since 10 */ - /** - * Grid Row Size Option sm, select sm gutter size based on gridRow current breakpoint - * - * @type { ?Length } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ sm?: Length, /** @@ -130,17 +91,6 @@ declare interface GridRowSizeOption { * @form * @since 10 */ - /** - * Grid Row Size Option md, select md gutter size based on gridRow current breakpoint - * - * @type { ?Length } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ md?: Length, /** @@ -160,17 +110,6 @@ declare interface GridRowSizeOption { * @form * @since 10 */ - /** - * Grid Row Size Option lg, select lg gutter size based on gridRow current breakpoint - * - * @type { ?Length } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ lg?: Length, /** @@ -190,17 +129,6 @@ declare interface GridRowSizeOption { * @form * @since 10 */ - /** - * Grid Row Size Option xl, select xl gutter size based on gridRow current breakpoint - * - * @type { ?Length } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ xl?: Length, /** @@ -220,17 +148,6 @@ declare interface GridRowSizeOption { * @form * @since 10 */ - /** - * Grid Row Size Option xxl, select xxl gutter size based on gridRow current breakpoint - * - * @type { ?Length } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ xxl?: Length, } @@ -251,17 +168,6 @@ declare interface GridRowSizeOption { * @form * @since 10 */ -/** - * Defines the option in number unit of grid-container component. - * - * @interface GridRowColumnOption - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ declare interface GridRowColumnOption { /** * Grid Row Column Option xs, select xs column num based on gridRow current breakpoint @@ -280,17 +186,6 @@ declare interface GridRowColumnOption { * @form * @since 10 */ - /** - * Grid Row Column Option xs, select xs column num based on gridRow current breakpoint - * - * @type { ?number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ xs?: number, /** @@ -310,17 +205,6 @@ declare interface GridRowColumnOption { * @form * @since 10 */ - /** - * Grid Row Column Option sm, select sm column num based on gridRow current breakpoint - * - * @type { ?number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ sm?: number, /** @@ -340,17 +224,6 @@ declare interface GridRowColumnOption { * @form * @since 10 */ - /** - * Grid Row Column Option md - * - * @type { ?number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ md?: number, /** @@ -370,17 +243,6 @@ declare interface GridRowColumnOption { * @form * @since 10 */ - /** - * Grid Row Column Option lg, select lg column num based on gridRow current breakpoint - * - * @type { ?number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ lg?: number, /** @@ -400,17 +262,6 @@ declare interface GridRowColumnOption { * @form * @since 10 */ - /** - * Grid Row Column Option xl, select xl column num based on gridRow current breakpoint - * - * @type { ?number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ xl?: number, /** @@ -430,17 +281,6 @@ declare interface GridRowColumnOption { * @form * @since 10 */ - /** - * Grid Row Column Option xxl, select xxl column num based on gridRow current breakpoint - * - * @type { ?number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ xxl?: number, } @@ -461,17 +301,6 @@ declare interface GridRowColumnOption { * @form * @since 10 */ -/** - * Defines the gutter of grid-row component. - * - * @interface GutterOption - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ declare interface GutterOption { /** * Define x in GutterOption @@ -490,17 +319,6 @@ declare interface GutterOption { * @form * @since 10 */ - /** - * Define x in GutterOption - * - * @type { ?(Length | GridRowSizeOption) } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ x?: Length | GridRowSizeOption, /** @@ -520,17 +338,6 @@ declare interface GutterOption { * @form * @since 10 */ - /** - * Define y in GutterOption - * - * @type { ?(Length | GridRowSizeOption) } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ y?: Length | GridRowSizeOption } @@ -551,17 +358,6 @@ declare interface GutterOption { * @form * @since 10 */ -/** - * Defines the breakpoint reference of grid-container component. - * - * @enum { number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ declare enum BreakpointsReference { /** * Respond to breakpoint changes according to window width @@ -578,16 +374,6 @@ declare enum BreakpointsReference { * @form * @since 10 */ - /** - * Respond to breakpoint changes according to window width - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ WindowSize, /** @@ -605,16 +391,6 @@ declare enum BreakpointsReference { * @form * @since 10 */ - /** - * Respond to breakpoint changes according to component width - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ ComponentSize, } @@ -635,17 +411,6 @@ declare enum BreakpointsReference { * @form * @since 10 */ -/** - * Defines the direction of grid-container component. - * - * @enum { number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ declare enum GridRowDirection { /** * The elements in the grid component are arranged in rows @@ -662,16 +427,6 @@ declare enum GridRowDirection { * @form * @since 10 */ - /** - * The elements in the grid component are arranged in rows - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ Row, /** @@ -689,16 +444,6 @@ declare enum GridRowDirection { * @form * @since 10 */ - /** - * The elements in the grid component are arranged in reverse order of rows - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ RowReverse, } @@ -719,17 +464,6 @@ declare enum GridRowDirection { * @form * @since 10 */ -/** - * Defines the breakpoints of grid-row component. - * - * @interface BreakPoints - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ declare interface BreakPoints { /** * Breakpoint array @@ -748,17 +482,6 @@ declare interface BreakPoints { * @form * @since 10 */ - /** - * Breakpoint array - * - * @type { ?Array } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ value?: Array, /** @@ -778,17 +501,6 @@ declare interface BreakPoints { * @form * @since 10 */ - /** - * Set breakpoint reference - * - * @type { ?BreakpointsReference } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ reference?: BreakpointsReference, } @@ -809,17 +521,6 @@ declare interface BreakPoints { * @form * @since 10 */ -/** - * Defines the options of grid-row component. - * - * @interface GridRowOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ declare interface GridRowOptions { /** * layout spacing between sub-components @@ -838,17 +539,6 @@ declare interface GridRowOptions { * @form * @since 10 */ - /** - * layout spacing between sub-components - * - * @type { ?(Length | GutterOption) } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ gutter?: Length | GutterOption; /** @@ -868,17 +558,6 @@ declare interface GridRowOptions { * @form * @since 10 */ - /** - * Sets the total number of columns in the current layout. - * - * @type { ?(number | GridRowColumnOption) } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ columns?: number | GridRowColumnOption; /** @@ -898,17 +577,6 @@ declare interface GridRowOptions { * @form * @since 10 */ - /** - * grid-row layout breakpoints. - * - * @type { ?BreakPoints } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ breakpoints?: BreakPoints; /** @@ -928,17 +596,6 @@ declare interface GridRowOptions { * @form * @since 10 */ - /** - * grid-row layout direction. - * - * @type { ?GridRowDirection } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ direction?: GridRowDirection; } @@ -959,17 +616,6 @@ declare interface GridRowOptions { * @form * @since 10 */ -/** - * Defines the the new version of grid-container component. - * - * @interface GridRowInterface - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ interface GridRowInterface { /** * Defines the constructor of GridRow. @@ -990,18 +636,6 @@ interface GridRowInterface { * @form * @since 10 */ - /** - * Defines the constructor of GridRow. - * - * @param { GridRowOptions } option - * @returns { GridRowAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ (option?: GridRowOptions): GridRowAttribute; } @@ -1022,17 +656,6 @@ interface GridRowInterface { * @form * @since 10 */ -/** - * Defines the GridRow attribute functions. - * - * @extends CommonMethod - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ declare class GridRowAttribute extends CommonMethod { /** * Callback triggered when the breakpoint changes, breakpoints value can be xs, sm, md, lg, xl, xxl @@ -1053,18 +676,6 @@ declare class GridRowAttribute extends CommonMethod { * @form * @since 10 */ - /** - * Callback triggered when the breakpoint changes, breakpoints value can be xs, sm, md, lg, xl, xxl - * - * @param { function } callback - * @returns { GridRowAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ onBreakpointChange(callback: (breakpoints: string) => void): GridRowAttribute; /** @@ -1077,18 +688,6 @@ declare class GridRowAttribute extends CommonMethod { * @form * @since 10 */ - /** - * Cross axis alignment of each line in GridRow. - * - * @param { ItemAlign } value - element alignment - * @returns { GridRowAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ alignItems(value: ItemAlign): GridRowAttribute; } diff --git a/api/@internal/component/ets/row.d.ts b/api/@internal/component/ets/row.d.ts index ee3b6bf646..c01587a450 100644 --- a/api/@internal/component/ets/row.d.ts +++ b/api/@internal/component/ets/row.d.ts @@ -18,13 +18,6 @@ * @kit ArkUI */ -/*** if arkts 1.2 */ -import { PointLightStyle, Optional, CommonMethod } from './common'; -import { VerticalAlign, FlexAlign } from './enums'; -import { SpaceType } from './column'; -/*** endif */ - - /** * Define options used to construct a row. * @@ -33,8 +26,7 @@ import { SpaceType } from './column'; * @crossplatform * @form * @atomicservice - * @since arkts {'1.1':'14','1.2':'20'} - * @arkts 1.1&1.2 + * @since 10 */ declare interface RowOptions { /** @@ -61,70 +53,10 @@ declare interface RowOptions { * @form * @since 10 */ - /** - * Row spacing. - * - * @type { ?(string | number) } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ space?: string | number; } -/** - * Define options used to construct a row. - * - * @interface RowOptionsV2 - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'18','1.2':'20'} - * @arkts 1.1&1.2 - */ -interface RowOptionsV2 { - /** - * Vertical layout element spacing. - * - * @type { ?SpaceType } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'18','1.2':'20'} - * @arkts 1.1&1.2 - */ - space?: SpaceType; -} -/** - * The components are laid out horizontally - * - * @interface RowInterface - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 7 - */ -/** - * The components are laid out horizontally - * - * @interface RowInterface - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @form - * @since 9 - */ -/** - * The components are laid out horizontally - * - * @interface RowInterface - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @since 10 - */ /** * The components are laid out horizontally * @@ -133,8 +65,7 @@ interface RowOptionsV2 { * @crossplatform * @form * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ interface RowInterface { /** @@ -175,32 +106,7 @@ interface RowInterface { * @atomicservice * @since 11 */ - /** - * Called when the layout is set in the horizontal direction. - * - * @param { ?RowOptions } options - row options - * @returns { RowAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'14','1.2':'20'} - * @arkts 1.1&1.2 - */ (options?: RowOptions): RowAttribute; - /** - * Called when the layout is set in the horizontal direction. - * - * @param { ?(RowOptions | RowOptionsV2) } options - row options - * @returns { RowAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'18','1.2':'20'} - * @arkts 1.1&1.2 - */ - (options?: RowOptions | RowOptionsV2): RowAttribute; } /** @@ -227,17 +133,6 @@ interface RowInterface { * @form * @since 10 */ -/** - * Defines the row attribute functions. - * - * @extends CommonMethod - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ declare class RowAttribute extends CommonMethod { /** * Called when the vertical alignment is set. @@ -266,18 +161,6 @@ declare class RowAttribute extends CommonMethod { * @form * @since 10 */ - /** - * Called when the vertical alignment is set. - * - * @param { VerticalAlign } value - * @returns { RowAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ alignItems(value: VerticalAlign): RowAttribute; /** @@ -307,43 +190,7 @@ declare class RowAttribute extends CommonMethod { * @form * @since 10 */ - /** - * Called when the horizontal alignment is set. - * - * @param { FlexAlign } value - * @returns { RowAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ justifyContent(value: FlexAlign): RowAttribute; - /** - * Defines the PointLight - * - * @param { PointLightStyle } value - The point light style. - * @returns { RowAttribute } The attribute of the row. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @systemapi - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ - pointLight(value: PointLightStyle): RowAttribute; - /** - * Called when the Main-Axis's direction is set reversed or not - * - * @param { Optional } isReversed - If the main axis is reversed. - * @returns { RowAttribute } The attribute of the row. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 - */ - reverse(isReversed: Optional): RowAttribute; } /** diff --git a/api/@internal/component/ets/row_split.d.ts b/api/@internal/component/ets/row_split.d.ts index 395b1e5e0a..4daaed6438 100644 --- a/api/@internal/component/ets/row_split.d.ts +++ b/api/@internal/component/ets/row_split.d.ts @@ -18,11 +18,6 @@ * @kit ArkUI */ -/*** if arkts 1.2 */ -import { CommonMethod } from './common'; -/*** endif */ - - /** * Provides interfaces for layout in the vertical direction. * @@ -38,16 +33,6 @@ import { CommonMethod } from './common'; * @crossplatform * @since 10 */ -/** - * Provides interfaces for layout in the vertical direction. - * - * @interface RowSplitInterface - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ interface RowSplitInterface { /** * Called when the layout along the vertical direction is set. @@ -64,16 +49,6 @@ interface RowSplitInterface { * @crossplatform * @since 10 */ - /** - * Called when the layout along the vertical direction is set. - * - * @returns { RowSplitAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ (): RowSplitAttribute; } @@ -88,14 +63,6 @@ interface RowSplitInterface { * @crossplatform * @since 10 */ -/** - * @extends CommonMethod - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ declare class RowSplitAttribute extends CommonMethod { /** * Called when judging whether the split line can be dragged. @@ -114,17 +81,6 @@ declare class RowSplitAttribute extends CommonMethod { * @crossplatform * @since 10 */ - /** - * Called when judging whether the split line can be dragged. - * - * @param { boolean } value - * @returns { RowSplitAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ resizeable(value: boolean): RowSplitAttribute; } diff --git a/api/@internal/component/ets/stack.d.ts b/api/@internal/component/ets/stack.d.ts index cc542a44c3..a18e8eac05 100644 --- a/api/@internal/component/ets/stack.d.ts +++ b/api/@internal/component/ets/stack.d.ts @@ -18,11 +18,6 @@ * @kit ArkUI */ -/*** if arkts 1.2 */ -import { PointLightStyle, CommonMethod } from './common'; -import { Alignment } from './enums'; -/*** endif */ - /** * Options used to construct the stack. * @@ -30,9 +25,7 @@ import { Alignment } from './enums'; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form - * @atomicservice - * @since arkts {'1.1':'14','1.2':'20'} - * @arkts 1.1&1.2 + * @since 10 */ declare interface StackOptions { /** @@ -59,17 +52,6 @@ declare interface StackOptions { * @form * @since 10 */ - /** - * Set the alignment of sub components within the container. - * - * @type { ?Alignment } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ alignContent?: Alignment; } @@ -105,8 +87,7 @@ declare interface StackOptions { * @crossplatform * @form * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 + * @since 11 */ interface StackInterface { /** @@ -147,18 +128,6 @@ interface StackInterface { * @atomicservice * @since 11 */ - /** - * Set the options. - * - * @param { ?StackOptions } options - stack options - * @returns { StackAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'14','1.2':'20'} - * @arkts 1.1&1.2 - */ (options?: StackOptions): StackAttribute; } @@ -180,15 +149,6 @@ interface StackInterface { * @form * @since 10 */ -/** - * @extends CommonMethod - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ declare class StackAttribute extends CommonMethod { /** * Called when the occupancy of items in the container is set. @@ -217,31 +177,7 @@ declare class StackAttribute extends CommonMethod { * @form * @since 10 */ - /** - * Called when the alignment of items in the container is set. - * - * @param { Alignment } value - * @returns { StackAttribute } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ alignContent(value: Alignment): StackAttribute; - - /** - * Defines the PointLight - * - * @param { PointLightStyle } value - The point light style. - * @returns { StackAttribute } The attribute of the stack. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @systemapi - * @since arkts {'1.1':'11','1.2':'20'} - * @arkts 1.1&1.2 - */ - pointLight(value: PointLightStyle): StackAttribute; } /** diff --git a/api/arkui/BlankModifier.d.ts b/api/arkui/BlankModifier.d.ts index 07af01f672..3162a7ea03 100644 --- a/api/arkui/BlankModifier.d.ts +++ b/api/arkui/BlankModifier.d.ts @@ -17,8 +17,11 @@ * @file * @kit ArkUI */ - - +/*** if arkts 1.2 */ +import { BlankAttribute } from "./component/blank"; +import { AttributeModifier } from "./component/common"; +import { ResourceColor } from "./component/units"; +/*** endif */ /** * Defines Blank Modifier @@ -42,3 +45,88 @@ export declare class BlankModifier extends BlankAttribute implements AttributeMo */ applyNormalAttribute?(instance: BlankAttribute): void; } + +/** + * Defines Blank Modifier + * + * @implements AttributeModifier + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 +*/ +export declare class BlankModifier implements AttributeModifier { + + /** + * Defines the normal update attribute function. + * + * @param { BlankAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyNormalAttribute(instance: BlankAttribute): void; + + /** + * Defines the pressed update attribute function. + * + * @param { BlankAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyPressedAttribute(instance: BlankAttribute): void; + + /** + * Defines the focused update attribute function. + * + * @param { BlankAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyFocusedAttribute(instance: BlankAttribute): void; + + /** + * Defines the disabled update attribute function. + * + * @param { BlankAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyDisabledAttribute(instance: BlankAttribute): void; + + /** + * Defines the selected update attribute function. + * + * @param { BlankAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applySelectedAttribute(instance: BlankAttribute): void; + + /** + * Defines the color value of Divider component + * + * @param { ResourceColor | undefined } value + * @returns { BlankModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + color(value: ResourceColor | undefined): BlankModifier; +} \ No newline at end of file diff --git a/api/arkui/ColumnModifier.d.ts b/api/arkui/ColumnModifier.d.ts index 138354dfd0..30b1d9b8cb 100644 --- a/api/arkui/ColumnModifier.d.ts +++ b/api/arkui/ColumnModifier.d.ts @@ -17,7 +17,11 @@ * @file * @kit ArkUI */ - +/*** if arkts 1.2 */ +import { ColumnAttribute } from "./component/column"; +import { AttributeModifier, PointLightStyle } from "./component/common"; +import { HorizontalAlign, FlexAlign } from "./component/enums"; +/*** endif */ /** * Defines Column Modifier @@ -41,3 +45,127 @@ export declare class ColumnModifier extends ColumnAttribute implements Attribute */ applyNormalAttribute?(instance: ColumnAttribute): void; } + +/** + * Defines Column Modifier + * + * @implements AttributeModifier + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 +*/ +export declare class ColumnModifier implements AttributeModifier { + + /** + * Defines the normal update attribute function. + * + * @param { ColumnAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyNormalAttribute(instance: ColumnAttribute): void; + + /** + * Defines the pressed update attribute function. + * + * @param { ColumnAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyPressedAttribute(instance: ColumnAttribute): void; + + /** + * Defines the focused update attribute function. + * + * @param { ColumnAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyFocusedAttribute(instance: ColumnAttribute): void; + + /** + * Defines the disabled update attribute function. + * + * @param { ColumnAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyDisabledAttribute(instance: ColumnAttribute): void; + + /** + * Defines the selected update attribute function. + * + * @param { ColumnAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applySelectedAttribute(instance: ColumnAttribute): void; + + /** + * Defines the alignItems value of Column component + * + * @param { HorizontalAlign | undefined } value + * @returns { ColumnModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + alignItems(value: HorizontalAlign | undefined): ColumnModifier; + + /** + * Defines the jusitfyContent value of Column component + * + * @param { FlexAlign | undefined } value + * @returns { ColumnModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + justifyContent(value: FlexAlign | undefined): ColumnModifier; + + /** + * Defines the pointLight value of Column component + * + * @param { PointLightStyle | undefined } value + * @returns { ColumnModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + pointLight(value: PointLightStyle | undefined): ColumnModifier; + + /** + * Defines the reverse value of Column component + * + * @param { boolean | undefined } value + * @returns { ColumnModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + reverse(value: boolean | undefined): ColumnModifier; +} diff --git a/api/arkui/ColumnSplitModifier.d.ts b/api/arkui/ColumnSplitModifier.d.ts index de7d7aea7a..f56ef47c11 100644 --- a/api/arkui/ColumnSplitModifier.d.ts +++ b/api/arkui/ColumnSplitModifier.d.ts @@ -17,9 +17,10 @@ * @file * @kit ArkUI */ - - - +/*** if arkts 1.2 */ +import { ColumnSplitAttribute, ColumnSplitDividerStyle } from "./component/columnSplit"; +import { AttributeModifier } from "./component/common"; +/*** endif */ /** * Defines ColumnSplit Modifier @@ -43,3 +44,87 @@ export declare class ColumnSplitModifier extends ColumnSplitAttribute implements */ applyNormalAttribute?(instance: ColumnSplitAttribute): void; } + +/** + * Defines ColumnSplit Modifier + * + * @implements AttributeModifier + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 +*/ +export declare class ColumnSplitModifier implements AttributeModifier { + /** + * Defines the normal update attribute function. + * + * @param { ColumnSplitAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyNormalAttribute(instance: ColumnSplitAttribute): void; + + /** + * Defines the pressed update attribute function. + * + * @param { ColumnSplitAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyPressedAttribute(instance: ColumnSplitAttribute): void; + + /** + * Defines the focused update attribute function. + * + * @param { ColumnSplitAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyFocusedAttribute(instance: ColumnSplitAttribute): void; + + /** + * Defines the disabled update attribute function. + * + * @param { ColumnSplitAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyDisabledAttribute(instance: ColumnSplitAttribute): void; + + /** + * Defines the selected update attribute function. + * + * @param { ColumnSplitAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applySelectedAttribute(instance: ColumnSplitAttribute): void; + + /** + * Defines the color value of ColumnSplit component + * + * @param { boolean | undefined } value + * @returns { ColumnSplitModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + color(value: boolean | undefined): ColumnSplitModifier; +} diff --git a/api/arkui/DividerModifier.d.ts b/api/arkui/DividerModifier.d.ts index 7e19ca7799..aa5bc4b892 100644 --- a/api/arkui/DividerModifier.d.ts +++ b/api/arkui/DividerModifier.d.ts @@ -17,9 +17,10 @@ * @file * @kit ArkUI */ - - - +/*** if arkts 1.2 */ +import { DividerAttribute } from "./component/divider"; +import { AttributeModifier, ResourceColor, LineCapStyle } from "./component/common"; +/*** endif */ /** * Defines Divider Modifier @@ -43,3 +44,127 @@ export declare class DividerModifier extends DividerAttribute implements Attribu */ applyNormalAttribute?(instance: DividerAttribute): void; } + +/** + * Defines Divider Modifier + * + * @implements AttributeModifier + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 +*/ +export declare class DividerModifier implements AttributeModifier { + + /** + * Defines the normal update attribute function. + * + * @param { DividerAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyNormalAttribute(instance: DividerAttribute): void; + + /** + * Defines the pressed update attribute function. + * + * @param { DividerAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyPressedAttribute(instance: DividerAttribute): void; + + /** + * Defines the focused update attribute function. + * + * @param { DividerAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyFocusedAttribute(instance: DividerAttribute): void; + + /** + * Defines the disabled update attribute function. + * + * @param { DividerAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyDisabledAttribute(instance: DividerAttribute): void; + + /** + * Defines the selected update attribute function. + * + * @param { DividerAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applySelectedAttribute(instance: DividerAttribute): void; + + /** + * Defines the color value of Divider component + * + * @param { ResourceColor | undefined } value + * @returns { DividerModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + color(value: ResourceColor | undefined): DividerModifier; + + /** + * Defines the strokeWidth value of Divider component + * + * @param { string | number | undefined } value + * @returns { DividerModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + strokeWidth(value: string | number | undefined): DividerModifier; + + /** + * Defines the vertical value of Divider component + * + * @param { boolean | undefined } value + * @returns { DividerModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + vertical(value: boolean | undefined): DividerModifier; + + /** + * Defines the lineCap value of Divider component + * + * @param { LineCapStyle | undefined } value + * @returns { DividerModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + lineCap(value: LineCapStyle | undefined): DividerModifier; +} diff --git a/api/arkui/GridColModifier.d.ts b/api/arkui/GridColModifier.d.ts index 99843bb25d..f84620691f 100644 --- a/api/arkui/GridColModifier.d.ts +++ b/api/arkui/GridColModifier.d.ts @@ -17,9 +17,10 @@ * @file * @kit ArkUI */ - - - +/*** if arkts 1.2 */ +import { GridColAttribute, GridColColumnOption } from "./component/gridCol"; +import { AttributeModifier } from "./component/common"; +/*** endif */ /** * Defines GridCol Modifier @@ -43,3 +44,114 @@ export declare class GridColModifier extends GridColAttribute implements Attribu */ applyNormalAttribute?(instance: GridColAttribute): void; } + +/** + * Defines GridCol Modifier + * + * @implements AttributeModifier + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 +*/ +export declare class GridColModifier implements AttributeModifier { + + /** + * Defines the normal update attribute function. + * + * @param { GridColAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyNormalAttribute(instance: GridColAttribute): void; + + /** + * Defines the pressed update attribute function. + * + * @param { GridColAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyPressedAttribute(instance: GridColAttribute): void; + + /** + * Defines the focused update attribute function. + * + * @param { GridColAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyFocusedAttribute(instance: GridColAttribute): void; + + /** + * Defines the disabled update attribute function. + * + * @param { GridColAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyDisabledAttribute(instance: GridColAttribute): void; + + /** + * Defines the selected update attribute function. + * + * @param { GridColAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applySelectedAttribute(instance: GridColAttribute): void; + + /** + * Defines the span value of GridCol component + * + * @param { number | GridColColumnOption | undefined } value + * @returns { GridColModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + span(value: number | GridColColumnOption | undefined): GridColModifier; + + /** + * Defines the gridColOffset value of GridCol component + * + * @param { number | GridColColumnOption | undefined } value + * @returns { GridColModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + gridColOffset(value: number | GridColColumnOption | undefined): GridColModifier; + + /** + * Defines the order value of GridCol component + * + * @param { number | GridColColumnOption | undefined } value + * @returns { GridColModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + order(value: number | GridColColumnOption | undefined): GridColModifier; +} diff --git a/api/arkui/GridRowModifier.d.ts b/api/arkui/GridRowModifier.d.ts index d9335fd5a8..01f941da77 100644 --- a/api/arkui/GridRowModifier.d.ts +++ b/api/arkui/GridRowModifier.d.ts @@ -17,9 +17,11 @@ * @file * @kit ArkUI */ - - - +/*** if arkts 1.2 */ +import { GridRowAttribute } from "./component/gridRow"; +import { AttributeModifier } from "./component/common"; +import { ItemAlign } from "./component/enums"; +/*** endif */ /** * Defines GridRow Modifier @@ -43,3 +45,100 @@ export declare class GridRowModifier extends GridRowAttribute implements Attribu */ applyNormalAttribute?(instance: GridRowAttribute): void; } + +/** + * Defines GridRow Modifier + * + * @implements AttributeModifier + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 +*/ +export declare class GridRowModifier implements AttributeModifier { + /** + * Defines the normal update attribute function. + * + * @param { GridRowAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyNormalAttribute(instance: GridRowAttribute): void; + + /** + * Defines the pressed update attribute function. + * + * @param { GridRowAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyPressedAttribute(instance: GridRowAttribute): void; + + /** + * Defines the focused update attribute function. + * + * @param { GridRowAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyFocusedAttribute(instance: GridRowAttribute): void; + + /** + * Defines the disabled update attribute function. + * + * @param { GridRowAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyDisabledAttribute(instance: GridRowAttribute): void; + + /** + * Defines the selected update attribute function. + * + * @param { GridRowAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applySelectedAttribute(instance: GridRowAttribute): void; + + /** + * Defines the onBreakPointChange update attribute function. + * + * @param { ((breakpoints: string) => void) | undefined} value + * @returns { GridRowModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onBreakpointChange(value: ((breakpoints: string) => void) | undefined): GridRowModifier; + + /** + * Defines the alignItems update attribute function. + * + * @param { ItemAlign | undefined } value + * @returns { GridRowModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + alignItems(value: ItemAlign | undefined): GridRowModifier; +} diff --git a/api/arkui/RowModifier.d.ts b/api/arkui/RowModifier.d.ts index 5152741f03..d46cb98a7e 100644 --- a/api/arkui/RowModifier.d.ts +++ b/api/arkui/RowModifier.d.ts @@ -17,9 +17,11 @@ * @file * @kit ArkUI */ - - - +/*** if arkts 1.2 */ +import { RowAttribute } from "./component/row"; +import { AttributeModifier, PointLightStyle } from "./component/common"; +import { VerticalAlign, FlexAlign } from "./component/enums"; +/*** endif */ /** * Defines Row Modifier @@ -43,3 +45,128 @@ export declare class RowModifier extends RowAttribute implements AttributeModifi */ applyNormalAttribute?(instance: RowAttribute): void; } + +/** + * Defines Row Modifier + * + * @implements AttributeModifier + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 +*/ +export declare class RowModifier implements AttributeModifier { + + /** + * Defines the normal update attribute function. + * + * @param { RowAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyNormalAttribute(instance: RowAttribute): void; + + /** + * Defines the pressed update attribute function. + * + * @param { RowAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyPressedAttribute(instance: RowAttribute): void; + + /** + * Defines the focused update attribute function. + * + * @param { RowAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyFocusedAttribute(instance: RowAttribute): void; + + /** + * Defines the disabled update attribute function. + * + * @param { RowAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyDisabledAttribute(instance: RowAttribute): void; + + /** + * Defines the selected update attribute function. + * + * @param { RowAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applySelectedAttribute(instance: RowAttribute): void; + + /** + * Defines the alignItems value of Row component + * + * @param { VerticalAlign | undefined } value + * @returns { RowModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + alignItems(value: VerticalAlign | undefined): RowModifier; + + /** + * Defines the justifyContent value of Row component + * + * @param { FlexAlign | undefined } value + * @returns { RowModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + justifyContent(value: FlexAlign | undefined): RowModifier; + + /** + * Defines the pointLight value of Row component + * + * @param { PointLightStyle | undefined } value + * @returns { RowModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + pointLight(value: PointLightStyle | undefined): RowModifier; + + /** + * Defines the reverse value of Row component + * + * @param { boolean | undefined } value + * @returns { RowModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + reverse(value: boolean | undefined): RowModifier; +} + diff --git a/api/arkui/RowSplitModifier.d.ts b/api/arkui/RowSplitModifier.d.ts index 7c5e20477b..480d5f37fd 100644 --- a/api/arkui/RowSplitModifier.d.ts +++ b/api/arkui/RowSplitModifier.d.ts @@ -17,9 +17,10 @@ * @file * @kit ArkUI */ - - - +/*** if arkts 1.2 */ +import { RowSplitAttribute } from "./component/rowSplit"; +import { AttributeModifier } from "./component/common"; +/*** endif */ /** * Defines RowSplit Modifier @@ -43,3 +44,87 @@ export declare class RowSplitModifier extends RowSplitAttribute implements Attri */ applyNormalAttribute?(instance: RowSplitAttribute): void; } + +/** + * Defines RowSplit Modifier + * + * @implements AttributeModifier + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 +*/ +export declare class RowSplitModifier implements AttributeModifier { + /** + * Defines the normal update attribute function. + * + * @param { RowSplitAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyNormalAttribute(instance: RowSplitAttribute): void; + + /** + * Defines the pressed update attribute function. + * + * @param { RowSplitAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyPressedAttribute(instance: RowSplitAttribute): void; + + /** + * Defines the focused update attribute function. + * + * @param { RowSplitAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyFocusedAttribute(instance: RowSplitAttribute): void; + + /** + * Defines the disabled update attribute function. + * + * @param { RowSplitAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyDisabledAttribute(instance: RowSplitAttribute): void; + + /** + * Defines the selected update attribute function. + * + * @param { RowSplitAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applySelectedAttribute(instance: RowSplitAttribute): void; + + /** + * Defines the resize value of Divider component + * + * @param { boolean | undefined } value + * @returns { RowSplitModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + resizable(value: boolean | undefined): RowSplitModifier; +} diff --git a/api/arkui/StackModifier.d.ts b/api/arkui/StackModifier.d.ts index c948d7e464..6c390c57cf 100644 --- a/api/arkui/StackModifier.d.ts +++ b/api/arkui/StackModifier.d.ts @@ -17,9 +17,11 @@ * @file * @kit ArkUI */ - - - +/*** if arkts 1.2 */ +import { StackAttribute } from "./component/stack"; +import { AttributeModifier, PointLightStyle } from "./component/common"; +import { Alignment } from "./component/enums"; +/*** endif */ /** * Defines Stack Modifier @@ -43,3 +45,101 @@ export declare class StackModifier extends StackAttribute implements AttributeMo */ applyNormalAttribute?(instance: StackAttribute): void; } + +/** + * Defines Stack Modifier + * + * @implements AttributeModifier + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 +*/ +export declare class StackModifier implements AttributeModifier { + + /** + * Defines the normal update attribute function. + * + * @param { StackAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyNormalAttribute(instance: StackAttribute): void; + + /** + * Defines the pressed update attribute function. + * + * @param { StackAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyPressedAttribute(instance: StackAttribute): void; + + /** + * Defines the focused update attribute function. + * + * @param { StackAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyFocusedAttribute(instance: StackAttribute): void; + + /** + * Defines the disabled update attribute function. + * + * @param { StackAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyDisabledAttribute(instance: StackAttribute): void; + + /** + * Defines the selected update attribute function. + * + * @param { StackAttribute } instance + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applySelectedAttribute(instance: StackAttribute): void; + + /** + * Defines the alignContent update attribute function. + * + * @param { Alignment | undefined } value + * @returns { StackModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + alignContent(value: Alignment | undefined): StackModifier; + + /** + * Defines the pointLight update attribute function. + * + * @param { PointLightStyle | undefined } value + * @returns { StackModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + pointLight(value: PointLightStyle | undefined): StackModifier; +} diff --git a/api/arkui/component/blank.d.ets b/api/arkui/component/blank.d.ets new file mode 100644 index 0000000000..5dcfd0f0ca --- /dev/null +++ b/api/arkui/component/blank.d.ets @@ -0,0 +1,46 @@ +/* + * Copyright (c) 2021-2023 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +/** + * @file + * @kit ArkUI + * @arkts 1.2 + */ +import { CommonMethod, AttributeModifier } from "./common"; +import { ResourceColor } from "./units"; +import { memo, ComponentBuilder } from "./../stateManagement/runtime"; +export declare interface BlankAttribute extends CommonMethod { + /** + * color: set color. + * + * @param { ResourceColor } value + * @returns { BlankAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + color(value: ResourceColor | undefined): this; + @memo + attributeModifier(value: AttributeModifier): this; +} + +@memo +@ComponentBuilder +export declare function Blank( + min?: number | string, + @memo + content_?: () => void, +): BlankAttribute \ No newline at end of file diff --git a/api/arkui/component/column.d.ets b/api/arkui/component/column.d.ets new file mode 100644 index 0000000000..298212d221 --- /dev/null +++ b/api/arkui/component/column.d.ets @@ -0,0 +1,138 @@ +/* + * Copyright (c) 2021-2023 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +/** + * @file + * @kit ArkUI + * @arkts 1.2 + */ +import { PointLightStyle, Optional, CommonMethod, AttributeModifier } from "./common"; +import { HorizontalAlign, FlexAlign } from "./enums"; +import { Resource } from './../../global/resource'; +import { memo, ComponentBuilder } from "./../stateManagement/runtime"; +/** + * Defines the space property with string, number and resource unit. + * + * @typedef { string | number | Resource } SpaceType + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ +export type SpaceType = string | number | Resource; +/** + * Column constructor options. + * + * @interface ColumnOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ +export interface ColumnOptions { + /** + * Vertical layout element spacing. + * + * @type { ?(string | number) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + space?: string | number; +} +/** + * Column constructor options. + * + * @interface ColumnOptionsV2 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ +export interface ColumnOptionsV2 { + /** + * Vertical layout element spacing. + * + * @type { ?SpaceType } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + space?: SpaceType; +} +export declare interface ColumnAttribute extends CommonMethod { + /** + * Sets the alignment format of the subassembly in the horizontal direction. + * + * @param { HorizontalAlign } value + * @returns { ColumnAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + alignItems(value: HorizontalAlign | undefined): this; + /** + * Sets the alignment format of the subassembly in the vertical direction. + * + * @param { FlexAlign } value + * @returns { ColumnAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + justifyContent(value: FlexAlign | undefined): this; + /** + * Defines the PointLight + * + * @param { PointLightStyle } value - The point light style. + * @returns { ColumnAttribute } The attribute of the column. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 20 + */ + pointLight(value: PointLightStyle | undefined): this; + /** + * Called when the Main-Axis's direction is set reversed or not + * + * @param { Optional } isReversed - If the main axis is reversed. + * @returns { ColumnAttribute } The attribute of the column. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + reverse(isReversed: boolean | undefined): this; + @memo + attributeModifier(value: AttributeModifier): this; +} + +@memo +@ComponentBuilder +export declare function Column( + options?: ColumnOptions | ColumnOptions | ColumnOptionsV2, + @memo + content_?: () => void, +): ColumnAttribute \ No newline at end of file diff --git a/api/arkui/component/columnSplit.d.ets b/api/arkui/component/columnSplit.d.ets new file mode 100644 index 0000000000..84751b2430 --- /dev/null +++ b/api/arkui/component/columnSplit.d.ets @@ -0,0 +1,89 @@ +/* + * Copyright (c) 2021-2023 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +/** + * @file + * @kit ArkUI + * @arkts 1.2 + */ +import { Dimension } from "./units"; +import { CommonMethod, AttributeModifier } from "./common"; +import { memo, ComponentBuilder } from "./../stateManagement/runtime"; +/** + * Provides an interface for the style of a divider including start margin and end margin + * + * @interface ColumnSplitDividerStyle + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ +export interface ColumnSplitDividerStyle { + /** + * Define the start margin of the divider + * + * @type { ?Dimension } + * @default 0 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + startMargin?: Dimension; + /** + * Define the end margin of the divider + * + * @type { ?Dimension } + * @default 0 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + endMargin?: Dimension; +} +export declare interface ColumnSplitAttribute extends CommonMethod { + /** + * Indicates whether the split line can be dragged. The default value is false. + * + * @param { boolean } value + * @returns { ColumnSplitAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + resizeable(value: boolean | undefined): this; + /** + * Called when the ColumnSplit split line style is set. + * @param { ColumnSplitDividerStyle | null } value - indicates the style of the indicator. + * if value is set to null, the value of startMargin and endMargin is set to 0.0 by default. + * @returns { ColumnSplitAttribute } the attribute of the ColumnSplit + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + divider(value: ColumnSplitDividerStyle | null | undefined): this; + @memo + attributeModifier(value: AttributeModifier): this; +} + +@memo +@ComponentBuilder +export declare function ColumnSplit( + + @memo + content_?: () => void, +): ColumnSplitAttribute \ No newline at end of file diff --git a/api/arkui/component/divider.d.ets b/api/arkui/component/divider.d.ets new file mode 100644 index 0000000000..30c54dc16c --- /dev/null +++ b/api/arkui/component/divider.d.ets @@ -0,0 +1,84 @@ +/* + * Copyright (c) 2021-2023 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +/** + * @file + * @kit ArkUI + * @arkts 1.2 + */ +import { ResourceColor } from "./units"; +import { CommonMethod, AttributeModifier } from "./common"; +import { LineCapStyle } from "./enums"; +import { memo, ComponentBuilder } from "./../stateManagement/runtime"; +export declare interface DividerAttribute extends CommonMethod { + /** + * Indicates whether to use a horizontal splitter or a vertical splitter. + * The options are as follows: false: horizontal splitter; true: vertical splitter. + * + * @param { boolean } value + * @returns { DividerAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + vertical(value: boolean | undefined): this; + /** + * Sets the color of the divider line. + * + * @param { ResourceColor } value + * @returns { DividerAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + color(value: ResourceColor | undefined): this; + /** + * Sets the width of the dividing line. + * + * @param { number | string } value + * @returns { DividerAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + strokeWidth(value: number | string | undefined): this; + /** + * Sets the end style of the split line. The default value is Butt. + * + * @param { LineCapStyle } value + * @returns { DividerAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + lineCap(value: LineCapStyle | undefined): this; + @memo + attributeModifier(value: AttributeModifier): this; +} + +@memo +@ComponentBuilder +export declare function Divider( + + @memo + content_?: () => void, +): DividerAttribute \ No newline at end of file diff --git a/api/arkui/component/gridCol.d.ets b/api/arkui/component/gridCol.d.ets new file mode 100644 index 0000000000..512aeb3b9a --- /dev/null +++ b/api/arkui/component/gridCol.d.ets @@ -0,0 +1,192 @@ +/* + * Copyright (c) 2022-2023 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +/** + * @file + * @kit ArkUI + * @arkts 1.2 + */ +import { CommonMethod, AttributeModifier } from "./common"; +import { memo, ComponentBuilder } from "./../stateManagement/runtime"; +/** + * Defines the option in number unit of grid-container child component. + * + * @interface GridColColumnOption + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ +export declare interface GridColColumnOption { + /** + * Grid Col Column Option xs + * + * @type { ?number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + xs?: number; + /** + * Grid Col Column Option sm + * + * @type { ?number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + sm?: number; + /** + * Grid Col Column Option md + * + * @type { ?number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + md?: number; + /** + * Grid Col Column Option lg + * + * @type { ?number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + lg?: number; + /** + * Grid Col Column Option xl + * + * @type { ?number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + xl?: number; + /** + * Grid Col Column Option xxl + * + * @type { ?number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + xxl?: number; +} +/** + * Defines the options of grid-container child component. + * + * @interface GridColOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ +export declare interface GridColOptions { + /** + * Sets the span of current gird-container item. + * + * @type { ?(number | GridColColumnOption) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + span?: number | GridColColumnOption; + /** + * Sets the offset of current gird-container item. + * + * @type { ?(number | GridColColumnOption) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + offset?: number | GridColColumnOption; + /** + * Sets the order of current gird-container item. + * + * @type { ?(number | GridColColumnOption) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + order?: number | GridColColumnOption; +} +export declare interface GridColAttribute extends CommonMethod { + /** + * Sets the span of current gird-container item. + * + * @param { number | GridColColumnOption } value + * @returns { GridColAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + span(value: number | GridColColumnOption | undefined): this; + /** + * Sets the offset of current gird-container item. + * + * @param { number | GridColColumnOption } value + * @returns { GridColAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + gridColOffset(value: number | GridColColumnOption | undefined): this; + /** + * Sets the order of current gird-container item. + * + * @param { number | GridColColumnOption } value + * @returns { GridColAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + order(value: number | GridColColumnOption | undefined): this; + @memo + attributeModifier(value: AttributeModifier): this; +} + +@memo +@ComponentBuilder +export declare function GridCol( + option?: GridColOptions, + @memo + content_?: () => void, +): GridColAttribute \ No newline at end of file diff --git a/api/arkui/component/gridRow.d.ets b/api/arkui/component/gridRow.d.ets new file mode 100644 index 0000000000..fb6d75a0ca --- /dev/null +++ b/api/arkui/component/gridRow.d.ets @@ -0,0 +1,403 @@ +/* + * Copyright (c) 2022-2023 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +/** + * @file + * @kit ArkUI + * @arkts 1.2 + */ +import { ItemAlign } from "./enums"; +import { CommonMethod, AttributeModifier } from "./common"; +import { Length } from "./units"; +import { memo, ComponentBuilder } from "./../stateManagement/runtime"; +/** + * Defines the option in length unit of grid-row component. + * + * @interface GridRowSizeOption + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ +export declare interface GridRowSizeOption { + /** + * Grid Row Size Option xs, select xs gutter size based on gridRow current breakpoint + * + * @type { ?Length } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + xs?: Length; + /** + * Grid Row Size Option sm, select sm gutter size based on gridRow current breakpoint + * + * @type { ?Length } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + sm?: Length; + /** + * Grid Row Size Option md, select md gutter size based on gridRow current breakpoint + * + * @type { ?Length } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + md?: Length; + /** + * Grid Row Size Option lg, select lg gutter size based on gridRow current breakpoint + * + * @type { ?Length } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + lg?: Length; + /** + * Grid Row Size Option xl, select xl gutter size based on gridRow current breakpoint + * + * @type { ?Length } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + xl?: Length; + /** + * Grid Row Size Option xxl, select xxl gutter size based on gridRow current breakpoint + * + * @type { ?Length } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + xxl?: Length; +} +/** + * Defines the option in number unit of grid-container component. + * + * @interface GridRowColumnOption + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ +export declare interface GridRowColumnOption { + /** + * Grid Row Column Option xs, select xs column num based on gridRow current breakpoint + * + * @type { ?number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + xs?: number; + /** + * Grid Row Column Option sm, select sm column num based on gridRow current breakpoint + * + * @type { ?number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + sm?: number; + /** + * Grid Row Column Option md + * + * @type { ?number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + md?: number; + /** + * Grid Row Column Option lg, select lg column num based on gridRow current breakpoint + * + * @type { ?number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + lg?: number; + /** + * Grid Row Column Option xl, select xl column num based on gridRow current breakpoint + * + * @type { ?number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + xl?: number; + /** + * Grid Row Column Option xxl, select xxl column num based on gridRow current breakpoint + * + * @type { ?number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + xxl?: number; +} +/** + * Defines the gutter of grid-row component. + * + * @interface GutterOption + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ +export declare interface GutterOption { + /** + * Define x in GutterOption + * + * @type { ?(Length | GridRowSizeOption) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + x?: Length | GridRowSizeOption; + /** + * Define y in GutterOption + * + * @type { ?(Length | GridRowSizeOption) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + y?: Length | GridRowSizeOption; +} +/** + * Defines the breakpoint reference of grid-container component. + * + * @enum { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ +export declare enum BreakpointsReference { + /** + * Respond to breakpoint changes according to window width + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + WindowSize, + /** + * Respond to breakpoint changes according to component width + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + ComponentSize +} +/** + * Defines the direction of grid-container component. + * + * @enum { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ +export declare enum GridRowDirection { + /** + * The elements in the grid component are arranged in rows + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + Row, + /** + * The elements in the grid component are arranged in reverse order of rows + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + RowReverse +} +/** + * Defines the breakpoints of grid-row component. + * + * @interface BreakPoints + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ +export declare interface BreakPoints { + /** + * Breakpoint array + * + * @type { ?Array } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + value?: Array; + /** + * Set breakpoint reference + * + * @type { ?BreakpointsReference } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + reference?: BreakpointsReference; +} +/** + * Defines the options of grid-row component. + * + * @interface GridRowOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ +export declare interface GridRowOptions { + /** + * layout spacing between sub-components + * + * @type { ?(Length | GutterOption) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + gutter?: Length | GutterOption; + /** + * Sets the total number of columns in the current layout. + * + * @type { ?(number | GridRowColumnOption) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + columns?: number | GridRowColumnOption; + /** + * grid-row layout breakpoints. + * + * @type { ?BreakPoints } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + breakpoints?: BreakPoints; + /** + * grid-row layout direction. + * + * @type { ?GridRowDirection } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + direction?: GridRowDirection; +} +export declare interface GridRowAttribute extends CommonMethod { + /** + * Callback triggered when the breakpoint changes, breakpoints value can be xs, sm, md, lg, xl, xxl + * + * @param { function } callback + * @returns { GridRowAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + onBreakpointChange(callback: ((breakpoints: string) => void) | undefined): this; + /** + * Cross axis alignment of each line in GridRow. + * + * @param { ItemAlign } value - element alignment + * @returns { GridRowAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + alignItems(value: ItemAlign | undefined): this; + @memo + attributeModifier(value: AttributeModifier): this; +} + +@memo +@ComponentBuilder +export declare function GridRow( + option?: GridRowOptions, + @memo + content_?: () => void, +): GridRowAttribute \ No newline at end of file diff --git a/api/arkui/component/row.d.ets b/api/arkui/component/row.d.ets new file mode 100644 index 0000000000..e17aa320e4 --- /dev/null +++ b/api/arkui/component/row.d.ets @@ -0,0 +1,127 @@ +/* + * Copyright (c) 2021-2023 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +/** + * @file + * @kit ArkUI + * @arkts 1.2 + */ +import { PointLightStyle, Optional, CommonMethod, AttributeModifier } from "./common"; +import { VerticalAlign, FlexAlign } from "./enums"; +import { SpaceType } from "./column"; +import { memo, ComponentBuilder } from "./../stateManagement/runtime"; +/** + * Define options used to construct a row. + * + * @interface RowOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ +export declare interface RowOptions { + /** + * Row spacing. + * + * @type { ?(string | number) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + space?: string | number; +} +/** + * Define options used to construct a row. + * + * @interface RowOptionsV2 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ +export interface RowOptionsV2 { + /** + * Vertical layout element spacing. + * + * @type { ?SpaceType } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + space?: SpaceType; +} +export declare interface RowAttribute extends CommonMethod { + /** + * Called when the vertical alignment is set. + * + * @param { VerticalAlign } value + * @returns { RowAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + alignItems(value: VerticalAlign | undefined): this; + /** + * Called when the horizontal alignment is set. + * + * @param { FlexAlign } value + * @returns { RowAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + justifyContent(value: FlexAlign | undefined): this; + /** + * Defines the PointLight + * + * @param { PointLightStyle } value - The point light style. + * @returns { RowAttribute } The attribute of the row. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 20 + */ + pointLight(value: PointLightStyle | undefined): this; + /** + * Called when the Main-Axis's direction is set reversed or not + * + * @param { Optional } isReversed - If the main axis is reversed. + * @returns { RowAttribute } The attribute of the row. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + reverse(isReversed: boolean | undefined): this; + @memo + attributeModifier(value: AttributeModifier): this; +} + +@memo +@ComponentBuilder +export declare function Row( + options?: RowOptions | RowOptions | RowOptionsV2, + @memo + content_?: () => void, +): RowAttribute \ No newline at end of file diff --git a/api/arkui/component/rowSplit.d.ets b/api/arkui/component/rowSplit.d.ets new file mode 100644 index 0000000000..7fccc85a2b --- /dev/null +++ b/api/arkui/component/rowSplit.d.ets @@ -0,0 +1,44 @@ +/* + * Copyright (c) 2021-2023 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +/** + * @file + * @kit ArkUI + * @arkts 1.2 + */ +import { CommonMethod, AttributeModifier } from "./common"; +import { memo, ComponentBuilder } from "./../stateManagement/runtime"; +export declare interface RowSplitAttribute extends CommonMethod { + /** + * Called when judging whether the split line can be dragged. + * + * @param { boolean } value + * @returns { RowSplitAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + resizeable(value: boolean | undefined): this; + @memo + attributeModifier(value: AttributeModifier): this; +} + +@memo +@ComponentBuilder +export declare function RowSplit( + + @memo + content_?: () => void, +): RowSplitAttribute \ No newline at end of file diff --git a/api/arkui/component/stack.d.ets b/api/arkui/component/stack.d.ets new file mode 100644 index 0000000000..dc11e7d12d --- /dev/null +++ b/api/arkui/component/stack.d.ets @@ -0,0 +1,79 @@ +/* + * Copyright (c) 2021-2023 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +/** + * @file + * @kit ArkUI + * @arkts 1.2 + */ +import { PointLightStyle, CommonMethod, AttributeModifier } from "./common"; +import { Alignment } from "./enums"; +import { memo, ComponentBuilder } from "./../stateManagement/runtime"; +/** + * Options used to construct the stack. + * + * @interface StackOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ +export declare interface StackOptions { + /** + * Set the alignment of sub components within the container. + * + * @type { ?Alignment } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + alignContent?: Alignment; +} +export declare interface StackAttribute extends CommonMethod { + /** + * Called when the alignment of items in the container is set. + * + * @param { Alignment } value + * @returns { StackAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + alignContent(value: Alignment | undefined): this; + /** + * Defines the PointLight + * + * @param { PointLightStyle } value - The point light style. + * @returns { StackAttribute } The attribute of the stack. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 20 + */ + pointLight(value: PointLightStyle | undefined): this; + @memo + attributeModifier(value: AttributeModifier): this; +} + +@memo +@ComponentBuilder +export declare function Stack( + options?: StackOptions, + @memo + content_?: () => void, +): StackAttribute \ No newline at end of file -- Gitee