RC #329#330
Merged
Merged
Conversation
example code updated to reflect latest Auro element APIs example documentation layout improved custom registration updated and moved to install page core element descriptions updated properties now listed alphabetically doc build system now uses the latest version of auro-cli package json configuration updated to support latest auro-cli additional packages dependencies updated to latest versions
Reviewer's GuideRefactors and expands auro-hyperlink documentation and examples, tidies base component APIs and typings, improves custom element registration and packaging, updates demos to modern ESM usage, and introduces a richer PR template with explicit RC/testing checklist. Updated class diagram for auro-hyperlink core componentsclassDiagram
class LitElement
class AuroElement {
+string appearance
+string layout
}
class ComponentBase {
+string appearance
+boolean download
+boolean fluid
+string href
+boolean ondark
+boolean referrerpolicy
+string rel
+string target
+string type
+string variant
+AuroLibraryRuntimeUtils runtimeUtils
+ComponentBase()
+void _initializeDefaults()
}
class AuroHyperlink {
+string appearance
+boolean download
+boolean fluid
+string href
+boolean ondark
+boolean referrerpolicy
+string rel
+string role
+string safeUri
+string target
+string type
+string variant
+static void register(name)
}
class AuroButton {
}
class AuroHyperlinkButton {
+static void register(name)
}
class AuroLibraryRuntimeUtils {
}
LitElement <|-- AuroElement
AuroElement <|-- ComponentBase
ComponentBase <|-- AuroHyperlink
AuroButton <|-- AuroHyperlinkButton
ComponentBase --> AuroLibraryRuntimeUtils
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Closed
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've found 4 issues, and left some high level feedback:
- In
apiExamples/relative-url_code.htmlthe resolved absolute URL useshttps://www.auro.alaskaair.com/..., which looks inconsistent with the main docs domain (auro.alaskaair.com) and may lead to a broken example link—worth double‑checking the correct hostname. - The
referrerpolicyAPI is documented as a boolean flag that always maps tostrict-origin-when-cross-origin, but the name matches the native string attribute; consider calling out this semantic difference more explicitly (or renaming the property) to avoid confusion for consumers expecting the standard string-valuedreferrerpolicy.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In `apiExamples/relative-url_code.html` the resolved absolute URL uses `https://www.auro.alaskaair.com/...`, which looks inconsistent with the main docs domain (`auro.alaskaair.com`) and may lead to a broken example link—worth double‑checking the correct hostname.
- The `referrerpolicy` API is documented as a boolean flag that always maps to `strict-origin-when-cross-origin`, but the name matches the native string attribute; consider calling out this semantic difference more explicitly (or renaming the property) to avoid confusion for consumers expecting the standard string-valued `referrerpolicy`.
## Individual Comments
### Comment 1
<location> `docs/partials/api.md:29` </location>
<code_context>
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/external.html) -->
- <!-- AURO-GENERATED-CONTENT:END -->
-</div>
+Difference appearance options through the `appearance` attribute. This example shows the `inverse` appearance.
<div class="exampleWrapper--ondark">
</code_context>
<issue_to_address>
**issue (typo):** Fix grammar in the appearance description sentence.
For example: “Different appearance options are available through the `appearance` attribute. This example shows the `inverse` appearance.”
Suggested implementation:
```
Different appearance options are available through the `appearance` attribute. This example shows the `inverse` appearance.
```
The replacement assumes the existing sentence appears exactly as `Difference appearance options through the \`appearance\` attribute. This example shows the \`inverse\` appearance.` elsewhere in `docs/partials/api.md`, likely just above the `.exampleWrapper--ondark` container. If there are similar sentences for other appearances (e.g., `primary`, `secondary`), you may want to apply the same grammatical structure to those as well.
</issue_to_address>
### Comment 2
<location> `docs/partials/api.md:65` </location>
<code_context>
+#### Relative URLs
-When using `auro-hyperlink` as a navigation style, use `type="nav"` for the alternate UI. With this type, links will appear without an underline, but present the underline feedback on hover.
+Absolute URLs are not always preferred. When using relative URLs `auro-hyperlink` will insert the `https://` protocol and hostname into the `<a>` element in the shadowDOM.
<div class="exampleWrapper">
</code_context>
<issue_to_address>
**suggestion (typo):** Use the conventional "shadow DOM" phrasing instead of "shadowDOM".
Please update this to "shadow DOM" (and other occurrences, such as the note about `javascript` returning a shadow DOM as simple text) to align with common terminology.
Suggested implementation:
```
into the `<a>` element in the shadow DOM.
```
```
returns a shadow DOM as simple text
```
If there are any other occurrences of "shadowDOM" in `docs/partials/api.md` (or related docs), they should be similarly updated to "shadow DOM" for consistency.
</issue_to_address>
### Comment 3
<location> `docs/partials/api.md:80` </location>
<code_context>
-## Relative vs absolute URLs and https enforcement
-
-By default the `auro-hyperlink` will assume that the url passed is an absolute URL to `www.alaskaair.com` with the `https` protocol.
+#### Using telephone/text/mailto URLs Schemes
<div class="exampleWrapper">
</code_context>
<issue_to_address>
**suggestion (typo):** Tidy the heading wording for URL schemes.
Please change the heading to something like "Using telephone, text, and mailto URL schemes" (singular "URL" and lowercase "schemes").
```suggestion
#### Using telephone, text, and mailto URL schemes
```
</issue_to_address>
### Comment 4
<location> `docs/partials/api.md:283` </location>
<code_context>
+
+**Note:** Any `href` will be ignored when using `role="button"`. A click-event must be passed to the element as illustrated in the example below.
+
+**Accessibility:** Review the code examples, the user of this element are responsible for keyboard support when using `role="button"`.
+
+<div class="exampleWrapper">
</code_context>
<issue_to_address>
**issue (typo):** Fix subject–verb agreement in the accessibility note.
Consider changing this to either “the user of this element is responsible” or “users of this element are responsible” to fix the agreement.
```suggestion
**Accessibility:** Review the code examples; users of this element are responsible for keyboard support when using `role="button"`.
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
rmenner
approved these changes
Jan 14, 2026
|
🎉 This PR is included in version 8.0.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Alaska Airlines Pull Request
Review Checklist:
RC Checklist
Testing Checklist:
Browsers
Browsers Support Guide
Dev demo link
Android
iOS
Desktop
Scenarios
Framework playground
**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
Refine the auro-hyperlink component’s API, documentation, and demos while improving package exports and tooling configuration.
New Features:
Enhancements:
Build:
CI:
Documentation: