saymrwulf/xous-core
1
0
Fork 0
mirror of https://github.com/saymrwulf/xous-core.git synced 2026-11-15 08:30:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

adding documentation for show_notification

Browse source
This commit is contained in:
Jeanie 2024-04-23 01:18:56 +09:00
parent c8986c40cc
commit cd5f6a1ae2
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
services/modals/src/lib.rs
View file

@ -196,7 +196,17 @@ impl Modals {
}
}
/// this blocks until the notification has been acknowledged.
/// Text/QR code notification modal dialog.
///
/// - `qrtext` turns submitted text into a qr code.
/// - This dialog blocks until the notification has been acknowledged via [ Press any key ].
/// - Dialog does not scroll, burden is on the consumer to make sure text + qr code do not overflow available space.
///
/// # Examples
/// ```
/// let modals = Modals::new(&xns).unwrap();
/// modals.show_notification("Check the wiki:", Some("https://github.com/betrusted-io/betrusted-wiki/wiki")).unwrap();
/// ```
pub fn show_notification(&self, notification: &str, qrtext: Option<&str>) -> Result<(), xous::Error> {
self.lock();
let qrtext = match qrtext {