UNPKG

febo-ui

Version:

Acelere seu Desenvolvimento com Nossa Biblioteca de Componentes para React, Febo UI

117 lines (75 loc) 4.42 kB
<a name="readme-top"></a> [![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Issues][issues-shield]][issues-url] [![Stargazers][stars-shield]][stars-url] [![LinkedIn][linkedin-shield]][linkedin-url] <p align="center"> <a href="https://www.feboui.com.br"> <img src="././public/febo_ui_logo.png" alt="Febo UI logo" width="300" /> </a> </p> <h1 align="center">Febo UI</h1> <h3 align="center">Acelere seu Desenvolvimento com Nossa Biblioteca de Componentes de Alta Performance para React</h3> <br> <p> Simplifique e otimize seus projetos com a versátil biblioteca de componentes para React reutilizáveis, Febo UI. Repleta de componentes simples e práticos, ela foi meticulosamente projetada para potencializar seu fluxo de trabalho. Com uma ampla gama de opções diversificadas à disposição, você poderá desenvolver interfaces robustas e atrativas de maneira fluida. Priorizamos a acessibilidade, assegurando que seus produtos sejam inclusivos e utilizáveis por todos os públicos. Desenvolva com confiança aplicações incríveis de forma eficaz e descomplicada. </p> <br/> ### Índice <a href="#Documentação">Documentação</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp; <a href="#Instalação">Instalação</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp; <a href="#Exemplos-de-uso">Exemplos de uso</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp; <a href="#Contribuindo">Contribuindo</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp; <a href="#Licença">Licença</a> <br> ### <strong>Documentação</strong> <p> Toda a documentação de cada componente criado, assim como seu uso prático, se encontra no nosso site oficial <a href="https://www.feboui.com.br">https://www.feboui.com.br</a> </p> <br/> ### <strong>Instalação</strong> <p>Para começar fazer uso da biblioteca Febo UI, é simples, basta apenas instalar o pacote <i>febo-ui</i> com suas dependências em seu projeto e começar a usar <p> ```sh npm i febo-ui # or yarn add febo-ui ``` <br/> ### <strong>Exemplos de uso</strong> <p>Após instalado a biblioteca, você pode estar fazendo a chamada dela importando algum de seus componentes dessa seguinte maneira. </p> ```jsx import { Button } from "febo-ui"; function App() { return ( <Button backgroundColor="#ff8b4d" bold color="white" label="Small" size="small" /> ); } ``` <p>Neste exemplo, dentro do arquivo App, estamos chamando diretamente o Componente Button e passando algumas de suas props, para ser renderizado na tela</p> <p>Mais exemplos de uso, e sobre quais props cada componente suporta, só acessar a documentação <a href="https://www.feboui.com.br">aqui</a></p> <br/> ### <strong>Contribuindo</strong> <p>Gostou do projeto? Saiba que ele é Open Source, ou seja, fique a seu critério caso queira contribuir, atualizando algo na documentação, ou adicionando um novo componente, corrigindo algum possível bug, o projeto é nosso, vou deixar o link do <a href="https://github.com/HMontarroyos/FeboUI">repositório aqui</a>, só forkar ele e abrir seu PR que estarei analisando cada trecho ;) </p> <br/> ### <strong>Licença</strong> MIT © [Hebert Montarroyos ](https://github.com/HMontarroyos) [contributors-shield]: https://img.shields.io/github/contributors/HMontarroyos/FeboUI.svg?style=for-the-badge [contributors-url]: https://github.com/HMontarroyos/FeboUI/graphs/contributors [forks-shield]: https://img.shields.io/github/forks/HMontarroyos/FeboUI.svg?style=for-the-badge [forks-url]: https://github.com/HMontarroyos/FeboUI/fork [stars-shield]: https://img.shields.io/github/stars/HMontarroyos/FeboUI.svg?style=for-the-badge [stars-url]: https://github.com/HMontarroyos/FeboUI/stargazers [issues-shield]: https://img.shields.io/github/issues/HMontarroyos/FeboUI.svg?style=for-the-badge [issues-url]: https://github.com/HMontarroyos/FeboUI/issues [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 [linkedin-url]: https://www.linkedin.com/in/hebertmontarroyos-developer/ [downloads-shield]: https://img.shields.io/github/contributors/HMontarroyos/FeboUI.svg?style=for-the-badge [downloads-url]: https://github.com/HMontarroyos/FeboUI/graphs/contributors