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

Improve header documentation #4279

Open
3 tasks
gfellerph opened this issue Dec 13, 2024 · 0 comments
Open
3 tasks

Improve header documentation #4279

gfellerph opened this issue Dec 13, 2024 · 0 comments
Labels
📦 documentation Related to the @swisspost/design-system-documentation package
Milestone

Comments

@gfellerph
Copy link
Member

The header docs does not have any controls (args). Add the following args to the header docs.

Controls

  • Application title: [boolean and string] Controls the presence and content of the slotted <h1>
  • Meta navigation: [boolean] Controls the presence of the meta navigation ("About us" and "Jobs")
  • Custom controls: [boolean] Controls the presence of default slot content (currently "Search" and "Login" links in the local header)

Slots

  • post-logo: Should be used together with the <post-logo> component (Remove default slot on host for post-logo #4276)
  • meta-navigation: Holds an ul with meta nav links
  • post-togglebutton: Holds the mobile menu toggler (Remove default slot on host for <post-togglebutton> #4277)
  • post-language-switch: For the post-language-switch component
  • title: Application title
  • default: Custom controls or content, right aligned in the local header
  • post-mainnavigation: Has a default slot because it's only meant to be used in the <post-header>

Required CSS imports

  • header
  • list
  • button

Utility classes should not be necessary to style the header (#4278).

Tasks

Preview Give feedback
@gfellerph gfellerph added the 📦 documentation Related to the @swisspost/design-system-documentation package label Dec 13, 2024
@gfellerph gfellerph changed the title Add controls for the header docs Improve header documentation Dec 13, 2024
@gfellerph gfellerph added this to the PPNL Support milestone Dec 13, 2024
@gfellerph gfellerph moved this from 👀 Triage to 💻 Ready for development in Design System Production Board Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📦 documentation Related to the @swisspost/design-system-documentation package
Projects
Status: 💻 Ready for development
Development

No branches or pull requests

1 participant