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

Expose cssparts for styling #262

Merged
merged 1 commit into from
Nov 13, 2024
Merged

Conversation

jordanjones243
Copy link
Contributor

@jordanjones243 jordanjones243 commented Nov 12, 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: #261

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

Expose CSS parts in the AuroDropdown component to allow styling from parent components and update the README.md to reflect the new version of the auro-dropdown script.

New Features:

  • Expose CSS parts for styling from parent components in the AuroDropdown component.

Documentation:

  • Update README.md to reflect the new version of auro-dropdown script.

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

sourcery-ai bot commented Nov 12, 2024

Reviewer's Guide by Sourcery

This PR adds CSS part exposure functionality to the auro-dropdown component, allowing parent components to style specific parts of the dropdown through the Shadow DOM. The implementation uses the exportparts attribute to expose specific CSS parts with corresponding names.

Class diagram for AuroDropdown with exposed CSS parts

classDiagram
    class AuroDropdown {
        +exposeCssParts() void
    }
    note for AuroDropdown "The exposeCssParts method sets the 'exportparts' attribute to expose CSS parts for styling."
Loading

File-Level Changes

Change Details Files
Added CSS parts exposure functionality to enable styling from parent components
  • Created new private method exposeCssParts()
  • Exposed trigger part as 'dropdownTrigger'
  • Exposed chevron part as 'dropdownChevron'
  • Exposed help text part as 'dropdownHelpText'
  • Exposed popover part as 'dropdownPopover'
src/auro-dropdown.js
Updated package version reference in documentation
  • Bumped auro-dropdown version from 3.1.3 to 3.1.4 in CDN script reference
README.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.
  • 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:

  • Please add documentation with examples showing how to use the newly exposed CSS parts (dropdownTrigger, dropdownChevron, dropdownHelpText, dropdownPopover) for styling customization.
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 merged commit 820d8e9 into main Nov 13, 2024
6 checks passed
@jordanjones243 jordanjones243 deleted the jjones/exposeCssParts/#216 branch November 13, 2024 16:21
@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.

Add functionality that will expose dropdown's cssparts to be consumed by parent components
3 participants