repository·main·Indexed 41 days ago
https://github.com/skryukov/inertia_rails-contribA playground for new features and ideas for Inertia Rails. It provides integration for InertiaUI Modal, allowing developers to render components in modals or slideovers via the `inertia_modal` render method and custom HTTP headers.
To use this gem in your Rails application, add it to your Gemfile using Bundler or install it directly via RubyGems.
$ bundle add inertia_rails-contribOr if you are not using Bundler:
$ gem install inertia_rails-contribThe inertia_rails-contrib gem provides integration for InertiaUI Modal, allowing you to open routes in Modals or Slideovers.
To use this feature, you must first follow the NPM installation instructions from the InertiaUI Modal documentation. Then, enable the feature in your Rails application via the inertia_rails_contrib.rb initializer.
InertiaRailsContrib.configure do |config|
config.enable_inertia_ui_modal = true
endOnce enable_inertia_ui_modal is set to true, you can use the inertia_modal render method in your controller actions. This allows you to render a component inside a modal without changing your existing routes or controllers.
You can provide a base_url to support updating the URL when the modal is opened.
class PostsController < ApplicationController
def new
render inertia_modal: 'Post/New', props: { post: Post.new }, base_url: posts_path
end
endThe InertiaRailsContrib::Configuration object allows you to enable or disable InertiaUI modal support. By default, enable_inertia_ui_modal is set to false. Set this to true to enable modal functionality within your Inertia application.
InertiaRailsContrib.configure do |config|
config.enable_inertia_ui_modal = true
endYou can configure the InertiaRailsContrib gem using the configure method. This method yields the configuration object to a block, allowing you to set various settings on the InertiaRailsContrib.configuration instance.
InertiaRailsContrib.configure do |config|
# Set configuration options here
endWhen working with Inertia UI Modals, standard Rails redirects might not behave as expected because the request originates from within a modal context. The InertiaRailsContrib::InertiaUIModal::Redirect module provides an override for redirect_back_or_to.
This method checks for the presence of the HEADER_BASE_URL in the request headers. If this header is present and the host is allowed, the redirect is sent back to the URL specified in the modal's base URL header, ensuring the user is returned to the correct underlying page rather than just the previous entry in the browser history. If the header is missing or the host is not allowed, it falls back to the standard Rails redirect_back_or_to behavior.
# This method is intended to be included in a controller context
# to enable modal-aware redirects.
redirect_back_or_to(fallback_location, allow_other_host: false, **options)The inertia_rails-contrib gem adds an inertia_modal renderer to ActionController. You can use this to render a specific Inertia component inside a modal. This is typically used when you want to trigger a modal view as part of a redirect or a specific controller action.
Usage:
render :inertia_modal, 'MyModalComponent', props: { user: @user }The gem uses specific HTTP headers to communicate modal state between the Rails backend and the Inertia frontend:
X-InertiaUI-Modal-Base-Url: The base URL used for modal routing.X-InertiaUI-Modal: Indicates that the response should be treated as a modal.HEADER_BASE_URL = "X-InertiaUI-Modal-Base-Url"
HEADER_MODAL = "X-InertiaUI-Modal"