v4v3v2

Appearance

License: Community

Views ​

The Avo CRUD feature generates four main views for each resource.

Index ​

The page where you see all your resources listed in a table, grid, or map.

Show ​

The page where you see one resource in more detail.

Related resources:

Edit ​

The page where you can edit one resource.

Related resources:

New ​

The page where you can create a new resource.

Related resources:

View groups ​

Three named groups let you target several views at once:

Display ​

:display is an alias for the Index and Show views where you can display records and their details.

Form ​

:form is an alias for the Edit and New views for creating and editing records. The create and update requests that submit those forms also count as form views.

Single ​

:single is an alias for every view except Index — that is Show, Edit, and New (plus the create and update form submissions).

Preview ​

The fields marked with show_on: :preview will be shown in the preview field popup. By default, all fields are hidden in :preview.

Checking the current view ​

The view object, available in the code, is an instance of the Avo::ViewInquirer class. This enables you to examine the existing view status through expressions such as view.show? and view.index?. Essentially, these are equivalent to asserting whether view equals show or index.

Multiple ways to check ​

ruby
view == "edit" # Check against a string
view == :edit # Check against a symbol
view.edit? # Ask if it's a view
view.form? # Ask if it's a collection of views
view.in? [:edit, :new] # Check against an array of symbols
view.in? ["edit", "new"] # Check against an array of strings
ruby
if view.show?
  # Code for the "show" view
elsif view.index?
  # Code for the "index" view
elsif view.edit?
  # Code for the "edit" view
elsif view.new?
  # Code for the "new" view
elsif view.form?
  # Code for the "new" or "edit" views
elsif view.display?
  # Code for the "index" or "show" views
end
ruby
if view == :show
  # Code for the "show" view
elsif view == :index
  # Code for the "index" view
elsif view == :edit
  # Code for the "edit" view
elsif view == :new
  # Code for the "new" view
end
ruby
if view == "show"
  # Code for the "show" view
elsif view == "index"
  # Code for the "index" view
elsif view == "edit"
  # Code for the "edit" view
elsif view == "new"
  # Code for the "new" view
end

It's also possible to check if the view is on a form (new, edit) or display (index, show).

ruby
if view.form?
  # Code for the "new" and "edit" views
elsif view.display?
  # Code for the "show" and "index" views
end
ruby
if view.in? [:new, :edit]
  # Code for the "new" and "edit" views
elsif view.in? [:show, :index]
  # Code for the "show" and "index" views
end
ruby
if view.in? ["new", "edit"]
  # Code for the "new" and "edit" views
elsif view.in? ["show", "index"]
  # Code for the "show" and "index" views
end

Common visible_on configuration values ​

In many parts of the DSL you'll be able to configure visibility through options like visible_on, show_on, hide_on, only_on, or except_on. These options control the views where the configuration applies. You may use the following values:

  • :show
  • :edit
  • :new
  • :index
  • :forms — expands to :new and :edit
  • :display — expands to :index and :show

You may also use a combination of views using an array.

  • [:show, :index]
  • [:show, :forms]

Field visibility options (show_on, hide_on, only_on, except_on) additionally accept :preview — see Preview above.

View types ​

The Index view can render records through several view types, each with its own options, documented on its own page:

  • Table view — the default tabular layout; row controls placement and per-row styling.
  • Grid view — card-based layout with cover, title, body, and badge, for image-heavy resources.
  • Map view — plot records with geospatial data on a map.
  • Custom view types — register entirely new view types from a plugin.

Restrict the available view types ​

By default, Avo displays all the configured view types on the view switcher. For example, if you have map_view and grid_view configured, both of them, along with the table_view, will be available on the view switcher.

However, there might be cases where you only want to make a specific view type available without removing the configurations for other view types. This can be achieved using the view_types class attribute on the resource. Note that when only one view type is available, the view switcher will not be displayed.

ruby
# app/avo/resources/city.rb
class Avo::Resources::City < Avo::BaseResource
  # ...
  self.view_types = :table
  # ...
end

If you want to make multiple view types available, you can use an array. The icons on the view switcher will follow the order in which they are declared in the configuration.

ruby
# app/avo/resources/city.rb
class Avo::Resources::City < Avo::BaseResource
  # ...
  self.view_types = [:table, :grid]
  # ...
end

You can also dynamically restrict the view types based on user roles, params, or other business logic. To do this, assign a block to the view_types attribute. Within the block, you'll have access to resource, record, params, current_user, and other default accessors provided by ExecutionContext.

ruby
# app/avo/resources/city.rb
class Avo::Resources::City < Avo::BaseResource
  # ...
  self.view_types = -> do
    if current_user.is_admin?
      [:table, :grid]
    else
      :table
    end
  end
  # ...
end

The current pick is persisted in the URL as the view_type query parameter, so it survives page reloads and can be bookmarked.

WARNING

Requesting a view type that isn't in the available list raises an error, and rendering a view type that was never registered raises Avo::ViewTypeComponentNotFoundError. Keep view_types, default_view_type, and your registered view types in sync.

Copyright © 2020–2026 Avo