@noot-front/voomp-ui

Biblioteca de componentes UI da Voomp para React.

Instalação

npm install @noot-front/voomp-ui
# ou
yarn add @noot-front/voomp-ui
# ou
pnpm add @noot-front/voomp-ui

Uso

Importando os componentes

import { Avatar, Typography } from '@noot-front/voomp-ui';

function App() {
  return (
    <div>
      <Avatar src="https://github.com/voomp.png" alt="Voomp" />
      <Typography variant="h1">Bem-vindo à Voomp</Typography>
    </div>
  );
}

Importando os estilos

Para usar os estilos padrão da biblioteca, importe o arquivo CSS no seu projeto:

// No seu arquivo principal (ex: App.tsx ou _app.tsx)
import '@noot-front/voomp-ui/dist/styles/tailwind.css';

Se você estiver usando Next.js, importe no seu _app.tsx:

import type { AppProps } from 'next/app';
import '@noot-front/voomp-ui/dist/styles/tailwind.css';

export default function App({ Component, pageProps }: AppProps) {
  return <Component {...pageProps} />;
}

Documentação

Para ver todos os componentes disponíveis e suas documentações, acesse nossa documentação no Storybook.

Desenvolvimento

Para contribuir com o projeto:

1. Clone o repositório
2. Instale as dependências: npm install
3. Inicie o Storybook: npm run storybook
4. Faça suas alterações
5. Crie um Pull Request

Licença

MIT