The Dialog root belongs inside the action layout that places its trigger.
Narrow transcript actions
A converted Redact and Permalink Flex once ended before the Dialog sibling, wrapping its trigger. One no-wrap cluster now owns all three actions, including the Dialog root.
sample("Open nonmodal panel", slug:"nonmodal") do
render NitroKit::Dialog.new(id:"gallery-dialog-open", dismissible:false) do |dialog|
dialog.panel(
title:"Release notes",
description:"This server-rendered panel is deliberately nonmodal and stays open; dismissal would belong to a page action.",
nonmodal:true
)
endend
sample("Required decision", slug:"required-decision") do
render NitroKit::Dialog.new(
id:"gallery-dialog-required",
dismissible:false
) do |dialog|
dialog.trigger("Accept updated terms")
dialog.panel(
title:"Accept the updated terms",
description:"This workspace cannot be used until an owner accepts the new processing terms."
) do
render NitroKit::Button.new(
"Accept terms",
id:"gallery-dialog-required-accept",
variant::primary,
html: { command:"close", commandfor:"gallery-dialog-required-panel" }
)
endendend
sample("Disabled trigger", slug:"disabled-trigger") do
render NitroKit::Dialog.new(id:"gallery-dialog-disabled") do |dialog|
dialog.trigger("Unavailable action", disabled:true)
dialog.panel(title:"Unavailable action") do
dialog.close_button
endendend
Long content
The panel scrolls while the close control stays pinned to the top of the panel.
render NitroKit::Dialog.new(id:"gallery-dialog-long") do |dialog|
dialog.trigger("Read processing terms")
dialog.panel(
title:"Data processing terms",
description:"Review the complete terms before accepting them for this workspace."
) do12.times do |index|
p do"Section #{index + 1}. The processor handles workspace content only on documented " \
"instructions from the controller, keeps every sub-processor under equivalent " \
"obligations, and reports a personal-data breach without undue delay."endend
dialog.close_button(label:"Close terms")
endend
Form composition
Field, Input, and Button compose directly inside a dialog without a second template API.
render NitroKit::Dialog.new(id:"gallery-dialog-invite") do |dialog|
dialog.trigger("Invite teammate", variant::primary)
dialog.panel(
title:"Invite a teammate",
description:"Choose an address and the role this person should receive."
) do
form(id:"gallery-dialog-invite-form", action:"#invite", method:"post") do
render NitroKit::FieldGroup.new do
render NitroKit::Field.new(
nil,
:email,
as::email,
id:"gallery-dialog-invite-email",
name:"invitation[email]",
value:"[email protected]",
label:"Email",
autocomplete:"email",
required:true,
html: { id:"gallery-dialog-invite-email-field" }
)
render NitroKit::Field.new(
nil,
:role,
as::select,
id:"gallery-dialog-invite-role",
name:"invitation[role]",
value:"member",
label:"Role",
options:Gallery::Forms::TeamInvitation::ROLES,
html: { id:"gallery-dialog-invite-role-field" }
)
render NitroKit::Button.new(
"Send invitation",
id:"gallery-dialog-invite-submit",
type::submit,
variant::primary
)
end
dialog.close_button(label:"Cancel invitation")
endendend
Component contract
Constructor options, rendered root, closed vocabularies, and compound boundary for this component, exactly as shipped.
docs/component_contracts.md · NitroKit::Dialog
Constructor-specific options
required id:
dismissible: true
Root and closed vocabulary
div[data-nk=dialog] owning exactly one native dialog
Compound contract
Requires a declaration block with exactly one panel(title:, description: nil, nonmodal: false) and at most one trigger, which forwards Button treatment options including icon:, icon_end:, and label:, matching Sheet and Dropdown. Nitro renders trigger then panel, and inside the panel it owns close button, title, description, then the captured application content, so a sticky close control survives long scrolling content. At most one close_button(label:) may be declared inside the panel block, whose label defaults to I18n.t("nitro_kit.dialog.close"); dismissible: false renders none and declaring one raises. nonmodal: true is the explicit server-open state and cannot be combined with a trigger, whose command="show-modal" would open the same panel modally. Trigger and close controls use native command/commandfor. Turbo confirmations are deliberately not a Dialog runtime: applications own inline confirmation dialogs, see destructive action (docs/patterns/destructive_action.md).
Relevant patterns
Application conventions this component belongs to. Each summary is the leading section of its pattern document.
docs/patterns/destructive_action.md
Destructive action
Use NitroKit::Dialog when the user must review impact or type confirmation; use Turbo's native browser confirmation for a one-sentence consequence.
A real Rails form owns the request, and the server owns authorization.
Put permanent deletion on the edit route, not the operational show route.
Use a server-rendered review route when confirmation must work without JavaScript or Invoker Commands.
System rules for coding agents
Instructions for coding agents, repeated on every component page so one fetched page has enough context. Humans can usually skip this section.
test/dummy/app/components/gallery/agent_rules.rb
View agent instructions
Nitro Kit 2.0 is a gem-owned, Phlex-only UI system for Rails. Render components directly: render NitroKit::Button.new("Save", variant: :primary).
Compose Nitro components inside application-owned Phlex classes. Public initializers and declared slots are the component API; private methods are not.
Public options are explicit keywords, and enumerated options are closed vocabularies. Invalid names or values raise ArgumentError; this component's accepted options are in the contract above.
Pass native attributes through their typed boundary: html: for HTML, aria: for ARIA, and data: for application data. class and style are forbidden, including inside html:.
Nitro owns NitroKit::Component::RESERVED_DATA_ATTRIBUTES: data-nk, data-slot, data-variant, data-size, data-nk-escape, data-enhanced, data-state, data-disabled, data-required, data-orientation, data-presentation, data-placement, data-layout, data-side, data-field-type, data-dir, data-gap, data-align, data-justify, data-wrap, data-cols, data-mode, data-key. Do not pass them through data:. data-action, data-controller are additive and compose with Nitro behavior.
If an integration truly requires a class, use desperately_need_a_class:. It requires a non-blank String and marks the exception with data-nk-escape="class".
Every root emits data-nk; owned parts emit component-qualified data-slot values such as field-control or card-title. Select on those attributes, never on classes.
Customize components with documented --nk-* custom properties in an application stylesheet. Variables beginning with --_nk-* are private component mechanics.
Use NitroKit::Flex and NitroKit::Grid for layout. Parents own external placement and available width; components own their intrinsic geometry.
Preserve native elements and accessibility semantics. State is exposed through native semantics and ARIA first, and through data-state when styling or behavior also needs it.