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

Address color theming issues #264

Merged
merged 5 commits into from
Sep 25, 2024
Merged

Conversation

jordanjones243
Copy link
Contributor

@jordanjones243 jordanjones243 commented Sep 23, 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: #253

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.

  • Update to use correct colors for theming
  • Update dependencies
  • Point to auro-library build scripts

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

Address color theming issues by updating design tokens and refactoring component registration to use auro-library's runtime utilities. Remove outdated build scripts and update documentation and tests accordingly.

Enhancements:

  • Update color theming to use correct design tokens and improve consistency across button variants.
  • Refactor component registration to utilize auro-library's runtime utilities for better modularity.

Build:

  • Remove obsolete build scripts and update dependencies to align with auro-library standards.

Documentation:

  • Update documentation to reflect changes in component registration and theming.

Tests:

  • Modify tests to accommodate changes in component registration method.

@jordanjones243 jordanjones243 requested a review from a team as a code owner September 23, 2024 19:56
@jordanjones243 jordanjones243 self-assigned this Sep 23, 2024
Copy link

sourcery-ai bot commented Sep 23, 2024

Reviewer's Guide by Sourcery

This pull request addresses color theming issues in the auro-button component by updating the use of design tokens, introducing a new 'flat' variant, and making several other improvements to enhance consistency and maintainability. The changes include updating dependencies, refactoring color-related code, correcting attribute naming, updating documentation, and removing obsolete scripts.

File-Level Changes

Change Details Files
Refactored color theming using design tokens
  • Updated color variables to use design tokens
  • Corrected color values for different button states (hover, active, disabled)
  • Improved consistency in color naming and usage across different button variants
src/color.scss
src/tokens.scss
Introduced new 'flat' button variant
  • Added support for a new 'flat' button style without borders or background
src/auro-button.js
Corrected attribute naming for consistency
  • Changed 'ondark' attribute to 'onDark'
  • Updated 'varient' to 'variant' in selectors
src/color.scss
src/auro-button.js
Updated dependencies and build process
  • Updated design tokens and webcore stylesheets to latest versions
  • Removed obsolete scripts related to documentation generation and build preparation
  • Updated component registration process to use RuntimeUtils
package.json
index.js
demo/index.html
demo/index.md
docs/partials/index.md
Improved documentation and examples
  • Updated README with new information about button variants and attribute usage
  • Updated API documentation to reflect changes in button styling and attributes
README.md
demo/api.md
Refactored and updated tests
  • Updated test cases to use new component registration method
  • Added tests for new 'flat' variant and corrected 'onDark' attribute
test/auro-button.test.js

Sequence Diagram

sequenceDiagram
    participant U as User
    participant B as auro-button
    participant T as Design Tokens
    U->>B: Interact (hover/active/disabled)
    B->>T: Request updated color values
    T-->>B: Return appropriate color tokens
    B->>B: Apply updated colors
    B-->>U: Display updated button state
Loading

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.

@CLAassistant
Copy link

CLAassistant commented Sep 23, 2024

CLA assistant check
All committers have signed the CLA.

Copy link

github-actions bot commented Sep 23, 2024

Surge demo deployment failed! 😭

@jordanjones243 jordanjones243 marked this pull request as draft September 23, 2024 20:04
@jordanjones243 jordanjones243 linked an issue Sep 23, 2024 that may be closed by this pull request
@jordanjones243 jordanjones243 marked this pull request as ready for review September 24, 2024 18:07
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 an explanation in the PR description about the changes to component registration, as this affects how developers will use the component.
  • Please confirm that the functionality of the removed scripts (generateDocs.mjs, prepForBuild.js) is no longer needed or has been moved elsewhere.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue found
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 2 issues 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.

index.js Show resolved Hide resolved
test/auro-button.test.js Show resolved Hide resolved
demo/api.md Outdated Show resolved Hide resolved
docs/partials/index.md Show resolved Hide resolved
Copy link
Member

@jason-capsule42 jason-capsule42 left a comment

Choose a reason for hiding this comment

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

Screenshot 2024-09-25 at 8 51 09 AM This text needs to get cleaned up.

@jordanjones243 jordanjones243 merged commit 2e57c03 into master Sep 25, 2024
6 of 7 checks passed
@jordanjones243 jordanjones243 deleted the jjones/colorIssues/#253 branch September 25, 2024 16:32
@blackfalcon
Copy link
Member

🎉 This PR is included in version 8.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Sep 25, 2024
@jordanjones243 jordanjones243 linked an issue Oct 4, 2024 that may be closed by this pull request
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.

4 participants