Generators

Avo Forms provides generators to help you quickly create forms and pages.

Form Generator

rails generate avo:form your_form_name

This will create a new form file at app/avo/forms/your_form_name.rb with the following structure:

# app/avo/forms/your_form_name.rb
class Avo::Forms::YourFormName < Avo::Core::Forms::Base
  self.title = "Your Form Name"
  self.description = "Manage your your form name"

  def fields
    field :example, as: :text, default: "Hello World"
  end

  def handle
    flash[:notice] = params[:example]
  end
end

🎨 Customization

You can customize the generated form by:

• ✏️ Modifying the title and description
• ➕ Adding fields in the fields method
• ⚙️ Implementing custom logic in the handle method

Page Generator

The page generator creates a new page class.

INFO

To create a sub-page, you need to create a page first. The sub-page need to be namespaced under the parent page.

Example:

# app/avo/pages/parent_page.rb
class Avo::Pages::ParentPage < Avo::Core::Pages::Base
  self.title = "Parent Page"
  self.description = "A page for parent page"

  def sub_pages
    sub_page Avo::Pages::ParentPage::SubPage
  end
end

# app/avo/pages/parent_page/sub_page.rb
class Avo::Pages::ParentPage::SubPage < Avo::Core::Pages::Base
  self.title = "Sub Page"
  self.description = "A page for sub page"
end

rails generate avo:page your_page_name

This will create a new page file at app/avo/pages/your_page_name.rb with the following structure:

class Avo::Pages::YourPageName < Avo::Core::Pages::Base
  self.title = "Your Page Name"
  self.description = "A page for your page name"

  def forms
    # form Avo::Forms::AnyFormClass
  end

  def sub_pages
    # sub_page Avo::Pages::AnySubPageClass
  end
end

🎨 Customization

You can customize the generated page by:

• ✏️ Modifying the title and description
• 📝 Adding forms in the forms method
• 📑 Adding sub-pages in the sub_pages method

✨ Best Practices

1. 📝 Use descriptive names for your forms and pages
2. 🎯 Keep form fields focused and relevant to their purpose
3. 📁 Organize related forms and pages together
4. 🗂️ Use sub-pages to create a logical navigation structure
5. 💬 Add appropriate descriptions to help users understand the purpose of each form and page