GORBIE 0.10.0

GORBIE! Is a minimalist notebook library for Rust.
Documentation 
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

/// Card types and helpers for building notebook content.
/// Cards with persistent state across frames.
pub mod stateful_card;
/// Cards redrawn from scratch each frame (no state).
pub mod stateless_card;

pub use stateful_card::*;
pub use stateless_card::*;

use crate::CardCtx;

/// Default inner margin applied to card frames.
pub const DEFAULT_CARD_PADDING: egui::Margin = egui::Margin::symmetric(16, 12);

/// Wraps content in a styled note frame with default padding and fill color.
pub fn note_frame<R>(
    ui: &mut egui::Ui,
    add_contents: impl FnOnce(&mut egui::Ui) -> R,
) -> egui::InnerResponse<R> {
    let fill = crate::themes::ral(1003);
    egui::Frame::new()
        .fill(fill)
        .stroke(egui::Stroke::NONE)
        .corner_radius(0.0)
        .inner_margin(DEFAULT_CARD_PADDING)
        .show(ui, |ui| {
            ui.set_width(ui.available_width());
            add_contents(ui)
        })
}

/// Render a formatted markdown string inside a styled note frame.
///
/// Accepts `format!`-style arguments:
/// ```ignore
/// note!(ui, "Status: **{}**", status);
/// ```
#[cfg(feature = "markdown")]
#[macro_export]
macro_rules! note {
    ($ui:expr, $fmt:expr $(, $args:expr)*) => {{
        let text = format!($fmt $(, $args)*);
        $crate::cards::note_frame($ui, |ui| {
            $crate::widgets::markdown(ui, &text);
        });
    }};
}

/// A drawable notebook card.
pub trait Card {
    /// Renders the card into the given drawing context.
    fn draw(&mut self, ctx: &mut CardCtx<'_>);
}