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

Give buttons unique id attributes #275

Merged
merged 1 commit into from
Jan 27, 2025
Merged

Conversation

jordanjones243
Copy link
Contributor

@jordanjones243 jordanjones243 commented Jan 27, 2025

Alaska Airlines Pull Request

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Resolves: #274

Summary:

Please summarize the scope of the changes you have submitted, what the intent of the work is and anything that describes the before/after state of the project.

Type of change:

Please delete options that are not relevant.

  • New capability
  • Revision of an existing capability
  • Infrastructure change (automation, etc.)
  • Other (please elaborate)

Checklist:

  • My update follows the CONTRIBUTING guidelines of this project
  • I have performed a self-review of my own update

By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission.

Thank you for your submission!

-- Auro Design System Team

Summary by Sourcery

Enhancements:

  • Give buttons unique id attributes to prevent conflicts.

@jordanjones243 jordanjones243 self-assigned this Jan 27, 2025
@jordanjones243 jordanjones243 requested a review from a team as a code owner January 27, 2025 20:37
Copy link

sourcery-ai bot commented Jan 27, 2025

Reviewer's Guide by Sourcery

This pull request ensures that each button has a unique ID, which is necessary for proper functionality when multiple buttons are present on a page. The change was implemented by updating the IDs of the auro-dropdown and custom-dropdown components in the apiExamples files and updating the corresponding javascript to use the new IDs.

Sequence diagram for updated dropdown dismiss interaction

sequenceDiagram
    participant User
    participant Button
    participant Dropdown

    User->>Button: Clicks dismiss button
    Button->>Dropdown: querySelector('#commonMatchWidth').hide()
    Note right of Dropdown: Updated selector with
    Note right of Dropdown: unique ID 'commonMatchWidth'
    Dropdown-->>User: Dropdown hidden
Loading

Class diagram showing component structure with unique IDs

classDiagram
    class AuroDropdown {
        +id: commonMatchWidth
        +common: boolean
        +matchWidth: boolean
        +hide()
    }

    class CustomDropdown {
        +id: commonCustom
        +common: boolean
        +hide()
    }

    class AuroButton {
        +onclick: function
    }

    AuroDropdown --> AuroButton
    CustomDropdown --> AuroButton

    note for AuroDropdown "Updated with unique ID"
    note for CustomDropdown "Updated with unique ID"
Loading

File-Level Changes

Change Details Files
Updated the ID of the auro-dropdown component and the corresponding javascript to use the new ID.
  • Changed the id of the auro-dropdown component from 'common' to 'commonMatchWidth'.
  • Updated the javascript to use the new id 'commonMatchWidth'.
apiExamples/commonMatchWidth.html
Updated the ID of the custom-dropdown component and the corresponding javascript to use the new ID.
  • Changed the id of the custom-dropdown component from 'common' to 'commonCustom'.
  • Updated the javascript to use the new id 'commonCustom'.
apiExamples/custom.html
Added auro-icon and auro-input to the demo page.
  • Added a script tag for auro-icon.
  • Added a script tag for auro-input.
demo/api.html
Removed the demo markdown files.
  • Removed the demo/api.md file.
  • Removed the demo/index.md file.
demo/api.md
demo/index.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@jordanjones243 jordanjones243 linked an issue Jan 27, 2025 that may be closed by this pull request
Copy link

github-actions bot commented Jan 27, 2025

Surge demo deployment failed! 😭

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @jordanjones243 - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@jordanjones243 jordanjones243 force-pushed the jjones/fixExamples/#274 branch from 11e1e25 to 230aabc Compare January 27, 2025 20:40
@jordanjones243 jordanjones243 force-pushed the jjones/fixExamples/#274 branch from 230aabc to 3ee21e4 Compare January 27, 2025 20:44
@jordanjones243 jordanjones243 merged commit e620091 into main Jan 27, 2025
6 of 7 checks passed
@jordanjones243 jordanjones243 deleted the jjones/fixExamples/#274 branch January 27, 2025 20:47
@blackfalcon
Copy link
Member

🎉 This PR is included in version 3.2.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Jan 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Completed work has been released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Give the auro-button in examples unique id attributes
3 participants