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

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

t()

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

Callbacks

js_config()

@callback js_config() :: map()

navigation_component()

@callback navigation_component() :: String.t() | nil

router()

@callback router() :: module() | nil

scripts()

@callback scripts() :: [ExTeal.Asset.Script.t()]

styles()

@callback styles() :: [ExTeal.Asset.Style.t()]

title()

@callback title() :: String.t()

uri()

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