1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
use dioxus::prelude::*;
use freya_elements::elements as dioxus_elements;
use freya_elements::events::MouseEvent;
use freya_hooks::{
use_applied_theme, use_focus, use_platform, MenuContainerTheme, MenuContainerThemeWith,
MenuItemTheme, MenuItemThemeWith,
};
use winit::window::CursorIcon;
/// `Menu` component.
///
/// # Example
///
/// ```no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// let mut show_menu = use_signal(|| false);
///
/// rsx!(
/// Body {
/// Button {
/// onclick: move |_| show_menu.toggle(),
/// label { "Open Menu" }
/// },
/// if *show_menu.read() {
/// Menu {
/// onclose: move |_| show_menu.set(false),
/// MenuButton {
/// label {
/// "Open"
/// }
/// }
/// MenuButton {
/// label {
/// "Save"
/// }
/// }
/// SubMenu {
/// menu: rsx!(
/// MenuButton {
/// label {
/// "Some option"
/// }
/// }
/// ),
/// label {
/// "Options"
/// }
/// }
/// MenuButton {
/// label {
/// "Close"
/// }
/// }
/// }
/// }
/// }
/// )
///}
/// ```
#[allow(non_snake_case)]
#[component]
pub fn Menu(children: Element, onclose: Option<EventHandler<()>>) -> Element {
// Provide the menus ID generator
use_context_provider(|| Signal::new(ROOT_MENU.0));
// Provide the menus stack
use_context_provider::<Signal<Vec<MenuId>>>(|| Signal::new(vec![ROOT_MENU]));
// Provide this the ROOT Menu ID
use_context_provider(|| ROOT_MENU);
rsx!(
rect {
onglobalclick: move |_| {
if let Some(onclose) = &onclose {
onclose.call(());
}
},
MenuContainer {
{children}
}
}
)
}
#[derive(Clone, Copy, PartialEq)]
struct MenuId(usize);
static ROOT_MENU: MenuId = MenuId(0);
fn close_menus_until(menus: &mut Signal<Vec<MenuId>>, until_to: MenuId) {
loop {
let last_menu_id = menus.read().last().cloned();
if let Some(last_menu_id) = last_menu_id {
if last_menu_id != until_to {
menus.write().pop();
} else {
break;
}
} else {
break;
}
}
}
fn push_menu(menus: &mut Signal<Vec<MenuId>>, menu_id: MenuId) {
let last_menu_id = menus.read().last().cloned();
if let Some(last_menu_id) = last_menu_id {
if last_menu_id != menu_id {
menus.write().push(menu_id)
}
} else {
menus.write().push(menu_id)
}
}
/// Indicates the current status of the MenuItem.
#[derive(Debug, Default, PartialEq, Clone, Copy)]
pub enum MenuItemStatus {
/// Default state.
#[default]
Idle,
/// Mouse is hovering the MenuItem.
Hovering,
}
/// `MenuItem` component.
///
/// # Styling
/// Inherits the [`MenuItemTheme`](freya_hooks::MenuItemTheme) theme.
///
#[allow(non_snake_case)]
#[component]
pub fn MenuItem(
/// Inner children for the MenuItem.
children: Element,
/// Theme override for the MenuItem.
theme: Option<MenuItemThemeWith>,
/// Handler for the `onclick` event.
onclick: Option<EventHandler<Option<MouseEvent>>>,
/// Handler for the `onmouseenter` event.
onmouseenter: Option<EventHandler<()>>,
) -> Element {
let mut focus = use_focus();
let mut status = use_signal(MenuItemStatus::default);
let platform = use_platform();
let focus_id = focus.attribute();
let click = &onclick;
let MenuItemTheme {
hover_background,
corner_radius,
font_theme,
} = use_applied_theme!(&theme, menu_item);
let onclick = {
to_owned![click];
move |ev| {
focus.focus();
if let Some(onclick) = &click {
onclick.call(Some(ev))
}
}
};
use_drop(move || {
if *status.read() == MenuItemStatus::Hovering {
platform.set_cursor(CursorIcon::default());
}
});
let onmouseenter = move |_| {
platform.set_cursor(CursorIcon::Pointer);
status.set(MenuItemStatus::Hovering);
if let Some(onmouseenter) = &onmouseenter {
onmouseenter.call(());
}
};
let onmouseleave = move |_| {
platform.set_cursor(CursorIcon::default());
status.set(MenuItemStatus::default());
};
let background = match *status.read() {
MenuItemStatus::Hovering => &hover_background,
MenuItemStatus::Idle => "transparent",
};
rsx!(
rect {
onclick,
onmouseenter,
onmouseleave,
focus_id,
width: "fill-min",
padding: "6",
margin: "2",
focusable: "true",
role: "button",
color: "{font_theme.color}",
corner_radius: "{corner_radius}",
background: "{background}",
text_align: "start",
main_align: "center",
{children}
}
)
}
#[allow(non_snake_case)]
#[component]
pub fn SubMenu(
/// Submenu configuration.
menu: Element,
/// Inner children for the MenuButton
children: Element,
) -> Element {
let parent_menu_id = use_context::<MenuId>();
let mut menus = use_context::<Signal<Vec<MenuId>>>();
let mut menus_ids_generator = use_context::<Signal<usize>>();
let submenu_id = use_hook(|| {
menus_ids_generator += 1;
provide_context(MenuId(*menus_ids_generator.peek()))
});
let show_submenu = menus.read().contains(&submenu_id);
rsx!(
MenuItem {
onmouseenter: move |_| {
close_menus_until(&mut menus, parent_menu_id);
push_menu(&mut menus, submenu_id);
},
{children},
if show_submenu {
rect {
position_top: "-12",
position_right: "-16",
position: "absolute",
width: "0",
height: "0",
rect {
width: "100v",
MenuContainer {
{menu}
}
}
}
}
}
)
}
#[allow(non_snake_case)]
#[component]
pub fn MenuButton(
/// Inner children for the MenuButton
children: Element,
/// Handler for the `onclick` event.
onclick: Option<EventHandler<Option<MouseEvent>>>,
) -> Element {
let mut menus = use_context::<Signal<Vec<MenuId>>>();
let parent_menu_id = use_context::<MenuId>();
rsx!(
MenuItem {
onmouseenter: move |_| close_menus_until(&mut menus, parent_menu_id),
onclick: move |e| {
if let Some(onclick) = &onclick {
onclick.call(e)
}
}
{children}
}
)
}
#[allow(non_snake_case)]
#[component]
pub fn MenuContainer(
/// Inner children for the MenuContainer. Usually just `MenuButton` or `SubMenu`.
children: Element,
/// Theme override.
theme: Option<MenuContainerThemeWith>,
) -> Element {
let MenuContainerTheme {
background,
padding,
shadow,
} = use_applied_theme!(&theme, menu_container);
rsx!(
rect {
background: "{background}",
corner_radius: "12",
shadow: "{shadow}",
padding: "{padding}",
content: "fit",
{children}
}
)
}
#[cfg(test)]
mod test {
use dioxus::prelude::use_signal;
use freya::prelude::*;
use freya_testing::*;
#[tokio::test]
pub async fn menu() {
fn menu_app() -> Element {
let mut show_menu = use_signal(|| false);
rsx!(
Body {
Button {
onclick: move |_| show_menu.toggle(),
label { "Open Menu" }
},
if *show_menu.read() {
Menu {
onclose: move |_| show_menu.set(false),
MenuButton {
label {
"Open"
}
}
MenuButton {
label {
"Save"
}
}
SubMenu {
menu: rsx!(
MenuButton {
label {
"Option 1"
}
}
SubMenu {
menu: rsx!(
MenuButton {
label {
"Option 3"
}
}
),
label {
"More Options"
}
}
),
label {
"Options"
}
}
MenuButton {
label {
"Close"
}
}
}
}
}
)
}
let mut utils = launch_test(menu_app);
utils.wait_for_update().await;
let start_size = utils.sdom().get().layout().size();
assert_eq!(utils.sdom().get().layout().size(), 4);
// Open the Menu
utils.push_event(PlatformEvent::Mouse {
name: EventName::Click,
cursor: (5.0, 5.0).into(),
button: Some(MouseButton::Left),
});
utils.wait_for_update().await;
// Check the `Open` button exists
assert_eq!(
utils
.root()
.get(0)
.get(1)
.get(0)
.get(0)
.get(0)
.get(0)
.text(),
Some("Open")
);
assert!(utils.sdom().get().layout().size() > start_size);
// Close the Menu
utils.push_event(PlatformEvent::Mouse {
name: EventName::Click,
cursor: (15.0, 60.0).into(),
button: Some(MouseButton::Left),
});
utils.wait_for_update().await;
assert_eq!(utils.sdom().get().layout().size(), start_size);
// Open the Menu again
utils.push_event(PlatformEvent::Mouse {
name: EventName::Click,
cursor: (15.0, 15.0).into(),
button: Some(MouseButton::Left),
});
utils.wait_for_update().await;
utils.wait_for_update().await;
let one_submenu_opened = utils.sdom().get().layout().size();
assert!(one_submenu_opened > start_size);
// Open the SubMenu
utils.push_event(PlatformEvent::Mouse {
name: EventName::MouseOver,
cursor: (15.0, 130.0).into(),
button: Some(MouseButton::Left),
});
utils.wait_for_update().await;
// Check the `Option 1` button exists
assert_eq!(
utils
.root()
.get(0)
.get(1)
.get(0)
.get(2)
.get(1)
.get(0)
.get(0)
.get(0)
.get(0)
.get(0)
.text(),
Some("Option 1")
);
assert!(utils.sdom().get().layout().size() > one_submenu_opened);
// Stop showing the submenu
utils.push_event(PlatformEvent::Mouse {
name: EventName::MouseOver,
cursor: (15.0, 90.0).into(),
button: Some(MouseButton::Left),
});
utils.wait_for_update().await;
assert_eq!(utils.sdom().get().layout().size(), one_submenu_opened);
// Click somewhere also so all the menus hide
utils.push_event(PlatformEvent::Mouse {
name: EventName::Click,
cursor: (333.0, 333.0).into(),
button: Some(MouseButton::Left),
});
utils.wait_for_update().await;
assert_eq!(utils.sdom().get().layout().size(), start_size);
}
}