/flowbite_icons

Phoenix components for Flowbite Icons!

Primary LanguageElixirMIT LicenseMIT

Flowbite Icons

Flowbite Icons "is a free and open-source collection of SVG icons that you can use in personal and commercial projects by giving attribution." This package gives you Elixir functions to drop Flowbite Icons into your HTML, styled with arbitrary classes.

This library provides optimized svgs for each Flowbite Icon packaged as a Phoenix Component.

Flowbite Icons are designed by Evelyne Krall & Robert Tanislav and interface coded by Zoltán Szőgyényi.

Current Flowbite Icons Version: main branch. Current Icon repository: github:themesberg/flowbite-icons

Installation

If available in Hex, the package can be installed by adding flowbite_icons to your list of dependencies in mix.exs:

def deps do
  [
    {:flowbite_icons, "~> 0.1.4"}
  ]
end

Usage

The icons are provided by the Flowbite.Icons module. Each icon is a Phoenix Component you can use in your HEEx templates.

Here are some examples:

<Flowbite.Icons.outline_file_copy />
<Flowbite.Icons.solid_users_group />
<Flowbite.Icons.solid_flowbite class="w-4 h-4" />

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/flowbite_icons.

Thank you and Credits

This package is mostly based on the work of @mveytsman and his repository heroicons_elixir.