Bevi Icon Library

Uma biblioteca de ícones voltada para projetos Bevi, oferecendo três variantes de modelos que permitem alterar cores e tamanhos de forma simplificada.

📖 Documentation · 🐞 Report Bug · 🚀 Request Feature

O que é Bevi Icon

A Biblioteca de Ícones da Bevi é uma ferramenta poderosa e flexível projetada especificamente para atender às necessidades dos projetos Bevi. Ela oferece uma vasta coleção de ícones que podem ser facilmente integrados em seus aplicativos e sites, proporcionando um toque visual distintivo e atraente.

Principais Recursos

• Três Variantes de Modelo: A Bevi Icon Library oferece três variantes de modelo: solid, duo, light e dark. Isso permite que você escolha o estilo de ícone que melhor se adapta ao seu projeto e ajuste as cores conforme necessário.

• Facilidade de Uso: Integrar ícones em seu projeto nunca foi tão simples. Com uma única linha de código, você pode adicionar ícones a botões, barras de navegação, menus e muito mais.

• Personalização Flexível: A biblioteca permite que você personalize o tamanho, a cor e até mesmo adicione títulos aos seus ícones, tornando-os altamente adaptáveis às suas necessidades de design.

• Acessibilidade: Os ícones da Bevi Icon Library são projetados com acessibilidade em mente. Eles incluem a capacidade de adicionar títulos que são usados para melhorar a experiência de usuários com leitores de tela.

Como começar

Instalação

Para começar a usar a Biblioteca de Ícones da Bevi, siga os passos simples de instalação:

1. Abra seu terminal.
2. Navegue até a pasta do seu projeto.
3. Execute o seguinte comando para instalar a biblioteca via NPM:

npm i bevi-icon

Para mais informações sobre o pacote NPM, você pode visitar a 📦 página do bevi-icon no NPM

Importação

Depois de instalar a biblioteca, você pode começar a usá-la em seu código. Importe o componente BvIcon onde você deseja utilizar ícones da Bevi Icon Library. Veja como fazer isso em JavaScript/ES6:

import { BvIcon } from 'bevi-icon'

Uso Básico

Agora que você importou o componente, você pode começar a usar ícones em seu projeto. É muito simples:

Em seu código HTML ou JSX, adicione o componente BvIcon e especifique o nome do ícone que você deseja exibir. Exemplo:

<BvIcon name='cube' />

Você pode personalizar ainda mais o ícone definindo suas propriedades, como variante, tamanho e título. Por exemplo:

<BvIcon
	name='cube'
	variant='duo'
	size={4}
	title='Ícone de Cubo'
/>

Isso é tudo o que você precisa para começar a usar ícones da Biblioteca de Ícones da Bevi em seu projeto. É simples e altamente personalizável para atender às suas necessidades de design.

Lembre-se de consultar a 📖 documentação dos ícones disponíveis para encontrar os nomes dos ícones que você pode usar em sua aplicação.

License

A Biblioteca de Ícones da Bevi é licenciada sob os termos da 📜 Licença MIT.