• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2023-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 * @file
18 * @kit ArkUI
19 */
20/*** if arkts 1.2 */
21import { ResourceStr } from './arkui/component/units';
22import { State, Prop } from './arkui/stateManagement/decorator';
23import { Component } from './arkui/component/customComponent';
24import { BuilderParam, Builder } from './arkui/component/builder';
25/*** endif */
26
27/**
28 * Declare SplitLayout.The SplitLayout is used for upper and lower graphic layouts.
29 * @syscap SystemCapability.ArkUI.ArkUI.Full
30 * @since 10
31 */
32/**
33 * Declare SplitLayout.The SplitLayout is used for upper and lower graphic layouts.
34 * @syscap SystemCapability.ArkUI.ArkUI.Full
35 * @atomicservice
36 * @since arkts{ '1.1':'11','1.2':'20'}
37 * @arkts 1.1&1.2
38 */
39@Component
40export declare struct SplitLayout {
41  /**
42   * Container in the user-defined splitlayout display area.
43   * @type { container: () => void }.
44   * @syscap SystemCapability.ArkUI.ArkUI.Full
45   * @since 10
46   */
47  /**
48   * Container in the user-defined splitlayout display area.
49   * @type { container: () => void }.
50   * @syscap SystemCapability.ArkUI.ArkUI.Full
51   * @atomicservice
52   * @since arkts{ '1.1':'11','1.2':'20'}
53   * @arkts 1.1&1.2
54   */
55  @BuilderParam container: () => void;
56
57  /**
58   * Image in the layout.
59   * @type { ResourceStr }.
60   * @syscap SystemCapability.ArkUI.ArkUI.Full
61   * @since 10
62   */
63  /**
64   * Image in the layout.
65   * @type { ResourceStr }.
66   * @syscap SystemCapability.ArkUI.ArkUI.Full
67   * @atomicservice
68   * @since arkts{ '1.1':'11','1.2':'20'}
69   * @arkts 1.1&1.2
70   */
71  @State mainImage: ResourceStr;
72
73  /**
74   * Title text in the layout.
75   * @type { ResourceStr }.
76   * @syscap SystemCapability.ArkUI.ArkUI.Full
77   * @since 10
78   */
79  /**
80   * Title text in the layout.
81   * @type { ResourceStr }.
82   * @syscap SystemCapability.ArkUI.ArkUI.Full
83   * @atomicservice
84   * @since arkts{ '1.1':'11','1.2':'20'}
85   * @arkts 1.1&1.2
86   */
87  @Prop primaryText: ResourceStr;
88
89  /**
90   * Description text in the layout.
91   * @type { ?ResourceStr }.
92   * @syscap SystemCapability.ArkUI.ArkUI.Full
93   * @since 10
94   */
95  /**
96   * Description text in the layout.
97   * @type { ?ResourceStr }.
98   * @syscap SystemCapability.ArkUI.ArkUI.Full
99   * @atomicservice
100   * @since arkts{ '1.1':'11','1.2':'20'}
101   * @arkts 1.1&1.2
102   */
103  @Prop secondaryText?: ResourceStr;
104
105  /**
106   * Auxiliary text in the layout.
107   * @type { ?ResourceStr }.
108   * @syscap SystemCapability.ArkUI.ArkUI.Full
109   * @since 10
110   */
111  /**
112   * Auxiliary text in the layout.
113   * @type { ?ResourceStr }.
114   * @syscap SystemCapability.ArkUI.ArkUI.Full
115   * @atomicservice
116   * @since arkts{ '1.1':'11','1.2':'20'}
117   * @arkts 1.1&1.2
118   */
119  @Prop tertiaryText?: ResourceStr;
120
121  /**
122   * The method to build component.
123   * @syscap SystemCapability.ArkUI.ArkUI.Full
124   * @atomicservice
125   * @since 20
126   * @arkts 1.2
127   */
128  @Builder build(): void;
129}
130