sourceboat / tabler_icons_elixir

This package provides Elixir functions in order to use Tabler Icons in your HTML, styled with arbitrary classes.

Tabler Icons

Tabler Icons are free and open source icons. This package provides Elixir functions in order to use Tabler Icons in your HTML, styled with arbitrary classes.

This package is strongly inspired by heroicons_elixir.

Note: As we are dealing with over 3.000 icons and an output file with more than 70.000 lines of code, the compile time may be longer than usual.

Installation

The package can be installed by adding tabler_icons to your list of dependencies in mix.exs:

def deps do
  [
    {:tabler_icons, "~> 0.5.0"}
  ]
end

Usage

<TablerIcons.user />
<TablerIcons.icon name={:user} />

You may pass arbitrary HTML attributes to the components:

<TablerIcons.user class="w-2 h-2" />
<TablerIcons.icon name={:user} class="w-2 h-2" />

For additional information and list of all icons see the docs.

Naming

We are interested in keeping the same icon names for our functions TablerIcons provides to us. Nevertheless, Elixir do not allow function names to begin with a number. Therefore we had to add some exceptions:

• 2fa -> two_fa
• 3d-cube-sphere-off -> three_d_cube_sphere_off
• 3d-cube-sphere -> three_d_cube_sphere
• 3d-rotate -> three_d_rotate
• 24-hours -> twenty_four_hours
• 12-hours -> twelve_hours
• 123 -> one_two_three
• 360-view -> three_sixty_view
• 360 -> three_sixty

A hyphen is replaced by an underscore automatically.

Update TablerIcons version

You can find the current TablerIcons version in lib/tabler_icons.ex.

Updating the TablerIcons version is usually done by the maintainers of this package so you may ignore this.

1. Check whether there are icon names that begin with a number and add exception to lib/mix/tasks/build.ex (add icon name to readme).
2. Update TablerIcons version in lib/mix/tasks/download.ex.
3. Run mix download in order to download newest icons into /assets.
4. Run mix build in order to build new lib/tabler_icons.ex file based on the icons.
5. Update version in mix.exs.
6. Update repository with the corresponding changes.
7. Release new version of the package.

tabler_icons_elixir's Issues

Create github action to publish package automatically

The package should be published to hex.pm automatically when new tag has been pushed to repository.

https://github.com/marketplace/actions/publish-to-hex

• Create hex.pm api key
• Create github action

Documentation

Improve ex_doc documentation.

Run tests automatically

Depends on #4

Run tests on repository pushes in github action.

• Add github action to run tests

Dynamic icons

Add component to render icon components dynamically.

For example <TablerIcons.icon name={:user} />

Cache dependencies in CI

Tests

Add tests.

• LiveView: test component returns corresponding svg
• Test documentation

Repository description and tags

• Add repository description:

  This package provides Elixir functions in order to use Tabler Icons in your HTML, styled with arbitrary classes.

  https://hex.pm/packages/tabler_icons

• Add repository tags: elixir, phoenix-framework, phoenix-liveview

• Remove release and packages section