Solid (solid v0.12.0) View Source
Main module to interact with Solid
Link to this section Summary
Functions
It generates the compiled template
It generates the compiled template
It renders the compiled template using a map with vars
Link to this section Functions
Specs
parse(String.t(), Keyword.t()) :: {:ok, %Solid.Template{parsed_template: term()}} | {:error, %Solid.TemplateError{ __exception__: term(), line: term(), message: term(), reason: term() }}
It generates the compiled template
This function returns {:ok, template}
if successfully parses the template, {:error, template_error}
otherwise
Options
parser
- a custom parser module can be passed. SeeSolid.Tag
for more information
Specs
It generates the compiled template
This function returns the compiled template or raises an error. Same options as parse/2
Specs
render(%Solid.Template{parsed_template: term()}, map(), Keyword.t()) :: iolist()
render( list(), %Solid.Context{ counter_vars: term(), cycle_state: term(), iteration_vars: term(), vars: term() }, Keyword.t() ) :: {iolist(), %Solid.Context{ counter_vars: term(), cycle_state: term(), iteration_vars: term(), vars: term() }}
It renders the compiled template using a map with vars
Options
file_system
: a tuple of {FileSystemModule, options}. If this option is not specified,Solid
usesSolid.BlankFileSystem
which raises an error when therender
tag is used.Solid.LocalFileSystem
can be used or a custom module may be implemented. SeeSolid.FileSystem
for more details.custom_filters
: a module name where additional filters are defined. The base filters (thos fromSolid.Filter
) still can be used, however, custom filters always take precedence.
Example:
fs = Solid.LocalFileSystem.new("/path/to/template/dir/")
Solid.render(template, vars, [file_system: {Solid.LocalFileSystem, fs}])