View Source Heroicons.Icon (ex_heroicons v2.0.0)

This module defines the data structure and functions for working with icons stored as SVG files.

Link to this section Summary

t()

%Heroicons.Icon{}

Defines the Heroicons.Icon struct.

Inserts HTML attributes into an SVG icon

opts_to_attrs(opts)

Converts opts to HTML attributes

parse!(filename)

Parses a SVG file and returns structured data

@type t() :: %Heroicons.Icon{file: binary(), name: String.t(), type: String.t()}

(struct)

Defines the Heroicons.Icon struct.

Its fields are:

@spec insert_attrs(
  binary(),
  keyword()
) :: Phoenix.HTML.safe()

Inserts HTML attributes into an SVG icon

@spec opts_to_attrs(keyword()) :: list()

Converts opts to HTML attributes

@spec parse!(String.t()) :: t()

Parses a SVG file and returns structured data