1/* 2 * Copyright (c) 2022-2023 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 list item group style. 18 * 19 * @enum { number } 20 * @syscap SystemCapability.ArkUI.ArkUI.Full 21 * @since 10 22 */ 23declare enum ListItemGroupStyle { 24 /** 25 * Show custom style. 26 * 27 * @syscap SystemCapability.ArkUI.ArkUI.Full 28 * @since 10 29 */ 30 NONE = 0, 31 32 /** 33 * Show default style. 34 * 35 * @syscap SystemCapability.ArkUI.ArkUI.Full 36 * @since 10 37 */ 38 CARD = 1, 39} 40 41/** 42 * Defines the list item group options. 43 * 44 * @interface ListItemGroupOptions 45 * @syscap SystemCapability.ArkUI.ArkUI.Full 46 * @since 9 47 */ 48/** 49 * Defines the list item group options. 50 * 51 * @interface ListItemGroupOptions 52 * @syscap SystemCapability.ArkUI.ArkUI.Full 53 * @crossplatform 54 * @since 10 55 */ 56declare interface ListItemGroupOptions { 57 /** 58 * Describes the ListItemGroup header. 59 * 60 * @type { ?CustomBuilder } 61 * @syscap SystemCapability.ArkUI.ArkUI.Full 62 * @since 9 63 */ 64 /** 65 * Describes the ListItemGroup header. 66 * 67 * @type { ?CustomBuilder } 68 * @syscap SystemCapability.ArkUI.ArkUI.Full 69 * @crossplatform 70 * @since 10 71 */ 72 header?: CustomBuilder; 73 74 /** 75 * Describes the ListItemGroup footer. 76 * 77 * @type { ?CustomBuilder } 78 * @syscap SystemCapability.ArkUI.ArkUI.Full 79 * @since 9 80 */ 81 /** 82 * Describes the ListItemGroup footer. 83 * 84 * @type { ?CustomBuilder } 85 * @syscap SystemCapability.ArkUI.ArkUI.Full 86 * @crossplatform 87 * @since 10 88 */ 89 footer?: CustomBuilder; 90 91 /** 92 * Describes the ListItemGroup space. 93 * 94 * @type { ?(number | string) } 95 * @syscap SystemCapability.ArkUI.ArkUI.Full 96 * @since 9 97 */ 98 /** 99 * Describes the ListItemGroup space. 100 * 101 * @type { ?(number | string) } 102 * @syscap SystemCapability.ArkUI.ArkUI.Full 103 * @crossplatform 104 * @since 10 105 */ 106 space?: number | string; 107 108 /** 109 * Describes the ListItemGroup style. 110 * 111 * @type { ?ListItemGroupStyle } 112 * @syscap SystemCapability.ArkUI.ArkUI.Full 113 * @since 10 114 */ 115 style?: ListItemGroupStyle; 116} 117 118/** 119 * Defines the ListItemGroup component 120 * 121 * @interface ListItemGroupInterface 122 * @syscap SystemCapability.ArkUI.ArkUI.Full 123 * @since 9 124 */ 125/** 126 * Defines the ListItemGroup component 127 * 128 * @interface ListItemGroupInterface 129 * @syscap SystemCapability.ArkUI.ArkUI.Full 130 * @crossplatform 131 * @since 10 132 */ 133interface ListItemGroupInterface { 134 /** 135 * Called when interface is called. 136 * 137 * @param { ListItemGroupOptions } options 138 * @returns { ListItemGroupAttribute } 139 * @syscap SystemCapability.ArkUI.ArkUI.Full 140 * @since 9 141 */ 142 /** 143 * Called when interface is called. 144 * 145 * @param { ListItemGroupOptions } options 146 * @returns { ListItemGroupAttribute } 147 * @syscap SystemCapability.ArkUI.ArkUI.Full 148 * @crossplatform 149 * @since 10 150 */ 151 (options?: ListItemGroupOptions): ListItemGroupAttribute; 152} 153 154/** 155 * Defines the item group attribute functions. 156 * 157 * @extends CommonMethod 158 * @syscap SystemCapability.ArkUI.ArkUI.Full 159 * @since 9 160 */ 161/** 162 * Defines the item group attribute functions. 163 * 164 * @extends CommonMethod 165 * @syscap SystemCapability.ArkUI.ArkUI.Full 166 * @crossplatform 167 * @since 10 168 */ 169declare class ListItemGroupAttribute extends CommonMethod<ListItemGroupAttribute> { 170 /** 171 * Called when the ListItemGroup split line style is set. 172 * 173 * @param { { 174 * strokeWidth: Length; 175 * color?: ResourceColor; 176 * startMargin?: Length; 177 * endMargin?: Length; 178 * } | null } value 179 * @returns { ListItemGroupAttribute } 180 * @syscap SystemCapability.ArkUI.ArkUI.Full 181 * @since 9 182 */ 183 /** 184 * Called when the ListItemGroup split line style is set. 185 * 186 * @param { { 187 * strokeWidth: Length; 188 * color?: ResourceColor; 189 * startMargin?: Length; 190 * endMargin?: Length; 191 * } | null } value 192 * @returns { ListItemGroupAttribute } 193 * @syscap SystemCapability.ArkUI.ArkUI.Full 194 * @crossplatform 195 * @since 10 196 */ 197 divider( 198 value: { 199 strokeWidth: Length; 200 color?: ResourceColor; 201 startMargin?: Length; 202 endMargin?: Length; 203 } | null, 204 ): ListItemGroupAttribute; 205} 206 207/** 208 * Defines ListItemGroup Component instance. 209 * 210 * @syscap SystemCapability.ArkUI.ArkUI.Full 211 * @since 9 212 */ 213/** 214 * Defines ListItemGroup Component instance. 215 * 216 * @syscap SystemCapability.ArkUI.ArkUI.Full 217 * @crossplatform 218 * @since 10 219 */ 220declare const ListItemGroupInstance: ListItemGroupAttribute; 221 222/** 223 * Defines ListItemGroup Component. 224 * 225 * @syscap SystemCapability.ArkUI.ArkUI.Full 226 * @since 9 227 */ 228/** 229 * Defines ListItemGroup Component. 230 * 231 * @syscap SystemCapability.ArkUI.ArkUI.Full 232 * @crossplatform 233 * @since 10 234 */ 235declare const ListItemGroup: ListItemGroupInterface; 236