API Reference AvenUI v#1.0.0

Copy Markdown View Source

Modules

AvenUI — A free, open-source UI component library for Phoenix LiveView.

Accordion / disclosure component using pure Phoenix LiveView JS — no hooks needed.

Alert/notification banners for inline feedback messages.

Avatar component — initials or image, with size, color, and stack variants.

Badge component for status indicators, labels, and counts.

Breadcrumb navigation component for showing page hierarchy.

Button component with full variant, size, loading, and icon support.

Card container with composable header, body, and footer slots.

Code block with language label and optional copy button. Requires the CopyToClipboard JS hook for the copy feature.

Combobox — searchable select input.

Rich data table with filter bar, server-side sort, and pagination.

DatePicker — calendar-based date input for single dates and date ranges.

Dropdown menu component using Phoenix LiveView's built-in JS commands.

Empty state with icon, title, description, and optional action slot.

File upload component with drag-and-drop support and progress tracking.

Form input components: text fields, selects, textareas, and search inputs. Designed to work seamlessly with Phoenix.HTML.Form and Ecto.Changeset.

Keyboard shortcut display.

Modal / Dialog component for Phoenix LiveView.

Progress bar component with label, value display, colors, and sizes.

Horizontal or vertical separator line with optional label.

Responsive sidebar navigation component for admin dashboards and applications.

Skeleton loader placeholder — shimmer animation for async content.

Animated loading spinner — 5 sizes, inherits color via currentColor.

Stat / metric card for dashboard KPIs.

Multi-step wizard component for guided workflows.

Data table component with sortable columns, striping, and LiveView pagination.

Tabs component with two visual styles and optional LiveView URL-sync.

Toast notification system for Phoenix LiveView.

Toggle switch component — accessible boolean input.

Tooltip component for contextual help and information.

State helper for the data_table/1 component.

Shared utilities for AvenUI components.

Mix Tasks

Copies AvenUI component source files into your project so you own them.

Scaffolds a full Phoenix 1.8 project with AvenUI pre-wired.