dan/gpui-component
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

modal: Add keyboard option to Modal to enable/disable default keyboard event. (#400)

Browse source
This commit is contained in:
ihavecoke 2024-11-08 13:50:05 +08:00 committed by GitHub
parent d4ee273bf5
commit 5aad0bf340
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 33 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
crates/story/src/modal_story.rs
View file

@ -154,6 +154,7 @@ pub struct ModalStory {
modal_overlay: bool,
model_show_close: bool,
model_padding: bool,
model_keyboard: bool,
}
impl super::Story for ModalStory {
@ -274,6 +275,7 @@ impl ModalStory {
modal_overlay: true,
model_show_close: true,
model_padding: true,
model_keyboard: true,
}
}
@ -335,11 +337,13 @@ impl ModalStory {
let date_picker = self.date_picker.clone();
let dropdown = self.dropdown.clone();
let view = cx.view().clone();
let keyboard = self.model_keyboard;
cx.open_modal(move |modal, _| {
modal
.title("Form Modal")
.overlay(overlay)
.keyboard(keyboard)
.show_close(modal_show_close)
.when(!modal_padding, |this| this.p(px(0.)))
.child(
@ -448,6 +452,15 @@ impl Render for ModalStory {
view.model_padding = !view.model_padding;
cx.notify();
})),
)
.child(
Checkbox::new("modal-keyboard")
.label("Keyboard")
.checked(self.model_keyboard)
.on_click(cx.listener(|view, _, cx| {
view.model_keyboard = !view.model_keyboard;
cx.notify();
})),
),
)
.child(

30
crates/ui/src/modal.rs
View file

@ -34,6 +34,7 @@ pub struct Modal {
on_close: Rc<dyn Fn(&ClickEvent, &mut WindowContext) + 'static>,
show_close: bool,
overlay: bool,
keyboard: bool,
/// This will be change when open the modal, the focus handle is create when open the modal.
pub(crate) focus_handle: FocusHandle,
@ -75,6 +76,7 @@ impl Modal {
width: px(480.),
max_width: None,
overlay: true,
keyboard: true,
layer_ix: 0,
overlay_visible: true,
on_close: Rc::new(|_, _| {}),
@ -133,6 +135,12 @@ impl Modal {
self
}
/// Set whether to support keyboard esc to close the modal, defaults to `true`.
pub fn keyboard(mut self, keyboard: bool) -> Self {
self.keyboard = keyboard;
self
}
pub(crate) fn has_overlay(&self) -> bool {
self.overlay
}
@ -185,16 +193,18 @@ impl RenderOnce for Modal {
.id(SharedString::from(format!("modal-{layer_ix}")))
.key_context(CONTEXT)
.track_focus(&self.focus_handle)
.on_action({
let on_close = self.on_close.clone();
move |_: &Escape, cx| {
// FIXME:
//
// Here some Modal have no focus_handle, so it will not work will Escape key.
// But by now, we `cx.close_modal()` going to close the last active model, so the Escape is unexpected to work.
on_close(&ClickEvent::default(), cx);
cx.close_modal();
}
.when(self.keyboard, |this| {
this.on_action({
let on_close = self.on_close.clone();
move |_: &Escape, cx| {
// FIXME:
//
// Here some Modal have no focus_handle, so it will not work will Escape key.
// But by now, we `cx.close_modal()` going to close the last active model, so the Escape is unexpected to work.
on_close(&ClickEvent::default(), cx);
cx.close_modal();
}
})
})
.absolute()
.occlude()