Iconify.Icon (Iconify v0.3.1)

Represents a single normalized Iconify icon.

Summary

Types

t()

Functions

decode(json)

Decodes a JSON string into this struct.

decode!(json)

Decodes a JSON string into this struct, raising on failure.

dump(struct)

Dumps this struct into JSON-shaped data, respecting JSON field names.

from_map(map)

Builds this struct from a decoded JSON map.

from_map!(map)

Builds this struct from a decoded JSON map, raising on failure.

schema()

Returns a JSON Schema-compatible schema map.

viewbox(icon)

Returns the viewBox string for this icon.

Types

t()

@type t() :: %Iconify.Icon{
  body: String.t(),
  h_flip: boolean(),
  height: pos_integer(),
  hidden: boolean(),
  left: integer(),
  name: String.t(),
  rotate: integer(),
  top: integer(),
  v_flip: boolean(),
  width: pos_integer()
}

Functions

decode(json)

Decodes a JSON string into this struct.

decode!(json)

Decodes a JSON string into this struct, raising on failure.

dump(struct)

Dumps this struct into JSON-shaped data, respecting JSON field names.

from_map(map)

Builds this struct from a decoded JSON map.

from_map!(map)

Builds this struct from a decoded JSON map, raising on failure.

schema()

Returns a JSON Schema-compatible schema map.

viewbox(icon)

@spec viewbox(t()) :: String.t()

Returns the viewBox string for this icon.