Eml.Element

Summary
Types
Functions

Eml.Element defines a struct that represents an element in Eml.

In practice, you will mostly use the element macro’s instead of directly creating Eml.Element structs, but the functions in this module can be valuable when querying, manipulating or transforming eml.

Source

Summary↑

add(el, data, opts \\ [])	Adds content to an element
attr(element, field)	Gets a specific attribute
attr(el, field, value)	Sets a attribute
attrs(element)	Gets the attributes map of an element
attrs(el, attrs)	Merges the passed attributes with the current attributes
class(element)	Gets the class or classes of an element
class(el, class)	Sets the class or classes of an element
content(element)	Gets the content of an element
content(el, data)	Sets the content of an element
has?(el, opts)	Returns true if all properties of the opts argument are matching with the provided element
id(element)	Gets the id of an element. Returns `nil` if the `id` attribute is not set for the element
id(el, id)	Sets the id of an element
new()	Creates a new `Eml.Element` structure with default values
new(tag, attrs \\ %{}, content \\ [])	Creates a new `Eml.Element` structure
remove(el, to_remove)	Removes content from an element that matches any term in the `to_remove` list
remove_attr(el, field)	Removes an attribute from an element
tag(element)	Gets the tag of an element
tag(el, tag)	Sets the tag of an element
update(el, fun)	Update content in an element by calling fun on the content to get new content

Types ↑

attr_name :: atom

attr_value :: String.t | Eml.Parameter.t | [String.t | Eml.Parameter]

attrs :: %{attr_name => attr_value}

attrs_in :: [{attr_name, attr_value_in}] | %{attr_name => attr_value_in}

t :: %Eml.Element{tag: atom, content: Eml.content, attrs: attrs}

Functions

add(el, data, opts \\ [])

(function) # ↑

Specs:

add(t, Eml.Data.t, Keyword.t) :: t

Adds content to an element.

Before being added to the element, input data is parsed to valid eml.

Example

iex> div = Eml.Element.new(:div, [], [])
#div<>
iex> div = Eml.Element.content(div, ["Hallo ", 2, 0, [1, 5]])
#div<["Hallo 2015"]>
iex> Eml.Element.add(div, " !!!")
#div<["Hallo 2015 !!!"]>

Source

attr(element, field)

(function) # ↑

Specs:

attr(t, atom) :: attr_value

Gets a specific attribute.

If the attribute does not exist, nil is returned.

Source

attr(el, field, value)

(function) # ↑

Specs:

attr(t, atom, attr_value_in) :: t

Sets a attribute.

If the attribute already exists, the old value gets overwritten.

Source

attrs(element)

(function) # ↑

Specs:

attrs(t) :: attrs

Gets the attributes map of an element.

Source

attrs(el, attrs)

(function) # ↑

Specs:

attrs(t, attrs_in) :: t

Merges the passed attributes with the current attributes.

Source

class(element)

(function) # ↑

Specs:

class(t) :: attr_value

Gets the class or classes of an element.

Multiple classes are stored in the form ["class1", "class2"].

Source

class(el, class)

(function) # ↑

Specs:

class(t, attr_value_in) :: t

Sets the class or classes of an element.

Multiple classes can be assigned by providing a list of strings.

Source

content(element)

(function) # ↑

Specs:

content(t) :: Eml.content

Gets the content of an element.

Note that content in Eml always is a list, so when an element’s content is empty, it returns an empty list.

Source

content(el, data)

(function) # ↑

Specs:

content(t, Eml.Data.t) :: t

Sets the content of an element.

Before being assigned to the element, input data is parsed to valid eml.

Example

iex> div = Eml.Element.new(:div, [], [])
#div<>
iex> Eml.Element.content(div, ["Hallo ", 2, 0, [1, 5]])
#div<["Hallo 2015"]>

Source

has?(el, opts)

(function) # ↑

Specs:

has?(t, Keyword.t) :: boolean

Returns true if all properties of the opts argument are matching with the provided element.

Example

iex> e = Eml.Element.new(:img, id: "duck-photo", src: "http://i.imgur.com/4xPWp.jpg")
#img<%{id: "duck-photo", src: "http://i.imgur.com/4xPWp.jpg"}>
iex> Eml.Element.has?(e, id: "duck-photo")
true
iex> Eml.Element.has?(e, src: "http://i.imgur.com/4xPWp.jpg")
true
iex> Eml.Element.has?(e, src: "http://i.imgur.com/4xPWp.jpg", id: "wrong")
false

Source

id(element)

(function) # ↑

Specs:

id(t) :: attr_value

Gets the id of an element. Returns nil if the id attribute is not set for the element.

Source

id(el, id)

(function) # ↑

Specs:

id(t, attr_value_in) :: t

Sets the id of an element.

Source

new()

(function) # ↑

Specs:

new :: t

Creates a new Eml.Element structure with default values.

Source

new(tag, attrs \\ %{}, content \\ [])

(function) # ↑

Specs:

new(atom, attrs_in, Eml.Data.t) :: t

Creates a new Eml.Element structure.

Example

iex> e = Eml.Element.new(:div, [id: 42], "hallo!")
#div<%{id: "42"} ["hallo!"]>
iex> Eml.render(e)
"<div id='42'>hallo!</div>"

Source

remove(el, to_remove)

(function) # ↑

Specs:

remove(t, Eml.t | Eml.content) :: t

Removes content from an element that matches any term in the to_remove list.

Example

iex> div1 = Eml.Element.new(:div, [], "hallo")
#div<["hallo"]>
iex> div2 = Eml.Element.new(:div, [], "world")
#div<["world"]>
iex> div3 = Eml.Element.new(:div, [], [div1, div2])
#div<[#div<["hallo"]>, #div<["world"]>]>
iex> Eml.Element.remove(div3, [div1, div2])
#div<>

Source

remove_attr(el, field)

(function) # ↑

Specs:

remove_attr(t, atom) :: t

Removes an attribute from an element.

Source

tag(element)

(function) # ↑

Specs:

tag(t) :: atom

Gets the tag of an element.

Source

tag(el, tag)

(function) # ↑

Specs:

tag(t, atom) :: t

Sets the tag of an element.

Source

update(el, fun)

(function) # ↑

Specs:

update(t, (Eml.t -> Eml.Data.t)) :: t

Update content in an element by calling fun on the content to get new content.

Before being added to the element, input data is parsed to valid eml.

Example

iex> div = Eml.Element.new(:div, [], "hallo")
#div<["hallo"]>
iex> Eml.Element.update(div, fn content -> String.upcase(content) end)
#div<["HALLO"]>

Source