View Source Heroicons.Icon (ex_heroicons v3.1.0)

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

Summary

Functions

Defines the Heroicons.Icon struct.

Parses a SVG file and returns structured data

Types

t()

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

Functions

%Heroicons.Icon{}

(struct)

Defines the Heroicons.Icon struct.

Its fields are:

  • :type - the type of the icon

  • :name - the name of the icon

  • :file - the binary content of the file

parse!(filename)

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

Parses a SVG file and returns structured data