Appearance
Tags field
Adding a list of things to a record is something we need to do pretty frequently; that's why having the tags field is helpful.
ruby
field :skills, as: :tags
Options
suggestions
You can give suggestions to your users to pick from which will be displayed to the user as a dropdown under the field.
ruby
# app/avo/resources/course_resource.rb
class CourseResource < Avo::BaseResource
field :skills, as: :tags, suggestions: -> { record.skill_suggestions }
end
# app/models/course.rb
class Course < ApplicationRecord
def skill_suggestions
['example suggestion', 'example tag', self.name]
end
end
Default
[]
Possible values
The suggestions option can be an array of strings, an object with the keys value, label, and (optionally) avatar, or a lambda that returns an array of that type of object.
The lambda is run inside a RecordHost, so it has access to the record along with other things (check the link).
ruby
# app/models/post.rb
class Post < ApplicationRecord
def self.tags_suggestions
# Example of an array of more advanced objects
[
{
value: 1,
label: 'one',
avatar: 'https://images.unsplash.com/photo-1560363199-a1264d4ea5fc?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&w=256&h=256&fit=crop',
},
{
value: 2,
label: 'two',
avatar: 'https://images.unsplash.com/photo-1567254790685-6b6d6abe4689?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&w=256&h=256&fit=crop',
},
{
value: 3,
label: 'three',
avatar: 'https://images.unsplash.com/photo-1560765447-da05a55e72f8?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&w=256&h=256&fit=crop',
},
]
end
end
dissallowed
The disallowed param works similarly to suggestions. Use it to prevent the user from adding specific values.
ruby
field :skills,
as: :tags,
disallowed: ["not", "that"]
Default
[]
Possible values
An array of strings representing the value that can't be stored in the database.
enforce_suggestions
Set whether the field should accept other values outside the suggested ones. If set to true the user won't be able to add anything else than what you posted in the suggestions option.
ruby
field :skills,
as: :tags,
suggestions: %w(one two three),
enforce_suggestions: true
Default
false
Possible values
true, false
close_on_select
Set whether the suggestions dropdown should close after the user makes a selection.
ruby
field :items,
as: :tags,
suggestions: -> { Post.tags_suggestions },
close_on_select: true
Default
false
Possible values
true, false
acts_as_taggable_on
Set the field the acts_as_taggable_on is set.
Default
nil
Possible values
Any string or symbol you have configured on your corresponding model.
disallowed
Default
false
Possible values
true, false
delimiters
Set the characters that will cut off the content into tags when the user inputs the tags.
ruby
field :skills,
as: :tags,
delimiters: [",", " "]
Default
[","]
Possible values
[",", " "]
Valid values are comma , and space .
PostgreSQL array fields
You can use the tags field with the PostgreSQL array field.
ruby
# app/avo/resources/course_resource.rb
class CourseResource < Avo::BaseResource
field :skills, as: :tags
end
# db/migrate/add_skills_to_courses.rb
class AddSkillsToCourses < ActiveRecord::Migration[6.0]
def change
add_column :courses, :skills, :text, array: true, default: []
end
end
Acts as taggable on
One popular gem used for tagging is acts-as-taggable-on. The tags field integrates very well with it.
You need to add gem 'acts-as-taggable-on', '~> 9.0' in your Gemfile, add it to your model acts_as_taggable_on :tags, and use acts_as_taggable_on on the field.
ruby
# app/avo/resources/post_resource.rb
class PostResource < Avo::BaseResource
field :tags,
as: :tags,
acts_as_taggable_on: :tags,
close_on_select: false,
placeholder: 'add some tags',
suggestions: -> { Post.tags_suggestions },
enforce_suggestions: true,
help: 'The only allowed values here are `one`, `two`, and `three`'
end
# app/models/post.rb
class Post < ApplicationRecord
acts_as_taggable_on :tags
end
That will let Avo know which attribute should be used to fill with the user's tags.
Array fields
We haven't tested all the scenarios, but the tags field should play nicely with any array fields provided by Rails.
ruby
# app/avo/resources/post_resource.rb
class PostResource < Avo::BaseResource
field :items, as: :tags
end
# app/models/post.rb
class Post < ApplicationRecord
def items=(items)
puts ["items->", items].inspect
end
def items
%w(1 2 3 4)
end
end