Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(OUI Docs) Notification event #88

Closed
3 tasks
Tracked by #112
KrooshalUX opened this issue Oct 17, 2022 · 7 comments · Fixed by #549
Closed
3 tasks
Tracked by #112

(OUI Docs) Notification event #88

KrooshalUX opened this issue Oct 17, 2022 · 7 comments · Fixed by #549
Assignees
Labels

Comments

@KrooshalUX
Copy link
Contributor

KrooshalUX commented Oct 17, 2022

  • remove all logos from each example
  • remove "beta" from page
  • remove "new" from side navigation
@KrooshalUX KrooshalUX changed the title Notification event Notification event (OUI Docs) Oct 17, 2022
@KrooshalUX KrooshalUX changed the title Notification event (OUI Docs) (OUI Docs) Notification event Oct 17, 2022
@bandinib-amzn
Copy link
Member

@KrooshalUX

Evaluate Notification event in its current state from the above list - Is it auditing task for notification event?

@kavilla
Copy link
Member

kavilla commented Oct 24, 2022

@kaddy645 will look into this.

@kaddy645
Copy link
Contributor

kaddy645 commented Nov 2, 2022

@KrooshalUX I do not think we are using this component anywhere in OSD. looking at its current state it looks good to use. In future we might need to update some of its prop if needed.

@KrooshalUX
Copy link
Contributor Author

@kaddy645 correct, we are not using it yet. I mostly just wanted to know if there is anything you might find that would prevent us from using it - sounds like no concern with its current implementation and documentation. Thanks!

@KrooshalUX
Copy link
Contributor Author

@kaddy645 did you notice any differences between the component and the documentation? if not, we can check these tasks off and close the issue, and i can remove beta from the docs pages (tracked in the meta docs issue)

@kaddy645
Copy link
Contributor

kaddy645 commented Nov 2, 2022

Component looks good to me. there are few required props we have in docs that end user will need when using this component. there are number of other props, but as long they are not required we are good.

(just for e.g )

  • Id : A unique identifier
title :The title of the event.
  • eventName : A unique, human-friendly name for the event to be used in aria attributes (e.g. "alert-critical-01", "cloud-no-severity-12", etc..
  • messages : Notification messages as an array of strings. More than one message wraps in an accordion.
  • time : Indicates when the event was received.
  • iconType : icon used to visually represent this data type. Accepts any OuiIcon IconType.
  • type : Type of event (e.g. "Alert", "Cloud", etc..). Shows inside a badge.


@KrooshalUX
Copy link
Contributor Author

Updated description relevant to docs site task

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

7 participants