API Reference Beacon LiveAdmin v0.4.0

View Source

Modules

Beacon LiveAdmin is a Phoenix LiveView web application to manage Beacon sites.

Provides Admin UI components.

Cluster management. Discover all sites running in the cluster and executes functions globally.

Raised when there is an error in calling a remove Beacon function through the cluster.

Configuration for Admin instances.

Raised when some option in Beacon.LiveAdmin.Config is invalid.

The foundation for building admin pages.

Represents a Page in the LiveAdmin UI.

Represents a Table in the LiveAdmin UI, with pagination, filtering, and sorting.

Required plug to load Admin pages allow navigation.

Routing for Beacon LiveAdmin.

The avatar component renders initials, an SVG, or an image thumbnail to represent a user. Avatars can be displayed as single items or combined into a horizontal stack.

The button component renders a <button> element with options for text-only, icon-only, or a combination of both.

The cards component renders a self-contained area of content which can contain

The Footer component includes "simple" (default), and "columns" variant. The default variant will list any footer_link slotted in horizontally, while the columns variant will loop over a grouped list of links under a heading.

This module exists to provide the same API as the Phoenix Core Components so as to support generators that target the Core Components (mix phx.gen.live, mix phx.gen.auth, etc...)

The spinner component offers two options (spinner and spinner_double) to render an animated looping SVG to represent a loading state. Spinners are used to notify users when something is in progress or fetching data. When a page or element is updating, the loading animation appears and then resolves once that action is complete. Each spinner option has a default size but this can be overridden.

For bordered tags, add "border-2"

Mix Tasks

Installs Beacon LiveAdmin in a Phoenix LiveView app.