ExTeal
v0.27.0

View Source ExTeal.Plugin behaviour (ExTeal v0.27.0)

The base module that describes the functionality of a plugin

Summary

Types

t()

Callbacks

js_config()
navigation_component()
router()
scripts()
styles()
title()
uri()

Functions

available_scripts(plugin)
available_styles()
available_styles(plugin)

Types

Link to this type

t()

View Source 
@type t() :: %ExTeal.Plugin{
  js_config: term(),
  navigation_component: term(),
  options: term(),
  router: term(),
  scripts: term(),
  styles: term(),
  title: term(),
  uri: term()
}

Callbacks

Link to this callback

js_config()

View Source 
@callback js_config() :: map()
Link to this callback

navigation_component()

View Source 
@callback navigation_component() :: String.t() | nil
Link to this callback

router()

View Source 
@callback router() :: module() | nil
Link to this callback

scripts()

View Source 
@callback scripts() :: [ExTeal.Asset.Script.t()]
Link to this callback

styles()

View Source 
@callback styles() :: [ExTeal.Asset.Style.t()]
Link to this callback

title()

View Source 
@callback title() :: String.t()
Link to this callback

uri()

View Source 
@callback uri() :: String.t() | nil

Functions

Link to this function

available_scripts(plugin)

View Source
Link to this function

available_styles()

View Source
Link to this function

available_styles(plugin)

View Source