1use gpui::{svg, AnimationElement, Hsla, IntoElement, Rems, Transformation};
2use serde::{Deserialize, Serialize};
3use strum::{EnumIter, EnumString, IntoStaticStr};
4
5use crate::{prelude::*, Indicator};
6
7#[derive(IntoElement)]
8pub enum AnyIcon {
9 Icon(Icon),
10 AnimatedIcon(AnimationElement<Icon>),
11}
12
13impl AnyIcon {
14 /// Returns a new [`AnyIcon`] after applying the given mapping function
15 /// to the contained [`Icon`].
16 pub fn map(self, f: impl FnOnce(Icon) -> Icon) -> Self {
17 match self {
18 Self::Icon(icon) => Self::Icon(f(icon)),
19 Self::AnimatedIcon(animated_icon) => Self::AnimatedIcon(animated_icon.map_element(f)),
20 }
21 }
22}
23
24impl From<Icon> for AnyIcon {
25 fn from(value: Icon) -> Self {
26 Self::Icon(value)
27 }
28}
29
30impl From<AnimationElement<Icon>> for AnyIcon {
31 fn from(value: AnimationElement<Icon>) -> Self {
32 Self::AnimatedIcon(value)
33 }
34}
35
36impl RenderOnce for AnyIcon {
37 fn render(self, _cx: &mut WindowContext) -> impl IntoElement {
38 match self {
39 Self::Icon(icon) => icon.into_any_element(),
40 Self::AnimatedIcon(animated_icon) => animated_icon.into_any_element(),
41 }
42 }
43}
44
45/// The decoration for an icon.
46///
47/// For example, this can show an indicator, an "x",
48/// or a diagonal strkethrough to indicate something is disabled.
49#[derive(Debug, PartialEq, Copy, Clone, EnumIter)]
50pub enum IconDecoration {
51 Strikethrough,
52 IndicatorDot,
53 X,
54}
55
56#[derive(Default, PartialEq, Copy, Clone)]
57pub enum IconSize {
58 /// 10px
59 Indicator,
60 /// 12px
61 XSmall,
62 /// 14px
63 Small,
64 #[default]
65 /// 16px
66 Medium,
67}
68
69impl IconSize {
70 pub fn rems(self) -> Rems {
71 match self {
72 IconSize::Indicator => rems_from_px(10.),
73 IconSize::XSmall => rems_from_px(12.),
74 IconSize::Small => rems_from_px(14.),
75 IconSize::Medium => rems_from_px(16.),
76 }
77 }
78
79 /// Returns the individual components of the square that contains this [`IconSize`].
80 ///
81 /// The returned tuple contains:
82 /// 1. The length of one side of the square
83 /// 2. The padding of one side of the square
84 pub fn square_components(&self, cx: &mut WindowContext) -> (Pixels, Pixels) {
85 let icon_size = self.rems() * cx.rem_size();
86 let padding = match self {
87 IconSize::Indicator => Spacing::None.px(cx),
88 IconSize::XSmall => Spacing::XSmall.px(cx),
89 IconSize::Small => Spacing::XSmall.px(cx),
90 IconSize::Medium => Spacing::XSmall.px(cx),
91 };
92
93 (icon_size, padding)
94 }
95
96 /// Returns the length of a side of the square that contains this [`IconSize`], with padding.
97 pub fn square(&self, cx: &mut WindowContext) -> Pixels {
98 let (icon_size, padding) = self.square_components(cx);
99
100 icon_size + padding * 2.
101 }
102}
103
104#[derive(
105 Debug, PartialEq, Eq, Copy, Clone, EnumIter, EnumString, IntoStaticStr, Serialize, Deserialize,
106)]
107pub enum IconName {
108 Ai,
109 AiAnthropic,
110 AiOpenAi,
111 AiGoogle,
112 AiOllama,
113 AiZed,
114 ArrowCircle,
115 ArrowDown,
116 ArrowDownFromLine,
117 ArrowLeft,
118 ArrowRight,
119 ArrowUp,
120 ArrowUpFromLine,
121 ArrowUpRight,
122 AtSign,
123 AudioOff,
124 AudioOn,
125 Backspace,
126 Bell,
127 BellDot,
128 BellOff,
129 BellRing,
130 Bolt,
131 Book,
132 BookCopy,
133 BookPlus,
134 CaseSensitive,
135 Check,
136 ChevronDown,
137 /// This chevron indicates a popover menu.
138 ChevronDownSmall,
139 ChevronLeft,
140 ChevronRight,
141 ChevronUp,
142 ChevronUpDown,
143 Close,
144 Code,
145 Collab,
146 Command,
147 Context,
148 Control,
149 Copilot,
150 CopilotDisabled,
151 CopilotError,
152 CopilotInit,
153 Copy,
154 CountdownTimer,
155 Dash,
156 Delete,
157 Disconnected,
158 Download,
159 Ellipsis,
160 Envelope,
161 Escape,
162 ExclamationTriangle,
163 Exit,
164 ExpandVertical,
165 ExternalLink,
166 Eye,
167 File,
168 FileDoc,
169 FileGeneric,
170 FileGit,
171 FileLock,
172 FileRust,
173 FileToml,
174 FileTree,
175 FileText,
176 FileCode,
177 Filter,
178 Folder,
179 FolderOpen,
180 FolderX,
181 Font,
182 FontSize,
183 FontWeight,
184 Github,
185 GenericMinimize,
186 GenericMaximize,
187 GenericClose,
188 GenericRestore,
189 Hash,
190 HistoryRerun,
191 Indicator,
192 IndicatorX,
193 InlayHint,
194 Library,
195 LineHeight,
196 Link,
197 ListTree,
198 MagicWand,
199 MagnifyingGlass,
200 MailOpen,
201 Maximize,
202 Menu,
203 MessageBubbles,
204 Mic,
205 MicMute,
206 Minimize,
207 Option,
208 PageDown,
209 PageUp,
210 Pencil,
211 Person,
212 Play,
213 Plus,
214 Public,
215 PullRequest,
216 Quote,
217 Regex,
218 ReplNeutral,
219 Replace,
220 ReplaceAll,
221 ReplaceNext,
222 ReplyArrowRight,
223 Rerun,
224 Return,
225 Reveal,
226 RotateCcw,
227 RotateCw,
228 Save,
229 Screen,
230 SearchSelection,
231 SelectAll,
232 Server,
233 Settings,
234 Shift,
235 Sliders,
236 SlidersAlt,
237 Snip,
238 Space,
239 Sparkle,
240 SparkleAlt,
241 SparkleFilled,
242 Spinner,
243 Split,
244 Star,
245 StarFilled,
246 Stop,
247 Strikethrough,
248 Supermaven,
249 SupermavenDisabled,
250 SupermavenError,
251 SupermavenInit,
252 Tab,
253 Terminal,
254 TextCursor,
255 Trash,
256 TriangleRight,
257 Update,
258 WholeWord,
259 XCircle,
260 ZedAssistant,
261 ZedAssistantFilled,
262 ZedXCopilot,
263 Visible,
264}
265
266impl IconName {
267 pub fn path(self) -> &'static str {
268 match self {
269 IconName::Ai => "icons/ai.svg",
270 IconName::AiAnthropic => "icons/ai_anthropic.svg",
271 IconName::AiOpenAi => "icons/ai_open_ai.svg",
272 IconName::AiGoogle => "icons/ai_google.svg",
273 IconName::AiOllama => "icons/ai_ollama.svg",
274 IconName::AiZed => "icons/ai_zed.svg",
275 IconName::ArrowCircle => "icons/arrow_circle.svg",
276 IconName::ArrowDown => "icons/arrow_down.svg",
277 IconName::ArrowDownFromLine => "icons/arrow_down_from_line.svg",
278 IconName::ArrowLeft => "icons/arrow_left.svg",
279 IconName::ArrowRight => "icons/arrow_right.svg",
280 IconName::ArrowUp => "icons/arrow_up.svg",
281 IconName::ArrowUpFromLine => "icons/arrow_up_from_line.svg",
282 IconName::ArrowUpRight => "icons/arrow_up_right.svg",
283 IconName::AtSign => "icons/at_sign.svg",
284 IconName::AudioOff => "icons/speaker_off.svg",
285 IconName::AudioOn => "icons/speaker_loud.svg",
286 IconName::Backspace => "icons/backspace.svg",
287 IconName::Bell => "icons/bell.svg",
288 IconName::BellDot => "icons/bell_dot.svg",
289 IconName::BellOff => "icons/bell_off.svg",
290 IconName::BellRing => "icons/bell_ring.svg",
291 IconName::Bolt => "icons/bolt.svg",
292 IconName::Book => "icons/book.svg",
293 IconName::BookCopy => "icons/book_copy.svg",
294 IconName::BookPlus => "icons/book_plus.svg",
295 IconName::CaseSensitive => "icons/case_insensitive.svg",
296 IconName::Check => "icons/check.svg",
297 IconName::ChevronDown => "icons/chevron_down.svg",
298 IconName::ChevronDownSmall => "icons/chevron_down_small.svg",
299 IconName::ChevronLeft => "icons/chevron_left.svg",
300 IconName::ChevronRight => "icons/chevron_right.svg",
301 IconName::ChevronUp => "icons/chevron_up.svg",
302 IconName::ChevronUpDown => "icons/chevron_up_down.svg",
303 IconName::Close => "icons/x.svg",
304 IconName::Code => "icons/code.svg",
305 IconName::Collab => "icons/user_group_16.svg",
306 IconName::Command => "icons/command.svg",
307 IconName::Context => "icons/context.svg",
308 IconName::Control => "icons/control.svg",
309 IconName::Copilot => "icons/copilot.svg",
310 IconName::CopilotDisabled => "icons/copilot_disabled.svg",
311 IconName::CopilotError => "icons/copilot_error.svg",
312 IconName::CopilotInit => "icons/copilot_init.svg",
313 IconName::Copy => "icons/copy.svg",
314 IconName::CountdownTimer => "icons/countdown_timer.svg",
315 IconName::Dash => "icons/dash.svg",
316 IconName::Delete => "icons/delete.svg",
317 IconName::Disconnected => "icons/disconnected.svg",
318 IconName::Download => "icons/download.svg",
319 IconName::Ellipsis => "icons/ellipsis.svg",
320 IconName::Envelope => "icons/feedback.svg",
321 IconName::Escape => "icons/escape.svg",
322 IconName::ExclamationTriangle => "icons/warning.svg",
323 IconName::Exit => "icons/exit.svg",
324 IconName::ExpandVertical => "icons/expand_vertical.svg",
325 IconName::ExternalLink => "icons/external_link.svg",
326 IconName::Eye => "icons/eye.svg",
327 IconName::File => "icons/file.svg",
328 IconName::FileDoc => "icons/file_icons/book.svg",
329 IconName::FileGeneric => "icons/file_icons/file.svg",
330 IconName::FileGit => "icons/file_icons/git.svg",
331 IconName::FileLock => "icons/file_icons/lock.svg",
332 IconName::FileRust => "icons/file_icons/rust.svg",
333 IconName::FileToml => "icons/file_icons/toml.svg",
334 IconName::FileTree => "icons/project.svg",
335 IconName::FileCode => "icons/file_code.svg",
336 IconName::FileText => "icons/file_text.svg",
337 IconName::Filter => "icons/filter.svg",
338 IconName::Folder => "icons/file_icons/folder.svg",
339 IconName::FolderOpen => "icons/file_icons/folder_open.svg",
340 IconName::FolderX => "icons/stop_sharing.svg",
341 IconName::Font => "icons/font.svg",
342 IconName::FontSize => "icons/font_size.svg",
343 IconName::FontWeight => "icons/font_weight.svg",
344 IconName::Github => "icons/github.svg",
345 IconName::GenericMinimize => "icons/generic_minimize.svg",
346 IconName::GenericMaximize => "icons/generic_maximize.svg",
347 IconName::GenericClose => "icons/generic_close.svg",
348 IconName::GenericRestore => "icons/generic_restore.svg",
349 IconName::Hash => "icons/hash.svg",
350 IconName::HistoryRerun => "icons/history_rerun.svg",
351 IconName::Indicator => "icons/indicator.svg",
352 IconName::IndicatorX => "icons/indicator_x.svg",
353 IconName::InlayHint => "icons/inlay_hint.svg",
354 IconName::Library => "icons/library.svg",
355 IconName::LineHeight => "icons/line_height.svg",
356 IconName::Link => "icons/link.svg",
357 IconName::ListTree => "icons/list_tree.svg",
358 IconName::MagicWand => "icons/magic_wand.svg",
359 IconName::MagnifyingGlass => "icons/magnifying_glass.svg",
360 IconName::MailOpen => "icons/mail_open.svg",
361 IconName::Maximize => "icons/maximize.svg",
362 IconName::Menu => "icons/menu.svg",
363 IconName::MessageBubbles => "icons/conversations.svg",
364 IconName::Mic => "icons/mic.svg",
365 IconName::MicMute => "icons/mic_mute.svg",
366 IconName::Minimize => "icons/minimize.svg",
367 IconName::Option => "icons/option.svg",
368 IconName::PageDown => "icons/page_down.svg",
369 IconName::PageUp => "icons/page_up.svg",
370 IconName::Pencil => "icons/pencil.svg",
371 IconName::Person => "icons/person.svg",
372 IconName::Play => "icons/play.svg",
373 IconName::Plus => "icons/plus.svg",
374 IconName::Public => "icons/public.svg",
375 IconName::PullRequest => "icons/pull_request.svg",
376 IconName::Quote => "icons/quote.svg",
377 IconName::Regex => "icons/regex.svg",
378 IconName::ReplNeutral => "icons/repl_neutral.svg",
379 IconName::Replace => "icons/replace.svg",
380 IconName::ReplaceAll => "icons/replace_all.svg",
381 IconName::ReplaceNext => "icons/replace_next.svg",
382 IconName::ReplyArrowRight => "icons/reply_arrow_right.svg",
383 IconName::Rerun => "icons/rerun.svg",
384 IconName::Return => "icons/return.svg",
385 IconName::Reveal => "icons/reveal.svg",
386 IconName::RotateCcw => "icons/rotate_ccw.svg",
387 IconName::RotateCw => "icons/rotate_cw.svg",
388 IconName::Save => "icons/save.svg",
389 IconName::Screen => "icons/desktop.svg",
390 IconName::SearchSelection => "icons/search_selection.svg",
391 IconName::SelectAll => "icons/select_all.svg",
392 IconName::Server => "icons/server.svg",
393 IconName::Settings => "icons/file_icons/settings.svg",
394 IconName::Shift => "icons/shift.svg",
395 IconName::Sliders => "icons/sliders.svg",
396 IconName::SlidersAlt => "icons/sliders-alt.svg",
397 IconName::Snip => "icons/snip.svg",
398 IconName::Space => "icons/space.svg",
399 IconName::Sparkle => "icons/sparkle.svg",
400 IconName::SparkleAlt => "icons/sparkle_alt.svg",
401 IconName::SparkleFilled => "icons/sparkle_filled.svg",
402 IconName::Spinner => "icons/spinner.svg",
403 IconName::Split => "icons/split.svg",
404 IconName::Star => "icons/star.svg",
405 IconName::StarFilled => "icons/star_filled.svg",
406 IconName::Stop => "icons/stop.svg",
407 IconName::Strikethrough => "icons/strikethrough.svg",
408 IconName::Supermaven => "icons/supermaven.svg",
409 IconName::SupermavenDisabled => "icons/supermaven_disabled.svg",
410 IconName::SupermavenError => "icons/supermaven_error.svg",
411 IconName::SupermavenInit => "icons/supermaven_init.svg",
412 IconName::Tab => "icons/tab.svg",
413 IconName::Terminal => "icons/terminal.svg",
414 IconName::TextCursor => "icons/text-cursor.svg",
415 IconName::Trash => "icons/trash.svg",
416 IconName::TriangleRight => "icons/triangle_right.svg",
417 IconName::Update => "icons/update.svg",
418 IconName::WholeWord => "icons/word_search.svg",
419 IconName::XCircle => "icons/error.svg",
420 IconName::ZedAssistant => "icons/zed_assistant.svg",
421 IconName::ZedAssistantFilled => "icons/zed_assistant_filled.svg",
422 IconName::ZedXCopilot => "icons/zed_x_copilot.svg",
423 IconName::Visible => "icons/visible.svg",
424 }
425 }
426}
427
428#[derive(IntoElement)]
429pub struct Icon {
430 path: SharedString,
431 color: Color,
432 size: Rems,
433 transformation: Transformation,
434}
435
436impl Icon {
437 pub fn new(icon: IconName) -> Self {
438 Self {
439 path: icon.path().into(),
440 color: Color::default(),
441 size: IconSize::default().rems(),
442 transformation: Transformation::default(),
443 }
444 }
445
446 pub fn from_path(path: impl Into<SharedString>) -> Self {
447 Self {
448 path: path.into(),
449 color: Color::default(),
450 size: IconSize::default().rems(),
451 transformation: Transformation::default(),
452 }
453 }
454
455 pub fn color(mut self, color: Color) -> Self {
456 self.color = color;
457 self
458 }
459
460 pub fn size(mut self, size: IconSize) -> Self {
461 self.size = size.rems();
462 self
463 }
464
465 /// Sets a custom size for the icon, in [`Rems`].
466 ///
467 /// Not to be exposed outside of the `ui` crate.
468 pub(crate) fn custom_size(mut self, size: Rems) -> Self {
469 self.size = size;
470 self
471 }
472
473 pub fn transform(mut self, transformation: Transformation) -> Self {
474 self.transformation = transformation;
475 self
476 }
477}
478
479impl RenderOnce for Icon {
480 fn render(self, cx: &mut WindowContext) -> impl IntoElement {
481 svg()
482 .with_transformation(self.transformation)
483 .size(self.size)
484 .flex_none()
485 .path(self.path)
486 .text_color(self.color.color(cx))
487 }
488}
489
490#[derive(IntoElement)]
491pub struct DecoratedIcon {
492 icon: Icon,
493 decoration: IconDecoration,
494 decoration_color: Color,
495 parent_background: Option<Hsla>,
496}
497
498impl DecoratedIcon {
499 pub fn new(icon: Icon, decoration: IconDecoration) -> Self {
500 Self {
501 icon,
502 decoration,
503 decoration_color: Color::Default,
504 parent_background: None,
505 }
506 }
507
508 pub fn decoration_color(mut self, color: Color) -> Self {
509 self.decoration_color = color;
510 self
511 }
512
513 pub fn parent_background(mut self, background: Option<Hsla>) -> Self {
514 self.parent_background = background;
515 self
516 }
517}
518
519impl RenderOnce for DecoratedIcon {
520 fn render(self, cx: &mut WindowContext) -> impl IntoElement {
521 let background = self
522 .parent_background
523 .unwrap_or(cx.theme().colors().background);
524
525 let size = self.icon.size;
526
527 let decoration_icon = match self.decoration {
528 IconDecoration::Strikethrough => IconName::Strikethrough,
529 IconDecoration::IndicatorDot => IconName::Indicator,
530 IconDecoration::X => IconName::IndicatorX,
531 };
532
533 let decoration_svg = |icon: IconName| {
534 svg()
535 .absolute()
536 .top_0()
537 .left_0()
538 .path(icon.path())
539 .size(size)
540 .flex_none()
541 .text_color(self.decoration_color.color(cx))
542 };
543
544 let decoration_knockout = |icon: IconName| {
545 svg()
546 .absolute()
547 .top(-rems_from_px(2.))
548 .left(-rems_from_px(3.))
549 .path(icon.path())
550 .size(size + rems_from_px(2.))
551 .flex_none()
552 .text_color(background)
553 };
554
555 div()
556 .relative()
557 .size(self.icon.size)
558 .child(self.icon)
559 .child(decoration_knockout(decoration_icon))
560 .child(decoration_svg(decoration_icon))
561 }
562}
563
564#[derive(IntoElement)]
565pub struct IconWithIndicator {
566 icon: Icon,
567 indicator: Option<Indicator>,
568 indicator_border_color: Option<Hsla>,
569}
570
571impl IconWithIndicator {
572 pub fn new(icon: Icon, indicator: Option<Indicator>) -> Self {
573 Self {
574 icon,
575 indicator,
576 indicator_border_color: None,
577 }
578 }
579
580 pub fn indicator(mut self, indicator: Option<Indicator>) -> Self {
581 self.indicator = indicator;
582 self
583 }
584
585 pub fn indicator_color(mut self, color: Color) -> Self {
586 if let Some(indicator) = self.indicator.as_mut() {
587 indicator.color = color;
588 }
589 self
590 }
591
592 pub fn indicator_border_color(mut self, color: Option<Hsla>) -> Self {
593 self.indicator_border_color = color;
594 self
595 }
596}
597
598impl RenderOnce for IconWithIndicator {
599 fn render(self, cx: &mut WindowContext) -> impl IntoElement {
600 let indicator_border_color = self
601 .indicator_border_color
602 .unwrap_or_else(|| cx.theme().colors().elevated_surface_background);
603
604 div()
605 .relative()
606 .child(self.icon)
607 .when_some(self.indicator, |this, indicator| {
608 this.child(
609 div()
610 .absolute()
611 .w_2()
612 .h_2()
613 .border_1()
614 .border_color(indicator_border_color)
615 .rounded_full()
616 .bottom_neg_0p5()
617 .right_neg_1()
618 .child(indicator),
619 )
620 })
621 }
622}