patternfly-react icon indicating copy to clipboard operation
patternfly-react copied to clipboard

chore(NotificationDrawer):convert examples to typescript

Open janwright73 opened this issue 3 years ago • 7 comments

What: Closes #7642

Additional issues: I may need some extra guidance here as the existing example is throwing errors on PF.org. I also noticed that the design guidelines stated for grouped examples that only one group should be open at a time. The existing demos do not enforce this behavior. Final question - the 'lightweight' example - what is the purpose of this one? The only difference is the lack of global action menu and no close button for the drawer??

janwright73 avatar Jul 05 '22 20:07 janwright73

Preview: https://patternfly-react-pr-7656.surge.sh

A11y report: https://patternfly-react-pr-7656-a11y.surge.sh

patternfly-build avatar Jul 05 '22 20:07 patternfly-build

I also noticed that the design guidelines stated for grouped examples that only one group should be open at a time. The existing demos do not enforce this behavior.

That's a great catch. It would be wise that our examples adhere to design guidelines since people like to copy/paste our example code. @mmenestr do you think the design guidelines that Jan references here are up to date and correct?

Final question - the 'lightweight' example - what is the purpose of this one? The only difference is the lack of global action menu and no close button for the drawer??

This is a great question for @mcarrano when he is back from PTO. A quick once over from me did not identify any other differences between the two examples.

nicolethoen avatar Jul 08 '22 13:07 nicolethoen

The design guidelines for this should be up to date as there have not really been any activity on this for at least the path year. If I recall, the "lightweight" variant was created specifically for OpenShift since they wanted to use a more stripped down implementation of the drawer.

mcarrano avatar Jul 11 '22 14:07 mcarrano

@mcarrano - would Joe C be a good person to connect with for the need to keep (or can) the lightweight example?

janwright73 avatar Jul 11 '22 17:07 janwright73

would Joe C be a good person to connect with for the need to keep (or can) the lightweight example?

Yes, definitely @janwright73

mcarrano avatar Jul 11 '22 20:07 mcarrano

@mcarrano @janwright73 @nicolethoen Thats correct, the lightweight example is basically the OpenShift implementation. Since the original design, however, there was a follow on feature to add the x to close the drawer. Also there is no read/unread notifications since we don't have that concept with openshift. I should also say that regrettably we have not yet merged the pr that @DaoDaoNoCode wrote that contributes back the pf component, but thats another story. Design wise, the lightweight example is supposed to reflect the openshift implementation.

jcaianirh avatar Jul 12 '22 21:07 jcaianirh

accepted all suggestions from Eric - please let me know if there are additional tasks to complete this work.

janwright73 avatar Aug 05 '22 19:08 janwright73

Hey @tlabaj - the alst update did include the lightweight example updates that Eric requested. Is there an issue with the changes that I missed?

janwright73 avatar Aug 18 '22 14:08 janwright73

Hey @tlabaj - the alst update did include the lightweight example updates that Eric requested. Is there an issue with the changes that I missed?

@janwright73 it looks fine to me. It is however visually different from what was there before. Which is ok based on the conversation above. I will defer to @jcaianirh and @mcarrano for approval on the lightweight example.

tlabaj avatar Aug 18 '22 18:08 tlabaj

Since the goal was to match OpenShift's implementation with this example, I'm OK with it even though it diverges from what we have now. That said, I'm not that familiar with the details of OpenShift's implementation so I'll defer to @jcaianirh on whether this is correct.

mcarrano avatar Aug 18 '22 20:08 mcarrano

Your changes have been released in:

Thanks for your contribution! :tada:

patternfly-build avatar Aug 23 '22 15:08 patternfly-build