use gpui::{AnyView, DefiniteLength, Hsla}; use super::button_like::{ButtonCommon, ButtonLike, ButtonSize, ButtonStyle}; use crate::{ElevationIndex, Indicator, SelectableButton, TintColor, prelude::*}; use crate::{IconName, IconSize}; use super::button_icon::ButtonIcon; /// The shape of an [`IconButton`]. #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy)] pub enum IconButtonShape { Square, Wide, } #[derive(IntoElement, RegisterComponent)] pub struct IconButton { base: ButtonLike, shape: IconButtonShape, icon: IconName, icon_size: IconSize, icon_color: Color, selected_icon: Option, selected_icon_color: Option, indicator: Option, indicator_border_color: Option, alpha: Option, } impl IconButton { pub fn new(id: impl Into, icon: IconName) -> Self { let mut this = Self { base: ButtonLike::new(id), shape: IconButtonShape::Square, icon, icon_size: IconSize::Small, icon_color: Color::Default, selected_icon: None, selected_icon_color: None, indicator: None, indicator_border_color: None, alpha: None, }; this.base.base = this.base.base.debug_selector(|| format!("ICON-{:?}", icon)); this } pub fn shape(mut self, shape: IconButtonShape) -> Self { self.shape = shape; self } pub fn icon_size(mut self, icon_size: IconSize) -> Self { self.icon_size = icon_size; self } pub fn icon_color(mut self, icon_color: Color) -> Self { self.icon_color = icon_color; self } pub fn alpha(mut self, alpha: f32) -> Self { self.alpha = Some(alpha); self } pub fn selected_icon(mut self, icon: impl Into>) -> Self { self.selected_icon = icon.into(); self } pub fn on_right_click( mut self, handler: impl Fn(&gpui::ClickEvent, &mut Window, &mut App) + 'static, ) -> Self { self.base = self.base.on_right_click(handler); self } /// Sets the icon color used when the button is in a selected state. pub fn selected_icon_color(mut self, color: impl Into>) -> Self { self.selected_icon_color = color.into(); self } pub fn indicator(mut self, indicator: Indicator) -> Self { self.indicator = Some(indicator); self } pub fn indicator_border_color(mut self, color: Option) -> Self { self.indicator_border_color = color; self } } impl Disableable for IconButton { fn disabled(mut self, disabled: bool) -> Self { self.base = self.base.disabled(disabled); self } } impl Toggleable for IconButton { fn toggle_state(mut self, selected: bool) -> Self { self.base = self.base.toggle_state(selected); self } } impl SelectableButton for IconButton { fn selected_style(mut self, style: ButtonStyle) -> Self { self.base = self.base.selected_style(style); self } } impl Clickable for IconButton { fn on_click( mut self, handler: impl Fn(&gpui::ClickEvent, &mut Window, &mut App) + 'static, ) -> Self { self.base = self.base.on_click(handler); self } fn cursor_style(mut self, cursor_style: gpui::CursorStyle) -> Self { self.base = self.base.cursor_style(cursor_style); self } } impl FixedWidth for IconButton { fn width(mut self, width: impl Into) -> Self { self.base = self.base.width(width); self } fn full_width(mut self) -> Self { self.base = self.base.full_width(); self } } impl ButtonCommon for IconButton { fn id(&self) -> &ElementId { self.base.id() } fn style(mut self, style: ButtonStyle) -> Self { self.base = self.base.style(style); self } fn size(mut self, size: ButtonSize) -> Self { self.base = self.base.size(size); self } fn tooltip(mut self, tooltip: impl Fn(&mut Window, &mut App) -> AnyView + 'static) -> Self { self.base = self.base.tooltip(tooltip); self } fn tab_index(mut self, tab_index: impl Into) -> Self { self.base = self.base.tab_index(tab_index); self } fn layer(mut self, elevation: ElevationIndex) -> Self { self.base = self.base.layer(elevation); self } } impl VisibleOnHover for IconButton { fn visible_on_hover(mut self, group_name: impl Into) -> Self { self.base = self.base.visible_on_hover(group_name); self } } impl RenderOnce for IconButton { #[allow(refining_impl_trait)] fn render(self, window: &mut Window, cx: &mut App) -> ButtonLike { let is_disabled = self.base.disabled; let is_selected = self.base.selected; let selected_style = self.base.selected_style; let color = self.icon_color.color(cx).opacity(self.alpha.unwrap_or(1.0)); self.base .map(|this| match self.shape { IconButtonShape::Square => { let size = self.icon_size.square(window, cx); this.width(size).height(size.into()) } IconButtonShape::Wide => this, }) .child( ButtonIcon::new(self.icon) .disabled(is_disabled) .toggle_state(is_selected) .selected_icon(self.selected_icon) .selected_icon_color(self.selected_icon_color) .when_some(selected_style, |this, style| this.selected_style(style)) .when_some(self.indicator, |this, indicator| { this.indicator(indicator) .indicator_border_color(self.indicator_border_color) }) .size(self.icon_size) .color(Color::Custom(color)), ) } } impl Component for IconButton { fn scope() -> ComponentScope { ComponentScope::Input } fn sort_name() -> &'static str { "ButtonB" } fn preview(_window: &mut Window, _cx: &mut App) -> Option { Some( v_flex() .gap_6() .children(vec![ example_group_with_title( "Icon Button Styles", vec![ // TODO: Remove/organize this later single_example( "SIZES", h_flex() .gap_0p5() .child( IconButton::new("tinted", IconName::Debug) .icon_size(IconSize::Indicator) .layer(ElevationIndex::Background) .style(ButtonStyle::Tinted(TintColor::Accent)), ) .child( IconButton::new("tinted", IconName::Debug) .icon_size(IconSize::XSmall) .layer(ElevationIndex::Background) .style(ButtonStyle::Tinted(TintColor::Accent)), ) .child( IconButton::new("tinted", IconName::Debug) .icon_size(IconSize::Small) .layer(ElevationIndex::Background) .style(ButtonStyle::Tinted(TintColor::Accent)), ) .child( IconButton::new("tinted", IconName::Debug) .icon_size(IconSize::Medium) .layer(ElevationIndex::Background) .style(ButtonStyle::Tinted(TintColor::Accent)), ) .child( IconButton::new("tinted", IconName::Debug) .icon_size(IconSize::XLarge) .layer(ElevationIndex::Background) .style(ButtonStyle::Tinted(TintColor::Accent)), ) .into_any_element(), ), single_example( "Default", IconButton::new("default", IconName::Check) .layer(ElevationIndex::Background) .into_any_element(), ), single_example( "Filled", IconButton::new("filled", IconName::Check) .layer(ElevationIndex::Background) .style(ButtonStyle::Filled) .into_any_element(), ), single_example( "Subtle", IconButton::new("subtle", IconName::Check) .layer(ElevationIndex::Background) .style(ButtonStyle::Subtle) .into_any_element(), ), single_example( "Tinted", IconButton::new("tinted", IconName::Check) .layer(ElevationIndex::Background) .style(ButtonStyle::Tinted(TintColor::Accent)) .into_any_element(), ), single_example( "Transparent", IconButton::new("transparent", IconName::Check) .layer(ElevationIndex::Background) .style(ButtonStyle::Transparent) .into_any_element(), ), ], ), example_group_with_title( "Icon Button Shapes", vec![ single_example( "Square", IconButton::new("square", IconName::Check) .shape(IconButtonShape::Square) .style(ButtonStyle::Filled) .layer(ElevationIndex::Background) .into_any_element(), ), single_example( "Wide", IconButton::new("wide", IconName::Check) .shape(IconButtonShape::Wide) .style(ButtonStyle::Filled) .layer(ElevationIndex::Background) .into_any_element(), ), ], ), example_group_with_title( "Icon Button Sizes", vec![ single_example( "XSmall", IconButton::new("xsmall", IconName::Check) .icon_size(IconSize::XSmall) .style(ButtonStyle::Filled) .layer(ElevationIndex::Background) .into_any_element(), ), single_example( "Small", IconButton::new("small", IconName::Check) .icon_size(IconSize::Small) .style(ButtonStyle::Filled) .layer(ElevationIndex::Background) .into_any_element(), ), single_example( "Medium", IconButton::new("medium", IconName::Check) .icon_size(IconSize::Medium) .style(ButtonStyle::Filled) .layer(ElevationIndex::Background) .into_any_element(), ), single_example( "XLarge", IconButton::new("xlarge", IconName::Check) .icon_size(IconSize::XLarge) .style(ButtonStyle::Filled) .layer(ElevationIndex::Background) .into_any_element(), ), ], ), example_group_with_title( "Special States", vec![ single_example( "Disabled", IconButton::new("disabled", IconName::Check) .disabled(true) .style(ButtonStyle::Filled) .layer(ElevationIndex::Background) .into_any_element(), ), single_example( "Selected", IconButton::new("selected", IconName::Check) .toggle_state(true) .style(ButtonStyle::Filled) .layer(ElevationIndex::Background) .into_any_element(), ), single_example( "With Indicator", IconButton::new("indicator", IconName::Check) .indicator(Indicator::dot().color(Color::Success)) .style(ButtonStyle::Filled) .layer(ElevationIndex::Background) .into_any_element(), ), ], ), example_group_with_title( "Custom Colors", vec![ single_example( "Custom Icon Color", IconButton::new("custom_color", IconName::Check) .icon_color(Color::Accent) .style(ButtonStyle::Filled) .layer(ElevationIndex::Background) .into_any_element(), ), single_example( "With Alpha", IconButton::new("alpha", IconName::Check) .alpha(0.5) .style(ButtonStyle::Filled) .layer(ElevationIndex::Background) .into_any_element(), ), ], ), ]) .into_any_element(), ) } }