@eduzz/ui-antd-theme

中文文档
5.0.1发布于 2026/10/17MITTypeScriptCommonJS近 30 天下载 2337

Eduzz Hooks: Antd Theme

原始使用文档
文档目录6 节
  1. Instalação
  2. Utilização
  3. Parâmetros
  4. useTheme
  5. Icon
  6. Animação nos botões

Eduzz UI: Antd Theme

version size

Tema de antd ajustado aos padrões de UI da Eduzz.

Changelog

Instalação

Para adicionar o tema no seu projeto, pasta rodar:

pnpm add @eduzz/ui-antd-theme

Utilização

import { ThemeProvider } from '@eduzz/ui-antd-theme';

function App() {
  return (
    <ThemeProvider>
      <section>
        <Typography.Title level={1}>H1 - Roboto</Typography.Title>
        <Typography.Title level={2}>H2 - Roboto</Typography.Title>
        <Typography.Title level={3}>H3 - Roboto</Typography.Title>
        <Typography.Title level={4}>H4 - Roboto</Typography.Title>
        <Typography.Title level={5}>H5 - Roboto</Typography.Title>

        <Typography.Paragraph>Paragraph - Roboto</Typography.Paragraph>
      </section>
    </ThemeProvider>
  );
}

export default App;

Parâmetros

Aceita todas as props do ConfigProvider do Antd e mais:

PropriedadeTipoObrigatórioPadrãoDescrição
modelight|darkfalse'light'Modo do tema (dark/light), troca automaticamente com o ModeSwitcher do @eduzz/ui-layout
persistModebooleanfalsefalseQuando true, lê e grava o modo no cookie eduzz-theme (mesmo cookie do @eduzz/ui-layout). Também aceita ?eduzzMode=dark|light na URL.
enableAnimationbooleanfalsefalseHabilita motion tokens do Antd e o efeito de wave/ripple nos botões (showInsetEffect por padrão). Override via prop wave.

useTheme

Hook para ler e alterar o modo do tema (light / dark). Deve ser usado dentro de um ThemeProvider.

Se estiver utilizando @eduzz/ui-layout, utilize o useTheme do @eduzz/ui-layout.

import { useTheme } from '@eduzz/ui-antd-theme';

function ThemeToggle() {
  const { theme, toggle, setTheme } = useTheme();

  return (
    <>
      <button onClick={toggle}>Tema atual: {theme}</button>
      <button onClick={() => setTheme('dark')}>Dark</button>
    </>
  );
}

Icon

Proxy sobre os ícones do lucide-react, acessados por nome (Icon.Home). Já inclui wrapper compatível com anticon do Antd e aceita todas as LucideProps (size, color, strokeWidth, etc.). className, style, ref e aria-label aplicam-se ao wrapper (span.anticon); props visuais do Lucide ficam no SVG.

import { Icon } from '@eduzz/ui-antd-theme';
import { Button } from 'antd';

function Example() {
  return (
    <Button icon={<Icon.Rocket />}>
      Launch
    </Button>
  );
}

Animação nos botões

Com enableAnimation, o ThemeProvider aplica showInsetEffect app-wide no ConfigProvider. Para trocar o efeito, passe wave ou use showShakeEffect:

import { ThemeProvider, showShakeEffect } from '@eduzz/ui-antd-theme';
import { Button } from 'antd';

function App() {
  return (
    <ThemeProvider enableAnimation wave={{ showEffect: showShakeEffect }}>
      <Button type="primary">Click me</Button>
    </ThemeProvider>
  );
}

版本与发布记录

@eduzz/ui-antd-theme 共发布 95 个版本,首次发布于 2023/07/11;过去 12 个月发布了 39 个版本。

版本发布日期距今
5.0.1latest2026/10/1728 天前
5.0.1-rc.3rc2026/10/101 个月前
5.0.1-rc.22026/10/091 个月前
5.0.1-rc.12026/10/031 个月前
5.0.1-rc.02026/10/031 个月前
5.0.02026/09/012 个月前

关于 @eduzz/ui-antd-theme 的常见问题

@eduzz/ui-antd-theme 是什么?

Eduzz Hooks: Antd Theme

如何安装 @eduzz/ui-antd-theme?

在项目目录运行 npm install @eduzz/ui-antd-theme,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:antd(6.6.0)、react(>=18)、react-dom(>=18)、lucide-react(1.25.0)、@ant-design/cssinjs(2.1.2)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@eduzz/ui-antd-theme 支持 TypeScript 吗?

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

@eduzz/ui-antd-theme 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@eduzz/ui-antd-theme 可以商用吗?

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

@eduzz/ui-antd-theme 的下载量有多少?

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

@eduzz/ui-antd-theme 还在维护吗?

最新版本 5.0.1 发布于 2026/10/17(28 天前);至今共发布 95 个版本,其中过去 12 个月发布了 39 个;首次发布于 2023/07/11。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。