docs(notification): add notification code docs #1217
Conversation
|
Deploy preview for carbon-website ready! Built with commit 2b1a949 |
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/carbon-design-system/carbon-website/cga9xtxjz |
ghost
requested review from
|
Removing WIP label since it seems like it all built fine and dandy |
…-website into notification-usage-updates
dakahn
changed the title
|
|
||
| ## Toast notification | ||
|
|
||
| You can use the `ToastNotification` component to display a non-modal, time-based short message that appears at the bottom or the top of the screen. |
There was a problem hiding this comment.
Would this be a non-modal dialog?
Also, just realized that we don't provide any kind of layout for where this component should be rendered 🤔
There was a problem hiding this comment.
Like do you mean we just say "render at the top" but don't describe how to do that?
…te into notification-usage-updates
There was a problem hiding this comment.
@dakahn there are just two things here from a content perspective:
-
Update the page description as follows:
How to build a notification using React. For code usage with other frameworks, please follow the links in the live demo on the usage tab. -
The anchor links are out of sync.
Thanks!
|
Updates added! Should be good to go 🏄 |
|
@dakahn , there is one H2 that's not currently in the anchor links: Inline notifications with action button. And it looks like it should probably be positioned after the H2 Inline notifications section, with the Component API and the Feedback H2s following behind. Is that right? I might be missing something here... So I'm thinking it should be:
Thanks |
|
Should be good to go for another round of reviews 👀 |
|
Sorry, I should have been clearer. @dakahn @joshblack The ordering of the anchor links still doesn't match the H2s on the page. If what I'm suggesting is correct, then the anchor links should be all the H2s in this order:
Thanks! |
…-website into notification-usage-updates
|
@janchild re organized the H2s and added the Overview anchor back in 👍 |
…1217) * docs(notification): add notification code docs * docs(notification): remove skeleton anchor link * docs(Notification): several suggested PR changes * fix(docs): update notification code docs * docs(notification): sync up the anchor links * docs(notification): fix missing anchor * docs(notification): add overview anchor and reorder h2 Co-authored-by: Josh Black <[email protected]> Co-authored-by: Jan Child <[email protected]>
…1217) * docs(notification): add notification code docs * docs(notification): remove skeleton anchor link * docs(Notification): several suggested PR changes * fix(docs): update notification code docs * docs(notification): sync up the anchor links * docs(notification): fix missing anchor * docs(notification): add overview anchor and reorder h2 Co-authored-by: Josh Black <[email protected]> Co-authored-by: Jan Child <[email protected]>
Updates Notification code docs according to (my interpretation) of our template.