Module: bajaux/icon/iconUtils

Methods

---

<static> toCssClass(uri)

Convert the URI to a usable CSS class, expected to be represented in the
spritesheet CSS for that module.

Parameters:

Name	Type	Description
uri	String

Returns:

Type

String

---

<static> toElements(icon [, sync])

Just like toHtml, but resolves an array of raw Elements instead.

Parameters:

Name	Type	Argument	Default	Description
icon	String | baja.Ord | Array.<(String|baja.Ord)> | baja.Icon
sync	boolean	<optional>	false	set to true to wait for the image to finish loading (making it possible to query it for width/height) before the toHtml promise resolves

Returns:

to be resolved with an array of
span elements

Type

Promise.<Array.<HTMLSpanElement>>

---

<static> toHtml(icon [, sync])

Given an icon value (string, baja.Icon, etc), convert it into a usable
HTML snippet.

The HTML will consist of a one or more span tags. Each span will have
one img element. If the icon is accounted for in a spritesheet, the
img tag will be hidden and the icon will be represented solely by the
span using pure CSS. If the icon is not in a spritesheet, the img
tag will be shown and have its src tag set to the raw icon image.

Parameters:

Name	Type	Argument	Default	Description
icon	String | baja.Ord | Array.<(String|baja.Ord)> | baja.Icon
sync	boolean	<optional>	false	set to true to wait for the image to finish loading (making it possible to query it for width/height) before the toHtml promise resolves

Returns:

promise to be resolved with a raw HTML string containing
one or more span tags

Type

Promise.<string>

---

<static> toUris(icon)

Convert a value to an array of image URIs.

Parameters:

Name	Type	Description
icon	String | baja.Ord | Array.<(String|baja.Ord)> | baja.Icon	a string or array of strings. Each string can be a URI directly, or a module:// ORD. These will be converted to URIs to image files. If passing in arbitrary ORDs, it's recommended to relativizeToSession() first.

Throws:

if invalid input given

Type

Error

Returns:

array of image URIs

Type

Array.<String>