Discreet Information

Sometimes you need some information available on the record page, but not necessarily front-and-center. The discreet_information resource option renders one or more small items — icons with tooltips, badges, links, or key-value pairs — next to the record title, without using up a whole field.

# app/avo/resources/post.rb
class Avo::Resources::Post < Avo::BaseResource
  self.discreet_information = [
    :timestamps,
    {
      as: :badge,
      text: -> { record.published_at ? "Published" : "Draft" },
      icon: -> { "heroicons/outline/#{record.published_at ? "eye" : "eye-slash"}" }
    }
  ]

  # fields and other resource configuration
end

By default the option is unset and nothing is rendered. You can pass a single item or an array of items; each item is either a preconfigured symbol or a Hash describing a custom item.

Show the record's ID

Use the :id preconfigured item to display the current record's ID as a key-value pair, saving a field slot.

# app/avo/resources/post.rb
class Avo::Resources::Post < Avo::BaseResource
  self.discreet_information = :id
end

Show timestamps without using a field

The reason we built this feature was that we wanted a place to display the created_at and updated_at timestamps without dedicating a whole field to them.

Set the option to :timestamps and an icon is added next to the title. Hovering over it reveals both timestamps in a tooltip.

# app/avo/resources/post.rb
class Avo::Resources::Post < Avo::BaseResource
  self.discreet_information = :timestamps
end

If the record has neither a created_at nor an updated_at value, the item is omitted.

If you'd rather show a single timestamp as a visible key-value pair instead of a tooltip, use :created_at or :updated_at.

Add a custom item

Pass a Hash to take full control of an item. Pick the representation with as — :text (default), :icon, :badge, or :key_value — then set the options that type uses: text for text and badge items, icon, title for the tooltip, or key and value for key-value items.

# app/avo/resources/post.rb
class Avo::Resources::Post < Avo::BaseResource
  self.discreet_information = {
    as: :badge,
    text: -> { record.published_at ? "Published" : "Draft" },
    title: -> { "Product is #{record.published_at ? "published" : "draft"}" },
    icon: "tabler/outline/bulb"
  }
end

Every option accepts a static value or a block. Blocks run in an ExecutionContext, so you have access to record, resource, and the rest of the common objects.

Turn an item into a link

If you want an item to navigate somewhere, add a url. Use target to control where it opens and data to set data attributes on the item.

# app/avo/resources/post.rb
class Avo::Resources::Post < Avo::BaseResource
  self.discreet_information = {
    as: :badge,
    text: "View on site",
    url: -> { main_app.post_path record },
    target: :_blank
  }
end

Show an item conditionally

Set visible to a boolean or a block if an item should only appear in certain conditions.

# app/avo/resources/post.rb
class Avo::Resources::Post < Avo::BaseResource
  self.discreet_information = {
    as: :badge,
    text: "Draft",
    visible: -> { record.published_at.nil? }
  }
end

Full example

Here's a possible full configuration for the discreet information area, mixing preconfigured and custom items.

# app/avo/resources/post.rb
class Avo::Resources::Post < Avo::BaseResource
  self.discreet_information = [
    :id,
    :timestamps,
    :created_at,
    :updated_at,
    {
      as: :badge,
      text: "label",
      title: -> { sanitize("View <strong>#{record.name}</strong> on site", tags: %w[strong]) },
      icon: -> { "heroicons/outline/arrow-top-right-on-square" },
      url: -> { main_app.root_url },
      target: :_blank
    },
    {
      as: :text,
      text: -> { "Simple text #{record.id}" },
      title: -> { sanitize("View <strong>#{record.name}</strong> on site", tags: %w[strong]) },
      icon: -> { "tabler/outline/external-link" },
      url: -> { main_app.root_url },
      visible: true
    },
    {
      as: :badge,
      text: "Test",
      visible: false
    },
    {
      as: :key_value,
      key: "Key",
      value: "Value"
    },
    {
      as: :icon,
      icon: "tabler/outline/cube-3d-sphere",
      title: -> { Time.now }
    }
  ]

  # fields and other resource configuration
end