CrudComponents — living documentation

Every page below is a real, running demo with a “How this page is built” panel showing the exact DSL and ERB. Rule zero: a bare model already renders — declaring things only refines it. 

<%= crud_collection Book.all %>   <%# a sortable, filterable, type-aware table — one line %>

Many demos gate columns or actions by permission. Use “Become admin” (top-right) to flip can? and watch manager-only fields and buttons appear or disappear.

Basics

The four everyday helpers — each renders from one line.

Table

Type-aware cells, an inline filter row, sort links and derived row/collection actions.

crud_collection @books
Open demo

Detail view

The record as a definition list — the same cells as the table. The picker drives it too.

crud_record @book
Open demo

Forms

A derived simple_form create/edit form; its permit-list comes from the same fieldset.

crud_form @book
Open demo

Zero config

Author declares nothing — every column, filter and action is derived from the schema.

crud_collection Author.all
Open demo

Identity & associations

How records are titled, linked and searched.

Icons & labels

A per-model icon and display label, plus an embedded static collection of the publisher's books.

label :name; icon 'building'
Open demo

Custom renderer

A custom cell partial (:stars), with search delegated through the :book association.

attribute(:rating, as: :stars)
Open demo

Power features

The reasons you'd reach for this gem over scaffolding.

Column picker

A per-user gear to hide and reorder columns, grouped by source model. Opens without JS.

crud_collection @books, picker: true
Open demo

Dynamic columns

Columns whose data lives outside the table (an EAV store) — filterable/sortable like any other.

extra_columns: @columns
Open demo

Headers & column actions

A column that is a domain object owns its <th> link and per-column bulk controls.

header_actions: [...]
Open demo

Grouping

Collapsible group headers by a column, belongs_to or enum.

group_by: :publisher
Open demo

Rendering & data shapes

Soft-dependency renderers and trickier model shapes.

Renderers

Markdown, highlighted JSON and asciidoc cells (feature-detected gems), plus manual crud_actions.

as: :markdown / :json / :asciidoc
Open demo

STI & polymorphic

Single-table inheritance (the type column) and a polymorphic belongs_to rendered as a nil-safe link.

Manual < Document; belongs_to :commentable, polymorphic: true
Open demo

Integration

Plays with the rest of your Rails app.

Pagination

Bring your own pager; the gem renders the rows and reflects the query state.

query: @query # kaminari / pagy
Open demo

Live (Turbo)

Morph-friendly markup: only the changed rows update in place over Turbo Streams.

broadcasts_refreshes
Open demo

Two collections

Two independent auto collections on one page, each with isolated filter/sort/search params.

param_prefix: :books
Open demo

Permissions

if:/editable: gate columns and actions by can?. Toggle “Become admin” to watch gated fields appear.

attribute :price, if: :manage
Open demo