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

Add note in the Dropdown docs to highlight possible quirk in the close execution #420

Merged
merged 1 commit into from
Jun 30, 2022

Conversation

didoo
Copy link
Contributor

@didoo didoo commented Jun 30, 2022

📌 Summary

@jgwhite has found a strange behaviour of the Dropdown::ListItem::Interactive when it's invoking the close method for the Dropdown component (documented in this comment).

As suggested in this Slack thread, it's better to document this quirk behaviour of the <LinkTo> Ember component in the Dropdown documentation and link to @jgwhite comment, that contains a detail explanation of the problem and a suggested solution (🙌).

🛠️ Detailed description

In this PR I have:

  • added a note in the Dropdown docs to highlight possible quirk in the close execution

Preview: https://hds-components-git-update-docs-linkto-quirk-hashicorp.vercel.app/components/dropdown


👀 How to review

👉 Review by files changed

💬 Please consider using conventional comments when reviewing this PR.

@didoo didoo requested review from jgwhite and alex-ju June 30, 2022 13:40
@changeset-bot
Copy link

changeset-bot bot commented Jun 30, 2022

⚠️ No Changeset found

Latest commit: 65bf52b

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
Copy link

vercel bot commented Jun 30, 2022

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

Name Status Preview Updated
hds-components ✅ Ready (Inspect) Visit Preview Jun 30, 2022 at 1:40PM (UTC)
hds-flight-website ✅ Ready (Inspect) Visit Preview Jun 30, 2022 at 1:40PM (UTC)

Copy link
Contributor

@jgwhite jgwhite left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@didoo didoo merged commit 08e0ae4 into main Jun 30, 2022
@didoo didoo deleted the update-docs-linkto-quirk branch June 30, 2022 14:01
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.

3 participants