instance method `root`

Ruby on Rails 4.1.16

Since v3.0.20 Last seen in v4.2.9

Available in: v3.0.20 v3.1.12 v3.2.22.5 v4.0.13 v4.1.16 v4.2.9

Compare with:

root(options = {})

You can specify what Rails should route “/” to with the root method:

root to: 'pages#main'

For options, see match, as root uses it internally.

You can also pass a string which will expand

root 'pages#main'

You should put the root route at the top of config/routes.rb, because this means it will be matched first. As this is the most popular route of most Rails applications, this is beneficial.

Parameters

options opt = {}

Source

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 339
        def root(options = {})
          match '/', { :as => :root, :via => :get }.merge!(options)
        end

Defined in actionpack/lib/action_dispatch/routing/mapper.rb line 339 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActionDispatch::Routing::Mapper::Base

Signature

Parameters