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 Route,
227 RotateCcw,
228 RotateCw,
229 Save,
230 Screen,
231 SearchSelection,
232 SelectAll,
233 Server,
234 Settings,
235 Shift,
236 Sliders,
237 SlidersAlt,
238 Snip,
239 Space,
240 Sparkle,
241 SparkleAlt,
242 SparkleFilled,
243 Spinner,
244 Split,
245 Star,
246 StarFilled,
247 Stop,
248 Strikethrough,
249 Supermaven,
250 SupermavenDisabled,
251 SupermavenError,
252 SupermavenInit,
253 Tab,
254 Terminal,
255 TextCursor,
256 Trash,
257 TriangleRight,
258 Update,
259 WholeWord,
260 XCircle,
261 ZedAssistant,
262 ZedAssistantFilled,
263 ZedXCopilot,
264 Visible,
265}
266
267impl IconName {
268 pub fn path(self) -> &'static str {
269 match self {
270 IconName::Ai => "icons/ai.svg",
271 IconName::AiAnthropic => "icons/ai_anthropic.svg",
272 IconName::AiOpenAi => "icons/ai_open_ai.svg",
273 IconName::AiGoogle => "icons/ai_google.svg",
274 IconName::AiOllama => "icons/ai_ollama.svg",
275 IconName::AiZed => "icons/ai_zed.svg",
276 IconName::ArrowCircle => "icons/arrow_circle.svg",
277 IconName::ArrowDown => "icons/arrow_down.svg",
278 IconName::ArrowDownFromLine => "icons/arrow_down_from_line.svg",
279 IconName::ArrowLeft => "icons/arrow_left.svg",
280 IconName::ArrowRight => "icons/arrow_right.svg",
281 IconName::ArrowUp => "icons/arrow_up.svg",
282 IconName::ArrowUpFromLine => "icons/arrow_up_from_line.svg",
283 IconName::ArrowUpRight => "icons/arrow_up_right.svg",
284 IconName::AtSign => "icons/at_sign.svg",
285 IconName::AudioOff => "icons/speaker_off.svg",
286 IconName::AudioOn => "icons/speaker_loud.svg",
287 IconName::Backspace => "icons/backspace.svg",
288 IconName::Bell => "icons/bell.svg",
289 IconName::BellDot => "icons/bell_dot.svg",
290 IconName::BellOff => "icons/bell_off.svg",
291 IconName::BellRing => "icons/bell_ring.svg",
292 IconName::Bolt => "icons/bolt.svg",
293 IconName::Book => "icons/book.svg",
294 IconName::BookCopy => "icons/book_copy.svg",
295 IconName::BookPlus => "icons/book_plus.svg",
296 IconName::CaseSensitive => "icons/case_insensitive.svg",
297 IconName::Check => "icons/check.svg",
298 IconName::ChevronDown => "icons/chevron_down.svg",
299 IconName::ChevronDownSmall => "icons/chevron_down_small.svg",
300 IconName::ChevronLeft => "icons/chevron_left.svg",
301 IconName::ChevronRight => "icons/chevron_right.svg",
302 IconName::ChevronUp => "icons/chevron_up.svg",
303 IconName::ChevronUpDown => "icons/chevron_up_down.svg",
304 IconName::Close => "icons/x.svg",
305 IconName::Code => "icons/code.svg",
306 IconName::Collab => "icons/user_group_16.svg",
307 IconName::Command => "icons/command.svg",
308 IconName::Context => "icons/context.svg",
309 IconName::Control => "icons/control.svg",
310 IconName::Copilot => "icons/copilot.svg",
311 IconName::CopilotDisabled => "icons/copilot_disabled.svg",
312 IconName::CopilotError => "icons/copilot_error.svg",
313 IconName::CopilotInit => "icons/copilot_init.svg",
314 IconName::Copy => "icons/copy.svg",
315 IconName::CountdownTimer => "icons/countdown_timer.svg",
316 IconName::Dash => "icons/dash.svg",
317 IconName::Delete => "icons/delete.svg",
318 IconName::Disconnected => "icons/disconnected.svg",
319 IconName::Download => "icons/download.svg",
320 IconName::Ellipsis => "icons/ellipsis.svg",
321 IconName::Envelope => "icons/feedback.svg",
322 IconName::Escape => "icons/escape.svg",
323 IconName::ExclamationTriangle => "icons/warning.svg",
324 IconName::Exit => "icons/exit.svg",
325 IconName::ExpandVertical => "icons/expand_vertical.svg",
326 IconName::ExternalLink => "icons/external_link.svg",
327 IconName::Eye => "icons/eye.svg",
328 IconName::File => "icons/file.svg",
329 IconName::FileDoc => "icons/file_icons/book.svg",
330 IconName::FileGeneric => "icons/file_icons/file.svg",
331 IconName::FileGit => "icons/file_icons/git.svg",
332 IconName::FileLock => "icons/file_icons/lock.svg",
333 IconName::FileRust => "icons/file_icons/rust.svg",
334 IconName::FileToml => "icons/file_icons/toml.svg",
335 IconName::FileTree => "icons/project.svg",
336 IconName::FileCode => "icons/file_code.svg",
337 IconName::FileText => "icons/file_text.svg",
338 IconName::Filter => "icons/filter.svg",
339 IconName::Folder => "icons/file_icons/folder.svg",
340 IconName::FolderOpen => "icons/file_icons/folder_open.svg",
341 IconName::FolderX => "icons/stop_sharing.svg",
342 IconName::Font => "icons/font.svg",
343 IconName::FontSize => "icons/font_size.svg",
344 IconName::FontWeight => "icons/font_weight.svg",
345 IconName::Github => "icons/github.svg",
346 IconName::GenericMinimize => "icons/generic_minimize.svg",
347 IconName::GenericMaximize => "icons/generic_maximize.svg",
348 IconName::GenericClose => "icons/generic_close.svg",
349 IconName::GenericRestore => "icons/generic_restore.svg",
350 IconName::Hash => "icons/hash.svg",
351 IconName::HistoryRerun => "icons/history_rerun.svg",
352 IconName::Indicator => "icons/indicator.svg",
353 IconName::IndicatorX => "icons/indicator_x.svg",
354 IconName::InlayHint => "icons/inlay_hint.svg",
355 IconName::Library => "icons/library.svg",
356 IconName::LineHeight => "icons/line_height.svg",
357 IconName::Link => "icons/link.svg",
358 IconName::ListTree => "icons/list_tree.svg",
359 IconName::MagicWand => "icons/magic_wand.svg",
360 IconName::MagnifyingGlass => "icons/magnifying_glass.svg",
361 IconName::MailOpen => "icons/mail_open.svg",
362 IconName::Maximize => "icons/maximize.svg",
363 IconName::Menu => "icons/menu.svg",
364 IconName::MessageBubbles => "icons/conversations.svg",
365 IconName::Mic => "icons/mic.svg",
366 IconName::MicMute => "icons/mic_mute.svg",
367 IconName::Minimize => "icons/minimize.svg",
368 IconName::Option => "icons/option.svg",
369 IconName::PageDown => "icons/page_down.svg",
370 IconName::PageUp => "icons/page_up.svg",
371 IconName::Pencil => "icons/pencil.svg",
372 IconName::Person => "icons/person.svg",
373 IconName::Play => "icons/play.svg",
374 IconName::Plus => "icons/plus.svg",
375 IconName::Public => "icons/public.svg",
376 IconName::PullRequest => "icons/pull_request.svg",
377 IconName::Quote => "icons/quote.svg",
378 IconName::Regex => "icons/regex.svg",
379 IconName::ReplNeutral => "icons/repl_neutral.svg",
380 IconName::Replace => "icons/replace.svg",
381 IconName::ReplaceAll => "icons/replace_all.svg",
382 IconName::ReplaceNext => "icons/replace_next.svg",
383 IconName::ReplyArrowRight => "icons/reply_arrow_right.svg",
384 IconName::Rerun => "icons/rerun.svg",
385 IconName::Return => "icons/return.svg",
386 IconName::Reveal => "icons/reveal.svg",
387 IconName::RotateCcw => "icons/rotate_ccw.svg",
388 IconName::RotateCw => "icons/rotate_cw.svg",
389 IconName::Route => "icons/route.svg",
390 IconName::Save => "icons/save.svg",
391 IconName::Screen => "icons/desktop.svg",
392 IconName::SearchSelection => "icons/search_selection.svg",
393 IconName::SelectAll => "icons/select_all.svg",
394 IconName::Server => "icons/server.svg",
395 IconName::Settings => "icons/file_icons/settings.svg",
396 IconName::Shift => "icons/shift.svg",
397 IconName::Sliders => "icons/sliders.svg",
398 IconName::SlidersAlt => "icons/sliders-alt.svg",
399 IconName::Snip => "icons/snip.svg",
400 IconName::Space => "icons/space.svg",
401 IconName::Sparkle => "icons/sparkle.svg",
402 IconName::SparkleAlt => "icons/sparkle_alt.svg",
403 IconName::SparkleFilled => "icons/sparkle_filled.svg",
404 IconName::Spinner => "icons/spinner.svg",
405 IconName::Split => "icons/split.svg",
406 IconName::Star => "icons/star.svg",
407 IconName::StarFilled => "icons/star_filled.svg",
408 IconName::Stop => "icons/stop.svg",
409 IconName::Strikethrough => "icons/strikethrough.svg",
410 IconName::Supermaven => "icons/supermaven.svg",
411 IconName::SupermavenDisabled => "icons/supermaven_disabled.svg",
412 IconName::SupermavenError => "icons/supermaven_error.svg",
413 IconName::SupermavenInit => "icons/supermaven_init.svg",
414 IconName::Tab => "icons/tab.svg",
415 IconName::Terminal => "icons/terminal.svg",
416 IconName::TextCursor => "icons/text-cursor.svg",
417 IconName::Trash => "icons/trash.svg",
418 IconName::TriangleRight => "icons/triangle_right.svg",
419 IconName::Update => "icons/update.svg",
420 IconName::WholeWord => "icons/word_search.svg",
421 IconName::XCircle => "icons/error.svg",
422 IconName::ZedAssistant => "icons/zed_assistant.svg",
423 IconName::ZedAssistantFilled => "icons/zed_assistant_filled.svg",
424 IconName::ZedXCopilot => "icons/zed_x_copilot.svg",
425 IconName::Visible => "icons/visible.svg",
426 }
427 }
428}
429
430#[derive(IntoElement)]
431pub struct Icon {
432 path: SharedString,
433 color: Color,
434 size: Rems,
435 transformation: Transformation,
436}
437
438impl Icon {
439 pub fn new(icon: IconName) -> Self {
440 Self {
441 path: icon.path().into(),
442 color: Color::default(),
443 size: IconSize::default().rems(),
444 transformation: Transformation::default(),
445 }
446 }
447
448 pub fn from_path(path: impl Into<SharedString>) -> Self {
449 Self {
450 path: path.into(),
451 color: Color::default(),
452 size: IconSize::default().rems(),
453 transformation: Transformation::default(),
454 }
455 }
456
457 pub fn color(mut self, color: Color) -> Self {
458 self.color = color;
459 self
460 }
461
462 pub fn size(mut self, size: IconSize) -> Self {
463 self.size = size.rems();
464 self
465 }
466
467 /// Sets a custom size for the icon, in [`Rems`].
468 ///
469 /// Not to be exposed outside of the `ui` crate.
470 pub(crate) fn custom_size(mut self, size: Rems) -> Self {
471 self.size = size;
472 self
473 }
474
475 pub fn transform(mut self, transformation: Transformation) -> Self {
476 self.transformation = transformation;
477 self
478 }
479}
480
481impl RenderOnce for Icon {
482 fn render(self, cx: &mut WindowContext) -> impl IntoElement {
483 svg()
484 .with_transformation(self.transformation)
485 .size(self.size)
486 .flex_none()
487 .path(self.path)
488 .text_color(self.color.color(cx))
489 }
490}
491
492#[derive(IntoElement)]
493pub struct DecoratedIcon {
494 icon: Icon,
495 decoration: IconDecoration,
496 decoration_color: Color,
497 parent_background: Option<Hsla>,
498}
499
500impl DecoratedIcon {
501 pub fn new(icon: Icon, decoration: IconDecoration) -> Self {
502 Self {
503 icon,
504 decoration,
505 decoration_color: Color::Default,
506 parent_background: None,
507 }
508 }
509
510 pub fn decoration_color(mut self, color: Color) -> Self {
511 self.decoration_color = color;
512 self
513 }
514
515 pub fn parent_background(mut self, background: Option<Hsla>) -> Self {
516 self.parent_background = background;
517 self
518 }
519}
520
521impl RenderOnce for DecoratedIcon {
522 fn render(self, cx: &mut WindowContext) -> impl IntoElement {
523 let background = self
524 .parent_background
525 .unwrap_or(cx.theme().colors().background);
526
527 let size = self.icon.size;
528
529 let decoration_icon = match self.decoration {
530 IconDecoration::Strikethrough => IconName::Strikethrough,
531 IconDecoration::IndicatorDot => IconName::Indicator,
532 IconDecoration::X => IconName::IndicatorX,
533 };
534
535 let decoration_svg = |icon: IconName| {
536 svg()
537 .absolute()
538 .top_0()
539 .left_0()
540 .path(icon.path())
541 .size(size)
542 .flex_none()
543 .text_color(self.decoration_color.color(cx))
544 };
545
546 let decoration_knockout = |icon: IconName| {
547 svg()
548 .absolute()
549 .top(-rems_from_px(2.))
550 .left(-rems_from_px(3.))
551 .path(icon.path())
552 .size(size + rems_from_px(2.))
553 .flex_none()
554 .text_color(background)
555 };
556
557 div()
558 .relative()
559 .size(self.icon.size)
560 .child(self.icon)
561 .child(decoration_knockout(decoration_icon))
562 .child(decoration_svg(decoration_icon))
563 }
564}
565
566#[derive(IntoElement)]
567pub struct IconWithIndicator {
568 icon: Icon,
569 indicator: Option<Indicator>,
570 indicator_border_color: Option<Hsla>,
571}
572
573impl IconWithIndicator {
574 pub fn new(icon: Icon, indicator: Option<Indicator>) -> Self {
575 Self {
576 icon,
577 indicator,
578 indicator_border_color: None,
579 }
580 }
581
582 pub fn indicator(mut self, indicator: Option<Indicator>) -> Self {
583 self.indicator = indicator;
584 self
585 }
586
587 pub fn indicator_color(mut self, color: Color) -> Self {
588 if let Some(indicator) = self.indicator.as_mut() {
589 indicator.color = color;
590 }
591 self
592 }
593
594 pub fn indicator_border_color(mut self, color: Option<Hsla>) -> Self {
595 self.indicator_border_color = color;
596 self
597 }
598}
599
600impl RenderOnce for IconWithIndicator {
601 fn render(self, cx: &mut WindowContext) -> impl IntoElement {
602 let indicator_border_color = self
603 .indicator_border_color
604 .unwrap_or_else(|| cx.theme().colors().elevated_surface_background);
605
606 div()
607 .relative()
608 .child(self.icon)
609 .when_some(self.indicator, |this, indicator| {
610 this.child(
611 div()
612 .absolute()
613 .w_2()
614 .h_2()
615 .border_1()
616 .border_color(indicator_border_color)
617 .rounded_full()
618 .bottom_neg_0p5()
619 .right_neg_1()
620 .child(indicator),
621 )
622 })
623 }
624}