1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
use crate::icon_text::{IconText, IconTextItem};
use crate::{design_tokens, icons, ColorToken, DesignTokens, Scale, UiExt};
use egui::{OpenUrl, RichText, Sense, TextBuffer, Ui, UiBuilder};
/// A help popup where you can show markdown text and controls as a table.
#[derive(Debug, Clone)]
pub struct Help<'a> {
title: String,
docs_link: Option<String>,
sections: Vec<HelpSection<'a>>,
}
/// A single section, separated by a [`egui::Separator`].
#[derive(Debug, Clone)]
enum HelpSection<'a> {
Markdown(String),
Controls(Vec<ControlRow<'a>>),
}
/// A single row in the controls table.
#[derive(Debug, Clone)]
pub struct ControlRow<'a> {
text: String,
items: IconText<'a>,
}
impl<'a> ControlRow<'a> {
/// Create a new control row.
#[allow(clippy::needless_pass_by_value)]
pub fn new(text: impl ToString, items: IconText<'a>) -> Self {
Self {
text: text.to_string(),
items,
}
}
}
impl<'a> Help<'a> {
/// Create a new help popup.
#[allow(clippy::needless_pass_by_value)]
pub fn new(title: impl ToString) -> Self {
Self {
title: title.to_string(),
docs_link: None,
sections: Vec::new(),
}
}
/// Add a docs link, to be shown in the top right corner.
#[allow(clippy::needless_pass_by_value)]
#[inline]
pub fn docs_link(mut self, docs_link: impl ToString) -> Self {
self.docs_link = Some(docs_link.to_string());
self
}
/// Add a markdown section.
#[allow(clippy::needless_pass_by_value)]
#[inline]
pub fn markdown(mut self, markdown: impl ToString) -> Self {
self.sections
.push(HelpSection::Markdown(markdown.to_string()));
self
}
/// Add a controls section.
#[inline]
pub fn controls(mut self, controls: Vec<ControlRow<'a>>) -> Self {
self.sections.push(HelpSection::Controls(controls));
self
}
/// Add a single control row to the last controls section.
#[allow(clippy::needless_pass_by_value)]
#[inline]
pub fn control(mut self, label: impl ToString, items: IconText<'a>) -> Self {
if let Some(HelpSection::Controls(controls)) = self.sections.last_mut() {
controls.push(ControlRow::new(label, items));
} else {
self.sections
.push(HelpSection::Controls(vec![ControlRow::new(label, items)]));
}
self
}
/// Create a new empty control section.
#[inline]
pub fn control_separator(mut self) -> Self {
self.sections.push(HelpSection::Controls(vec![]));
self
}
fn separator(ui: &mut Ui) {
ui.scope(|ui| {
ui.style_mut()
.visuals
.widgets
.noninteractive
.bg_stroke
.color = design_tokens().color_table.gray(Scale::S400);
ui.separator();
});
}
/// Show the help popup. Usually you want to show this in [`egui::Response::on_hover_ui`].
pub fn ui(&self, ui: &mut Ui) {
egui::Sides::new().show(
ui,
|ui| {
ui.label(RichText::new(&self.title).strong().size(11.0));
},
|ui| {
if let Some(docs_link) = &self.docs_link {
// Since we are in rtl layout, we need to make our own link since the
// re_ui link icon would be reversed.
let response = ui
.scope_builder(UiBuilder::new().sense(Sense::click()), |ui| {
ui.spacing_mut().item_spacing.x = 2.0;
let hovered = ui.response().hovered();
let tint = design_tokens().color(ColorToken::gray(if hovered {
Scale::S900
} else {
Scale::S700
}));
ui.label(RichText::new("Docs").color(tint).size(11.0));
ui.small_icon(&icons::EXTERNAL_LINK, Some(tint));
})
.response;
if response.clicked() {
ui.ctx().open_url(OpenUrl::new_tab(docs_link));
}
}
},
);
for section in &self.sections {
Self::separator(ui);
match section {
HelpSection::Markdown(md) => {
ui.markdown_ui(md);
}
HelpSection::Controls(controls) => {
for row in controls {
egui::Sides::new().spacing(8.0).show(
ui,
|ui| {
ui.strong(RichText::new(&row.text).size(11.0));
},
|ui| {
ui.set_height(DesignTokens::small_icon_size().y);
for item in row.items.0.iter().rev() {
match item {
IconTextItem::Icon(icon) => {
ui.small_icon(
icon,
Some(
design_tokens()
.color(ColorToken::gray(Scale::S700)),
),
);
}
IconTextItem::Text(text) => {
ui.label(
RichText::new(text.as_str())
.monospace()
.size(11.0)
.color(
design_tokens()
.color(ColorToken::gray(Scale::S700)),
),
);
}
}
}
},
);
}
}
}
}
}
}