Current section

Files

Jump to
primer_live README.md
Raw

README.md

[![Hex](https://img.shields.io/hexpm/v/primer_live?label=Hex)](https://hex.pm/packages/primer_live) [![HexDocs](https://img.shields.io/badge/hexdocs-HexDocs-blue?label=Documentation)](https://primer_live.hexdocs.pm/) [![CI status](https://codeberg.org/ArthurClemens/primer_live/badges/workflows/ci.yml/badge.svg?label=CI)](https://codeberg.org/ArthurClemens/primer_live/actions) [![License](https://img.shields.io/hexpm/l/primer_live.svg?label=Licence)](https://codeberg.org/ArthurClemens/primer_live/src/branch/main/LICENSE)

An implementation of GitHub's [Primer Design System](https://primer.style/design) for Phoenix LiveView and regular (non-LiveView) views in Phoenix applications.

PrimerLive provides a strong base for creating data driven applications such as rich CRUD applications with interactive forms that integrate with Phoenix Forms, and Ecto Changesets.

Menus and dialogs allow for in-page viewing and editing of data, without leaving the current page. Alternatively, menus and dialogs can be invoked when visiting a specific route.

Components (and their inner elements) can be styled with custom CSS, or by passing pre-made utility classes.

Right-to-left languages are supported.

## Documentation

- [Documentation on HexDocs]([doc-extra/installation.md](https://primer-live.hexdocs.pm/))
- [PrimerLive Storybook and Demo](https://primer-live.org)