Skip to content

[Header]: mark remaining community subcomponents as deprecated #965

Description

@ly-tempel-bitweb

Problem

The community Header is deprecated in favour of Header from @tedi-design-system/react/tedi, and so are HeaderLanguage and HeaderRole. Several other community Header subcomponents are not marked as deprecated.

Consumers get mixed signals and can keep building on these parts without any warning, even though the parent component is going away.

Subcomponent JSDoc @deprecated Storybook deprecated status
Header ✅ ✅
HeaderLanguage ✅ ✅
HeaderRole ✅ ✅
HeaderBottomContent ❌ ❌
HeaderContent ❌ ❌
HeaderDropdown ❌ ❌
HeaderModal ❌ ❌
HeaderSettings ❌ ❌
HeaderNotification (internal) – ❌

Solution

Mark the remaining subcomponents as deprecated in the same way as HeaderLanguage and HeaderRole, with these replacements from @tedi-design-system/react/tedi:

Subcomponent Replacement Storybook status
HeaderBottomContent bottom prop of Header ['deprecated', 'ExistsInTediReady']
HeaderContent Header.Center or Header.Actions ['deprecated', 'ExistsInTediReady']
HeaderSettings HeaderProfile, HeaderLogin or HeaderLogout ['deprecated', 'ExistsInTediReady']
HeaderNotification Alert with isGlobal, rendered before Header ['deprecated', 'ExistsInTediReady']
HeaderDropdown HeaderProfile for account menus, or Popover for other content ['deprecated']
HeaderModal HeaderProfile for account menus, or Modal with position="right" for other content ['deprecated']

HeaderDropdown and HeaderModal don't get ExistsInTediReady. They are general-purpose building blocks, and there is no one-to-one TEDI-Ready version of them.

HeaderNotification is not publicly exported. It is only used through the community Header's notification prop. It gets the Storybook badge and a replacement note in its story description, but no @deprecated JSDoc.

  • Add @deprecated JSDoc naming the replacement to each exported subcomponent above
  • Set the Storybook status as listed above
  • No runtime warnings: these subcomponents are meant to be used inside the community Header, which already warns (see the deprecation guide in .claude/skills/contributing/references/deprecation.md)
  • No runtime or API changes (deprecation markers only)

SkipLinks is not part of this issue. There is no TEDI-Ready replacement yet, so it stays undeprecated until one exists.

Metadata

Metadata

Labels

communityCommunity component issue

Type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions