From f13eb3cf35384e41277843e37675f1d4d798b37f Mon Sep 17 00:00:00 2001 From: limeng Date: Mon, 19 Sep 2022 13:25:30 +0800 Subject: [PATCH 1/4] update interfaces for waterflow & flowitem Signed-off-by: limeng --- api/@internal/component/ets/flow_Item.d.ts | 34 +++++++ api/@internal/component/ets/water_flow.d.ts | 100 ++++++++++++++++++++ 2 files changed, 134 insertions(+) create mode 100644 api/@internal/component/ets/flow_Item.d.ts create mode 100644 api/@internal/component/ets/water_flow.d.ts diff --git a/api/@internal/component/ets/flow_Item.d.ts b/api/@internal/component/ets/flow_Item.d.ts new file mode 100644 index 0000000000..fcfc6f1ebb --- /dev/null +++ b/api/@internal/component/ets/flow_Item.d.ts @@ -0,0 +1,34 @@ +/* + * Copyright (c) 2022 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. + */ + +/** + * Mesh container for static fixed-size layout scenarios. + * @since 9 + */ +interface FlowItemInterface { + /** + * Return to get flowItem. + * @since 9 + */ + (): FlowItemAttribute; +} + +/** + * @since 9 + */ +declare class FlowItemAttribute extends CommonMethod {} + +declare const FlowItem: FlowItemInterface +declare const FlowItemInstance: FlowItemAttribute; diff --git a/api/@internal/component/ets/water_flow.d.ts b/api/@internal/component/ets/water_flow.d.ts new file mode 100644 index 0000000000..d3e1e13d04 --- /dev/null +++ b/api/@internal/component/ets/water_flow.d.ts @@ -0,0 +1,100 @@ +/* + * Copyright (c) 2022 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. + */ + +/** +* Defines the water flow options. +* @since 9 +*/ +declare interface WaterFlowOptions { + /** + * Describes the water flow footer. + * @since 9 + */ + footer?: CustomBuilder; + + /** + * Describes the water flow scroller. + * @since 9 + */ + scroller?: Scroller; +} + + +/** + * @since 9 + */ +interface WaterFlowInterface { + /** + * WaterFlow is returned when the parameter is transferred. only support api: scrollToIndex + * @since 9 + */ + (options?: WaterFlowOptions): WaterFlowAttribute; +} + +/** + * @since 9 + */ +declare class WaterFlowAttribute extends CommonMethod { + /** + * This parameter specifies the number of columns in the current waterflow. + * @since 9 + */ + columnsTemplate(value: string): WaterFlowAttribute; + + /** + * This parameter specifies the min or max size of each item. + * @since 9 + */ + itemConstraintSize(value: ConstraintSizeOptions): WaterFlowAttribute; + + /** + * Lets you set the number of rows in the current waterflow。 + * @since 9 + */ + rowsTemplate(value: string): WaterFlowAttribute; + + /** + * Allows you to set the spacing between columns. + * @since 9 + */ + columnsGap(value: Length): WaterFlowAttribute; + + /** + * Lets you set the spacing between rows. + * @since 9 + */ + rowsGap(value: Length): WaterFlowAttribute; + + /** + * control WaterFlowDirection of the WaterFlow. + * @since 9 + */ + layoutDirection(value: FlexDirection): WaterFlowAttribute; + + /** + * Called when the water flow begins to arrive. + * @since 9 + */ + onReachStart(event: () => void): WaterFlowAttribute; + + /** + * Called when the water flow reaches the end. + * @since 9 + */ + onReachEnd(event: () => void): WaterFlowAttribute; +} + +declare const WaterFlow: WaterFlowInterface; +declare const WaterFlowInstance: WaterFlowAttribute; -- Gitee From f4dc319500cf56a77263ac68886782fc728a4c08 Mon Sep 17 00:00:00 2001 From: limeng Date: Tue, 27 Sep 2022 17:42:43 +0800 Subject: [PATCH 2/4] modify index-full Signed-off-by: limeng --- api/@internal/component/ets/index-full.d.ts | 2 ++ 1 file changed, 2 insertions(+) diff --git a/api/@internal/component/ets/index-full.d.ts b/api/@internal/component/ets/index-full.d.ts index 85abad3e47..b5c05715db 100644 --- a/api/@internal/component/ets/index-full.d.ts +++ b/api/@internal/component/ets/index-full.d.ts @@ -106,3 +106,5 @@ /// /// /// +/// +/// -- Gitee From e1ab9bc221595d0b54178f0d66265bc44d9ac2c9 Mon Sep 17 00:00:00 2001 From: limeng Date: Sun, 9 Oct 2022 10:42:08 +0800 Subject: [PATCH 3/4] Change the name of flow_item Signed-off-by: limeng --- api/@internal/component/ets/{flow_Item.d.ts => flow_item.d.ts} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename api/@internal/component/ets/{flow_Item.d.ts => flow_item.d.ts} (100%) diff --git a/api/@internal/component/ets/flow_Item.d.ts b/api/@internal/component/ets/flow_item.d.ts similarity index 100% rename from api/@internal/component/ets/flow_Item.d.ts rename to api/@internal/component/ets/flow_item.d.ts -- Gitee From 1e3beaff1f544340789d5616bfb82b95fa83a3b7 Mon Sep 17 00:00:00 2001 From: limeng Date: Mon, 10 Oct 2022 10:06:28 +0800 Subject: [PATCH 4/4] update by commits Signed-off-by: limeng --- api/@internal/component/ets/flow_item.d.ts | 2 +- api/@internal/component/ets/water_flow.d.ts | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/api/@internal/component/ets/flow_item.d.ts b/api/@internal/component/ets/flow_item.d.ts index fcfc6f1ebb..801acb1a9b 100644 --- a/api/@internal/component/ets/flow_item.d.ts +++ b/api/@internal/component/ets/flow_item.d.ts @@ -19,7 +19,7 @@ */ interface FlowItemInterface { /** - * Return to get flowItem. + * Construct the flow item. * @since 9 */ (): FlowItemAttribute; diff --git a/api/@internal/component/ets/water_flow.d.ts b/api/@internal/component/ets/water_flow.d.ts index d3e1e13d04..c5387a22c5 100644 --- a/api/@internal/component/ets/water_flow.d.ts +++ b/api/@internal/component/ets/water_flow.d.ts @@ -37,7 +37,7 @@ declare interface WaterFlowOptions { */ interface WaterFlowInterface { /** - * WaterFlow is returned when the parameter is transferred. only support api: scrollToIndex + * WaterFlow is returned when the parameter is transferred. Only support api: scrollToIndex * @since 9 */ (options?: WaterFlowOptions): WaterFlowAttribute; @@ -60,25 +60,25 @@ declare class WaterFlowAttribute extends CommonMethod { itemConstraintSize(value: ConstraintSizeOptions): WaterFlowAttribute; /** - * Lets you set the number of rows in the current waterflow。 + * Set the number of rows in the current waterflow. * @since 9 */ rowsTemplate(value: string): WaterFlowAttribute; /** - * Allows you to set the spacing between columns. + * Set the spacing between columns. * @since 9 */ columnsGap(value: Length): WaterFlowAttribute; /** - * Lets you set the spacing between rows. + * Set the spacing between rows. * @since 9 */ rowsGap(value: Length): WaterFlowAttribute; /** - * control WaterFlowDirection of the WaterFlow. + * Control layout direction of the WaterFlow. * @since 9 */ layoutDirection(value: FlexDirection): WaterFlowAttribute; -- Gitee