method

root

v4.2.1 - Show latest stable - 1 note - Class: ActionDispatch::Routing::Mapper::Base

1.0.0
1.1.6
1.2.6
2.0.3
2.1.0
2.2.1
2.3.8
3.0.0 (0)
3.0.9 (35)
3.1.0 (-2)
3.2.1 (0)
3.2.8 (0)
3.2.13 (0)
4.0.2 (6)
4.1.8 (0)
4.2.1 (0)
4.2.7 (0)
4.2.9 (0)
5.0.0.1
5.1.7
5.2.3
6.0.0
6.1.3.1
6.1.7.7
7.0.0
7.1.3.2
7.1.3.4
What's this?

root(options = {}) public

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.

Show source

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

March 28, 2012 - (>= v3.0.0)

0 thanks

:as option

Code

root :to => 'projects#index', :as => 'foobar'

will generate a helper

foobar_path

root

Related methods

:as option