Merge pull request #531 from rowr111/main

documentation for modals.show_notification
This commit is contained in:
bunnie 2024-04-30 12:08:39 -07:00 committed by GitHub
commit bed33393ff
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 27 additions and 1 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

View file

@ -196,7 +196,33 @@ 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.
///
/// <details>
/// <summary>Example Image</summary>
///
/// ![Example Image](https://github.com/betrusted-io/xous-core/blob/main/docs/images/modals_show_notification.png?raw=true)
///
/// </details>
///
/// # Examples
/// ```
/// use modals::Modals;
/// use xous_names::XousNames;
/// let xns = XousNames::new().unwrap();
/// 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 {