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

Jbaker/fix placeholder reset #203

Merged
merged 2 commits into from
Sep 11, 2024
Merged

Conversation

jason-capsule42
Copy link
Member

@jason-capsule42 jason-capsule42 commented Sep 11, 2024

Alaska Airlines Pull Request

Resolves: #202

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

Enhance the auro-select component to support simultaneous use of the label slot and placeholder attribute, fix a bug related to placeholder handling, and update documentation with relevant examples.

New Features:

  • Introduce the ability to use the label slot and placeholder attribute together in the auro-select component.

Bug Fixes:

  • Fix the issue where the placeholder text was incorrectly handled when the option was a string in the auro-select component.

Documentation:

  • Add documentation and examples for using the label slot with the placeholder attribute in the auro-select component.

@jason-capsule42 jason-capsule42 requested a review from a team as a code owner September 11, 2024 16:44
@jason-capsule42 jason-capsule42 self-assigned this Sep 11, 2024
Copy link

sourcery-ai bot commented Sep 11, 2024

Reviewer's Guide by Sourcery

This pull request addresses an issue with placeholder reset in the auro-select component and adds documentation for using a label with a placeholder. The main changes include modifying the auro-select.js file to handle placeholder text correctly and updating documentation files to demonstrate the new functionality.

File-Level Changes

Change Details Files
Modified auro-select.js to handle placeholder text correctly
  • Added a condition to check if the option is not equal to the placeholder
  • Added an additional check to ensure the option is an object before cloning
src/auro-select.js
Added documentation for using a label with a placeholder
  • Created a new example file labelWithPlaceholder.html
  • Updated demo/api.md with new section for label with placeholder
  • Updated docs/partials/api.md with new section for label with placeholder
apiExamples/labelWithPlaceholder.html
demo/api.md
docs/partials/api.md
Removed CSS Custom Property fallbacks section from README
  • Deleted the section for CSS Custom Property fallbacks
docTemplates/README.md

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

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 @jason-capsule42 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding unit tests to verify the new placeholder reset behavior and prevent future regressions.
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: 1 issue found

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 to tell me if it was helpful.

demo/api.md Show resolved Hide resolved
@jason-capsule42
Copy link
Member Author

  • Consider adding unit tests to verify the new placeholder reset behavior and prevent future regressions.

Unit tests for this behavior already exist.

@jason-capsule42 jason-capsule42 merged commit 78d72d1 into main Sep 11, 2024
6 checks passed
@jason-capsule42 jason-capsule42 deleted the jbaker/fixPlaceholderReset branch September 11, 2024 20:18
@blackfalcon
Copy link
Member

🎉 This PR is included in version 2.10.8 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Sep 11, 2024
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.

Select with a placeholder and label displays the placeholder value more than once when cleared
3 participants