@dt-dds/react-app-header

中文文档
1.0.0-beta.111发布于 2026/11/13MITTypeScriptESM + CJS近 30 天下载 5019

AppHeader is a flexible compound component that provides a complete application header with support for multiple layouts, responsive behavior, and customizable sections including logo, app name, navigation, and action buttons.

原始使用文档
文档目录13 节
  1. Figma Reference
  2. AppHeader Usage
  3. API
  4. AppHeader
  5. AppHeader.Logo
  6. AppHeader.AppName
  7. AppHeader.Navigation
  8. AppHeader.Actions
  9. Stack
  10. Commands
  11. Compilation
  12. Versioning
  13. © License

AppHeader

AppHeader is a flexible compound component that provides a complete application header with support for multiple layouts, responsive behavior, and customizable sections including logo, app name, navigation, and action buttons.

Figma Reference

Figma

AppHeader Usage

import { AppHeader } from '@dt-dds/react-app-header';
import { Icon } from '@dt-dds/react-icon';
import { IconButton } from '@dt-dds/react-icon-button';

export const App = () => {
  return (
    <AppHeader type='standard'>
      <AppHeader.Actions position='left'>
        <IconButton ariaLabel='menu' onClick={() => null}>
          <Icon code='menu' />
        </IconButton>
      </AppHeader.Actions>

      <AppHeader.AppName name='My App' />

      <AppHeader.Logo>
        <img src='/logo.svg' alt='Logo' />
      </AppHeader.Logo>

      <AppHeader.Navigation position='center'>
        <ul>
          <li>
            <a href='/home'>Home</a>
          </li>
          <li>
            <a href='/about'>About</a>
          </li>
        </ul>
      </AppHeader.Navigation>

      <AppHeader.Actions position='right'>
        <IconButton ariaLabel='search' onClick={() => null}>
          <Icon code='search' />
        </IconButton>
      </AppHeader.Actions>
    </AppHeader>
  );
};

API

AppHeader

The main container component that manages layout and state for all child components.

PropertyTypeDefaultDescription
type'standard' | 'compact'standardDetermines the header layout. standard shows app name before logo, compact shows it after logo.
styleReact.CSSProperties-Custom CSS properties to apply to the header container
childrenReactNode-Child components: Logo, AppName, Navigation, and Actions

Container for the application logo. Automatically adjusts positioning based on header type and layout.

PropertyTypeDefaultDescription
childrenReactNode-Logo content (typically an image)
styleReact.CSSProperties-Custom CSS properties

AppHeader.AppName

Displays the application name with automatic typography styling based on header type.

PropertyTypeDefaultDescription
namestring-Application name text
childrenReactNode-Alternative to name prop for custom content
styleReact.CSSProperties-Custom CSS properties

AppHeader.Navigation

Container for navigation links. Supports flexible positioning and responsive visibility.

PropertyTypeDefaultDescription
childrenReactNode-Navigation content (typically a list of links)
position'center' | 'left' | 'right'centerNavigation position within the header
styleReact.CSSProperties-Custom CSS properties

AppHeader.Actions

Container for action buttons and controls (search, menu, user profile, etc.). Supports left and right positioning.

PropertyTypeDefaultDescription
childrenReactNode-Action buttons and controls
position'left' | 'right'rightPosition of actions within the header
styleReact.CSSProperties-Custom CSS properties

Responsive Props

All compound components (Logo, AppName, Navigation, Actions) support responsive visibility through hide and show props:

  • hide: Hides the component when the media query matches (e.g., hide={(min-width: ${theme.breakpoints.mq3}px)} hides on desktop)
  • show: Shows the component only when the media query matches (e.g., show={(max-width: ${theme.breakpoints.mq3}px)} shows only on mobile)
  • If both hide and show are provided, hide takes precedence

Stack

  • TypeScript for static type checking
  • React — JavaScript library for user interfaces
  • Emotion — for writing css styles with JavaScript
  • Storybook — UI component environment powered by Vite
  • Jest - JavaScript Testing Framework
  • React Testing Library - to test UI components in a user-centric way
  • ESLint for code linting
  • Prettier for code formatting
  • Tsup — TypeScript bundler powered by esbuild
  • Yarn from managing packages

Commands

  • yarn build - Build the package
  • yarn dev - Run the package locally
  • yarn lint - Lint all files within this package
  • yarn test - Run all unit tests
  • yarn test:report - Open the test coverage report
  • yarn test:update:snapshot - Run all unit tests and update the snapshot

Compilation

Running yarn build from the root of the package will use tsup to compile the raw TypeScript and React code to plain JavaScript.

The /dist folder contains the compiled output.

app-header
└── dist
    ├── index.d.ts  <-- Types
    ├── index.js    <-- CommonJS version
    └── index.mjs   <-- ES Modules version
    ...

Versioning

Follows semantic versioning

© License

Licensed under MIT License

版本与发布记录

@dt-dds/react-app-header 共发布 108 个版本,首次发布于 2025/11/26;过去 12 个月发布了 108 个版本。

版本发布日期距今
1.0.0-beta.111latest2026/11/13今天
1.0.0-beta.1102026/11/094 天前
1.0.0-beta.1092026/11/094 天前
1.0.0-beta.1082026/11/058 天前
1.0.0-beta.1072026/11/058 天前
1.0.0-beta.1062026/11/049 天前

关于 @dt-dds/react-app-header 的常见问题

@dt-dds/react-app-header 是什么?

AppHeader is a flexible compound component that provides a complete application header with support for multiple layouts, responsive behavior, and customizable sections including logo, app name, navigation, and action buttons.

如何安装 @dt-dds/react-app-header?

在项目目录运行 npm install @dt-dds/react-app-header,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(>=17.0.2)、react-dom(>=17.0.2)、@emotion/css(^11.7.1)、@emotion/react(^11.8.2)、@emotion/styled(^11.8.1)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@dt-dds/react-app-header 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@dt-dds/react-app-header 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@dt-dds/react-app-header 可以商用吗?

@dt-dds/react-app-header 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@dt-dds/react-app-header 的下载量有多少?

根据 npm 官方下载统计,@dt-dds/react-app-header 在 2026/10/13 – 2026/11/11 这 30 天内被下载 5,019 次,日均约 167 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@dt-dds/react-app-header 还在维护吗?

最新版本 1.0.0-beta.111 发布于 2026/11/13(今天);至今共发布 108 个版本,其中过去 12 个月发布了 108 个;首次发布于 2025/11/26。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。