Sha256: a31f073456dfff41ec6e8f949a8d54909293647ab833935e8f3e7e68617fcca0

Contents?: true

Size: 827 Bytes

Versions: 5

Compression:

Stored size: 827 Bytes

Contents

# Create an Index

If the supplied Active Admin index components are insufficient for your project
feel free to define your own. Index classes inherit from `ActiveAdmin::Component`
and require a `build` method and an `index_name` class method.

```ruby
module ActiveAdmin
  module Views
    class IndexAsMyIdea < ActiveAdmin::Component

      def build(page_presenter, collection)
        # ...
      end

      def self.index_name
        "my_idea"
      end

    end
  end
end
```

The build method takes a PagePresenter object and collection of whatever you
choose.

The `index_name` class method takes no arguments and returns a string that should
be representative of the the class name. If this method is not defined, your
index component will not be able take advantage of Active Admin's
*multiple index pages* feature.

Version data entries

5 entries across 5 versions & 2 rubygems

Version Path
active_administration-0.0.3 docs/3-index-pages/create-an-index.md
activeadministration-0.0.2 docs/3-index-pages/create-an-index.md
active_administration-0.0.2 docs/3-index-pages/create-an-index.md
activeadministration-0.0.1 docs/3-index-pages/create-an-index.md
active_administration-0.0.1 docs/3-index-pages/create-an-index.md