ragrig-gpui 0.5.0

Reusable GPUI components for Ragrig RAG chat, citations, and reference ingestion
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
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

//! Composer attachments.

use gpui_kit::assets::IconName;

/// How an attachment chip behaves.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum AttachmentKind {
    /// A context toggle, rendered selected while `on`.
    Toggle {
        /// Current state.
        on: bool,
    },
    /// Context waiting for the next question; it can be dropped.
    Pending,
    /// A ready artefact with a host-named action, plus a drop button.
    Offer {
        /// Action caption, e.g. `Insert`.
        action: String,
    },
}

/// One chip above the composer.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct Attachment {
    /// Stable identifier reported back on interaction.
    pub id: String,
    /// What the chip offers.
    pub kind: AttachmentKind,
    /// Icon shown before the label.
    pub icon: IconName,
    /// Chip text, e.g. `draft.md`.
    pub label: String,
    /// Optional tooltip.
    pub hint: Option<String>,
    /// Whether the chip accepts interaction.
    pub enabled: bool,
}

impl Attachment {
    /// A document-context toggle, initially off.
    pub fn document(id: impl Into<String>, label: impl Into<String>) -> Self {
        Self {
            id: id.into(),
            kind: AttachmentKind::Toggle { on: false },
            icon: IconName::FileText,
            label: label.into(),
            hint: None,
            enabled: true,
        }
    }

    /// A bibliography-context toggle, initially off.
    pub fn bibliography(id: impl Into<String>, label: impl Into<String>) -> Self {
        Self {
            id: id.into(),
            kind: AttachmentKind::Toggle { on: false },
            icon: IconName::BookOpen,
            label: label.into(),
            hint: None,
            enabled: true,
        }
    }

    /// Context that waits for the next question.
    pub fn pending(id: impl Into<String>, label: impl Into<String>) -> Self {
        Self {
            id: id.into(),
            kind: AttachmentKind::Pending,
            icon: IconName::Paperclip,
            label: label.into(),
            hint: None,
            enabled: true,
        }
    }

    /// A ready artefact with an action button.
    pub fn offer(
        id: impl Into<String>,
        label: impl Into<String>,
        action: impl Into<String>,
    ) -> Self {
        Self {
            id: id.into(),
            kind: AttachmentKind::Offer {
                action: action.into(),
            },
            icon: IconName::FileText,
            label: label.into(),
            hint: None,
            enabled: true,
        }
    }

    /// Set the toggle state (meaningful for [`AttachmentKind::Toggle`]).
    pub fn on(mut self, on: bool) -> Self {
        if let AttachmentKind::Toggle { on: state } = &mut self.kind {
            *state = on;
        }
        self
    }

    /// Set the tooltip.
    pub fn hint(mut self, hint: impl Into<String>) -> Self {
        self.hint = Some(hint.into());
        self
    }

    /// Enable or disable the whole chip.
    pub fn enabled(mut self, enabled: bool) -> Self {
        self.enabled = enabled;
        self
    }

    /// Returns whether this is a selected toggle.
    pub fn is_on(&self) -> bool {
        matches!(self.kind, AttachmentKind::Toggle { on: true })
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn toggle_state_is_readable_and_settable() {
        let attachment = Attachment::document("draft", "draft.md");
        assert!(!attachment.is_on());
        assert!(attachment.clone().on(true).is_on());
    }

    #[test]
    fn kinds_carry_their_own_action() {
        let offer = Attachment::offer("refs", "references.bib", "Insert");
        assert_eq!(
            offer.kind,
            AttachmentKind::Offer {
                action: "Insert".to_owned()
            }
        );
        assert_eq!(
            Attachment::pending("region", "Selection").kind,
            AttachmentKind::Pending
        );
    }
}