- Skill ID
- inertia-rails/skills/inertia-rails-controllers
- Publisher
- inertia-rails
- Repository
- skills
- Installs
- 0
- Files
- 4
- Synced
- Sep 23, 2026
Open any RiverX project, open the Skills panel in the chat, and search for this identifier. The files are fetched from the source repository at install time.
inertia-rails/skills/inertia-rails-controllersInstalls these files- SKILL.md
- references/authorization.md
- references/configuration.md
- references/prop-types.md
What this skill tells the agent
Inertia Rails Controllers
Server-side patterns for Rails controllers serving Inertia responses.
Before adding a prop, ask:
- Needed on every page? →
inertia_sharein a base controller (InertiaController), not a per-action prop - Expensive to compute? →
InertiaRails.defer— page loads fast, data streams in after - Only needed on partial reload? →
InertiaRails.optional— skipped on initial load - Reference data that rarely changes? →
InertiaRails.once— cached across navigations
NEVER:
- Use
redirect_tofor external URLs (Stripe, OAuth, SSO) — it returns 302 but the Inertia client tries to parse the response as JSON, causing a broken redirect. Useinertia_location(returns 409 +X-Inertia-Locationheader). - Use
errors.full_messagesfor validation errors — it produces flat strings without field keys, so errors can't be mapped to the corresponding input fields on the frontend. Useerrors.to_hash(true). - Use
inertia.defer,Inertia.defer, orinertia_rails.defer— the correct syntax isInertiaRails.defer { ... }. All prop helpers are module methods on theInertiaRailsconstant. - Assume instance variables are auto-passed as props — they are NOT (unless
alba-inertiagem is configured). Every action that passes props to the frontend MUST callrender inertia: { key: data }. - Use
success/erroras flash keys without updatingconfig.flash_keys— Rails defaults tonotice/alert. Custom keys must be added to both the initializer config and theFlashDataTypeScript type.
Render Syntax
`default_render: true` TRAP: This setting only auto-infers the component name from controller/action — it does NOT auto-pass instance variables as props. Writing@posts = Post.allin an action withdefault_render: truerenders the correct component but sends zero data to the frontend. Instance variables are only auto-serialized as props whenalba-inertiagem is configured — checkGemfilebefore relying on this. Without it, you MUST userender inertia: { posts: data }to pass any data to the page. Empty actions (def index; end) are correct ONLY for pages that need no data (e.g., a static dashboard page, a login form). If the action queries the database, it MUST callrender inertia:with data.
| Situation | Syntax | Component path |
|---|---|---|
| Action loads data | render inertia: { users: data } | Inferred from controller/action |
| Action loads NO data (static page) | Empty action or render inertia: {} | Inferred from controller/action |
| Rendering a different page | render inertia: 'errors/show', props: { error: e } | Explicit path |
Rule of thumb: If your action touches the database, it MUST call render inertia: with data. If the action body is empty, the page receives only shared props (from inertia_share).
# CORRECT — data passed as props
def index
render inertia: { users: users_data, stats: InertiaRails.defer { ExpensiveQuery.run } }
end
# CORRECT — static page, no data needed
def index; end
# WRONG — @posts is NEVER sent to the frontend (without alba-inertia)
def index
@posts = Post.all
endNote: If the project uses thealba-inertiagem (checkGemfile), instance variables are auto-serialized as props and explicitrender inertia:is not needed. See thealba-inertiaskill for that convention.
Prop Types
`InertiaRails.defer` — NOT inertia.defer, NOT Inertia.defer. All prop helpers are module methods on InertiaRails.
| Type | Syntax | Behavior |
|---|---|---|
| Regular | { key: value } | Always evaluated, always included |
| Lazy | -> { expensive_value } | Included on initial page render, lazily evaluated on partial reloads |
| Optional | InertiaRails.optional { ... } | Only evaluated on partial reload requesting it |
| Defer | InertiaRails.defer { ... } | Loaded after initial page render |
| Defer (grouped) | InertiaRails.defer(group: 'name') { ... } | Grouped deferred — fetched in parallel |
| Once | InertiaRails.once { ... } | Resolved once, remembered across navigations |
| Merge | InertiaRails.merge { ... } | Appended to existing array (infinite scroll) |
| Deep merge | InertiaRails.deep_merge { ... } | Deep merged into existing object |
| Always | InertiaRails.always { ... } | Included even in partial reloads |
| Scroll | InertiaRails.scroll { ... } | Scroll-aware prop for infinite scroll |
def index
render inertia: {
filters: filter_params,
messages: -> { messages_scope.as_json },
stats: InertiaRails.defer { Dashboard.stats },
chart: InertiaRails.defer(group: 'analytics') { Dashboard.chart },
countries: InertiaRails.once { Country.pluck(:name, :code) },
posts: InertiaRails.merge { @posts.as_json },
csrf: InertiaRails.always { form_authenticity_token },
}
endDeferred Props — Full Stack Example
Server defers slow data, client shows fallback then swaps in content:
# Controller
def show
render inertia: {
basic_stats: Stats.quick_summary,
analytics: InertiaRails.defer { Analytics.compute_slow },
}
end// Page component — child reads deferred prop from page props
import { Deferred, usePage } from '@inertiajs/react'
export default function Dashboard({ basic_stats }: Props) {
return (
<>
<QuickStats data={basic_stats} />
<Deferred data="analytics" fallback={<div>Loading analytics...</div>}>
<AnalyticsPanel />
</Deferred>
</>
)
}
function AnalyticsPanel() {
const { analytics } = usePage<{ analytics: Analytics }>().props
return <div>{analytics.revenue}</div>
}Shared Data
Use inertia_share in controllers — it needs controller context (current_user, request). The initializer only handles config.* settings (version, flash_keys).
class ApplicationController < ActionController::Base
# Static
inertia_share app_name: 'MyApp'
# Using lambdas (most common)
inertia_share auth: -> { { user: current_user&.as_json(only: [:id, :name, :email, :role]) } }
# Conditional
inertia_share if: :user_signed_in? do
{ notifications: -> { current_user.unread_notifications_count } }
end
endLambda and action-scoped variants are in `references/configuration.md`.
Evaluation order: Multiple inertia_share calls merge top-down. If a child controller shares the same key as a parent, the child's value wins. Block and lambda shares are lazily evaluated per-request — they don't run for non-Inertia requests.
Flash Messages
Flash is automatic. Configure exposed keys if needed:
# config/initializers/inertia_rails.rb
InertiaRails.configure do |config|
config.flash_keys = %i[notice alert toast] # default: %i[notice alert]
endUse standard Rails flash in controllers:
redirect_to users_path, notice: "User created!"
# or
flash.alert = "Something went wrong"
redirect_to users_pathRedirects & Validation Errors
After create/update/delete, always redirect (Post-Redirect-Get). Standard Rails redirect_to works. The Inertia-specific part is validation error handling:
def create
@user = User.new(user_params)
if @user.save
redirect_to users_path, notice: "Created!"
else
redirect_back_or_to new_user_path, inertia: { errors: @user.errors.to_hash(true) }
end
end`to_hash` vs `to_hash(true)`: to_hash gives { name: ["can't be blank"] }, to_hash(true) gives { name: ["Name can't be blank"] }. Keys must match input name attributes — mismatched keys mean errors won't display next to the right field.
NEVER use `errors.full_messages` — it produces flat strings without field keys, so errors can't be mapped to the corresponding input fields on the frontend.
Authorization as Props
Pass permissions as per-resource can hash — frontend controls visibility,
More from inertia-rails
Use this skill in a project
Open any RiverX project, search the Skills panel for inertia-rails/skills/inertia-rails-controllers, and install it in one click.
