View Source API Reference ExTeal v0.28.1

ExTeal Actions allow you to perform one off tasks on your ExTeal Index resources with custom conditions. For example you might want to batch update a group of articles to a published state.

Used to return the result of an action and specifies how the ux should respond

API Responder that manages cards

Translates a changeset into an error

API Responder that manages the many to many relationships via

API Responder for Metrics

Simple Plug that routes a request to the appropriate plugin

Hands requests of a certain type to the appropriate resource, and returns the resources response as serialized json

Defines a behavior for configuring the main teal application.

Functionality for fetching Vue Assets

Struct used to represent a JS Script that is served by Teal and required by a plugin on the front end.

Struct used to represent a CSS Stylesheet that is served by Teal and required by a plugin on the front end.

Generic Provider that allows anyone to interact with ExTeal.

Interface for providing authorization and authentication to ExTeal.

Represents a Card that can be displayed on a dashboard or resource

Not the thing you get the mail, but a card that appears on the dashboard.

Sometimes you need a summary table that doesn't easily fit into a single resource. Sometimes you need a collection of summary tables on a dashboard.

Module used to represent a dashboard which contains a grid of metrics, this will one day be extendable to include plugin or custom cards in the future.

Generates a panel that contains the fields for a single embed, defined by its field name

The core struct that represents a field on a resource served by ExTeal.

Functionality for gathering and parsing filters for a resource index based on the fields present on the resource.

Field Filter for belongs to fields

Field Filter for boolean fields

Field Filter for date fields

Field Filter for date time fields

Field Filter for number fields

Simple Field Filter that builds operators from the options stored on the field

Field Filter for text fields

Functions that allow a resource to configure which fields can be displayed on which parts of the resource.

The Array field may be used to represent an Ecto array.

The BelongsTo field corresponds to a belongs_to ecto relationship. For example, let's assume a Post schema belongs_to a User schema. We may add the relationship to our Post ExTeal resource like so

A group of boolean inputs that represent a map, or embedded schema where each value is a boolean. Useful for embedding features, permissions, or roles into a schema.

The Date field may be used to generate a calendar date select.

Generates a panel that contains a list of cards that represent the embedded associations of the given schema.

The HasMany field corresponds to a has_many ecto relationship. For example, let's assume a User schema has many Post schema. We may add the relationship to our User ExTeal resource like so

The HasOne field corresponds to a has_one ecto relationship. For example, let's assume a Post schema has_one PermaLink schema. We may add the relationship to our Post ExTeal resource like so

A hidden field is a field that is not shown on the index or detail pages, but is still rendered on forms for use with embedded fields that have ids.

The ManyToMany field corresponds to a many_to_many ecto relationship. For example, let's assume a User schema has a many_to_many relationship with a Role schema. We can add the relationship to our User resource like so

Internal Field that replicates a belongs to field for display during an index query of a many to many relationship.

The MultiSelect field may be used to generate a drop-down menu with multiple fields.

The Select field may be used to generate a drop-down select menu.

Functionality for searching across a collection of resources using a single search term.

The default auth provider that allows all access to ExTeal. Should not be used in production!

Card that sits on the main, default dashboard

Behavior for configuring and defining ExTeal

Describes the behaviour of a metric with specific callbacks for building a base result, calculating the values, applying then and returning the result

Partition metrics displays a pie chart of values.

Trend Expressions for Postgresql databases

Composeable Queries Helpers for Building Metrics

Helper functions for building time intervals and queries based on the params of a request.

Data Structure for building a Query for a Metric

A Data Structure returned and serialized by a successful Value Metric Query

Trend metrics display the trend of a computed aggregate over a range of time. For example, a trend metric might display the count of new users created every day for the last thirty days.

Behaviour for trend expression builders

Factory for selecting the implementation to generate a date factory based on the specific database adapter (and database).

Value Metrics display a single value and it's change compared to a previous interval of time. For example, a value metric might display the total number of blog posts created in the last thirty days, versus the previous thirty days.

Conveniences for inflecting and working with names in ExTeal.

The default policy that allows authenticated users access to CRUD. All callbacks default to always being true. Should not be used in production!

Separates fields on the detail page into panels

The core struct that represents and validates an address

The base module that describes the functionality of a plugin

A Policy authorizes CRUD use of a resource based on the Plug.Conn

When used, includes all aspects of the functionality required to manage the resource.

Provides the permitted_attributes/3 callback used for filtering attributes.

Defines a behaviour for creating a resource and the function to execute it.

Defines a behaviour for deleting a resource and the function to execute it.

Adds functionality for exporting a stream of records as a csv file.

Provides the fields/0 callback used by the following ExTeal actions

Behavior for handling index requests for a given resource

Provides the model/0 callback used to customize the resource served.

Used to build paginated views of resources

Defines a behaviour for authorizing use CRUD

This behaviour is used by the following ExTeal.Resource actions

Provides the records/1 callback used for querying records to be served.

Serializes a resource response into json

Defines a behaviour for displaying a resource and the function to execute it.

Defines a behaviour for updating a resource and the function to execute it.

A Plug.Router. This module is meant to be plugged into host applications.

The default search adapter. Uses dynamic ecto queries to build a simple ILIKE comparison across the field specified by the search/2 function on the resource.

The Theme module provides functionality for engineers to customize the appearance of Teal by changing the colors used in the user interface. The struct provides the default values, and can be overriden by providing a custom struct in the ExTeal.Manifest module.

Returns HTML to render as the main interface of Teal.

The default dashboard that contains links to documentation for new engineers.