Skip to content

[Documentation] Form: document Rails form_with integration and real-world examples #434

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cirdes merged 2 commits into from
Jun 22, 2026
Merged

[Documentation] Form: document Rails form_with integration and real-world examples #434

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c6321c
[Documentation] Form: document Rails form_with integration and real-w…
djalmaaraujo Jun 22, 2026
55fd108
[Documentation] Form: make Rails examples code-only and rebuild MCP r…
djalmaaraujo Jun 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 91 additions & 0 deletions docs/app/views/docs/form.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,97 @@ def view_template
RUBY
end

Heading(level: 2) { "Rails Integration" }

Text do
plain "RubyUI Form components are plain HTML — they work with any form submission strategy. "
plain "The recommended approach for Rails apps is to use "
InlineLink(href: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-form_with", target: "_blank") { "form_with" }
plain " to generate the "
code(class: "font-mono text-sm") { "action" }
plain " URL and CSRF token, then pass explicit "
code(class: "font-mono text-sm") { "name" }
plain " / "
code(class: "font-mono text-sm") { "id" }
plain " attributes to each RubyUI input so the browser serialises them correctly. "
plain "Server-side errors can be surfaced by rendering "
code(class: "font-mono text-sm") { "FormFieldError" }
plain " with content from "
code(class: "font-mono text-sm") { "model.errors.full_messages_for(:attr)" }
plain "."
end

render Docs::VisualCodeExample.new(title: "Minimal Rails form", context: self) do
<<~RUBY
# In your Phlex view, call form_with via helpers:
# form_with(url: users_path, method: :post) passes action + CSRF automatically.
#
# You can also set action and the CSRF token manually:
Form(action: helpers.users_path, method: "post", class: "w-2/3 space-y-6") do
input(type: "hidden", name: "authenticity_token", value: helpers.form_authenticity_token)

FormField do
FormFieldLabel(for: "user_email") { "Email" }
Input(
type: "email",
id: "user_email",
name: "user[email]",
placeholder: "you@example.com",
required: true
)
FormFieldError()
end

Button(type: "submit") { "Continue" }
end
RUBY
end

render Docs::VisualCodeExample.new(title: "Devise-style login form", context: self) do
<<~RUBY
# Full sign-in form mirroring Devise session[email] / session[password] params.
# Pass backend errors (e.g. "Invalid email or password") into FormFieldError.
Form(action: helpers.user_session_path, method: "post", class: "space-y-6") do
input(type: "hidden", name: "authenticity_token", value: helpers.form_authenticity_token)

FormField do
FormFieldLabel(for: "session_email") { "Email" }
Input(
type: "email",
id: "session_email",
name: "session[email]",
placeholder: "you@example.com",
autocomplete: "email",
required: true
)
FormFieldError { @error_message }
end

FormField do
FormFieldLabel(for: "session_password") { "Password" }
Input(
type: "password",
id: "session_password",
name: "session[password]",
autocomplete: "current-password",
required: true,
minlength: "8"
)
FormFieldError()
end

FormField do
div(class: "flex items-center gap-2") do
Checkbox(id: "session_remember_me", name: "session[remember_me]", value: "1")
FormFieldLabel(for: "session_remember_me") { "Remember me" }
end
end

Button(type: "submit", class: "w-full") { "Sign in" }
end
RUBY
end

render Components::ComponentSetup::Tabs.new(component_name: component)

render Docs::ComponentsTable.new(component_files(component))
Expand Down
91 changes: 91 additions & 0 deletions gem/lib/ruby_ui/form/form_docs.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,97 @@ def view_template
RUBY
end

Heading(level: 2) { "Rails Integration" }

Text do
plain "RubyUI Form components are plain HTML — they work with any form submission strategy. "
plain "The recommended approach for Rails apps is to use "
InlineLink(href: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-form_with", target: "_blank") { "form_with" }
plain " to generate the "
code(class: "font-mono text-sm") { "action" }
plain " URL and CSRF token, then pass explicit "
code(class: "font-mono text-sm") { "name" }
plain " / "
code(class: "font-mono text-sm") { "id" }
plain " attributes to each RubyUI input so the browser serialises them correctly. "
plain "Server-side errors can be surfaced by rendering "
code(class: "font-mono text-sm") { "FormFieldError" }
plain " with content from "
code(class: "font-mono text-sm") { "model.errors.full_messages_for(:attr)" }
plain "."
end

render Docs::VisualCodeExample.new(title: "Minimal Rails form", context: self) do
<<~RUBY
# In your Phlex view, call form_with via helpers:
# form_with(url: users_path, method: :post) passes action + CSRF automatically.
#
# You can also set action and the CSRF token manually:
Form(action: helpers.users_path, method: "post", class: "w-2/3 space-y-6") do
input(type: "hidden", name: "authenticity_token", value: helpers.form_authenticity_token)

FormField do
FormFieldLabel(for: "user_email") { "Email" }
Input(
type: "email",
id: "user_email",
name: "user[email]",
placeholder: "you@example.com",
required: true
)
FormFieldError()
end

Button(type: "submit") { "Continue" }
end
RUBY
end

render Docs::VisualCodeExample.new(title: "Devise-style login form", context: self) do
<<~RUBY
# Full sign-in form mirroring Devise session[email] / session[password] params.
# Pass backend errors (e.g. "Invalid email or password") into FormFieldError.
Form(action: helpers.user_session_path, method: "post", class: "space-y-6") do
input(type: "hidden", name: "authenticity_token", value: helpers.form_authenticity_token)

FormField do
FormFieldLabel(for: "session_email") { "Email" }
Input(
type: "email",
id: "session_email",
name: "session[email]",
placeholder: "you@example.com",
autocomplete: "email",
required: true
)
FormFieldError { @error_message }
end

FormField do
FormFieldLabel(for: "session_password") { "Password" }
Input(
type: "password",
id: "session_password",
name: "session[password]",
autocomplete: "current-password",
required: true,
minlength: "8"
)
FormFieldError()
end

FormField do
div(class: "flex items-center gap-2") do
Checkbox(id: "session_remember_me", name: "session[remember_me]", value: "1")
FormFieldLabel(for: "session_remember_me") { "Remember me" }
end
end

Button(type: "submit", class: "w-full") { "Sign in" }
end
RUBY
end

render Components::ComponentSetup::Tabs.new(component_name: component)

render Docs::ComponentsTable.new(component_files(component))
Expand Down
Loading