Avo

https://docs.avohq.io/3.0/llms-full.txt
Admin
Avo is a Ruby on Rails tool designed to accelerate app development by abstracting common features...
Tokens:277,177
Snippets:2,479
Trust Score:8.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Set up Solid Cache with Avo

Source: https://docs.avohq.io/3.0/llms-full.txt

Setup Solid Cache: add the gem, install it, copy migrations, run them, and set `config.cache_store = :solid_cache_store` in the production environment config.

```ruby
gem "solid_cache"
```

```bash
$ bundle
```

```bash
$ gem install solid_cache
```

```bash
$ bin/rails solid_cache:install:migrations
```

```bash
$ bin/rails db:migrate
```

```ruby
# config/environments/production.rb

config.cache_store = :solid_cache_store
```

--------------------------------

### Run One-Command Install

Source: https://docs.avohq.io/3.0/llms-full.txt

Execute the Rails template command to automatically install Avo.

```bash
bin/rails app:template LOCATION='https://avohq.io/app-template'
```

--------------------------------

### Install avo-kanban gem

Source: https://docs.avohq.io/3.0/llms-full.txt

Installs the avo-kanban gem and its dependencies after adding it to the Gemfile.

```bash
bundle install
```

--------------------------------

### Run Bundle Install

Source: https://avohq.io/templates/jumpstart-pro

Runs 'bundle install' in an unbundled environment to install the gems added to the Gemfile.

```ruby
# === Run bundle install ===
Bundler.with_unbundled_env { run "bundle install" }
```

--------------------------------

### Avo action generator examples

Source: https://docs.avohq.io/3.0/llms-full.txt

Examples of generating regular, standalone, and namespaced Avo actions.

```bash
# Generate a regular action
bin/rails generate avo:action mark_as_featured

# Generate a standalone action
bin/rails generate avo:action generate_monthly_report --standalone

# Generate an action in a namespace
bin/rails generate avo:action admin/approve_user
```

--------------------------------

### Install avo-collaboration gem and run migrations

Source: https://docs.avohq.io/3.0/llms-full.txt

Install the avo-collaboration gem by adding it to your Gemfile, then run bundle, generate the required migrations, and apply them to your database.

```ruby
gem "avo-collaboration", source: "https://packager.dev/avo-hq"
```

```bash
bundle
```

```bash
rails avo_collaboration:install:migrations
```

```bash
rails db:migrate
```

--------------------------------

### Default pagination example

Source: https://docs.avohq.io/3.0/resources.html

Example of default pagination configuration. Uses the default type and size values.

```ruby
self.pagination = -> do
  {
    type: :default,
    size: [1, 2, 2, 1],
  }
end
```

--------------------------------

### Example RoleResource

Source: https://docs.avohq.io/3.0/llms-full.txt

Example RoleResource with name and accounts fields, enabling role management in Avo.

```ruby
class RoleResource < Avo::BaseResource
  self.title = :name
  self.includes = []

  field :name, as: :text
  field :accounts, as: :has_and_belongs_to_many
end
```

--------------------------------

### Use a lambda function for home_path

Source: https://docs.avohq.io/3.0/customization.html

Since v2.8.0, you can use a lambda function to define the home_path dynamically. When configured, the 'Get started' sidebar item is hidden in development.

```ruby
Avo.configure do |config|
  config.home_path = -> { avo_dashboards.dashboard_path(:dashy) }
end
```

--------------------------------

### Install Avo in Jumpstart Pro

Source: https://docs.avohq.io/3.0/llms-full.txt

Use the provided template to add Avo to a Jumpstart Pro application.

```ruby
bin/rails app:template LOCATION=https://v3.avohq.io/templates/jumpstart-pro.template
```

--------------------------------

### Avo Resource Routing Examples

Source: https://docs.avohq.io/3.0/resources.html

Examples of how Avo automatically generates routes based on the resource name.

```text
Avo::Resources::Post         -> /avo/resources/posts
Avo::Resources::PhotoComment -> /avo/resources/photo_comments
```

--------------------------------

### Installation script for Avo editions

Source: https://avohq.io/templates/bullet-train

Ruby script that prompts for the Avo edition (community, pro, or advanced) and installs the corresponding gem. It also adds the ransack gem and runs bundle install.

```ruby
if ARGV.include? "--community-edition"
  edition = "community"
elsif ARGV.include? "--pro-edition"
  edition = "pro"
elsif ARGV.include? "--advanced-edition"
  edition = "advanced"
end

unless edition
  # === Fetch the Avo edition ===
  question = <<~QUESTION


    Which version of Avo would you like to install?
    1. Avo Community (default)
    2. Avo Pro
    3. Avo Advanced

    More information about version features here:
    https://avohq.io/pricing


  QUESTION
  puts question

  answer = ask("Which version of Avo would you like to install?", default: "1", limited_to: ["1", "2", "3"])

  edition = case answer
  when "1"
    "community"
  when "2"
    "pro"
  when "3"
    "advanced"
  end
end

# === Add gem to Gemfile ===
case edition
when "community"
  gem "avo", ">= 3.2.3"
when "pro"
  gem "avo-pro", source: "https://packager.dev/avo-hq"
when "advanced"
  gem "avo-advanced", source: "https://packager.dev/avo-hq"
end

gem "ransack"

# === Run bundle install ===
Bundler.with_unbundled_env { run "bundle install" }

```

--------------------------------

### Custom search provider example

Source: https://docs.avohq.io/3.0/llms-full.txt

Example of a custom search provider returning an array of hashes. The `query` block returns the search results directly. Results count will not be available with custom search providers.

```ruby
class Avo::Resources::Project < Avo::BaseResource
  self.search = {
    query: -> do
      [
        { _id: 1, _label: "Record One", _url: "https://example.com/1" },
        { _id: 2, _label: "Record Two", _url: "https://example.com/2" },
        { _id: 3, _label: "Record Three", _url: "https://example.com/3" }
      ]
    end
  }
end
```

--------------------------------

### Countless and pageless pagination example

Source: https://docs.avohq.io/3.0/resources.html

Example of countless pagination with an empty size array, effectively making the pagination 'pageless'.

```ruby
self.pagination = -> do
  {
    type: :countless,
    size: []
  }
end
```

--------------------------------

### Full discreet information configuration

Source: https://docs.avohq.io/3.0/llms-full.txt

Full configuration example combining timestamps, a tooltip with sanitized HTML, and a label with URL and target.

```ruby
# app/avo/resources/post.rb
class Avo::Resources::Post < Avo::BaseResource
  self.discreet_information = [
    :timestamps,
    {
      tooltip: -> { sanitize("Product is <strong>#{record.published_at ? "published" : "draft"}</strong>", tags: %w[strong]) },
      icon: -> { "heroicons/outline/#{record.published_at ? "eye" : "eye-slash"}" }
    },
    {
      label: -> { record.published_at ? "✅" : "🙄" },
      url: -> { "https://avohq.io" },
      url_target: :_blank
    }
  ]

  # fields and other resource configuration
end
```

--------------------------------

### Run database migration

Source: https://docs.avohq.io/3.0/llms-full.txt

Applies the database changes created by the avo:kanban install generator.

```bash
rails db:migrate
```

--------------------------------

### Generate Avo JS install with esbuild

Source: https://docs.avohq.io/3.0/llms-full.txt

Run this command to install Avo's custom JS assets with the esbuild bundler. It ejects the _head.html.erb file, adds the avo.custom.js asset to it, and creates the avo.custom.js file under app/javascript as your entrypoint.

```bash
bin/rails generate avo:js:install --bundler esbuild
```

--------------------------------

### Generate avo:kanban install

Source: https://docs.avohq.io/3.0/llms-full.txt

Generates pre-configured resources and controllers for managing boards, columns, and items. Also generates the item's partial and a migration.

```bash
rails generate avo:kanban install
```

--------------------------------

### standalone

Source: https://docs.avohq.io/3.0/llms-full.txt

Example of creating a standalone action using the standalone attribute.

```APIDOC
## [Ruby] Avo::Actions::GlobalReport (standalone)

### Description
Creates a standalone action that is not tied to specific model records, useful for global operations.

### Method
Ruby class attribute assignment or generator command

### Endpoint
N/A (Ruby class definition)

### Parameters
#### Class Attributes
- **standalone** (boolean) - Required - Set to `true` to make the action standalone.

### Request Example
```ruby
# app/avo/actions/global_report.rb
class Avo::Actions::GlobalReport < Avo::BaseAction
  self.name = "Generate Global Report"
  self.standalone = true
end
```

### Response
No response body. The action appears in the Actions dropdown even when no records are selected.
```

--------------------------------

### Use full paths for other configurations

Source: https://docs.avohq.io/3.0/customization.html

When mounting under a nested path, use full paths for other configurations like home_path and set_initial_breadcrumbs. The example shows the correct full paths.

```ruby
Avo.configure do |config|
  config.home_path = "/uk/admin/dashboard"

  config.set_initial_breadcrumbs do
    add_breadcrumb "Dashboard", "/uk/admin/dashboard"
  end
end
```

--------------------------------

### Production log for unauthorized action

Source: https://docs.avohq.io/3.0/llms-full.txt

Example log output in production when an unauthorized action is attempted. Provides details only about the policy class and the attempted action.

```bash
web     | [Avo->] Unauthorized action 'act_on?' for 'UserPolicy'
```

--------------------------------

### download

Source: https://docs.avohq.io/3.0/llms-full.txt

The download response starts a file download to the specified path and filename. For versions before 3.2.2, you need to set self.may_download_file to true for the download response to work.

```APIDOC
## download

### Description
Starts a file download to the specified `path` and `filename`. For versions before 3.2.2, you need to set `self.may_download_file` to true for the download response to work.

### Parameters
- `data` (String) - Required - The data to be downloaded.
- `filename` (String) - Required - The name of the file to be downloaded.

### Example
```ruby
class Avo::Actions::DownloadFile < Avo::BaseAction
  self.name = "Download file"
  # Only required for versions before 3.2.2
  self.may_download_file = true

  def handle(query:, **args)
    filename = "projects.csv"
    report_data = []

    query.each do |project|
      report_data << project.generate_report_data
    end

    succeed 'Done!'

    if report_data.present? and filename.present?
      download report_data, filename
    end
  end
end
```
```

--------------------------------

### Example brand color palettes

Source: https://docs.avohq.io/3.0/llms-full.txt

Example color palettes for blue, red, green, and orange. Each color provides the four required variants (`100`, `400`, `500`, `600`). Use these as a starting point or generate your own with tools like Palettte, ColorBox, or TailwindInk.

```ruby
config.branding = {
  colors: {
    # BLUE
    100 => "#CEE7F8",
    400 => "#399EE5",
    500 => "#0886DE",
    600 => "#066BB2",
    # RED
    100 => "#FACDD4",
    400 => "#F06A7D",
    500 => "#EB3851",
    600 => "#E60626",
    # GREEN
    100 => "#C5F1D4",
    400 => "#3CD070",
    500 => "#30A65A",
    600 => "#247D43",
    # ORANGE
    100 => "#FFECCC",
    400 => "#FFB435",
    500 => "#FFA102",
    600 => "#CC8102",
  }
}
```

--------------------------------

### Configure main_menu and profile_menu

Source: https://docs.avohq.io/3.0/llms-full.txt

Configures both main_menu and profile_menu in the initializer. Shows how to add dashboards, resources, tools, and links with visibility options.

```ruby
# config/initializers/avo.rb
Avo.configure do |config|
  config.main_menu = -> {
    section I18n.t("avo.dashboards"), icon: "dashboards" do
      dashboard :dashy, visible: -> { true }
      dashboard :sales, visible: -> { true }

      group "All dashboards", visible: false do
        all_dashboards
      end
    end

    section "Resources", icon: "heroicons/outline/academic-cap" do
      group "Academia" do
        resource :course
        resource :course_link
      end

      group "Blog" do
        resource :posts
        resource :comments
      end

      group "Other" do
        resource :fish
      end
    end

    section "Tools", icon: "heroicons/outline/finger-print" do
      all_tools
    end

    group do
      link_to "Avo", path: "https://avohq.io"
      link_to "Google", path: "https://google.com", target: :_blank
    end
  }
  config.profile_menu = -> {
    link_to "Profile", path: "/profile", icon: "user-circle"
  }
end
```

--------------------------------

### Field wrappers as stimulus targets

Source: https://docs.avohq.io/3.0/llms-full.txt

Field wrappers get stimulus target data attributes using the notation `[FIELD_NAME][FIELD_TYPE]WrapperTarget`. The example shows how to define fields that will generate these targets.

```ruby
# Wrappers get the `data-[CONTROLLER]-target="nameTextWrapper"` attribute and can be targeted using nameTextWrapperTarget
field :name, as: :text

# Wrappers get the `data-[CONTROLLER]-target="createdAtDateTimeWrapper"` attribute and can be targeted using createdAtDateTimeWrapperTarget
field :created_at, as: :date_time

# Wrappers get the `data-[CONTROLLER]-target="hasSkillsTagsWrapper"` attribute and can be targeted using hasSkillsTagsWrapperTarget
field :has_skills, as: :tags
```

--------------------------------

### Integrate FriendlyID with Avo

Source: https://docs.avohq.io/3.0/llms-full.txt

Steps to integrate FriendlyID with Avo: add the gem, install it, generate and run the migration, and configure the model with `use: :finders` for full Avo compatibility. After setup, `Post.find("bar")` finds records by custom IDs.

```ruby
gem "friendly_id", "~> 5.5.0"
```

```bash
bundle install
```

```bash
rails generate friendly_id
rails db:migrate
```

```ruby
# app/models/post.rb
class Post < ApplicationRecord
  extend FriendlyId

  # This post model have a name column
  friendly_id :name, use: :finders
end
```

--------------------------------

### Full Jumpstart Pro blueprint

Source: https://avohq.io/templates/jumpstart-pro

The full blueprint file listing all Avo files and their contents. This is the complete template used by the app:template command.

```ruby
# Blueprint info:
#   Link: https://avohq.io/blueprints/jumpstart-pro
#   Repository: https://github.com/avo-hq/jumpstart-pro-app-template

# List of all Avo files with path and contents
files = {"app/avo/cards/active_subscriptions.rb" => "class Avo::Cards::ActiveSubscriptions < Avo::Cards::MetricCard\n  self.id = \"active_subscriptions\"\n  self.label = \"Active subscriptions\"\n  self.description = \"Total number of active subscriptions\"\n\n  def query\n    result ::Pay::Subscription.active.count\n  end\nend\n", "app/avo/cards/total_revenue.rb" => "class Avo::Cards::TotalRevenue < Avo::Cards::MetricCard\n  self.id = \"total_revenue\"\n  self.label = \"Total revenue\"\n  self.prefix = \"$\"\n\n  def query\n    case arguments[:period]\n    when :last_12_months\n      result last_12_months\n    when :last_month\n      result last_month\n    when :this_month\n      result this_month\n    else\n      result total_revenue\n    end\n  end\n\n  def total_revenue\n    revenue_in_cents = ::Pay::Charge.sum(:amount)\n    refunds_in_cents = ::Pay::Charge.sum(:amount_refunded)\n    (revenue_in_cents - refunds_in_cents) / 100.0\n  end\n\n  def last_12_months\n    revenue_for_range 12.months.ago..Time.current\n  end\n\n  def last_month\n    month = Time.current.prev_month\n    revenue_for_range month.beginning_of_month..month.end_of_month\n  end\n\n  def this_month\n    month = Time.current\n    revenue_for_range month.beginning_of_month..month.end_of_month\n  end\n\n  def revenue_for_range(range)\n    revenue_in_cents = ::Pay::Charge.where(created_at: range).sum(:amount)\n    refunds_in_cents = ::Pay::Charge.where(created_at: range).sum(:amount_refunded)\n    (revenue_in_cents - refunds_in_cents) / 100.0\n  end\nend\n", "app/avo/cards/users_count.rb" => "class Avo::Cards::UsersCount < Avo::Cards::MetricCard\n  self.id = \"users_count\"\n  self.label = \"Users count\"\n  self.description = \"Total number of users registered\"\n\n  def query\n    result ::User.all.count\n  end\nend\n", "app/avo/dashboards/overview.rb" => "class Avo::Dashboards::Overview < Avo::Dashboards::BaseDashboard\n  self.id = \"overview\"\n  self.name = \"Overview\"\n  self.grid_cols = 4\n\n  def cards\n    divider label: \"Revenue\"\n    card Avo::Cards::TotalRevenue,\n      arguments: {\n        period: :this_month\n      },\n      label: \"This month\"\n    card Avo::Cards::TotalRevenue,\n      arguments: {\n        period: :last_month\n      },\n      label: \"Last month\"\n    card Avo::Cards::TotalRevenue,\n      arguments: {\n        period: :last_12_months\n      },\n      label: \"Last 12 months\"\n    card Avo::Cards::TotalRevenue\n\n    divider\n\n    card Avo::Cards::UsersCount\n    card Avo::Cards::ActiveSubscriptions\n  end\nend\n", "app/avo/resources/account.rb" => "class Avo::Resources::Account < Avo::BaseResource\n  self.title = :name\n  self.includes = [:owner, :users]\n  self.search = {\n    query: -> { query.ransack(id_eq: params[:q], name_cont: params[:q], m: \"or\").result(distinct: false) },\n    item: -> {\n      {\n        title: record.name,\n        image_url: record.avatar\n      }\n    }\n  }\n\n  def fields\n    main_panel do\n      field :id, as: :id\n      field :avatar,\n        as: :file,\n        is_image: true,\n        link_to_resource: true,\n        rounded: true,\n        hide_on: :forms\n      field :owner, as: :belongs_to\n      field :name, as: :text\n      field :personal, as: :boolean\n      field :users_count, as: :text do\n        record.users.length\n      end\n\n      sidebar do\n        field :extra_billing_info, as: :textarea\n        field :created_at, as: :date_time\n        field :updated_at, as: :date_time\n      end\n    end\n\n    tabs do\n      field :subscriptions, as: :has_many\n      field :pay_customers, as: :has_many\n      field :charges, as: :has_many\n      field :account_users, as: :has_many\n      field :users, as: :has_many\n    end\n  end\nend\n", "app/avo/resources/account_user.rb" => "class Avo::Resources::AccountUser < Avo::BaseResource\n  self.title = :id\n  self.includes = []\n\n  def fields\n    main_panel do\n      field :id, as: :id\n      field :account, as: :belongs_to\n      field :user, as: :belongs_to\n      field :roles,\n        as: :boolean_group,\n        options: {\n          admin: 
```

--------------------------------

### Apply Jumpstart Pro blueprint

Source: https://avohq.io/templates/jumpstart-pro

Run this command to apply the Jumpstart Pro blueprint to your Rails app. It will add Avo 3 files and configuration.

```bash
bin/rails app:template LOCATION=https://avohq.io/blueprints/jumpstart-pro.template
```

--------------------------------

### Build Docker image with BUNDLE_PACKAGER__DEV

Source: https://docs.avohq.io/3.0/llms-full.txt

Build with Docker by passing BUNDLE_PACKAGER__DEV as a build argument. The Dockerfile accepts the ARG and sets it as an ENV, then bundle install runs. Use the bash commands to pass the key directly or from an environment variable, and the compose command for docker compose.

```dockerfile
FROM ruby:3.2.2
RUN apt-get update -qq && apt-get install -y nodejs postgresql-client
WORKDIR /app
COPY Gemfile /app/Gemfile
COPY Gemfile.lock /app/Gemfile.lock

# get the build argument
ARG BUNDLE_PACKAGER__DEV
# make it available in the docker image
ENV BUNDLE_PACKAGER__DEV=$BUNDLE_PACKAGER__DEV

RUN bundle install
COPY . /app
# do more stuff
```

```bash
# Pass the key to the build argument
docker build --build-arg BUNDLE_PACKAGER__DEV=xxx

# OR

# Set the key as an environment variable on your machine
# Somewhere in your `.bashrc` or `.bash_profile` file
export BUNDLE_PACKAGER__DEV=xxx
# Then pass it to the build argument from there
docker build --build-arg BUNDLE_PACKAGER__DEV=$BUNDLE_PACKAGER__DEV
```

```bash
docker compose build --build-arg BUNDLE_PACKAGER__DEV=xxx
```

--------------------------------

### Download file response with action and resource registration

Source: https://docs.avohq.io/3.0/llms-full.txt

Use the `download` response to start a file download to a specified `path` and `filename`. For versions before 3.2.2, you must set `self.may_download_file = true` for the download to work. The action is registered in the resource's `actions` method.

```ruby
class Avo::Actions::DownloadFile < Avo::BaseAction
  self.name = "Download file"
  # Only required for versions before 3.2.2
  self.may_download_file = true

def handle(query:, **args)
    filename = "projects.csv"
    report_data = []

    query.each do |project|
      report_data << project.generate_report_data
    end

    succeed 'Done!'

    if report_data.present? and filename.present?
      download report_data, filename
    end
  end
end
```

```ruby
# app/avo/resources/project.rb
class Avo::Resources::Project < Avo::BaseResource
  def fields
    # fields here
  end

  def actions
    action Avo::Actions::DownloadFile
  end
end
```

--------------------------------

### Boolean group DB payload example

Source: https://docs.avohq.io/3.0/llms-full.txt

Example of a boolean group object stored in the database. The keys are strings and the values are booleans.

```ruby
{
  "admin": true,
  "manager": true,
  "writer": true,
}
```

--------------------------------

### all_tools

Source: https://docs.avohq.io/3.0/llms-full.txt

Renders all tools in the menu.

```ruby
section "App", icon: "heroicons/outline/beaker" do
  group "All tools", icon: "tools" do
    all_tools
  end
end
```

--------------------------------

### Install avo-rhino_field gem

Source: https://docs.avohq.io/3.0/llms-full.txt

Add this line to your application's Gemfile to install the avo-rhino_field gem, which is required to use the Rhino editor field.

```ruby
gem "avo-rhino_field"
```

--------------------------------

### Countless pagination example

Source: https://docs.avohq.io/3.0/resources.html

Example of countless pagination. Disables the pagination count on the index page, which is beneficial for large datasets where counting is inefficient.

```ruby
self.pagination = -> do
  {
    type: :countless
  }
end
```

--------------------------------

### Avo initializer configuration

Source: https://avohq.io/templates/bullet-train

Main Avo configuration file. Includes routing, licensing, authentication, authorization, localization, resource options, branding, breadcrumbs, and menus. Most options are commented out and can be uncommented as needed.

```ruby
# For more information regarding these settings check out our docs https://docs.avohq.io
Avo.configure do |config|
  ## == Routing ==
  config.root_path = "/admin/avo"
  # used only when you have custom `map` configuration in your config.ru
  # config.prefix_path = "/internal"

  # Where should the user be redirected when visting the `/avo` url
  # config.home_path = nil

  ## == Licensing ==
  # config.license_key = ENV['AVO_LICENSE_KEY']

  ## == Set the context ==
  config.set_context do
    # Return a context object that gets evaluated in Avo::ApplicationController
  end

  ## == Authentication ==
  config.current_user_method = :current_user
  # config.authenticate_with do
  # end

  ## == Authorization ==
  # config.authorization_methods = {
  #   index: 'index?',
  #   show: 'show?',
  #   edit: 'edit?',
  #   new: 'new?',
  #   update: 'update?',
  #   create: 'create?',
  #   destroy: 'destroy?',
  #   search: 'search?',
  # }
  # config.raise_error_on_missing_policy = false
  # config.authorization_client = :pundit

  ## == Localization ==
  # config.locale = 'en-US'

  ## == Resource options ==
  # config.resource_controls_placement = :right
  # config.model_resource_mapping = {}
  # config.default_view_type = :table
  # config.per_page = 24
  # config.per_page_steps = [12, 24, 48, 72]
  # config.via_per_page = 8
  config.id_links_to_resource = true
  # config.cache_resources_on_index_view = true
  ## permanent enable or disable cache_resource_filters, default value is false
  # config.cache_resource_filters = false
  ## provide a lambda to enable or disable cache_resource_filters per user/resource.
  # config.cache_resource_filters = ->(current_user:, resource:) { current_user.cache_resource_filters?}

  ## == Customization ==
  config.app_name = -> { I18n.t "application.name" }
  # config.timezone = 'UTC'
  # config.currency = 'USD'
  # config.hide_layout_when_printing = false
  # config.full_width_container = false
  # config.full_width_index_view = false
  # config.search_debounce = 300
  # config.view_component_path = "app/components"
  # config.display_license_request_timeout_error = true
  # config.disabled_features = []
  # config.buttons_on_form_footers = true
  # config.field_wrapper_layout = true

  ## == Branding ==
  # config.branding = {
  #   colors: {
  #     background: "248 246 242",
  #     100 => "#CEE7F8",
  #     400 => "#399EE5",
  #     500 => "#0886DE",
  #     600 => "#066BB2",
  #   },
  #   chart_colors: ["#0B8AE2", "#34C683", "#2AB1EE", "#34C6A8"],
  #   logo: "/avo-assets/logo.png",
  #   logomark: "/avo-assets/logomark.png",
  #   placeholder: "/avo-assets/placeholder.svg",
  #   favicon: "/avo-assets/favicon.ico"
  # }

  ## == Breadcrumbs ==
  # config.display_breadcrumbs = true
  # config.set_initial_breadcrumbs do
  #   add_breadcrumb "Home", '/avo'
  # end

  ## == Menus ==
  # config.main_menu = -> {
  #   section "Dashboards", icon: "dashboards" do
  #     all_dashboards
  #   end

  #   section "Resources", icon: "resources" do
  #     all_resources
  #   end

  #   section "Tools", icon: "tools" do
  #     all_tools
  #   end
  # }
  # config.profile_menu = -> {
  #   link "Profile", path: "/avo/profile", icon: "user-circle"
  # }
end

```

--------------------------------

### Example models for has_many :through with join fields

Source: https://docs.avohq.io/3.0/llms-full.txt

Example models for a has_many :through association with a join table (StorePatron) that carries an extra review field. The User model includes attr_accessor :review so the field can be edited in Avo.

```ruby
class Store < ApplicationRecord
  has_one :location

  has_many :patronships, class_name: :StorePatron
  has_many :patrons, through: :patronships, class_name: :User, source: :user
end

class User < ApplicationRecord
  has_many :patronships, class_name: :StorePatron
  has_many :stores, through: :patronships

  # Needed to make the field editable in Avo
  attr_accessor :review
end

# Join Table
class StorePatron < ApplicationRecord
  belongs_to :store
  belongs_to :user

  validates :review, presence: true
end
```

--------------------------------

### Sample resource tool partial with Avo::PanelComponent

Source: https://docs.avohq.io/3.0/llms-full.txt

Sample resource tool partial generated by Avo. It renders an Avo::PanelComponent with a tools section and a body section, and includes comments listing the variables available in the partial: tool, @resource, @resource.model, form (on create & edit pages), params, Avo::Current.context, and current_user.

```erb
<div class="flex flex-col">
  <%= render Avo::PanelComponent.new title: "Post info" do |c| %>
    <% c.with_tools do %>
      <%= a_link('/avo', icon: 'heroicons/solid/academic-cap', style: :primary) do %>
        Dummy link
      <% end %>
    <% end %>
    <% c.with_body do %>
      <div class="flex flex-col p-4 min-h-24">
        <div class="space-y-4">
          <h3>🪧 This partial is waiting to be updated</h3>
          <p>
            You can edit this file here <code class='p-1 rounded bg-gray-500 text-white text-sm'>app/views/avo/resource_tools/post_info.html.erb</code>.
          </p>
          <p>
            The resource tool configuration file should be here <code class='p-1 rounded bg-gray-500 text-white text-sm'>app/avo/resource_tools/post_info.rb</code>.
          </p>
          <%
            # In this partial, you have access to the following variables:
            # tool
            # @resource
            # @resource.model
            # form (on create & edit pages. please check for presence first)
            # params
            # Avo::Current.context
            # current_user
          %>
        </div>
      </div>
    <% end %>
  <% end %>
</div>
```

--------------------------------

### Set BUNDLE_PACKAGER__DEV for bundler

Source: https://docs.avohq.io/3.0/llms-full.txt

Sets the BUNDLE_PACKAGER__DEV environment variable to authenticate with the private gem server. Use the export command before bundle install or prefix the bundle install command directly. The token is found on the license page.

```bash
export BUNDLE_PACKAGER__DEV=xxx
# or
BUNDLE_PACKAGER__DEV=xxx bundle install
```

--------------------------------

### close_modal_on_backdrop_click

Source: https://docs.avohq.io/3.0/llms-full.txt

Example of setting close_modal_on_backdrop_click to false.

```APIDOC
## [Ruby] Avo::Actions::ToggleInactive (close_modal_on_backdrop_click)

### Description
Prevents the user from closing the action modal by clicking on the backdrop.

### Method
Ruby class attribute assignment

### Endpoint
N/A (Ruby class definition)

### Parameters
#### Class Attributes
- **close_modal_on_backdrop_click** (boolean) - Required - Set to `false` to prevent closing the modal on backdrop click.

### Request Example
```ruby
# app/avo/actions/toggle_inactive.rb
class Avo::Actions::ToggleInactive < Avo::BaseAction
  self.close_modal_on_backdrop_click = false
end
```

### Response
No response body. The modal remains open when clicking the backdrop.
```

--------------------------------

### Combine home_path with set_initial_breadcrumbs

Source: https://docs.avohq.io/3.0/customization.html

Use home_path alongside set_initial_breadcrumbs to create a cohesive experience. Users are redirected to the specified path when clicking the logo.

```ruby
Avo.configure do |config|
  config.home_path = "/avo/dashboard"
  config.set_initial_breadcrumbs do
    add_breadcrumb "Dashboard", "/avo/dashboard"
  end
end
```

--------------------------------

### Configure record previews with show_on: :preview

Source: https://docs.avohq.io/3.0/llms-full.txt

Add the `preview` field to a resource and set `show_on: :preview` on fields to display them in the preview popover.

```ruby
class Avo::Resources::Team < Avo::BaseResource
  def fields
    field :preview, as: :preview
    field :name,
    as: :text,
    sortable: true,
    show_on: :preview
    field :color,
      as: Avo::Fields::ColorPickerField,
      hide_on: :index,
      show_on: :preview
    field :description,
      as: :textarea,
      show_on: :preview
  end
end
```

--------------------------------

### turbo

Source: https://docs.avohq.io/3.0/llms-full.txt

Example of setting the turbo attribute to false.

```APIDOC
## [Ruby] Avo::Actions::ToggleInactive (turbo)

### Description
Controls the Turbo behavior of actions by setting the `turbo` attribute.

### Method
Ruby class attribute assignment

### Endpoint
N/A (Ruby class definition)

### Parameters
#### Class Attributes
- **turbo** (boolean) - Required - Set to `false` to disable Turbo for the action.

### Request Example
```ruby
# app/avo/actions/toggle_inactive.rb
class Avo::Actions::ToggleInactive < Avo::BaseAction
  self.turbo = false
end
```

### Response
No response body. The action executes without Turbo.
```

--------------------------------

### Run Rails app template

Source: https://docs.avohq.io/3.0/llms-full.txt

Run this command to apply the Rails application template that sets up the helper inclusion described in the article.

```bash
rails app:template LOCATION='https://railsbytes.com/script/V2Gsb9'
```

--------------------------------

### Generate Avo TailwindCSS install

Source: https://docs.avohq.io/3.0/llms-full.txt

Run this generator to set up TailwindCSS integration with Avo. It installs the tailwindcss-rails gem if missing, generates config/avo/tailwind.config.js, creates app/assets/stylesheets/avo/tailwind.css, and updates Procfile.dev and package.json. Ensure a package.json file is present; yarn init will generate one if needed.

```bash
bin/rails generate avo:tailwindcss:install
```

--------------------------------

### Install Avo with optional paid gems group

Source: https://docs.avohq.io/3.0/llms-full.txt

Use this to install the Avo gem and its paid gems without bundling them by default. The command sets RAILS_GROUPS and BUNDLE_WITH to include the optional :avo group, and the Gemfile defines that group as optional with the paid gems sourced from packager.dev.

```bash
RAILS_GROUPS=avo BUNDLE_WITH=avo bundle install
```

```ruby
# Gemfile
gem 'avo'

group :avo, optional: true do
  source "https://packager.dev/avo-hq/" do
    gem "avo-advanced", "~> 3.17"
  end
end
```

--------------------------------

### Use all_ helpers in main menu

Source: https://docs.avohq.io/3.0/llms-full.txt

Use the all_ helpers to automatically add menu items for all dashboards, resources, and tools. The all_resources helper respects authorization rules, so ensure the resource policy has def index? enabled.

```ruby
section "App", icon: "heroicons/outline/beaker" do
  group "Dashboards", icon: "dashboards" do
    all_dashboards
  end

  group "Resources", icon: "resources" do
    all_resources
  end

  group "All tools", icon: "tools" do
    all_tools
  end
end
```

--------------------------------

### authorize

Source: https://docs.avohq.io/3.0/llms-full.txt

Example of using the authorize attribute to restrict action access.

```APIDOC
## [Ruby] Avo::Actions::GlobalReport (authorize)

### Description
Restricts access to actions based on custom logic using the `authorize` attribute.

### Method
Ruby class attribute assignment

### Endpoint
N/A (Ruby class definition)

### Parameters
#### Class Attributes
- **authorize** (boolean or proc) - Required - Determines if the action is authorized. The block is executed within `Avo::ExecutionContext` and has access to `action`, `resource`, `view`, and other context attributes.

### Request Example
```ruby
class Avo::Actions::GlobalReport < Avo::BaseAction
  self.authorize = false

  # Or as a block
  self.authorize = -> {
    current_user.is_admin?
  }
end
```

### Response
No response body. Unauthorized actions are hidden and blocked by the controller.
```

--------------------------------

### visible

Source: https://docs.avohq.io/3.0/llms-full.txt

Example of using the visible attribute to control action visibility.

```APIDOC
## [Ruby] Avo::Actions::GlobalReport (visible)

### Description
Controls the visibility of an action on different views using the `visible` attribute.

### Method
Ruby class attribute assignment

### Endpoint
N/A (Ruby class definition)

### Parameters
#### Class Attributes
- **visible** (boolean or block) - Required - Determines if the action is visible. The block is executed within `Avo::ExecutionContext` and has access to `view`, `resource`, `parent_resource`, and other context attributes.

### Request Example
```ruby
# app/avo/actions/global_report.rb
class Avo::Actions::GlobalReport < Avo::BaseAction
  self.name = "Generate Global Report"
  self.standalone = true
  self.visible = true

  # Or as a block
  self.visible = -> { view.index? }
end
```

### Response
No response body. The action is shown or hidden based on the visibility logic.
```

--------------------------------

### Create Rails app and set Avo root path

Source: https://docs.avohq.io/3.0/llms-full.txt

Commands to create a new Rails app, apply the Avo template, and change the root_path to '/' in the initializer.

```bash
rails new avo-root-path
cd avo-root-path
bin/rails app:template LOCATION='https://avohq.io/app-template'
sed -i '' "s|config.root_path = '/avo'|config.root_path = '/'|" config/initializers/avo.rb
```

--------------------------------

### Mount Avo with default and custom path

Source: https://docs.avohq.io/3.0/llms-full.txt

Shows the default mounting of Avo and how to customize the mount path using the `at` argument. The first `mount_avo` uses `Avo.configuration.root_path`; the second mounts at `/custom_path`.

```ruby
# config/routes.rb
Rails.application.routes.draw do
  # Mounts Avo at Avo.configuration.root_path
  mount_avo

  # Mounts Avo at `/custom_path` instead of the default
  mount_avo at: "custom_path"
end
```

--------------------------------

### Add Media Library to menu editor with media_library helper

Source: https://docs.avohq.io/3.0/llms-full.txt

Add the Media Library to the menu editor using the media_library helper. It becomes a menu item in the sidebar.

```ruby
# config/initializers/avo.rb
Avo.configure do |config|
  config.main_menu = lambda {
    link_to 'Media Library', avo.media_library_index_path
  }
end
```

--------------------------------

### no_confirmation

Source: https://docs.avohq.io/3.0/llms-full.txt

Example of setting the no_confirmation attribute to bypass the confirmation modal.

```APIDOC
## [Ruby] Avo::Actions::ReleaseFish

### Description
Bypasses the confirmation modal for an action by setting `self.no_confirmation = true`.

### Method
Ruby class attribute assignment

### Endpoint
N/A (Ruby class definition)

### Parameters
#### Class Attributes
- **no_confirmation** (boolean) - Required - Set to `true` to skip the confirmation modal.

### Request Example
```ruby
# app/avo/actions/release_fish.rb
class Avo::Actions::ReleaseFish < Avo::BaseAction
  self.no_confirmation = true
end
```

### Response
No response body. The action executes immediately upon triggering.
```

--------------------------------

### Create Rails app with Avo, avo-pro, or avo-advanced

Source: https://docs.avohq.io/3.0/llms-full.txt

Commands to create a new Rails app with Avo, avo-pro, or avo-advanced installed. Replace APP_NAME with your app name. These are used to create a reproduction repository for troubleshooting.

```bash
rails new -m https://avo.cool/new.rb APP_NAME
```

```bash
rails new -m https://avo.cool/new-pro.rb APP_NAME
```

```bash
rails new -m https://avo.cool/new-advanced.rb APP_NAME
```

--------------------------------

### Money Field

Source: https://docs.avohq.io/3.0/llms-full.txt

Documentation for the Avo Money field, including usage, options, installation, and prerequisite.

```APIDOC
## [FIELD] money

### Description
Displays a monetary value with a currency dropdown.

### Usage
```ruby
field :price, as: :money, currencies: %w[EUR USD RON PEN]
```

### Options
#### `currencies`
- **Type**: Array of ISO currency codes
- **Default**: `[]` (empty array)
- **Description**: Controls which currencies are visible in the dropdown.

### Installation
Add the `avo-money_field` gem and `money-rails` to your Gemfile:
```ruby
gem "avo-money_field"
gem "money-rails", "~> 1.12"
```

### Prerequisite
Monetize the associated attribute at the model level using the `monetize` method from `money-rails`:
```ruby
monetize :price_cents
```
```

--------------------------------

### Generate Avo resources for all models

Source: https://docs.avohq.io/3.0/resources.html

Run this command to scan the app/models directory and generate Avo resources for all database-backed models.

```bash
rails generate avo:all_resources
```

--------------------------------

### Configure Avo license key in initializer

Source: https://docs.avohq.io/3.0/llms-full.txt

Use this initializer to set the Avo license key from an environment variable. This is the typical way to register the license in your app, and you should verify the key is set on your production server.

```ruby
# config/initializers/avo.rb
Avo.configure do |config|
  config.license_key = ENV["AVO_LICENSE_KEY"]
end
```

--------------------------------

### Install Avo in Bullet Train

Source: https://docs.avohq.io/3.0/llms-full.txt

Use the provided template to add Avo to a Bullet Train application.

```ruby
bin/rails app:template LOCATION=https://v3.avohq.io/templates/bullet-train.template
```

--------------------------------

### Development log for unauthorized action

Source: https://docs.avohq.io/3.0/llms-full.txt

Example log output in development when an unauthorized action is attempted. Includes the policy class, the action attempted, and the global IDs of the user and record involved.

```bash
web     | [Avo->] Unauthorized action 'reorder?' for 'UserPolicy'
web     | user: gid://dummy/User/20
web     | record: gid://dummy/User/31
```

--------------------------------

### Use footer slot in Avo::PanelComponent

Source: https://docs.avohq.io/3.0/llms-full.txt

Example of the footer slot, the lowest available area at the end of the component.

```erb
<%= render Avo::PanelComponent.new do |c| %>
  <% c.with_footer do %>
    Something here.
  <% end %>
<% end %>
```

--------------------------------

### Use sidebar slot in Avo::PanelComponent

Source: https://docs.avohq.io/3.0/llms-full.txt

Example of the sidebar slot, which shows content in a smaller area on the right of the body.

```erb
<%= render Avo::PanelComponent.new do |c| %>
  <% c.with_Sidebar do %>
    Something tiny here.
  <% end %>
<% end %>
```

--------------------------------

### Add avo-kanban gem to Gemfile

Source: https://docs.avohq.io/3.0/llms-full.txt

Adds the avo-kanban gem to your Gemfile, pulling it from the specified package source. Required before installing the gem.

```ruby
gem "avo-kanban", source: "https://packager.dev/avo-hq/"
```

--------------------------------

### PostPolicy with only show? method

Source: https://docs.avohq.io/3.0/llms-full.txt

Example policy class for a Post resource that only defines the show? method. When explicit_authorization is true, missing methods like index? cause the corresponding action to be denied by default. When explicit_authorization is false, missing methods allow access by default.

```ruby
class PostPolicy < ApplicationPolicy
  def show?
    user.admin?
  end
end
```
Tokens:
Raw