• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2021 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16/**
17 * Defines the size type.
18 * @since 7
19 */
20declare enum SizeType {
21  /**
22   * Select a value based on the device type.
23   * @since 7
24   */
25  Auto,
26
27  /**
28   * Select a value based on the device type.
29   * @since 7
30   */
31  XS,
32
33  /**
34   * Small width type device.
35   * @since 7
36   */
37  SM,
38
39  /**
40   * Medium width type device.
41   * @since 7
42   */
43  MD,
44
45  /**
46   * Large width type device.
47   * @since 7
48   */
49  LG,
50}
51
52/**
53 * Defines the options of GridContainer.
54 * @since 7
55 */
56declare interface GridContainerOptions {
57  /**
58   * Sets the total number of columns in the current layout.
59   * @since 7
60   */
61  columns?: number | "auto";
62
63  /**
64   * Select the device width type.
65   * @since 7
66   */
67  sizeType?: SizeType;
68
69  /**
70   * Grid layout column spacing.
71   * @since 7
72   */
73  gutter?: number | string;
74
75  /**
76   * Spacing on both sides of the grid layout.
77   * @since 7
78   */
79  margin?: number | string;
80}
81
82/**
83 * Defines the GridContainer component.
84 * @since 7
85 */
86interface GridContainerInterface {
87  /**
88   * Defines the constructor of GridContainer.
89   * @since 7
90   */
91  (value?: GridContainerOptions): GridContainerAttribute;
92}
93
94/**
95 * Defines the grid container attribute from inheritance Column
96 * @since 7
97 */
98declare class GridContainerAttribute extends ColumnAttribute {}
99
100/**
101 * Defines GridContainer Component.
102 * @since 7
103 * @deprecated since 9
104 * @useinstead grid_col/[GridColColumnOption] and grid_row/[GridRowColumnOption]
105 */
106declare const GridContainer: GridContainerInterface
107
108/**
109 * Defines GridContainer Component instance.
110 * @since 7
111 * @deprecated since 9
112 * @useinstead grid_col/[GridColAttribute] and grid_row/[GridRowAttribute]
113 */
114declare const GridContainerInstance: GridContainerAttribute;
115