Biblioteca ZUQ Components

Esta biblioteca contém uma coleção de componentes reutilizáveis que podem ser integrados aos seus projetos. A biblioteca é construída com Vite e suporta múltiplos modos de execução para desenvolvimento e produção.

Instalação

Primeiro, instale todas as dependências necessárias:

npm install

Modos de Execução

O projeto suporta múltiplos modos de execução:

Storybook

Para executar o servidor Storybook para documentação e teste dos componentes:

npm run storybook

Build de Produção

Para gerar um build de produção dos componentes:

npm run build

Importar build para o projeto pneus:

Execute o build para produção.
Execute o comando abaixo no projeto que vai importar o pacote do zuq-components,
OBS: no exemplo abaixo é utilizado o path onde o zuq-components está duas pastas antes da atual, sempre dar import no path onde se encontra o package.json do zuq-components.

npm install --save ./../../zuq-components

Importe os seguintes pacotes do projeto que vai utilizar o zuq-components:

import 'zuq-components'
import 'zuq-components/style.css'

Utilizando os Componentes

Você pode importar os componentes de duas maneiras:

Importação Estática

import { Button } from '@zuq/components';

function App() {
  return <Button>Click me</Button>;
}

Importação Dinâmica

const Button = await import('@zuq/components/Button');

function App() {
  return <Button>Click me</Button>;
}

Variáveis de Ambiente

Para configurar as variáveis de ambiente deste projeto, siga estes passos:

1. Criar o arquivo .env

Dentro da pasta zuq-components (no mesmo local do arquivo vite.config.lib.js), crie um arquivo chamado .env com o seguinte conteúdo:

VITE_FIGSPEC_KEY=...

Substitua ... por uma chave válida sem aspas (" " ou ' ').

2. Exemplo de uma Chave Válida

Uma chave formatada corretamente se parece com isto:

VITE_FIGSPEC_KEY=figd121ndebfiy2yuk32aokhy3adwaieo12h8nty1

3. Obtendo a Chave

Se você não tem acesso à chave necessária, você pode:

• Entrar em contato com o líder técnico para assistência
• Verificar a documentação do projeto para mais detalhes

Atenção

Esta biblioteca está em constante evolução e desenvolvimento. Por isso:

• Novos componentes são adicionados regularmente
• Atualizações de segurança e melhorias de performance são frequentes
• Recomendamos sempre utilizar a versão mais recente
• Fique atento às breaking changes nas notas de atualização
• Para sugestões ou problemas, abra uma issue no repositório

Para manter-se atualizado sobre as mudanças, consulte nosso changelog regularmente.