#![allow(missing_docs)] mod decorated_icon; mod icon_decoration; pub use decorated_icon::*; use gpui::{svg, AnimationElement, Hsla, IntoElement, Rems, Transformation}; pub use icon_decoration::*; use serde::{Deserialize, Serialize}; use strum::{EnumIter, EnumString, IntoStaticStr}; use ui_macros::DerivePathStr; use crate::{ prelude::*, traits::component_preview::{ComponentExample, ComponentPreview}, Indicator, }; #[derive(IntoElement)] pub enum AnyIcon { Icon(Icon), AnimatedIcon(AnimationElement), } impl AnyIcon { /// Returns a new [`AnyIcon`] after applying the given mapping function /// to the contained [`Icon`]. pub fn map(self, f: impl FnOnce(Icon) -> Icon) -> Self { match self { Self::Icon(icon) => Self::Icon(f(icon)), Self::AnimatedIcon(animated_icon) => Self::AnimatedIcon(animated_icon.map_element(f)), } } } impl From for AnyIcon { fn from(value: Icon) -> Self { Self::Icon(value) } } impl From> for AnyIcon { fn from(value: AnimationElement) -> Self { Self::AnimatedIcon(value) } } impl RenderOnce for AnyIcon { fn render(self, _cx: &mut WindowContext) -> impl IntoElement { match self { Self::Icon(icon) => icon.into_any_element(), Self::AnimatedIcon(animated_icon) => animated_icon.into_any_element(), } } } #[derive(Default, PartialEq, Copy, Clone)] pub enum IconSize { /// 10px Indicator, /// 12px XSmall, /// 14px Small, #[default] /// 16px Medium, } impl IconSize { pub fn rems(self) -> Rems { match self { IconSize::Indicator => rems_from_px(10.), IconSize::XSmall => rems_from_px(12.), IconSize::Small => rems_from_px(14.), IconSize::Medium => rems_from_px(16.), } } /// Returns the individual components of the square that contains this [`IconSize`]. /// /// The returned tuple contains: /// 1. The length of one side of the square /// 2. The padding of one side of the square pub fn square_components(&self, cx: &mut WindowContext) -> (Pixels, Pixels) { let icon_size = self.rems() * cx.rem_size(); let padding = match self { IconSize::Indicator => DynamicSpacing::Base00.px(cx), IconSize::XSmall => DynamicSpacing::Base02.px(cx), IconSize::Small => DynamicSpacing::Base02.px(cx), IconSize::Medium => DynamicSpacing::Base02.px(cx), }; (icon_size, padding) } /// Returns the length of a side of the square that contains this [`IconSize`], with padding. pub fn square(&self, cx: &mut WindowContext) -> Pixels { let (icon_size, padding) = self.square_components(cx); icon_size + padding * 2. } } #[derive( Debug, PartialEq, Eq, Copy, Clone, EnumIter, EnumString, IntoStaticStr, Serialize, Deserialize, DerivePathStr, )] #[strum(serialize_all = "snake_case")] #[path_str(prefix = "icons", suffix = ".svg")] pub enum IconName { Ai, AiAnthropic, AiAnthropicHosted, AiGoogle, AiLmStudio, AiOllama, AiOpenAi, AiZed, ArrowCircle, ArrowDown, ArrowDownFromLine, ArrowLeft, ArrowRight, ArrowUp, ArrowUpFromLine, ArrowUpRight, AtSign, AudioOff, AudioOn, Backspace, Bell, BellDot, BellOff, BellRing, Blocks, Bolt, Book, BookCopy, BookPlus, CaseSensitive, Check, ChevronDown, /// This chevron indicates a popover menu. ChevronDownSmall, ChevronLeft, ChevronRight, ChevronUp, ChevronUpDown, Close, Code, Command, Context, Control, Copilot, CopilotDisabled, CopilotError, CopilotInit, Copy, CountdownTimer, CursorIBeam, Dash, DatabaseZap, Delete, Diff, Disconnected, Download, Ellipsis, EllipsisVertical, Envelope, Eraser, Escape, ExpandVertical, Exit, ExternalLink, Eye, File, FileCode, FileDoc, FileDiff, FileGeneric, FileGit, FileLock, FileRust, FileSearch, FileText, FileToml, FileTree, Filter, Folder, FolderOpen, FolderX, Font, FontSize, FontWeight, GenericClose, GenericMaximize, GenericMinimize, GenericRestore, Github, Globe, GitBranch, Hash, HistoryRerun, Indicator, IndicatorX, Info, InlayHint, Keyboard, Library, LineHeight, Link, ListTree, ListX, MagnifyingGlass, MailOpen, Maximize, Menu, MessageBubbles, MessageCircle, Mic, MicMute, Microscope, Minimize, Option, PageDown, PageUp, PanelLeft, PanelRight, Pencil, Person, PersonCircle, PhoneIncoming, Pin, Play, Plus, PocketKnife, Public, PullRequest, Quote, RefreshTitle, Regex, ReplNeutral, Replace, ReplaceAll, ReplaceNext, ReplyArrowRight, Rerun, Return, Reveal, RotateCcw, RotateCw, Route, Save, Screen, SearchCode, SearchSelection, SelectAll, Server, Settings, SettingsAlt, Shift, Slash, SlashSquare, Sliders, SlidersVertical, Snip, Space, Sparkle, SparkleAlt, SparkleFilled, Spinner, Split, SquareDot, SquareMinus, SquarePlus, Star, StarFilled, Stop, Strikethrough, Supermaven, SupermavenDisabled, SupermavenError, SupermavenInit, SwatchBook, Tab, Terminal, TextSnippet, ThumbsUp, ThumbsDown, Trash, TrashAlt, Triangle, TriangleRight, Undo, Unpin, Update, UserGroup, Visible, Wand, Warning, WholeWord, X, XCircle, ZedAssistant, ZedAssistant2, ZedAssistantFilled, ZedPredict, ZedXCopilot, } impl From for Icon { fn from(icon: IconName) -> Self { Icon::new(icon) } } #[derive(IntoElement)] pub struct Icon { path: SharedString, color: Color, size: Rems, transformation: Transformation, } impl Icon { pub fn new(icon: IconName) -> Self { Self { path: icon.path().into(), color: Color::default(), size: IconSize::default().rems(), transformation: Transformation::default(), } } pub fn from_path(path: impl Into) -> Self { Self { path: path.into(), color: Color::default(), size: IconSize::default().rems(), transformation: Transformation::default(), } } pub fn color(mut self, color: Color) -> Self { self.color = color; self } pub fn size(mut self, size: IconSize) -> Self { self.size = size.rems(); self } /// Sets a custom size for the icon, in [`Rems`]. /// /// Not to be exposed outside of the `ui` crate. pub(crate) fn custom_size(mut self, size: Rems) -> Self { self.size = size; self } pub fn transform(mut self, transformation: Transformation) -> Self { self.transformation = transformation; self } } impl RenderOnce for Icon { fn render(self, cx: &mut WindowContext) -> impl IntoElement { svg() .with_transformation(self.transformation) .size(self.size) .flex_none() .path(self.path) .text_color(self.color.color(cx)) } } #[derive(IntoElement)] pub struct IconWithIndicator { icon: Icon, indicator: Option, indicator_border_color: Option, } impl IconWithIndicator { pub fn new(icon: Icon, indicator: Option) -> Self { Self { icon, indicator, indicator_border_color: None, } } pub fn indicator(mut self, indicator: Option) -> Self { self.indicator = indicator; self } pub fn indicator_color(mut self, color: Color) -> Self { if let Some(indicator) = self.indicator.as_mut() { indicator.color = color; } self } pub fn indicator_border_color(mut self, color: Option) -> Self { self.indicator_border_color = color; self } } impl RenderOnce for IconWithIndicator { fn render(self, cx: &mut WindowContext) -> impl IntoElement { let indicator_border_color = self .indicator_border_color .unwrap_or_else(|| cx.theme().colors().elevated_surface_background); div() .relative() .child(self.icon) .when_some(self.indicator, |this, indicator| { this.child( div() .absolute() .size_2p5() .border_2() .border_color(indicator_border_color) .rounded_full() .bottom_neg_0p5() .right_neg_0p5() .child(indicator), ) }) } } impl ComponentPreview for Icon { fn examples(_cx: &mut WindowContext) -> Vec> { let arrow_icons = vec![ IconName::ArrowDown, IconName::ArrowLeft, IconName::ArrowRight, IconName::ArrowUp, IconName::ArrowCircle, ]; vec![example_group_with_title( "Arrow Icons", arrow_icons .into_iter() .map(|icon| { let name = format!("{:?}", icon).to_string(); ComponentExample::new(name, Icon::new(icon)) }) .collect(), )] } }