@govbr-ds/react-components

中文文档
2.15.1发布于 2026/02/06MITTypeScriptESM + CJS近 30 天下载 4745

Biblioteca de componentes react baseados no GOVBR-DS

原始使用文档
文档目录9 节
  1. Tecnologias
  2. Instalação
  3. Utilização
  4. Documentação e exemplos
  5. Contribuição
  6. Reportar bugs/necessidades
  7. Precisa de ajuda?
  8. Créditos
  9. Licença

React Components - GOVBR-DS

Licença Última release Cobertura de Testes Downloads/Mês Storybook

Biblioteca de componentes React baseada nas especificações do Padrão Digital de Governo (GOVBR-DS).

Tecnologias

Este projeto está sendo desenvolvido com:

  1. React
  2. TypeScript
  3. Jest & React Testing Library
  4. Prettier, ESLint & EditorConfig
  5. Storybook
  6. Vite

Para saber mais detalhes sobre React, sugerimos que consulte a Documentação Oficial.

Instalação

  1. Instalar a biblioteca de componentes React:

    npm install --save @govbr-ds/react-components
    
  2. Instalar a biblioteca de ícones Font Awesome Free na versão 5.x:

    npm install --save @fortawesome/fontawesome-free@^5.11.2
    
  3. Importar os arquivos CSS necessários das duas bibliotecas acima no entrypoint da aplicação (geralmente o arquivo src/index.jsx, src/index.tsx ou src/main.tsx):

    /* Arquivo src/index.jsx, src/index.tsx ou src/main.tsx */
    
    import "@fortawesome/fontawesome-free/css/all.min.css";
    import "@govbr-ds/core/dist/core.min.css";
    
  4. Adicionar as fontes Rawline e Raleway, utilizadas pelo GOVBR-DS, ao <head> do arquivo index.html ou public/index.html do projeto (Opção 1), ou instalar/baixar estas dependências e importar no entrypoint da aplicação (Opção 2):

    Opção 1:

    <!-- Arquivo index.html ou public/index.html -->
    
    <html>
      <head>
        <!-- outras entradas do <head> ... -->
    
        <!-- Fonte Rawline-->
        <link href="https://fonts.cdnfonts.com/css/rawline" rel="stylesheet" />
    
        <!-- Fonte Raleway-->
        <link
          rel="stylesheet"
          href="https://fonts.googleapis.com/css?family=Raleway:300,400,500,600,700,800,900&amp;display=swap"
        />
      </head>
      <!-- restante do documento -->
    </html>
    

    ou

    Opção 2:

    /* Arquivo src/index.jsx, src/index.tsx ou src/main.tsx */
    
    import "./assets/arquivo-fonte-rawline.css";
    import "./assets/arquivo-fonte-raleway.css";
    

Utilização

Após os passos de instalação, ja é possível importar do pacote @govbr-ds/react-components os componentes necessários em sua aplicação. Como o pacote exporta os tipos TypeScript dos componentes, se o seu projeto utilizar TypeScript, poderá se aproveitar do recurso de auto-completar as propriedades.

Exemplo:

import { BrButton } from "@govbr-ds/react-components";

const MyComponent = () => {
   return (
      <div>
         <BrButton primary size="large">My Button</Button>
      </div>
   )
}

Documentação e exemplos

A documentação sobre as propriedades dos componentes e exemplos de utilização podem ser vistos no Storybook.

Contribuição

Por favor, verifique o nosso guia de contribuição.

Especificação mínima de ferramentas para contribuição

A única ferramenta estritamente necessária é o Node.js em alguma versão >= 18.x

Desenvolvimento da biblioteca

Após clonar o projeto, entre em seu diretório pelo terminal e execute o comando abaixo para instalar as dependências necessárias:

npm install

Depois utilize os scripts disponíveis, de acordo com a necessidade, executando comandos no padrão:

npm run <nome-do-script>

Scripts disponíveis:

  • generate: executa o Plop para criar um novo componente, utilizando templates pré-definidos, com uma estrutura inicial de componente, testes unitários e Storybook. Informando apenas o nome do componente em um guia interativo, serão criados os arquivos em src/components/NomeDoComponente. Exemplo:

    $ npm run generate
    
    @govbr-ds/[email protected] generate
    plop --plopfile ./generators/plopfile.js
    
    Nome do componente? BrTable
    
    ✔  ++ ~/react-components/src/components/BrTable/index.tsx
    ✔  ++ ~/react-components/src/components/BrTable/stories.tsx
    ✔  ++ ~/react-components/src/components/BrTable/BrTable.test.tsx
    
  • test: Executa todos os testes.

  • test:watch: Executa todos os testes em watch mode.

  • coverage: Verifica a cobertura de testes do projeto.

  • dev: Inicia uma aplicação React, em modo de desenvolvimento, permitindo testar os componentes criados em um Showcase.

  • build:lib: Compila e empacota a biblioteca de componentes e a disponibiliza no diretório dist.

  • build:showcase: Compila e empacota o Showcase para produção e o disponibiliza no diretório showcase/.

  • storybook: Executa localmente a documentação do Storybook.

  • storybook:build: Prepara documentação estática do Storybook para implantação e a disponibiliza no diretório storybook/.

  • lint: Executa o ESLint para checagem estática do código, gerando um relatório no arquivo report-eslint.html.

  • commit: Executa o Commitizen para facilitar a padronização dos commits.

Commits

Utilizamos um padrão para branches e commits. Por favor observe a documentação na nossa wiki para aprender sobre os nossos padrões.

Reportar bugs/necessidades

Você pode criar issues para nos informar os problemas que tem enfrentado ao utilizar nossa biblioteca ou sugestões de novas features. Por favor, preencha o modelo que mais se encaixa na sua necessidade com o máximo de detalhes possíveis.

Nos comprometemos a responder a todas as issues.

Precisa de ajuda?

Por favor, não crie issues para fazer perguntas!

Acesse os canais abaixo para tirar suas dúvidas:

Créditos

O React Components - GOVBR-DS foi criado pelo SERPRO e Dataprev, com a participação da comunidade.

Licença

Neste projeto utilizamos a licença MIT.

版本与发布记录

@govbr-ds/react-components 共发布 26 个版本,首次发布于 2022/09/22;过去 12 个月发布了 20 个版本。

版本发布日期距今
2.15.1latest2026/02/069 个月前
2.15.02026/02/069 个月前
2.14.22026/01/289 个月前
2.14.12026/01/289 个月前
2.14.02026/01/279 个月前
2.13.02026/01/249 个月前

其他发布通道:next → 2.0.0。

关于 @govbr-ds/react-components 的常见问题

@govbr-ds/react-components 是什么?

Biblioteca de componentes react baseados no GOVBR-DS

如何安装 @govbr-ds/react-components?

在项目目录运行 npm install @govbr-ds/react-components,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(>=18.0.0)、react-dom(>=18.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@govbr-ds/react-components 支持 TypeScript 吗?

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

@govbr-ds/react-components 支持 ESM 还是 CommonJS?

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

@govbr-ds/react-components 可以商用吗?

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

@govbr-ds/react-components 的下载量有多少?

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

@govbr-ds/react-components 还在维护吗?

最新版本 2.15.1 发布于 2026/02/06(9 个月前);至今共发布 26 个版本,其中过去 12 个月发布了 20 个;首次发布于 2022/09/22。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。