Files
oak-gpui/crates/workspace/src/theme_preview.rs
T
Finn Evers f393138711 Fix keybind hints flickering in certain scenarios (#40927)
Closes #39172

This refactors when we resolve UI keybindings in an effort to reduce
flickering whilst painting these: Previously, we would always resolve
these upon creating the binding. This could lead to cases where the
corresponding context was not yet available and no binding could be
resolved, even if the binding was then available on the next presented
frame. Following that, on the next rerender of whatever requested this
keybinding, the keybind for that context would then be found, we would
render that and then also win a layout shift in that process, as we went
from nothing rendered to something rendered between these frames.

With these changes, this now happens less often, because we only look
for the keybinding once the context can actually be resolved in the
window.

| Before | After | 
| --- | --- |
|
https://github.com/user-attachments/assets/adebf8ac-217d-4c7f-ae5a-bab3aa0b0ee8
|
https://github.com/user-attachments/assets/70a82b4b-488f-4a9f-94d7-b6d0a49aada9
|

Also reduced cloning in the keymap editor in this process, since that
requiered changing due to this anyway.

Release Notes:

- Fixed some cases where keybinds would appear with a slight delay,
causing a flicker in the process
2025-10-22 19:52:38 +00:00

426 lines
17 KiB
Rust

#![allow(unused, dead_code)]
use gpui::{
AnyElement, App, Entity, EventEmitter, FocusHandle, Focusable, Hsla, Task, actions, hsla,
};
use strum::IntoEnumIterator;
use theme::all_theme_colors;
use ui::{
AudioStatus, Avatar, AvatarAudioStatusIndicator, AvatarAvailabilityIndicator, ButtonLike,
Checkbox, CheckboxWithLabel, CollaboratorAvailability, ContentGroup, DecoratedIcon,
ElevationIndex, Facepile, IconDecoration, Indicator, KeybindingHint, Switch, TintColor,
Tooltip, prelude::*, utils::calculate_contrast_ratio,
};
use crate::{Item, Workspace};
actions!(
dev,
[
/// Opens the theme preview window.
OpenThemePreview
]
);
pub fn init(cx: &mut App) {
cx.observe_new(|workspace: &mut Workspace, _, _| {
workspace.register_action(|workspace, _: &OpenThemePreview, window, cx| {
let theme_preview = cx.new(|cx| ThemePreview::new(window, cx));
workspace.add_item_to_active_pane(Box::new(theme_preview), None, true, window, cx)
});
})
.detach();
}
#[derive(Debug, Clone, Copy, PartialEq, PartialOrd, strum::EnumIter)]
enum ThemePreviewPage {
Overview,
Typography,
}
impl ThemePreviewPage {
pub fn name(&self) -> &'static str {
match self {
Self::Overview => "Overview",
Self::Typography => "Typography",
}
}
}
struct ThemePreview {
current_page: ThemePreviewPage,
focus_handle: FocusHandle,
}
impl ThemePreview {
pub fn new(window: &mut Window, cx: &mut Context<Self>) -> Self {
Self {
current_page: ThemePreviewPage::Overview,
focus_handle: cx.focus_handle(),
}
}
pub fn view(
&self,
page: ThemePreviewPage,
window: &mut Window,
cx: &mut Context<ThemePreview>,
) -> impl IntoElement {
match page {
ThemePreviewPage::Overview => self.render_overview_page(window, cx).into_any_element(),
ThemePreviewPage::Typography => {
self.render_typography_page(window, cx).into_any_element()
}
}
}
}
impl EventEmitter<()> for ThemePreview {}
impl Focusable for ThemePreview {
fn focus_handle(&self, _: &App) -> gpui::FocusHandle {
self.focus_handle.clone()
}
}
impl ThemePreview {}
impl Item for ThemePreview {
type Event = ();
fn to_item_events(_: &Self::Event, _: impl FnMut(crate::item::ItemEvent)) {}
fn tab_content_text(&self, _detail: usize, cx: &App) -> SharedString {
let name = cx.theme().name.clone();
format!("{} Preview", name).into()
}
fn telemetry_event_text(&self) -> Option<&'static str> {
None
}
fn clone_on_split(
&self,
_workspace_id: Option<crate::WorkspaceId>,
window: &mut Window,
cx: &mut Context<Self>,
) -> Task<Option<Entity<Self>>>
where
Self: Sized,
{
Task::ready(Some(cx.new(|cx| Self::new(window, cx))))
}
}
const AVATAR_URL: &str = "https://avatars.githubusercontent.com/u/1714999?v=4";
impl ThemePreview {
fn preview_bg(window: &mut Window, cx: &mut App) -> Hsla {
cx.theme().colors().editor_background
}
fn render_text(
&self,
layer: ElevationIndex,
window: &mut Window,
cx: &mut Context<Self>,
) -> impl IntoElement {
let bg = layer.bg(cx);
let label_with_contrast = |label: &str, fg: Hsla| {
let contrast = calculate_contrast_ratio(fg, bg);
format!("{} ({:.2})", label, contrast)
};
v_flex()
.gap_1()
.child(Headline::new("Text").size(HeadlineSize::Small).color(Color::Muted))
.child(
h_flex()
.items_start()
.gap_4()
.child(
v_flex()
.gap_1()
.child(Headline::new("Headline Sizes").size(HeadlineSize::Small).color(Color::Muted))
.child(Headline::new("XLarge Headline").size(HeadlineSize::XLarge))
.child(Headline::new("Large Headline").size(HeadlineSize::Large))
.child(Headline::new("Medium Headline").size(HeadlineSize::Medium))
.child(Headline::new("Small Headline").size(HeadlineSize::Small))
.child(Headline::new("XSmall Headline").size(HeadlineSize::XSmall)),
)
.child(
v_flex()
.gap_1()
.child(Headline::new("Text Colors").size(HeadlineSize::Small).color(Color::Muted))
.child(
Label::new(label_with_contrast(
"Default Text",
Color::Default.color(cx),
))
.color(Color::Default),
)
.child(
Label::new(label_with_contrast(
"Accent Text",
Color::Accent.color(cx),
))
.color(Color::Accent),
)
.child(
Label::new(label_with_contrast(
"Conflict Text",
Color::Conflict.color(cx),
))
.color(Color::Conflict),
)
.child(
Label::new(label_with_contrast(
"Created Text",
Color::Created.color(cx),
))
.color(Color::Created),
)
.child(
Label::new(label_with_contrast(
"Deleted Text",
Color::Deleted.color(cx),
))
.color(Color::Deleted),
)
.child(
Label::new(label_with_contrast(
"Disabled Text",
Color::Disabled.color(cx),
))
.color(Color::Disabled),
)
.child(
Label::new(label_with_contrast(
"Error Text",
Color::Error.color(cx),
))
.color(Color::Error),
)
.child(
Label::new(label_with_contrast(
"Hidden Text",
Color::Hidden.color(cx),
))
.color(Color::Hidden),
)
.child(
Label::new(label_with_contrast(
"Hint Text",
Color::Hint.color(cx),
))
.color(Color::Hint),
)
.child(
Label::new(label_with_contrast(
"Ignored Text",
Color::Ignored.color(cx),
))
.color(Color::Ignored),
)
.child(
Label::new(label_with_contrast(
"Info Text",
Color::Info.color(cx),
))
.color(Color::Info),
)
.child(
Label::new(label_with_contrast(
"Modified Text",
Color::Modified.color(cx),
))
.color(Color::Modified),
)
.child(
Label::new(label_with_contrast(
"Muted Text",
Color::Muted.color(cx),
))
.color(Color::Muted),
)
.child(
Label::new(label_with_contrast(
"Placeholder Text",
Color::Placeholder.color(cx),
))
.color(Color::Placeholder),
)
.child(
Label::new(label_with_contrast(
"Selected Text",
Color::Selected.color(cx),
))
.color(Color::Selected),
)
.child(
Label::new(label_with_contrast(
"Success Text",
Color::Success.color(cx),
))
.color(Color::Success),
)
.child(
Label::new(label_with_contrast(
"Warning Text",
Color::Warning.color(cx),
))
.color(Color::Warning),
)
)
.child(
v_flex()
.gap_1()
.child(Headline::new("Wrapping Text").size(HeadlineSize::Small).color(Color::Muted))
.child(
div().max_w(px(200.)).child(
"This is a longer piece of text that should wrap to multiple lines. It demonstrates how text behaves when it exceeds the width of its container."
))
)
)
}
fn render_colors(
&self,
layer: ElevationIndex,
window: &mut Window,
cx: &mut Context<Self>,
) -> impl IntoElement {
let bg = layer.bg(cx);
let all_colors = all_theme_colors(cx);
v_flex()
.gap_1()
.child(
Headline::new("Colors")
.size(HeadlineSize::Small)
.color(Color::Muted),
)
.child(
h_flex()
.flex_wrap()
.gap_1()
.children(all_colors.into_iter().map(|(color, name)| {
let id = ElementId::Name(format!("{:?}-preview", color).into());
div().size_8().flex_none().child(
ButtonLike::new(id)
.child(
div()
.size_8()
.bg(color)
.border_1()
.border_color(cx.theme().colors().border)
.overflow_hidden(),
)
.size(ButtonSize::None)
.style(ButtonStyle::Transparent)
.tooltip(move |window, cx| {
let name = name.clone();
Tooltip::with_meta(name, None, format!("{:?}", color), cx)
}),
)
})),
)
}
fn render_theme_layer(
&self,
layer: ElevationIndex,
window: &mut Window,
cx: &mut Context<Self>,
) -> impl IntoElement {
v_flex()
.p_4()
.bg(layer.bg(cx))
.text_color(cx.theme().colors().text)
.gap_2()
.child(Headline::new(layer.clone().to_string()).size(HeadlineSize::Medium))
.child(self.render_text(layer, window, cx))
.child(self.render_colors(layer, window, cx))
}
fn render_overview_page(
&self,
window: &mut Window,
cx: &mut Context<Self>,
) -> impl IntoElement {
v_flex()
.id("theme-preview-overview")
.overflow_scroll()
.size_full()
.child(
v_flex()
.child(Headline::new("Theme Preview").size(HeadlineSize::Large))
.child(div().w_full().text_color(cx.theme().colors().text_muted).child("This view lets you preview a range of UI elements across a theme. Use it for testing out changes to the theme."))
)
.child(self.render_theme_layer(ElevationIndex::Background, window, cx))
.child(self.render_theme_layer(ElevationIndex::Surface, window, cx))
.child(self.render_theme_layer(ElevationIndex::EditorSurface, window, cx))
.child(self.render_theme_layer(ElevationIndex::ElevatedSurface, window, cx))
}
fn render_typography_page(
&self,
window: &mut Window,
cx: &mut Context<Self>,
) -> impl IntoElement {
v_flex()
.id("theme-preview-typography")
.overflow_scroll()
.size_full()
.child(v_flex()
.gap_4()
.child(Headline::new("Headline 1").size(HeadlineSize::XLarge))
.child(Label::new("Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."))
.child(Headline::new("Headline 2").size(HeadlineSize::Large))
.child(Label::new("Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."))
.child(Headline::new("Headline 3").size(HeadlineSize::Medium))
.child(Label::new("Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur."))
.child(Headline::new("Headline 4").size(HeadlineSize::Small))
.child(Label::new("Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."))
.child(Headline::new("Headline 5").size(HeadlineSize::XSmall))
.child(Label::new("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."))
.child(Headline::new("Body Text").size(HeadlineSize::Small))
.child(Label::new("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."))
)
}
fn render_page_nav(&self, window: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
h_flex()
.id("theme-preview-nav")
.items_center()
.gap_4()
.py_2()
.bg(Self::preview_bg(window, cx))
.children(ThemePreviewPage::iter().map(|p| {
Button::new(ElementId::Name(p.name().into()), p.name())
.on_click(cx.listener(move |this, _, window, cx| {
this.current_page = p;
cx.notify();
}))
.toggle_state(p == self.current_page)
.selected_style(ButtonStyle::Tinted(TintColor::Accent))
}))
}
}
impl Render for ThemePreview {
fn render(&mut self, window: &mut Window, cx: &mut Context<Self>) -> impl ui::IntoElement {
v_flex()
.id("theme-preview")
.key_context("ThemePreview")
.items_start()
.overflow_hidden()
.size_full()
.max_h_full()
.track_focus(&self.focus_handle)
.px_2()
.bg(Self::preview_bg(window, cx))
.child(self.render_page_nav(window, cx))
.child(self.view(self.current_page, window, cx))
}
}