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.

Sign up for GitHub

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

Jump to bottom

Overlay documentation #2856

Closed
wants to merge 1 commit into from
Closed

Overlay documentation #2856

wants to merge 1 commit into from

Conversation

mikearildbrown
Copy link
Contributor

@mikearildbrown mikearildbrown commented Dec 18, 2023 •
edited by feliciackh
Loading

closes #2807
documentation for #2735

@mikearildbrown mikearildbrown linked an issue Dec 18, 2023 that may be closed by this pull request
Overlay Documentation #2807
Closed
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Dec 18, 2023

⚠️ No Changeset found

Latest commit: c1d1fa9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel Vercel
Copy link

vercel bot commented Dec 18, 2023 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
saltdesignsystem ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 18, 2023 4:45pm

@github-actions GitHub Actions
Copy link
Contributor

Storybook Preview Link https://b16fe7ca.saltdesignsystem-storybook.pages.dev

joshwooding
joshwooding reviewed Dec 19, 2023
View reviewed changes
site/docs/components/overlay/index.mdx
sourceCodeUrl: "https://github.com/jpmorganchase/salt-ds/tree/main/packages/lab/src/overlay"
package:
name: "@salt-ds/lab"
alsoKnownAs: ["Dialog", "Modal"]
Copy link
Contributor

Choose a reason for hiding this comment

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

Where did we get these from?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

the alsoKnownAs metadata? it came from the word doc, should we remove?

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm a bit conflicted about it, we already have a Dialog component which is also known as a Modal. Having two with the same aka seems confusing. I also wouldn't expect someone who is looking for a Dialog to want an overlay

Copy link
Contributor

Choose a reason for hiding this comment

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

that was included as part of my initial draft for Overlay docs. I think Popover works better than the above 2, @joshwooding what others do you reckon would be best suited for aka here?

cc @bhoppers2008 @mikearildbrown please feel free to amend/update accordingly

@feliciackh feliciackh changed the base branch from main to overlay December 19, 2023 11:00
@feliciackh
Copy link
Contributor

closing this draft PR, new PR here: #2860

@feliciackh feliciackh closed this Dec 19, 2023
@joshwooding joshwooding deleted the 2807-overlay-documentation branch May 31, 2024 09:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@feliciackh feliciackh feliciackh left review comments

@joshwooding joshwooding joshwooding left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Overlay Documentation
3 participants
@mikearildbrown @feliciackh @joshwooding