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 const std::string 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 // subtitle
56 constexpr Dimension SUBTITLE_FONT_SIZE = 14.0_vp; // ohos_id_text_size_sub_title3
57 constexpr Dimension SUBTITLE_HEIGHT = 26.0_vp;
58 constexpr Dimension MIN_ADAPT_SUBTITLE_FONT_SIZE = 10.0_vp;
59 constexpr Color SUBTITLE_COLOR = Color(0x99000000); // ohos_id_alpha_content_secondary
60 // back button
61 constexpr Dimension BACK_BUTTON_SIZE = 48.0_vp;
62 constexpr Dimension BACK_BUTTON_ICON_SIZE = 24.0_vp;
63 // title bar
64 constexpr Dimension TITLEBAR_HEIGHT_MINI = 56.0_vp;
65 constexpr Dimension TITLEBAR_HEIGHT_WITH_SUBTITLE = 137.0_vp;
66 constexpr Dimension TITLEBAR_HEIGHT_WITHOUT_SUBTITLE = 112.0_vp;
67 constexpr uint32_t TITLEBAR_MAX_LINES = 2;
68 // toolbar item
69 constexpr Dimension TEXT_FONT_SIZE = 10.0_vp;
70 constexpr Color TEXT_COLOR = Color(0xE6000000);
71 constexpr Color ICON_COLOR = Color(0xE6000000);
72 // toolbar
73 constexpr Dimension ICON_PADDING = 10.0_vp;
74 constexpr Dimension TEXT_TOP_PADDING = 2.0_vp;
75
76 // divider
77 constexpr Dimension DIVIDER_WIDTH = 1.0_vp;
78 constexpr Color DIVIDER_COLOR = Color(0x08000000);
79 constexpr Dimension DEFAULT_DIVIDER_START_MARGIN = 0.0_vp;
80 constexpr Dimension DEFAULT_DIVIDER_HOT_ZONE_HORIZONTAL_PADDING = 2.0_vp;
81 constexpr int32_t DIVIDER_HOT_ZONE_HORIZONTAL_PADDING_NUM = 2;
82
83 // navigation content
84 constexpr Dimension SINGLE_LINE_TITLEBAR_HEIGHT = 56.0_vp;
85 constexpr Dimension DOUBLE_LINE_TITLEBAR_HEIGHT = 82.0_vp;
86 constexpr Dimension DEFAULT_MIN_CONTENT_WIDTH = 360.0_vp;
87
88 // navBar
89 constexpr Dimension FULL_SINGLE_LINE_TITLEBAR_HEIGHT = 112.0_vp;
90 constexpr Dimension FULL_DOUBLE_LINE_TITLEBAR_HEIGHT = 138.0_vp;
91 constexpr Dimension NAV_HORIZONTAL_MARGIN_L = 16.0_vp; // ohos_id_elements_margin_horizontal_l
92 constexpr Dimension NAV_HORIZONTAL_MARGIN_M = 8.0_vp; // ohos_id_elements_margin_horizontal_m
93 constexpr Dimension MENU_ITEM_PADDING = 24.0_vp;
94 constexpr Dimension MENU_ITEM_SIZE = 48.0_vp;
95 constexpr Dimension BUTTON_PADDING = 12.0_vp;
96 constexpr Dimension BUTTON_RADIUS = 5.0_vp;
97 constexpr Dimension MAX_OVER_DRAG_OFFSET = 180.0_vp;
98 constexpr Dimension DEFAULT_MIN_NAV_BAR_WIDTH = 240.0_vp;
99 constexpr Dimension DEFAULT_MAX_NAV_BAR_WIDTH = 432.0_vp;
100 constexpr float MAX_NAV_BAR_WIDTH_SCALE = 0.4f;
101
102 // more button
103 constexpr Dimension MORE_BUTTON_CORNER_RADIUS = 8.0_vp;
104
105 // maximum number of toolbar items
106 constexpr uint32_t MAXIMUM_TOOLBAR_ITEMS_IN_BAR = 5;
107 constexpr uint32_t ONE_TOOLBAR_ITEM = 1;
108
109 // navigation mask color
110 const Color MASK_COLOR = Color::FromARGB(25, 0, 0, 0);
111 const Color DEFAULT_MASK_COLOR = Color::FromARGB(0, 0, 0, 0);
112
113 enum class NavToolbarItemStatus {
114 NORMAL = 0,
115 DISABLED,
116 ACTIVE,
117 };
118
119 // appbar menu item and toolbar item configuration
120 struct BarItem {
121 std::optional<std::string> text;
122 std::optional<std::string> icon;
123 std::function<void()> action;
124 NavToolbarItemStatus status;
125 std::optional<std::string> activeIcon;
ToStringBarItem126 std::string ToString() const
127 {
128 std::string result;
129 result.append("text: ");
130 result.append(text.value_or("na"));
131 result.append(", icon: ");
132 result.append(icon.value_or("na"));
133 return result;
134 }
135 };
136
137 enum class ToolbarIconStatus {
138 INITIAL = 0,
139 ACTIVE,
140 };
141
142 enum class TitleBarChildType {
143 TITLE = 0,
144 SUBTITLE,
145 MENU,
146 };
147
148 enum class NavigationTitleMode {
149 FREE = 0,
150 FULL,
151 MINI,
152 };
153
154 enum class NavigationMode {
155 STACK = 0,
156 SPLIT,
157 AUTO,
158 };
159
160 enum class NavBarPosition {
161 START = 0,
162 END,
163 };
164
165 enum class ChildNodeOperation {
166 ADD,
167 // remove case only used for back button
168 REMOVE,
169 REPLACE,
170 NONE
171 };
172
173 enum class TitleHeight { MAIN_ONLY, MAIN_WITH_SUB };
174
175 enum class TitleBarParentType { NAVBAR, NAV_DESTINATION };
176
177 enum class NavRouteMode {
178 PUSH_WITH_RECREATE = 0,
179 PUSH,
180 REPLACE,
181 };
182 } // namespace OHOS::Ace::NG
183 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_DECLARATION_NAVIGATION_NAVIGATION_DECLARATION_H
184