method

root

rails latest stable - Class: ActionDispatch::Routing::Mapper::Mapping::Resources

root(path, 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.

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1903
        def root(path, options = {})
          if path.is_a?(String)
            options[:to] = path
          elsif path.is_a?(Hash) && options.empty?
            options = path
          else
            raise ArgumentError, "must be called with a path and/or options"
          end

          if @scope.resources?
            with_scope_level(:root) do
              path_scope(parent_resource.path) do
                match_root_route(options)
              end
            end
          else
            match_root_route(options)
          end
        end

root

Method not available on this version

Related methods