Repository navigation
Release v1.9.0
Drop <Marquee /> into an application shell and a product shows its announcements the way Studio does: banners at the top and dialogs one at a time. It brings its own generated query and command proxies, so it needs nothing but the backend package.
Added
@cratis/showrunner.marquee.reactwith<Marquee />, mounted once: banners in a polite live region with the importance icon and color, and dialogs one at a time, the most important first. A dialog shown once is acknowledged through the command when it is closed, so it is gone on every device; a dialog shown every session is closed for that session only. (#39)- Safe Markdown for announcement bodies: raw HTML is dropped, images are left out, links open in a new tab with
noopener noreferrer, and onlyhttps,mailtoandtellinks are links. (part of #39) - The window of each announcement is applied against the clock every 60 seconds, with the start inclusive and the end exclusive, so a scheduled announcement appears and ends on time without a round trip. (part of #39)
banner,dialogandmarkdownslots to replace what is drawn,labelsto localize every text, anduseAnnouncementsto draw a surface of your own. (part of #39)- Storybook stories for the banner and the dialog, one for every importance and display. (part of #39)
- Marquee documentation: how it works, a tutorial for adding announcements to a product, how to author announcements without Direct, how to replace the banner or the dialog, and a reference of the contract events and their generations. The code examples build with the package. (#41)