View Source ExTeal.Application.Configuration behaviour (ExTeal v0.26.0)

Defines a behavior for configuring the main teal application.

It relies on (and uses):

Summary

Callbacks

Returns the name of the teal application that is used in the html titles of all pages.

Returns an array of dashboards

Returns the json configuration required for the vue app.

Returns the path to the logo that is used in the admin panel.

Define the order in which groups are shown in the sidebar. By default only the general 'Resources' group is used, but by overriding the nav_groups/1 function in the manifest, you can define the order of the groups.

Returns the base path that the teal app is located.

Callbacks

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

Returns the name of the teal application that is used in the html titles of all pages.

@callback dashboards() :: [module()]

Returns an array of dashboards

@callback json_configuration(Plug.Conn.t()) :: map()

Returns the json configuration required for the vue app.

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

Returns the path to the logo that is used in the admin panel.

@callback nav_groups(Plug.Conn.t()) :: [String.t()]

Define the order in which groups are shown in the sidebar. By default only the general 'Resources' group is used, but by overriding the nav_groups/1 function in the manifest, you can define the order of the groups.

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

Returns the base path that the teal app is located.

Functions

@spec parse_json(Plug.Conn.t()) :: map()