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 example of how to make a custom bib height with new dropdown feature #220

Merged
merged 5 commits into from
Nov 13, 2024

Conversation

jordanjones243
Copy link
Contributor

@jordanjones243 jordanjones243 commented Nov 13, 2024

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: #134, #216

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

Add an example to demonstrate customizing the bib height in the auro-dropdown component using CSS parts, and update documentation accordingly. Enhance the auro-select component by exposing CSS parts for styling.

New Features:

  • Introduce an example demonstrating how to set a custom height for the bib in the auro-dropdown component using CSS parts.

Enhancements:

  • Expose CSS parts from the auro-dropdown for styling purposes, allowing more customization.

Documentation:

  • Add documentation for a new example showing how to customize the bib height in auro-dropdown using CSS parts.

@jordanjones243 jordanjones243 self-assigned this Nov 13, 2024
@jordanjones243 jordanjones243 requested a review from a team as a code owner November 13, 2024 17:12
Copy link

sourcery-ai bot commented Nov 13, 2024

Reviewer's Guide by Sourcery

This PR adds documentation and implementation for customizing the bib (dropdown menu) height in auro-select component. The changes include updating dependencies, adding new examples, and exposing CSS parts from the dropdown component for styling customization.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added support for custom bib height styling in auro-select component
  • Exposed CSS parts from the dropdown component through exposeCssParts() method
  • Added 'part="dropdown"' attribute to enable CSS part styling
  • Created new example demonstrating custom bib height implementation
src/auro-select.js
Added documentation for custom bib height feature
  • Added new section explaining how to customize bib height
  • Included code examples with max-height and overflow-y scroll settings
  • Added documentation for CSS Shadow Parts
demo/index.md
docs/partials/index.md
docs/api.md
demo/api.md
Updated project dependencies and configuration
  • Updated auro-dropdown to version 3.2.0
  • Updated auro-menu to version 4.1.5
  • Added nodeResolve plugin to rollup configuration
  • Updated various dev dependencies
package.json
rollup.config.mjs

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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

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 - here's some feedback:

Overall Comments:

  • Consider adding accessibility guidance for keyboard users when implementing scrollable dropdowns, particularly regarding focus management and ensuring all options remain keyboard-navigable.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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 and I'll use the feedback to improve your reviews.

src/auro-select.js Show resolved Hide resolved
demo/index.md Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/index.md Outdated Show resolved Hide resolved
demo/index.md Outdated Show resolved Hide resolved
demo/api.md Outdated Show resolved Hide resolved
@jason-capsule42 jason-capsule42 merged commit f84293c into main Nov 13, 2024
6 checks passed
@jason-capsule42 jason-capsule42 deleted the jjones/customBibSize/#216 branch November 13, 2024 20:27
@blackfalcon
Copy link
Member

🎉 This PR is included in version 3.2.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

auro-select: Dropdown list too narrow and expanding to full screen Document how restricted height works
3 participants