use std::{cell::RefCell, rc::Rc};
use gpui::{
Anchor, AnyElement, App, Background, Bounds, ClickEvent, Edges, ElementId, Entity, EntityId,
InteractiveElement, IntoElement, ParentElement, Pixels, RenderOnce, ScrollHandle, SharedString,
StatefulInteractiveElement as _, StyleRefinement, Styled, Window, div, point,
prelude::FluentBuilder as _, px,
};
use gpui_base::spring;
use rust_i18n::t;
use smallvec::SmallVec;
use super::{Tab, TabVariant};
use crate::button::{Button, ButtonVariants as _};
use crate::menu::{DropdownMenu as _, PopupMenuItem};
use crate::{
ActiveTheme, ElementExt, Icon, InteractiveElementExt as _, Selectable, Sizable, Size,
StyledExt, h_flex, styled::raised_shadow,
};
struct TabIndicatorBounds {
container: Bounds<Pixels>,
tabs: Vec<Bounds<Pixels>>,
}
impl TabIndicatorBounds {
fn new(num_tabs: usize) -> Self {
Self {
container: Bounds::default(),
tabs: vec![Bounds::default(); num_tabs],
}
}
fn resize(&mut self, num_tabs: usize) {
self.tabs.resize(num_tabs, Bounds::default());
}
}
#[derive(IntoElement)]
pub struct TabBar {
id: ElementId,
base: gpui_base::Tabs,
style: StyleRefinement,
scroll_handle: Option<ScrollHandle>,
prefix: Option<AnyElement>,
suffix: Option<AnyElement>,
children: SmallVec<[Tab; 2]>,
last_empty_space: AnyElement,
selected_index: Option<usize>,
variant: TabVariant,
size: Size,
menu: bool,
max_width: Option<Pixels>,
on_click: Option<Rc<dyn Fn(&usize, &mut Window, &mut App) + 'static>>,
}
impl TabBar {
pub fn new(id: impl Into<ElementId>) -> Self {
let id = id.into();
Self {
id: id.clone(),
base: gpui_base::Tabs::new(id).px(px(-1.)),
style: StyleRefinement::default(),
children: SmallVec::new(),
scroll_handle: None,
prefix: None,
suffix: None,
variant: TabVariant::default(),
size: Size::default(),
last_empty_space: div().w_3().into_any_element(),
selected_index: None,
on_click: None,
menu: false,
max_width: None,
}
}
pub fn with_variant(mut self, variant: TabVariant) -> Self {
self.variant = variant;
self
}
pub fn pill(mut self) -> Self {
self.variant = TabVariant::Pill;
self
}
pub fn outline(mut self) -> Self {
self.variant = TabVariant::Outline;
self
}
pub fn segmented(mut self) -> Self {
self.variant = TabVariant::Segmented;
self
}
pub fn underline(mut self) -> Self {
self.variant = TabVariant::Underline;
self
}
pub fn menu(mut self, menu: bool) -> Self {
self.menu = menu;
self
}
pub fn max_width(mut self, width: impl Into<Pixels>) -> Self {
self.max_width = Some(width.into());
self
}
pub fn track_scroll(mut self, scroll_handle: &ScrollHandle) -> Self {
self.scroll_handle = Some(scroll_handle.clone());
self
}
pub fn prefix(mut self, prefix: impl IntoElement) -> Self {
self.prefix = Some(prefix.into_any_element());
self
}
pub fn suffix(mut self, suffix: impl IntoElement) -> Self {
self.suffix = Some(suffix.into_any_element());
self
}
pub fn children(mut self, children: impl IntoIterator<Item = impl Into<Tab>>) -> Self {
self.children.extend(children.into_iter().map(Into::into));
self
}
pub fn child(mut self, child: impl Into<Tab>) -> Self {
self.children.push(child.into());
self
}
pub fn selected_index(mut self, index: usize) -> Self {
self.selected_index = Some(index);
self
}
pub fn last_empty_space(mut self, last_empty_space: impl IntoElement) -> Self {
self.last_empty_space = last_empty_space.into_any_element();
self
}
pub fn on_click<F>(mut self, on_click: F) -> Self
where
F: Fn(&usize, &mut Window, &mut App) + 'static,
{
self.on_click = Some(Rc::new(on_click));
self
}
fn render_indicator(
&self,
bounds_rc: &Option<Rc<RefCell<TabIndicatorBounds>>>,
window: &mut Window,
cx: &mut App,
) -> Option<(AnyElement, u64)> {
let has_indicator = matches!(
self.variant,
TabVariant::Segmented | TabVariant::Pill | TabVariant::Underline
);
let num_tabs = self.children.len();
let selected_ix = self.selected_index.unwrap_or(usize::MAX);
if !(has_indicator && num_tabs > 0 && selected_ix < num_tabs) {
return None;
}
let prev_key = format!("{}-tab-prev", self.id);
let anim_key = format!("{}-tab-anim", self.id);
let init_key = format!("{}-tab-init", self.id);
let prev_selected = window.use_keyed_state(prev_key, cx, |_, _| selected_ix);
let anim_params = window.use_keyed_state(anim_key, cx, |_, _| (px(0.), px(0.), 0u64));
let initialized = window.use_keyed_state(init_key, cx, |_, _| false);
if !*initialized.read(cx) {
initialized.update(cx, |v, _| *v = true);
}
self.update_anim_params(selected_ix, bounds_rc, &prev_selected, &anim_params, cx);
let (to_left, to_width, epoch) = *anim_params.read(cx);
if to_width <= px(0.) {
return None;
}
let indicator_key = format!("{}-tab-indicator", self.id);
let left = spring(
(indicator_key.clone(), "left"),
to_left,
cx.theme().motion_tokens().spring_move,
window,
cx,
);
let width = spring(
(indicator_key, "width"),
to_width,
cx.theme().motion_tokens().spring_move,
window,
cx,
);
let variant = self.variant;
let size = self.size;
let inner_height = variant.inner_height(size);
let inner_radius = variant.inner_radius(size, cx);
let indicator = div()
.absolute()
.top_0()
.bottom_0()
.left(left)
.w(width)
.map(|el| match variant {
TabVariant::Segmented => el.flex().items_center().child(
div()
.w_full()
.h(inner_height)
.bg(cx.theme().tokens.background)
.rounded(inner_radius)
.shadow(raised_shadow()),
),
TabVariant::Pill => el.flex().items_center().child(
div()
.size_full()
.bg(cx.theme().tokens.primary)
.rounded(cx.theme().radius_full()),
),
TabVariant::Underline => el.child(
div()
.absolute()
.left_0()
.right_0()
.bottom_0()
.h(px(2.))
.bg(cx.theme().tokens.primary),
),
_ => el,
});
Some((indicator.into_any_element(), epoch))
}
fn update_anim_params(
&self,
selected_ix: usize,
bounds_rc: &Option<Rc<RefCell<TabIndicatorBounds>>>,
prev_selected: &gpui::Entity<usize>,
anim_params: &gpui::Entity<(Pixels, Pixels, u64)>,
cx: &mut App,
) {
let rc = match bounds_rc {
Some(rc) => rc,
None => return,
};
let prev_ix = *prev_selected.read(cx);
let bounds = rc.borrow();
let container = bounds.container;
if container.size.width == px(0.) {
if prev_ix != selected_ix {
prev_selected.update(cx, |v, _| *v = selected_ix);
}
return;
}
let first_tab_origin = bounds
.tabs
.first()
.map(|tab| tab.origin.x)
.unwrap_or(container.origin.x);
if prev_ix != selected_ix {
if let Some(to_b) = bounds.tabs.get(selected_ix) {
let left = to_b.origin.x - first_tab_origin;
let width = to_b.size.width;
let epoch = anim_params.read(cx).2;
let epoch = match bounds.tabs.get(prev_ix) {
Some(_) => epoch + 1,
None => epoch,
};
anim_params.update(cx, |v, _| *v = (left, width, epoch));
}
drop(bounds);
prev_selected.update(cx, |v, _| *v = selected_ix);
return;
}
if let Some(to_b) = bounds.tabs.get(selected_ix) {
let left = to_b.origin.x - first_tab_origin;
let width = to_b.size.width;
let (to_left, to_width, epoch) = *anim_params.read(cx);
if left != to_left || width != to_width {
anim_params.update(cx, |v, _| *v = (left, width, epoch));
}
}
}
}
impl Styled for TabBar {
fn style(&mut self) -> &mut StyleRefinement {
&mut self.style
}
}
impl Sizable for TabBar {
fn with_size(mut self, size: impl Into<Size>) -> Self {
self.size = size.into();
self
}
}
impl RenderOnce for TabBar {
fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement {
let default_gap = match self.size {
Size::Small | Size::XSmall => px(8.),
Size::Large => px(16.),
_ => px(12.),
};
let (bg, paddings, gap): (Background, _, _) = match self.variant {
TabVariant::Tab => {
let padding = Edges::all(px(0.));
(cx.theme().tokens.tab_bar.into(), padding, px(0.))
}
TabVariant::Outline => {
let padding = Edges::all(px(0.));
(cx.theme().transparent.into(), padding, default_gap)
}
TabVariant::Pill => {
let padding = Edges::all(px(0.));
(cx.theme().transparent.into(), padding, px(4.))
}
TabVariant::Segmented => {
let padding_x = match self.size {
Size::XSmall => px(2.),
Size::Small => px(3.),
_ => px(4.),
};
let padding = Edges {
left: padding_x,
right: padding_x,
..Default::default()
};
(cx.theme().tokens.tab_bar_segmented.into(), padding, px(2.))
}
TabVariant::Underline => {
let gap = match self.size {
Size::XSmall => px(10.),
Size::Small => px(12.),
Size::Large => px(20.),
_ => px(16.),
};
(cx.theme().transparent.into(), Edges::all(px(0.)), gap)
}
};
let has_indicator = matches!(
self.variant,
TabVariant::Segmented | TabVariant::Pill | TabVariant::Underline
);
let num_tabs = self.children.len();
let bounds_rc = if has_indicator && num_tabs > 0 {
let rc: Rc<RefCell<TabIndicatorBounds>> = window
.use_keyed_state(format!("{}-tab-bounds", self.id), cx, |_, _| {
Rc::new(RefCell::new(TabIndicatorBounds::new(num_tabs)))
})
.read(cx)
.clone();
rc.borrow_mut().resize(num_tabs);
Some(rc)
} else {
None
};
let scroll_handle = self.scroll_handle.clone().unwrap_or_else(|| {
window
.use_keyed_state(format!("{}-scroll", self.id), cx, |_, _| {
ScrollHandle::new()
})
.read(cx)
.clone()
});
let reveal = TabReveal {
spring_id: format!("{}-reveal", self.id).into(),
target: window.use_keyed_state(format!("{}-reveal", self.id), cx, |_, _| None),
scroll_handle: scroll_handle.clone(),
view: window.current_view(),
peek: match self.size {
Size::XSmall | Size::Small => px(24.),
Size::Large => px(40.),
_ => px(32.),
},
num_tabs,
};
reveal.advance(window, cx);
let padding_x = paddings.left;
let indicator = self.render_indicator(&bounds_rc, window, cx);
let indicator_epoch = indicator.as_ref().map(|(_, epoch)| *epoch).unwrap_or(0);
let mut indicator_element = indicator.map(|(el, _)| el);
let indicator_ready = indicator_element.is_some();
let has_suffix_or_menu = self.suffix.is_some() || self.menu;
let mut item_metas: Vec<(Option<SharedString>, Option<Icon>, bool)> = Vec::new();
let selected_index = self.selected_index;
let on_click = self.on_click.clone();
let tabs = self.base;
let mut rendered_tabs = Vec::with_capacity(self.children.len());
let max_width = self.max_width;
for (ix, child) in self.children.into_iter().enumerate() {
item_metas.push((child.label.clone(), child.icon.clone(), child.disabled));
let tab_bar_prefix = child.tab_bar_prefix.unwrap_or(true);
let mut tab = child
.ix(ix)
.tab_bar_prefix(tab_bar_prefix)
.max_width(max_width)
.with_variant(self.variant)
.with_size(self.size);
tab.indicator_active = has_indicator;
tab.indicator_ready = indicator_ready;
tab.indicator_epoch = indicator_epoch;
let mut tab = tab
.when_some(selected_index, |tab, selected_index| {
tab.selected(selected_index == ix)
})
.map(|mut tab| {
let on_click: Option<TabClickHandler> = match self.on_click.clone() {
Some(on_click) => {
Some(Rc::new(move |_, window, cx| on_click(&ix, window, cx)))
}
None => tab.on_click.take(),
};
tab.on_click = on_click.map(|on_click| {
let reveal = reveal.clone();
Rc::new(
move |event: &ClickEvent, window: &mut Window, cx: &mut App| {
reveal.reveal(ix, cx);
on_click(event, window, cx)
},
) as TabClickHandler
});
tab
});
let flex_grow = tab.style().flex_grow;
let flex_basis = tab.style().flex_basis;
rendered_tabs.push(if let Some(ref rc) = bounds_rc {
let rc = rc.clone();
div()
.flex_shrink_0()
.map(|mut this| {
this.style().flex_grow = flex_grow;
this.style().flex_basis = flex_basis;
this
})
.on_prepaint(move |bounds, _, _| {
if let Some(slot) = rc.borrow_mut().tabs.get_mut(ix) {
*slot = bounds;
}
})
.relative()
.when(ix == 0, |this| {
this.when_some(indicator_element.take(), |this, indicator| {
this.child(indicator)
})
})
.child(tab)
.into_any_element()
} else {
tab.into_any_element()
});
}
tabs.group("tab-bar")
.relative()
.flex()
.items_center()
.bg(bg)
.text_color(cx.theme().tab_foreground)
.when(
self.variant == TabVariant::Underline || self.variant == TabVariant::Tab,
|this| {
this.child(
div()
.id("border-b")
.absolute()
.left_0()
.bottom_0()
.size_full()
.border_b_1()
.border_color(cx.theme().border),
)
},
)
.rounded(self.variant.tab_bar_radius(self.size, cx))
.paddings(paddings)
.refine_style(&self.style)
.when_some(self.prefix, |this, prefix| this.child(prefix))
.child(
h_flex()
.id("tabs")
.flex_1()
.min_w_0()
.mx(-padding_x)
.px(padding_x)
.overflow_x_hidden()
.when_some(bounds_rc.clone(), |this, rc| {
this.on_prepaint(move |bounds, _, _| {
rc.borrow_mut().container = bounds;
})
})
.child(
h_flex()
.id("tabs-inner")
.flex_1()
.relative()
.gap(gap)
.overflow_x_scroll()
.lock_scroll_axis()
.track_scroll(&scroll_handle)
.children(rendered_tabs)
.when(has_suffix_or_menu, |this| this.child(self.last_empty_space)),
),
)
.when(self.menu, |this| {
this.child(
Button::new("more")
.xsmall()
.ghost()
.dropdown_caret(true)
.dropdown_menu(move |mut this, _, _| {
this = this.scrollable(true);
for (ix, (label, icon, disabled)) in item_metas.iter().enumerate() {
let base = if let Some(label) = label.clone() {
PopupMenuItem::new(label)
} else if let Some(icon) = icon.clone() {
PopupMenuItem::element(move |_, _| icon.clone())
} else {
PopupMenuItem::new(t!("Dock.Unnamed"))
};
this = this.item(
base.checked(selected_index == Some(ix))
.disabled(*disabled)
.when_some(on_click.clone(), |this, on_click| {
let reveal = reveal.clone();
this.on_click(move |_, window, cx| {
reveal.reveal(ix, cx);
on_click(&ix, window, cx)
})
}),
);
}
this
})
.anchor(Anchor::TopRight),
)
})
.when_some(self.suffix, |this, suffix| this.child(suffix))
}
}
type TabClickHandler = Rc<dyn Fn(&ClickEvent, &mut Window, &mut App) + 'static>;
#[derive(Clone)]
struct TabReveal {
spring_id: SharedString,
target: Entity<Option<RevealTarget>>,
scroll_handle: ScrollHandle,
view: EntityId,
peek: Pixels,
num_tabs: usize,
}
#[derive(Clone, Copy)]
struct RevealTarget {
to: Pixels,
last: Option<Pixels>,
}
impl TabReveal {
fn reveal(&self, ix: usize, cx: &mut App) {
let Some(to) = self.offset_revealing(ix) else {
return;
};
let running = self.target.read(cx).is_some();
if !running && to == self.scroll_handle.offset().x {
return;
}
self.target.update(cx, |target, _| match target {
Some(target) => target.to = to,
None => *target = Some(RevealTarget { to, last: None }),
});
cx.notify(self.view);
}
fn offset_revealing(&self, ix: usize) -> Option<Pixels> {
let handle = &self.scroll_handle;
let viewport = handle.bounds();
let tab = handle.bounds_for_item(ix)?;
let max = handle.max_offset().x;
let want_left = match ix.checked_sub(1).and_then(|ix| handle.bounds_for_item(ix)) {
Some(prev) => (prev.right() - self.peek).max(prev.left()),
None => viewport.left(),
};
let want_right = match (ix + 1 < self.num_tabs)
.then(|| handle.bounds_for_item(ix + 1))
.flatten()
{
Some(next) => (next.left() + self.peek).min(next.right()),
None => viewport.right() + max,
};
let mut offset = handle.offset().x;
let show_left = |offset: &mut Pixels, left: Pixels| {
if left < viewport.left() - *offset {
*offset = viewport.left() - left;
}
};
let show_right = |offset: &mut Pixels, right: Pixels| {
if right > viewport.right() - *offset {
*offset = viewport.right() - right;
}
};
if tab.center().x + offset > viewport.center().x {
show_left(&mut offset, want_left);
show_right(&mut offset, want_right);
} else {
show_right(&mut offset, want_right);
show_left(&mut offset, want_left);
}
show_right(&mut offset, tab.right());
show_left(&mut offset, tab.left());
Some(offset.min(px(0.)).max(-max))
}
fn advance(&self, window: &mut Window, cx: &mut App) {
let Some(target) = *self.target.read(cx) else {
return;
};
let offset = self.scroll_handle.offset();
if target.last.is_some_and(|last| last != offset.x) {
self.target.update(cx, |target, _| *target = None);
return;
}
let policy = cx.theme().motion_tokens().spring_move;
if target.last.is_none() {
spring(
self.spring_id.clone(),
offset.x,
policy.with_travel(false),
window,
cx,
);
}
let x = spring(self.spring_id.clone(), target.to, policy, window, cx);
self.scroll_handle.set_offset(point(x, offset.y));
self.target.update(cx, |state, _| {
*state = (x != target.to).then_some(RevealTarget {
last: Some(x),
..target
})
});
}
}
#[cfg(test)]
mod tests {
use std::{cell::Cell, rc::Rc};
use gpui::{Context, Modifiers, Render, TestAppContext};
use super::*;
struct Harness {
group_handler: bool,
disabled: bool,
child_clicks: Rc<Cell<usize>>,
group_clicks: Rc<Cell<usize>>,
}
impl Render for Harness {
fn render(&mut self, _: &mut Window, _: &mut Context<Self>) -> impl IntoElement {
let child_clicks = self.child_clicks.clone();
let group_clicks = self.group_clicks.clone();
TabBar::new("tabs")
.w(px(240.))
.child(
Tab::new()
.debug_selector(|| "first-tab".into())
.disabled(self.disabled)
.label("First")
.on_click(move |_, _, _| child_clicks.set(child_clicks.get() + 1)),
)
.when(self.group_handler, |tabs| {
tabs.on_click(move |ix, _, _| group_clicks.set(*ix + 1))
})
}
}
fn harness(
cx: &mut TestAppContext,
group_handler: bool,
disabled: bool,
) -> (
&mut gpui::VisualTestContext,
Rc<Cell<usize>>,
Rc<Cell<usize>>,
) {
cx.update(crate::theme::init);
let child_clicks = Rc::new(Cell::new(0));
let group_clicks = Rc::new(Cell::new(0));
let (_, cx) = cx.add_window_view({
let child_clicks = child_clicks.clone();
let group_clicks = group_clicks.clone();
move |_, _| Harness {
group_handler,
disabled,
child_clicks,
group_clicks,
}
});
cx.update(|window, cx| window.draw(cx).clear(cx));
(cx, child_clicks, group_clicks)
}
#[gpui::test]
fn group_callback_overrides_child_callback(cx: &mut TestAppContext) {
let (cx, child_clicks, group_clicks) = harness(cx, true, false);
let position = cx.debug_bounds("first-tab").unwrap().center();
cx.simulate_click(position, Modifiers::default());
assert_eq!(child_clicks.get(), 0);
assert_eq!(group_clicks.get(), 1);
}
#[gpui::test]
fn child_callback_is_preserved_without_group_callback(cx: &mut TestAppContext) {
let (cx, child_clicks, group_clicks) = harness(cx, false, false);
let position = cx.debug_bounds("first-tab").unwrap().center();
cx.simulate_click(position, Modifiers::default());
assert_eq!(child_clicks.get(), 1);
assert_eq!(group_clicks.get(), 0);
}
#[gpui::test]
fn disabled_tab_suppresses_child_and_group_callbacks(cx: &mut TestAppContext) {
let (cx, child_clicks, group_clicks) = harness(cx, true, true);
let position = cx.debug_bounds("first-tab").unwrap().center();
cx.simulate_click(position, Modifiers::default());
assert_eq!(child_clicks.get(), 0);
assert_eq!(group_clicks.get(), 0);
}
struct ContentHarness;
impl Render for ContentHarness {
fn render(&mut self, _: &mut Window, _: &mut Context<Self>) -> impl IntoElement {
TabBar::new("content-tabs").w(px(320.)).child(
Tab::new()
.prefix(div().debug_selector(|| "tab-prefix".into()).child("P"))
.child(div().debug_selector(|| "tab-child".into()).child("Content"))
.suffix(div().debug_selector(|| "tab-suffix".into()).child("S")),
)
}
}
#[gpui::test]
fn prefix_content_and_suffix_keep_their_order(cx: &mut TestAppContext) {
cx.update(crate::theme::init);
let (_, cx) = cx.add_window_view(|_, _| ContentHarness);
cx.update(|window, cx| window.draw(cx).clear(cx));
let prefix = cx.debug_bounds("tab-prefix").unwrap();
let child = cx.debug_bounds("tab-child").unwrap();
let suffix = cx.debug_bounds("tab-suffix").unwrap();
assert!(prefix.origin.x < child.origin.x);
assert!(child.origin.x < suffix.origin.x);
assert!(prefix.size.width > px(0.));
assert!(child.size.width > px(0.));
assert!(suffix.size.width > px(0.));
}
struct ScrollHarness {
scroll_handle: ScrollHandle,
}
struct DynamicScrollHarness {
scroll_handle: ScrollHandle,
menu: bool,
size: Size,
tabs: usize,
selected_index: usize,
}
struct ManualScrollHarness {
scroll_handle: ScrollHandle,
tabs: usize,
selected_index: usize,
label: &'static str,
top: Pixels,
}
impl ScrollHarness {
fn tabs() -> impl Iterator<Item = Tab> {
(0..5).map(|ix| {
Tab::new()
.w(px(60.))
.label(format!("Tab {ix}"))
.debug_selector(move || format!("tab-{ix}"))
})
}
}
impl Render for ScrollHarness {
fn render(&mut self, _: &mut Window, _: &mut Context<Self>) -> impl IntoElement {
div().w(px(100.)).child(
TabBar::new("scrolling-tabs")
.w_full()
.segmented()
.menu(true)
.track_scroll(&self.scroll_handle)
.selected_index(4)
.children(Self::tabs()),
)
}
}
impl DynamicScrollHarness {
fn tabs(&self) -> impl Iterator<Item = Tab> {
(0..self.tabs).map(|ix| {
Tab::new()
.w(px(60.))
.label(format!("Tab {ix}"))
.debug_selector(move || format!("dynamic-tab-{ix}"))
})
}
}
impl Render for DynamicScrollHarness {
fn render(&mut self, _: &mut Window, _: &mut Context<Self>) -> impl IntoElement {
div()
.w(px(100.))
.debug_selector(|| "dynamic-bar".into())
.child(
TabBar::new("dynamic-scrolling-tabs")
.with_size(self.size)
.w_full()
.segmented()
.menu(self.menu)
.track_scroll(&self.scroll_handle)
.selected_index(self.selected_index)
.children(self.tabs()),
)
}
}
impl ManualScrollHarness {
fn tabs(&self) -> impl Iterator<Item = Tab> {
let width = if self.label == "old" {
px(60.)
} else {
px(120.)
};
let label = self.label;
(0..self.tabs).map(move |ix| {
Tab::new()
.w(width)
.label(format!("Tab {ix} {label}"))
.debug_selector(move || format!("manual-tab-{ix}"))
})
}
}
impl Render for ManualScrollHarness {
fn render(&mut self, _: &mut Window, _: &mut Context<Self>) -> impl IntoElement {
div().w(px(160.)).h(px(40.)).child(
div().relative().top(self.top).w_full().child(
TabBar::new("manual-scrolling-tabs")
.w_full()
.segmented()
.menu(true)
.track_scroll(&self.scroll_handle)
.selected_index(self.selected_index)
.children(self.tabs()),
),
)
}
}
fn draw(cx: &mut gpui::VisualTestContext) {
cx.run_until_parked();
cx.update(|window, cx| window.draw(cx).clear(cx));
}
#[gpui::test]
fn scrolling_to_a_tab_uses_logical_tab_indices(cx: &mut TestAppContext) {
cx.update(crate::theme::init);
let scroll_handle = ScrollHandle::new();
let (_, cx) = cx.add_window_view({
let scroll_handle = scroll_handle.clone();
move |_, _| ScrollHarness { scroll_handle }
});
draw(cx);
draw(cx);
assert_eq!(scroll_handle.offset().x, px(0.));
scroll_handle.scroll_to_item(4);
draw(cx);
draw(cx);
let viewport = scroll_handle.bounds();
let last_tab = cx.debug_bounds("tab-4").unwrap();
assert!(
last_tab.left() >= viewport.left(),
"last tab {last_tab:?} is left of viewport {viewport:?}, offset {:?}",
scroll_handle.offset()
);
assert!(
last_tab.right() <= viewport.right(),
"last tab {last_tab:?} is right of viewport {viewport:?}, offset {:?}",
scroll_handle.offset()
);
assert_eq!(scroll_handle.children_count(), 6);
}
#[gpui::test]
fn scrolling_to_a_new_tab_preserves_the_explicit_target(cx: &mut TestAppContext) {
cx.update(crate::theme::init);
let scroll_handle = ScrollHandle::new();
let (view, cx) = cx.add_window_view({
let scroll_handle = scroll_handle.clone();
move |_, _| DynamicScrollHarness {
scroll_handle,
menu: true,
size: Size::default(),
tabs: 4,
selected_index: 3,
}
});
draw(cx);
draw(cx);
view.update(cx, |view, cx| {
view.tabs = 5;
view.selected_index = 4;
view.scroll_handle.scroll_to_item(4);
cx.notify();
});
draw(cx);
let viewport = scroll_handle.bounds();
let last_tab = cx.debug_bounds("dynamic-tab-4").unwrap();
assert!(last_tab.left() >= viewport.left());
assert!(last_tab.right() <= viewport.right());
assert_eq!(scroll_handle.children_count(), 6);
}
#[gpui::test]
fn scrolling_to_a_new_tab_preserves_bar_padding(cx: &mut TestAppContext) {
cx.update(crate::theme::init);
for (size, padding) in [
(Size::XSmall, px(2.)),
(Size::Small, px(3.)),
(Size::Medium, px(4.)),
(Size::Large, px(4.)),
] {
let scroll_handle = ScrollHandle::new();
let (view, cx) = cx.add_window_view({
let scroll_handle = scroll_handle.clone();
move |_, _| DynamicScrollHarness {
scroll_handle,
menu: false,
size,
tabs: 4,
selected_index: 0,
}
});
draw(cx);
draw(cx);
view.update(cx, |view, cx| {
view.tabs = 5;
view.scroll_handle.scroll_to_item(4);
cx.notify();
});
draw(cx);
draw(cx);
let bar = cx.debug_bounds("dynamic-bar").unwrap();
let last_tab = cx.debug_bounds("dynamic-tab-4").unwrap();
assert_eq!(
bar.right() - last_tab.right(),
padding,
"right padding for {size:?}"
);
scroll_handle.scroll_to_item(0);
draw(cx);
draw(cx);
let first_tab = cx.debug_bounds("dynamic-tab-0").unwrap();
assert_eq!(
first_tab.left() - bar.left(),
padding,
"left padding for {size:?}"
);
assert_eq!(scroll_handle.children_count(), 5);
}
}
#[gpui::test]
fn closing_an_unselected_trailing_tab_preserves_manual_scrolling(cx: &mut TestAppContext) {
cx.update(crate::theme::init);
let scroll_handle = ScrollHandle::new();
let (view, cx) = cx.add_window_view({
let scroll_handle = scroll_handle.clone();
move |_, _| ManualScrollHarness {
scroll_handle,
tabs: 6,
selected_index: 0,
label: "old",
top: px(0.),
}
});
draw(cx);
scroll_handle.set_offset(gpui::point(px(-100.), px(0.)));
draw(cx);
assert_eq!(scroll_handle.offset().x, px(-100.));
view.update(cx, |view, cx| {
view.tabs = 5;
cx.notify();
});
draw(cx);
assert_eq!(scroll_handle.offset().x, px(-100.));
}
#[gpui::test]
fn changing_selection_does_not_move_manual_scrolling(cx: &mut TestAppContext) {
cx.update(crate::theme::init);
let scroll_handle = ScrollHandle::new();
let (view, cx) = cx.add_window_view({
let scroll_handle = scroll_handle.clone();
move |_, _| ManualScrollHarness {
scroll_handle,
tabs: 6,
selected_index: 0,
label: "old",
top: px(0.),
}
});
draw(cx);
scroll_handle.set_offset(gpui::point(px(-100.), px(0.)));
draw(cx);
view.update(cx, |view, cx| {
view.selected_index = 5;
cx.notify();
});
draw(cx);
assert_eq!(scroll_handle.offset().x, px(-100.));
}
#[gpui::test]
fn changing_tab_labels_does_not_move_manual_scrolling(cx: &mut TestAppContext) {
cx.update(crate::theme::init);
let scroll_handle = ScrollHandle::new();
let (view, cx) = cx.add_window_view({
let scroll_handle = scroll_handle.clone();
move |_, _| ManualScrollHarness {
scroll_handle,
tabs: 6,
selected_index: 0,
label: "old",
top: px(0.),
}
});
draw(cx);
scroll_handle.set_offset(gpui::point(px(-100.), px(0.)));
draw(cx);
view.update(cx, |view, cx| {
view.label = "new";
cx.notify();
});
draw(cx);
assert_eq!(scroll_handle.offset().x, px(-100.));
}
#[gpui::test]
fn moving_the_tab_bar_preserves_manual_scrolling(cx: &mut TestAppContext) {
cx.update(crate::theme::init);
let scroll_handle = ScrollHandle::new();
let (view, cx) = cx.add_window_view({
let scroll_handle = scroll_handle.clone();
move |_, _| ManualScrollHarness {
scroll_handle,
tabs: 6,
selected_index: 0,
label: "old",
top: px(0.),
}
});
draw(cx);
scroll_handle.set_offset(gpui::point(px(-100.), px(0.)));
draw(cx);
assert_eq!(scroll_handle.offset().x, px(-100.));
let viewport_size = scroll_handle.bounds().size;
view.update(cx, |view, cx| {
view.top = px(20.);
cx.notify();
});
draw(cx);
assert_eq!(scroll_handle.bounds().size, viewport_size);
assert_eq!(scroll_handle.offset().x, px(-100.));
}
struct FlexHarness {
variant: TabVariant,
}
impl Render for FlexHarness {
fn render(&mut self, _: &mut Window, _: &mut Context<Self>) -> impl IntoElement {
div()
.w(px(200.))
.debug_selector(|| "flex-bar".into())
.child(
TabBar::new("flex-tabs")
.w_full()
.with_variant(self.variant)
.selected_index(0)
.child(
Tab::new()
.flex_1()
.label("A")
.debug_selector(|| "flex-tab-0".into()),
)
.child(
Tab::new()
.flex_1()
.label("B")
.debug_selector(|| "flex-tab-1".into()),
),
)
}
}
#[gpui::test]
fn flex_tabs_share_the_available_width(cx: &mut TestAppContext) {
cx.update(crate::theme::init);
for variant in [
TabVariant::Tab,
TabVariant::Outline,
TabVariant::Segmented,
TabVariant::Pill,
TabVariant::Underline,
] {
let (_, cx) = cx.add_window_view(move |_, _| FlexHarness { variant });
draw(cx);
draw(cx);
let bar = cx.debug_bounds("flex-bar").unwrap();
let first = cx.debug_bounds("flex-tab-0").unwrap();
let second = cx.debug_bounds("flex-tab-1").unwrap();
assert_eq!(first.size.width, second.size.width, "{variant:?}");
assert_eq!(
first.left() - bar.left(),
bar.right() - second.right(),
"{variant:?}"
);
assert!(
bar.right() - second.right() <= px(4.),
"{variant:?}: tabs end at {:?} but the bar ends at {:?}",
second.right(),
bar.right()
);
}
}
struct ClickRevealHarness {
group_handler: bool,
scroll_handle: Option<ScrollHandle>,
}
impl Render for ClickRevealHarness {
fn render(&mut self, _: &mut Window, _: &mut Context<Self>) -> impl IntoElement {
div()
.w(px(100.))
.debug_selector(|| "click-bar".into())
.child(
TabBar::new("click-reveal-tabs")
.w_full()
.when_some(self.scroll_handle.as_ref(), |tabs, handle| {
tabs.track_scroll(handle)
})
.children((0..5).map(|ix| {
Tab::new()
.w(px(60.))
.label(format!("Tab {ix}"))
.debug_selector(move || format!("click-tab-{ix}"))
.on_click(|_, _, _| {})
}))
.when(self.group_handler, |tabs| tabs.on_click(|_, _, _| {})),
)
}
}
fn click_reveal_harness(
cx: &mut TestAppContext,
group_handler: bool,
scroll_handle: Option<ScrollHandle>,
reduce_motion: bool,
) -> &mut gpui::VisualTestContext {
cx.update(|cx| {
crate::theme::init(cx);
cx.set_reduce_motion(reduce_motion);
});
let (_, cx) = cx.add_window_view(move |_, _| ClickRevealHarness {
group_handler,
scroll_handle,
});
draw(cx);
cx
}
fn next_frame(cx: &mut gpui::VisualTestContext) {
cx.executor()
.advance_clock(std::time::Duration::from_millis(16));
cx.update(|window, cx| window.simulate_next_frame(cx));
draw(cx);
}
#[gpui::test]
fn clicking_a_clipped_tab_reveals_it_and_part_of_the_next(cx: &mut TestAppContext) {
for group_handler in [false, true] {
let cx = click_reveal_harness(cx, group_handler, None, true);
let bar = cx.debug_bounds("click-bar").unwrap();
let tab = cx.debug_bounds("click-tab-1").unwrap();
assert!(tab.right() > bar.right(), "tab 1 starts clipped");
cx.simulate_click(tab.center(), Modifiers::default());
draw(cx);
let tab = cx.debug_bounds("click-tab-1").unwrap();
let next = cx.debug_bounds("click-tab-2").unwrap();
assert!(tab.left() >= bar.left() && tab.right() <= bar.right());
assert_eq!(bar.right() - next.left(), px(32.), "group: {group_handler}");
}
}
#[gpui::test]
fn clicking_the_last_tab_reveals_the_end_of_the_bar(cx: &mut TestAppContext) {
let scroll_handle = ScrollHandle::new();
let cx = click_reveal_harness(cx, true, Some(scroll_handle.clone()), true);
scroll_handle.set_offset(gpui::point(px(-160.), px(0.)));
draw(cx);
let tab = cx.debug_bounds("click-tab-4").unwrap();
cx.simulate_click(
tab.origin + gpui::point(px(10.), px(10.)),
Modifiers::default(),
);
draw(cx);
assert_eq!(scroll_handle.offset().x, -scroll_handle.max_offset().x);
}
#[gpui::test]
fn reveal_animates_and_yields_to_manual_scrolling(cx: &mut TestAppContext) {
let scroll_handle = ScrollHandle::new();
let cx = click_reveal_harness(cx, true, Some(scroll_handle.clone()), false);
let tab = cx.debug_bounds("click-tab-1").unwrap();
cx.simulate_click(tab.center(), Modifiers::default());
draw(cx);
next_frame(cx);
let moving = scroll_handle.offset().x;
assert!(
moving < px(0.) && moving > px(-52.),
"mid-flight at {moving:?}"
);
scroll_handle.set_offset(gpui::point(px(-10.), px(0.)));
for _ in 0..30 {
next_frame(cx);
}
assert_eq!(scroll_handle.offset().x, px(-10.));
cx.simulate_click(
tab.center() - gpui::point(px(10.), px(0.)),
Modifiers::default(),
);
for _ in 0..60 {
next_frame(cx);
}
assert_eq!(scroll_handle.offset().x, px(-52.));
}
}