View Source API Reference Tamnoon v1.0.0-rc.3
Modules
This module provides functions needed to initialize Tamnoon. You do not need to handle
it directly, rather, the only time you need to call something in this module is in your
supervision tree, to add it to the children and configure it (see child_spec/1).
This module provides functions for compiling (/parsing) Tamnoon HEEx components.
This module defines the Tamnoon.Component behaviour, which includes the
heex/0 callback. It should be implemented in every component module.
An action that will append the :child node to the :parent node's children.
An action that will trigger the :callback action on each element in the
collection :target.
An action that will remove the :target node from the DOM.
An action that will replace the :target node with the :replacement node.
An action that will set the :attribute attribute of the :target node
to :value. Can also be used to set the textContent of a node by passing "textContent"
to :attribute.
An action that will replace the :target node's innerHTML with :value.
An action that will set the value of the :target node to :value.
An action that will toggle :attribute attribute of the :target node. An additional
argument :force_to can also be provided in order to force the value as true or false.
Represents a DOM node. Accepts two parameters for how to select the node,
:selector_type and :selector_value. For example, when :selector_type is :id and
:selector_value is "id-to-select", it will be equivalent to using
document.getElementById("id-to-select") in JS.
Represents a DOM node collection. Accepts two parameters for how to select the nodes,
:selector_type and :selector_value. For example, when :selector_type is :children and
:selector_value is a Tamnoon.DOM.Node.t/0, it will be equivalent to using
element.children() in JS.
This module handles the management of different methods as you create them.
Notably, it provides the defmethod/2 macro.
A methods module that provides built-in methods for use in your Tamnoon application.
This module provides a default router for HTTP(S) requests, which builds and serves the web app.
Tamnoon's :cowboy_websocket implementation. There should be no reason to interact with this
module, however, it is still documented to allow extensibility.
You can replace the module with another by setting the :socket_handler value in
Tamnoon.start_link/1's options.
Mix Tasks
Creates a "components" directory inside "lib" and a "tamnoon_out" directory in the root of the project.
Creates a default router module and a root component.
Runs all the necessary Tamnoon setup tasks.