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 #ifndef FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_DECLARATION_NAVIGATION_NAVIGATION_DECLARATION_H
17 #define FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_DECLARATION_NAVIGATION_NAVIGATION_DECLARATION_H
18
19 #include <string>
20
21 #include "base/geometry/dimension.h"
22 #include "core/components/common/properties/color.h"
23 #include "core/components/declaration/common/declaration.h"
24 #include "core/components/navigation_bar/navigation_bar_theme.h"
25 #include "core/pipeline_ng/pipeline_context.h"
26
27 namespace OHOS::Ace::NG {
28
NavigationGetTheme()29 inline RefPtr<NavigationBarTheme> NavigationGetTheme()
30 {
31 auto pipeline = PipelineBase::GetCurrentContext();
32 CHECK_NULL_RETURN(pipeline, nullptr);
33 auto theme = pipeline->GetTheme<NavigationBarTheme>();
34 return theme;
35 }
36
37 // TODO：move some items to theme
38 // title bar back button
39 constexpr const char* BACK_BUTTON = "Back";
40 constexpr InternalResource::ResourceId BACK_ICON = InternalResource::ResourceId::IC_BACK;
41 constexpr InternalResource::ResourceId MORE_ICON = InternalResource::ResourceId::IC_MORE;
42 // title bar and tool bar, bar item
43 constexpr float BAR_ITEM_WIDTH = 40.0f;
44 constexpr float BAR_ITEM_HEIGHT = 60.0f;
45 constexpr float BAR_TEXT_FONT_SIZE = 18.0f;
46 // title bar title and subtitle
47 constexpr float TITLE_WIDTH = 100.0f;
48 // single page maximum width
49 constexpr float SINGLE_PAGE_MAXIMUM_WIDTH = 720.0f;
50
51 // title
52 constexpr Dimension MAX_TITLE_FONT_SIZE = 30.0_vp;
53 constexpr Dimension MIN_TITLE_FONT_SIZE = 20.0_vp;
54 constexpr Dimension MIN_ADAPT_TITLE_FONT_SIZE = 14.0_vp;
55 constexpr const char* TITLE_MAIN = "MainOnly";
56 constexpr const char* TITLE_MAIN_WITH_SUB = "MainWithSub";
57
58 // subtitle
59 constexpr Dimension SUBTITLE_FONT_SIZE = 14.0_vp; // ohos_id_text_size_sub_title3
60 constexpr Dimension SUBTITLE_HEIGHT = 26.0_vp;
61 constexpr Dimension MIN_ADAPT_SUBTITLE_FONT_SIZE = 10.0_vp;
62 constexpr Color SUBTITLE_COLOR = Color(0x99000000); // ohos_id_alpha_content_secondary
63 // back button
64 constexpr Dimension BACK_BUTTON_SIZE = 48.0_vp;
65 constexpr Dimension BACK_BUTTON_ICON_SIZE = 24.0_vp;
66 // title bar
67 constexpr Dimension TITLEBAR_HEIGHT_MINI = 56.0_vp;
68 constexpr Dimension TITLEBAR_HEIGHT_WITH_SUBTITLE = 137.0_vp;
69 constexpr Dimension TITLEBAR_HEIGHT_WITHOUT_SUBTITLE = 112.0_vp;
70 constexpr uint32_t TITLEBAR_MAX_LINES = 2;
71 // toolbar item
72 constexpr Dimension TEXT_FONT_SIZE = 10.0_vp;
73 constexpr Color TEXT_COLOR = Color(0xE6000000);
74 constexpr Color ICON_COLOR = Color(0xE6000000);
75 // toolbar
76 constexpr Dimension ICON_PADDING = 10.0_vp;
77 constexpr Dimension TEXT_TOP_PADDING = 2.0_vp;
78
79 // divider
80 constexpr Dimension DIVIDER_WIDTH = 1.0_px;
81 constexpr Dimension DEFAULT_DIVIDER_START_MARGIN = 0.0_vp;
82 constexpr Dimension DEFAULT_DIVIDER_HOT_ZONE_HORIZONTAL_PADDING = 2.0_vp;
83 constexpr int32_t DIVIDER_HOT_ZONE_HORIZONTAL_PADDING_NUM = 2;
84
85 // navigation content
86 constexpr Dimension SINGLE_LINE_TITLEBAR_HEIGHT = 56.0_vp;
87 constexpr Dimension DOUBLE_LINE_TITLEBAR_HEIGHT = 82.0_vp;
88 constexpr Dimension DEFAULT_MIN_CONTENT_WIDTH = 360.0_vp;
89
90 // navBar
91 constexpr Dimension FULL_SINGLE_LINE_TITLEBAR_HEIGHT = 112.0_vp;
92 constexpr Dimension FULL_DOUBLE_LINE_TITLEBAR_HEIGHT = 138.0_vp;
93 constexpr Dimension NAV_HORIZONTAL_MARGIN_L = 16.0_vp; // ohos_id_elements_margin_horizontal_l
94 constexpr Dimension NAV_HORIZONTAL_MARGIN_M = 8.0_vp; // ohos_id_elements_margin_horizontal_m
95 constexpr Dimension MENU_ITEM_PADDING = 24.0_vp;
96 constexpr Dimension MENU_ITEM_SIZE = 48.0_vp;
97 constexpr Dimension BUTTON_PADDING = 12.0_vp;
98 constexpr Dimension BUTTON_RADIUS_SIZE = 5.0_vp;
99 constexpr Dimension MAX_OVER_DRAG_OFFSET = 180.0_vp;
100 constexpr Dimension DEFAULT_MIN_NAV_BAR_WIDTH = 240.0_vp;
101 constexpr Dimension DEFAULT_MAX_NAV_BAR_WIDTH = 432.0_vp;
102 constexpr Dimension MAX_MENU_CHANGE_SIZE = 600.0_vp;
103 constexpr int8_t MAX_MENU_NUM_SMALL = 3;
104 const int8_t MAX_MENU_NUM_LARGE = 5;
105 constexpr float MAX_NAV_BAR_WIDTH_SCALE = 0.4f;
106
107 // more button
108 constexpr Dimension MORE_BUTTON_CORNER_RADIUS = 8.0_vp;
109
110 // maximum number of toolbar items
111 constexpr uint32_t MAXIMUM_TOOLBAR_ITEMS_IN_BAR = 5;
112 constexpr uint32_t ONE_TOOLBAR_ITEM = 1;
113
114 enum class NavToolbarItemStatus {
115 NORMAL = 0,
116 DISABLED,
117 ACTIVE,
118 };
119
120 // appbar menu item and toolbar item configuration
121 struct BarItem {
122 std::optional<std::string> text;
123 std::optional<std::string> icon;
124 std::function<void()> action;
125 NavToolbarItemStatus status;
126 std::optional<std::string> activeIcon;
ToStringBarItem127 std::string ToString() const
128 {
129 std::string result;
130 result.append("text: ");
131 result.append(text.value_or("na"));
132 result.append(", icon: ");
133 result.append(icon.value_or("na"));
134 return result;
135 }
136 };
137
138 enum class ToolbarIconStatus {
139 INITIAL = 0,
140 ACTIVE,
141 };
142
143 enum class TitleBarChildType {
144 TITLE = 0,
145 SUBTITLE,
146 MENU,
147 };
148
149 enum class NavigationTitleMode {
150 FREE = 0,
151 FULL,
152 MINI,
153 };
154
155 enum class NavigationMode {
156 STACK = 0,
157 SPLIT,
158 AUTO,
159 };
160
161 enum class NavBarPosition {
162 START = 0,
163 END,
164 };
165
166 enum class NavDestinationMode {
167 STANDARD = 0,
168 DIALOG,
169 };
170
171 enum class ChildNodeOperation {
172 ADD,
173 // remove case only used for back button
174 REMOVE,
175 REPLACE,
176 NONE
177 };
178
179 enum class TitleBarParentType { NAVBAR, NAV_DESTINATION };
180
181 enum class NavRouteMode {
182 PUSH_WITH_RECREATE = 0,
183 PUSH,
184 REPLACE,
185 };
186
187 enum class NavigationOperation {
188 PUSH = 1,
189 POP,
190 REPLACE,
191 };
192
193 struct NavContentInfo {
194 std::string name;
195 int32_t index = 0;
196 NavDestinationMode mode;
197 };
198
199 } // namespace OHOS::Ace::NG
200 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_DECLARATION_NAVIGATION_NAVIGATION_DECLARATION_H
201