Skip to content

Update AppHeader docs with Application Title content #2968

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

Merged
merged 31 commits into from
Jun 30, 2025

Conversation

jorytindall
Copy link
Contributor

@jorytindall jorytindall commented Jun 21, 2025

📌 Summary

This PR updates the documentation of the AppHeader with content detailing the properties and arguments pertaining to adding an application title, including:

  • the addition of the @text and @isIconOnly properties
  • the change in logic for the aria-label within the home link
  • removes the @ariaLabel property from the component API.

🔗 External links

Jira ticket: HDS-4918
Figma file

📋 PCI review checklist
  • If applicable, I've documented a plan to revert these changes if they require more than reverting the pull request.
  • If applicable, I've worked with GRC to document the impact of any changes to security controls.
    Examples of changes to controls include access controls, encryption, logging, etc.
  • If applicable, I've worked with GRC to ensure compliance due to a significant change to the in-scope PCI environment.
    Examples include changes to operating systems, ports, protocols, services, cryptography-related components, PII processing code, etc.

…dding instead to support variable length string content
…sktop to the showcase, along with examples of child components
Copy link

vercel bot commented Jun 21, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
hds-showcase ✅ Ready (Inspect) Visit Preview Jun 23, 2025 10:07pm
hds-website ✅ Ready (Inspect) Visit Preview Jun 23, 2025 10:07pm

@hashibot-hds hashibot-hds added packages/components docs-website Content updates to the documentation website showcase labels Jun 21, 2025
@jorytindall jorytindall changed the base branch from main to jt/application-title/hds-4866 June 21, 2025 23:46
@jorytindall jorytindall marked this pull request as ready for review June 22, 2025 00:03
@jorytindall jorytindall requested review from a team as code owners June 22, 2025 00:03
Copy link
Contributor

@didoo didoo left a comment

Choose a reason for hiding this comment

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

there may be an issue in the Component API definitions

Copy link
Contributor

@didoo didoo left a comment

Choose a reason for hiding this comment

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

👍

Copy link
Contributor

@majedelass majedelass left a comment

Choose a reason for hiding this comment

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

This looks good to me 👍

@jorytindall jorytindall changed the base branch from jt/application-title/hds-4866 to docs/4.21 June 25, 2025 20:51
@jorytindall jorytindall merged commit 0d6ca33 into docs/4.21 Jun 30, 2025
16 checks passed
@jorytindall jorytindall deleted the jt/application-title-docs branch June 30, 2025 23:19
@didoo didoo mentioned this pull request Jul 1, 2025
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-website Content updates to the documentation website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants