gazin-tech-gazin-ui v1.4.2

Gazin UI

Essa é a biblioteca de componentes para os projetos web da Gazin Tech, baseado no Chakra-ui

Instalação

O projeto de produção pode ser usado adicionando a dependência com:

yarn add gazin-tech-gazin-ui

ou

npm i gazin-tech-gazin-ui

Configure o Provider

Na raiz do seu projeto configure o provider, também é necessário utilizar o react-router-dom

import * as React from 'react'
import ReactDOM from 'react-dom'

// 1. importe o `GazinTechProvider` e o BrowserRouter

import {
  GazinTechProvider,
  extendTheme,
  ExampleTheme,
} from "gazin-tech-gazin-ui";

import { BrowserRouter } from 'react-router-dom'

ReactDOM.render(
  <React.StrictMode>
    // 2. Envolva seu código no provider e no BrowserRouter
    <BrowserRouter>
        <GazinTechProvider theme={extendTheme(ExampleTheme)}>
            <p>Seu código vai aqui</p>
        </GazinTechProvider>
    </BrowserRouter>
  </React.StrictMode>,
  document.getElementById('root')
)

Ou, em um projeto com Next.js use como

import type { AppProps } from 'next/app'
// 1. importe o `GazinTechProvider` e o BrowserRouter

import {
  GazinTechProvider,
  extendTheme,
  ExampleTheme,
} from "gazin-tech-gazin-ui";

import { BrowserRouter } from 'react-router-dom'

function MyApp({ Component, pageProps }: AppProps) {
  return (
    // 2. Envolva seu código no provider e no BrowserRouter
    <BrowserRouter>
      <GazinTechProvider theme={extendTheme(ExampleTheme)}>
        <Component {...pageProps} />
      </GazinTechProvider>
    <BrowserRouter/>
  )
}

Pronto! Agora é só usar os componentes disponíveis da gazin-ui

Como contribuir

1. Faça o clone do repositorio:

  $ git clone https://gitlab.gazin.com.br/internal-tools/gazin-ui.git

Depois instale as dependências do projeto.

yarn

ou

npm install

Publishing

Todo a parte de publish do pacote é gerenciada pela pipeline, não realize publish manual, basta utilizar o prefixo de commmit Fix

fix: 'initial commit'