Changelog for Aurora UIX

Copy Markdown

[0.1.4] -

Ash Framework improved support - Changes in this release comes from the experience of adopting aurora_uix on real applications

Requires:

  • Elixir 1.17+
  • Phoenix 1.8+
  • Phoenix LiveView 1.1+
  • Ecto 3.13+

Added

  • File-upload support via data.upload field config #251
    • A resource field can now carry a LiveView upload by setting data: %{upload: %{allow: [...], consume: &fun/1}}.
    • The library registers uploads via allow_upload/3, renders live_file_input with entry progress and cancel buttons, and invokes the :consume callback on save.
    • Purely additive — fields without data.upload are unaffected.
    • See guides/core/resource_metadata.md for the data.upload configuration reference.

[0.1.3] - 2026-02-15

Ash Framework Integration & Improvements - This release adds full support for Ash Framework as a backend alternative to Phoenix Contexts, along with custom action support and various improvements.

Requires:

  • Elixir 1.17+
  • Phoenix 1.8+
  • Phoenix LiveView 1.1+
  • Ecto 3.13+

Added

  • Ash Framework Integration #208

    • Full support for Ash Framework as a backend alternative to Phoenix Contexts
    • Automatic field parsing, pagination, and embeds support
    • Support for custom Ash actions (read, create, update, destroy)
    • See guides/core/ash_integration.md for details

  • Custom Action Support #214

    • Support for custom backend actions via resource metadata options
    • Custom Ash actions: :ash_read_action, :ash_create_action, :ash_update_action, etc.
    • Custom Context functions: :ctx_list_function, :ctx_create_function, etc.
    • See resource metadata guide for configuration options

  • Integration Architecture

    • New connector behaviour for backend abstraction
    • Unified CRUD and field parser interfaces
    • Automatic backend type detection (:ctx or :ash)

Changed

  • Refactored Integration Layer

    • Improved separation of concerns between parsers and CRUD operations
    • Enhanced support for custom functions in Context-based backends

  • Enhanced Parser Module

    • Extended to support both Context and Ash backends
    • Improved error handling and validation

  • Unified Handler Callback Pattern

    • All handler implementations now follow a consistent auix_* callback pattern
    • Added auix_mount/3, auix_handle_params/3, auix_handle_event/3, auix_handle_info/2, auix_handle_async/3 to IndexImpl
    • Added auix_update/2 to FormImpl and ShowComponentImpl
    • All callbacks properly marked as @callback and defoverridable
    • Phoenix callbacks remain overridable for advanced use cases
    • See guides/core/liveview.md for comprehensive callback documentation

  • Updated Dependencies

    • ash: 3.12.0 → 3.16.0
    • ash_postgres: 2.6.27 → 2.6.31
    • bandit: 1.10.1 → 1.10.2
    • credo: 1.7.15 → 1.7.16
    • ex_doc: 0.39.3 → 0.40.1
    • lazy_html: 0.1.8 → 0.1.10
    • phoenix_live_view: 1.1.19 → 1.1.22

Fixed

  • Record navigator incorrectly rendered in new entry forms #213
  • Failure to detect embeds_one or embeds_many in some cases
  • Error resolving default function in :ctx type backends
  • Missing HTML type assignment for certain field types

Documentation

  • Added comprehensive Ash Framework integration guide (guides/core/ash_integration.md)
  • Updated resource metadata guide with backend-specific examples
  • Updated LiveView integration guide with unified callback pattern documentation (guides/core/liveview.md)
    • Callback reference tables for IndexImpl, FormImpl, and ShowComponentImpl
    • Distinction between Aurora UIX callbacks and Phoenix callbacks
    • Examples and guidance for customization
  • Corrected QueryBuilder documentation in layouts guide (guides/core/layouts.md)

Build

  • Excluded guide modules from Hex package distribution
  • Updated test environment for Ash resources
  • Added Ash dependencies for development and testing

[0.1.2] - 2026-01-14

Record Navigation - Now users can navigate back and forth while editing or viewing records.

Requires:

  • Elixir 1.17+
  • Phoenix 1.7+
  • Phoenix LiveView 1.0+
  • Ecto 3.2+

Added

  • Record navigation feature for show and edit views that added navigation controls to move among records without returning to index
  • Option to disable record navigation when needed

Changed

  • Updated dependencies to latest versions

Fixed

  • Navigation issues by implementing fallback URI handling
  • Section switching when in show record mode

[0.1.1] - 2025-01-07

Show Component Refactor - In this release, the show live view is no longer generated. Instead, a show component (LiveComponent) is now used within the Index LiveView. This is a preparatory step towards implementing record navigation in show and edit modals.

Requires:

  • Elixir 1.17+
  • Phoenix 1.7+
  • Phoenix LiveView 1.0+
  • Ecto 3.2+

Changed

  • Routing architecture: Show and show_edit actions now route to .Index module instead of .Show module
    • GET /path/:id/show → .Index module with :show action (was GET /path/:id to .Show module)
    • GET /path/:id/show-edit → .Index module with :show_edit action (was GET /path/:id/show/edit to .Show module with :edit action)
  • Show implementation: Replaced show LiveView module with ShowComponent (LiveComponent)
  • Handler behavior: Show handler now uses ShowComponentImpl instead of ShowImpl

Added

Removed

  • ShowGenerator - No longer generates standalone show LiveView modules
  • Aurora.Uix.Templates.Basic.Handlers.ShowImpl - Replaced by ShowComponentImpl

Breaking Changes

If you are using Aurora UIX 0.1.0, review these potential breaking changes:

  1. Manual Route Definitions

    If you manually defined routes instead of using auix_live_resources, update them:

    # OLD (0.1.0) - will break
live "/:id", MyApp.Product.Show, :show
live "/:id/show/edit", MyApp.Product.Show, :edit

# NEW (0.1.1) - correct
live "/:id/show", MyApp.Product.Index, :show
live "/:id/show-edit", MyApp.Product.Index, :show_edit

    Note: If you used auix_live_resources, no changes needed - it generates correct routes automatically.

  2. Custom Show Handler Hooks

    If you implemented a custom show handler using the old behavior:

    # OLD (0.1.0) - will break
defmodule MyApp.ProductShowHandler do
  use Aurora.Uix.Templates.Basic.Handlers.ShowImpl
  # ...custom implementation
end

    Update to the new behavior:

    # NEW (0.1.1) - correct
defmodule MyApp.ProductShowHandler do
  use Aurora.Uix.Templates.Basic.Handlers.ShowComponentImpl
  # ...custom implementation
end

    Migration steps:

    • Change ShowImpl to ShowComponentImpl
    • Update @impl Phoenix.LiveView to @impl Phoenix.LiveComponent where applicable
    • Replace mount/3 with update/2 if you override lifecycle callbacks
    • Handler hooks specified in layout DSL via show_handler_module option will continue to work

Most users will not be affected as these scenarios only apply if you:

  • Manually defined routes (instead of using auix_live_resources)
  • Created custom show handler implementations

[0.1.0] - 2024-12-11

Initial Release - Aurora UIX 0.1.0 is the first stable release, providing a complete low-code CRUD UI generation framework for Elixir's Phoenix LiveView.

Requires:

  • Elixir 1.17+
  • Phoenix 1.7+
  • Phoenix LiveView 1.0+
  • Ecto 3.2+

Added

Core Features

  • Resource Metadata System (auix_resource_metadata/3)

    • Declarative resource and field configuration
    • Field-level customization: labels, placeholders, validation rules
    • Association support: belongs_to, has_many, embeds_one, embeds_many
    • Field attributes: type, precision, scale, required, readonly, hidden, disabled
    • Per-field HTML type overrides and custom rendering options

  • Layout System

    • Layout macros: edit_layout/3, show_layout/3, index_columns/3
    • Layout containers: inline/2, stacked/2, group/3, sections/3, section/3
    • Support for complex, nested layouts
    • Flexible field organization and UI composition

  • Compile-Time Code Generation

    • use Aurora.Uix macro for automatic LiveView module generation
    • Generates index, show, and edit views
    • Template generation from layout definitions
    • Zero-runtime-overhead through compile-time processing

  • View Features

    • Index Views: Pagination, sorting, filtering, selection, bulk actions
    • Show Views: Display with read-only fields, navigation
    • Edit Views: Form handling, validation, error display, real-time updates

  • Association Handling

    • One-to-many inline tables with edit/delete/add actions
    • Embeds-many collections with dynamic entry management
    • Many-to-one select fields with related data loading

  • Action System

    • Customizable actions for index, show, form, and association layouts
    • Action groups: header, footer, row, selected, filters
    • Support for add, insert, replace, remove action operations
    • Extensible action component system

UI & Theming

  • Built-in Templates

    • Basic template with Phoenix components
    • Responsive, mobile-first design
    • Light and dark theme variants

  • Core Components

    • Form inputs with validation feedback
    • Tables with responsive behavior
    • Modals for confirmations
    • Buttons with various styles
    • Navigation components
    • Icon support via Heroicons

Developer Experience

  • Internationalization (i18n)

    • Configurable Gettext backend
    • Automatic translation of UI strings
    • Support for multiple languages

  • Extensibility

    • Custom template support via Aurora.Uix.Template behaviour
    • Customizable core components
    • Field renderer overrides
    • Layout container customization
    • Theme customization

  • Documentation

    • Comprehensive guides: Overview, Getting Started, Core Concepts
    • Advanced usage documentation
    • Troubleshooting guide
    • Real-world examples

Infrastructure

  • Development Tools

  • Testing

    • UICase test helper
    • WebCase test helper
    • Fixtures and test utilities

API Highlights

  • Metadata Module Functions

    • auix_resources/0 - Retrieve all configured resources
    • auix_resource/1 - Get specific resource metadata
    • Metadata export for separation of concerns

  • Template API

    • Template behavior with required callbacks
    • Module name generation helpers
    • Field omission support

  • Action API

Known Limitations

  • Templates currently support compile-time generation only (no dynamic template creation at runtime)
  • Limited to Ecto-based schemas (other data sources require custom integration)
  • CSS themes are basic and designed for light customization
  • Some advanced Phoenix features (plugs, channels) require manual setup

Fixed

  • N/A (initial release)

Security

  • Form validations run both client-side and server-side
  • CSRF protection via Phoenix's standard mechanisms
  • No sensitive data logged or exposed in templates

Future Roadmap

Future releases may include:

  • Additional rendering components and theme options
  • Simplified template creation with better hooks for customization
  • Enhanced theme adoption and customization
  • Query builder integration for advanced filtering
  • Performance optimizations for large datasets
  • GraphQL integration support