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

docs: Toast UI Component Docs #1003

Closed
wants to merge 4 commits into from

Conversation

dgodinez-dh
Copy link
Contributor

closes #874
Some thoughts from the Spectrum docs (https://react-spectrum.adobe.com/react-spectrum/Toast.html)

  • Toast is in beta. Do we want to use beta components in deephaven ui?
  • I tried to import Toast from our components package and does not seem to be available, so this will require a change.
  • The docs say to render a ToastContainer at the root of your app, so this is another change.
  • The Spectrum API passes an object of options to the queue methods. I though our code would look cleaner if those options were direct arguments in the method calls, so I wrote the documentation as such. But I am fine changing it if we do not like that idea.

@dgodinez-dh dgodinez-dh changed the title Toast UI Component Docs docs: Toast UI Component Docs Nov 8, 2024
@dsmmcken
Copy link
Contributor

This all seems reasonable to me. Implementation looks good.

Copy link
Member

@mofojed mofojed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks fine an matches Spectrum spec.
I would've thought ui.toast("blah", variant="positive") (or even just ui.text.positive("blah"))would be more intuitive/concise, but I'm hesitant to deviate from the Spectrum spec (even though it's in Beta, hasn't changed in a while). Sounds like @dsmmcken doesn't want to deviate either.

@dgodinez-dh
Copy link
Contributor Author

Do we want to merge these docs or start implementation and then merge them?

@dsmmcken
Copy link
Contributor

ui.toast("blah", variant="positive") does seem more concise, and I would support that instead if you prefer it.

Start implementation and then merge them, docs should go in at same time as feature is supported.

@dgodinez-dh
Copy link
Contributor Author

I prefer the more concise syntax as well. We need to make changes in web-client-ui. I created this issue and assigned it to myself.
deephaven/web-client-ui#2293
Let me know if there is any problem with that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: ui.toast
3 participants