feat: add appearance and deprecate ondark #304

[sun-mota]

Alaska Airlines Pull Request

Close #304

This is to replace onDark attr with surface attr.

• Adding surface with its default value light
• Mark onDark as deprecated in the api table
• Replace onDark with surface="dark" in all examples

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

Introduce a new appearance attribute to control light or dark styling and deprecate the ondark flag across the hyperlink component.

New Features:

• Add appearance property with default value 'default' to replace ondark.

Enhancements:

• Update component base and styles to use appearance for theme variants while marking ondark as deprecated.
• Adjust hyperlink rendering logic to reflect appearance and maintain backward compatibility with ondark.

Documentation:

• Revise API documentation and all example files to replace ondark with appearance="inverse" and note deprecation of ondark.

Chores:

• Bump devDependencies for @aurodesignsystem/auro-button and @aurodesignsystem/auro-icon.

[sourcery-ai]

Reviewer's Guide

Introduce a new appearance attribute with default and inverse variants to replace ondark, deprecate ondark in the API and code, update styling and examples to use appearance, and bump relevant dependencies.

Class diagram for updated hyperlink component attributes

classDiagram
    class ComponentBase {
        +String appearance = 'default'
        +Boolean ondark (deprecated)
        +Boolean download
        +Boolean relative
        +String href
        +String referrerpolicy
        +String rel
        +Boolean fluid
        +String role
        +String safeUri
        +String target
        +String type
        +String variant
    }
    class AuroElement {
        +String appearance = 'default'
        +String lang
    }
    class AuroHyperlink {
        +String appearance
        +Boolean ondark (deprecated)
        +String type
        +String variant
        +String role
        +String safeUri
        +Boolean fluid
        +String target
        +String href
        +String rel
        +String referrerpolicy
        +Boolean download
        +Boolean relative
    }
    ComponentBase <|-- AuroHyperlink
    AuroElement <|-- ComponentBase

Loading

File-Level Changes

Change	Details	Files
Introduce appearance attribute for surface styling	Add appearance default property and reflection to ComponentBase Add appearance property declaration in AuroElement layout base	src/component-base.mjs src/layoutElement/auroElement.js
Deprecate ondark attribute	Mark ondark as deprecated in the API documentation table Annotate ondark with deprecation notice in JSDoc comments	docs/api.md src/component-base.mjs
Support appearance in styling and rendering	Extend SCSS selectors to handle [appearance="inverse"] alongside ondark Update hyperlink class logic to derive inverse mode from appearance	src/styles/color.scss src/auro-hyperlink.js
Replace example usages of ondark with appearance="inverse"	Update all HTML example files to use appearance="inverse" instead of ondark	apiExamples/cta-ondark.html apiExamples/cta-external-link-ondark.html apiExamples/navPattern-ondark.html apiExamples/basic-ondark.html apiExamples/external-ondark.html apiExamples/external-referrer-ondark.html apiExamples/navStyle-ondark.html apiExamples/roleButton-ondark.html apiExamples/cta-shape.html
Bump devDependencies patch versions	Update @aurodesignsystem/auro-button to ^12.1.0 Update @aurodesignsystem/auro-icon to ^9.1.0	package.json

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#304	Replace the 'ondark' attribute with a new attribute ('appearance' or 'surface') for indicating component background styling.	✅
#304	Deprecate the 'ondark' attribute in the API and documentation, clearly indicating to use the new attribute instead.	✅
#304	Update all code examples and usages to use the new attribute ('appearance' or 'surface') instead of 'ondark'.	✅

---

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!

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[github-actions]

Surge demo deployment failed! 😭

[sourcery-ai]

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

Prompt for AI Agents

Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `src/auro-hyperlink.js:117` </location>
<code_context>
       hyperlink: this.safeUri || this.role,
       "hyperlink--nav": this.type === "nav",
-      "hyperlink--ondark": this.ondark,
+      'hyperlink--ondark': this.appearance === 'inverse' || this.ondark,
       "hyperlink--button": this.role,
       "hyperlink--secondary": this.variant === "secondary",
</code_context>

<issue_to_address>
**issue (bug_risk):** Combining 'appearance' and 'ondark' may cause ambiguous styling.

If both 'appearance' and 'ondark' are set, clarify which should take precedence or add a warning to prevent conflicting states.
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[github-actions]

🚀 PR Release Published! v0.0.0-pr306.1

To install:

npm install @aurodesignsystem-dev/auro-hyperlink@0.0.0-pr306.1

Install via alias:

npm install @aurodesignsystem/auro-hyperlink@npm:@aurodesignsystem-dev/auro-hyperlink@0.0.0-pr306.1

View on npmjs.com

[jordanjones243]

Change name of ondark files and this PR is good to go

[github-actions]

🎉 This PR is included in version 7.0.0-rc-309.1 🎉

The release is available on:

• npm package (@rc dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[github-actions]

🎉 This PR is included in version 7.1.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[github-actions]

🎉 This PR is included in version 7.0.0-rc-320.1 🎉

The release is available on:

• npm package (@rc dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[github-actions]

🎉 This PR is included in version 7.0.0-rc-329.1 🎉

The release is available on:

• npm package (@rc dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[github-actions]

🎉 This PR is included in version 7.0.0-rc-336.1 🎉

The release is available on:

• npm package (@rc dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[github-actions]

🎉 This PR is included in version 7.0.0-rc-339.1 🎉

The release is available on:

• npm package (@rc dist-tag)
• GitHub release

Your semantic-release bot 📦🚀