This guide covers all configuration options available for Fluxbit generators, allowing you to customize the generated code to match your application’s needs.

Generator Options

Global Configuration

You can set default options for all generators by creating an initializer:

# config/initializers/fluxbit_generators.rb
Rails.application.config.generators do |g|
  g.fluxbit_ui = :modal           # Default UI interaction
  g.fluxbit_turbo = true          # Enable Turbo Streams
  g.fluxbit_paginator = true      # Enable pagination
  g.fluxbit_pundit = true         # Enable Pundit authorization
end

Per-Command Configuration

Override defaults for specific commands:

# Use drawer UI with pagination enabled
rails generate fluxbit:scaffold Product name:string --ui=drawer --paginator

# Disable Turbo, pagination, and Pundit for simple CRUD
rails generate fluxbit:scaffold Product name:string --no-turbo --no-paginator --no-pundit

# Use traditional page-based forms
rails generate fluxbit:scaffold Product name:string --ui=none

UI Configuration (--ui)

Controls how forms and interactions are presented to users.

rails generate fluxbit:scaffold Product name:string --ui=modal

Features:

  • Forms open in overlay modals
  • Non-blocking user experience
  • Perfect for quick CRUD operations
  • Turbo Stream compatible

Generated code:

<!-- Trigger -->
&lt;%= fx_button(data: { action: "fx-modal#show", target: "product-modal" }) do %>
  New Product
&lt;% end %&gt;

<!-- Modal -->
&lt;%= fx_modal(id: "product-modal") do %>
  <%%= render "form", product: @product %>
&lt;% end %&gt;

Drawer 

rails generate fluxbit:scaffold Product name:string --ui=drawer

Features:

  • Forms slide in from screen edges
  • Great for complex forms with multiple steps
  • More screen real estate than modals
  • Mobile-friendly

Generated code:

<!-- Trigger -->
&lt;%= fx_button(data: { action: "fx-drawer#show", target: "product-drawer" }) do %>
  New Product
&lt;% end %&gt;

<!-- Drawer -->
&lt;%= fx_drawer(id: "product-drawer", position: :right) do %>
  <%%= render "form", product: @product %>
&lt;% end %&gt;

None (Traditional Pages) 

rails generate fluxbit:scaffold Product name:string --ui=none

Features:

  • Separate pages for each form
  • Traditional Rails approach
  • Better for complex workflows
  • SEO-friendly URLs

Generated code:

<!-- Navigation -->
&lt;%= fx_button(as: :a, href: new_product_path) do %>
  New Product
&lt;% end %&gt;

<!-- Separate pages: new.html.erb, edit.html.erb -->

Turbo Configuration (--turbo)

Controls whether Turbo Streams are used for dynamic page updates.

With Turbo Streams (Default) 

rails generate fluxbit:scaffold Product name:string --turbo

Features:

  • Dynamic page updates without full reload
  • Better user experience
  • Modern Rails approach
  • Requires Turbo to be configured

Generated files:

  • create.turbo_stream.erb
  • update.turbo_stream.erb
  • destroy.turbo_stream.erb
  • update_all.turbo_stream.erb
  • destroy_all.turbo_stream.erb

Without Turbo Streams 

rails generate fluxbit:scaffold Product name:string --no-turbo

Features:

  • Traditional HTTP redirects
  • Simpler architecture
  • Works without JavaScript
  • Full page reloads

Generated code:

# Controller actions redirect instead of rendering streams
def create
  if @product.save
    redirect_to @product, notice: 'Created successfully'
  else
    render :new
  end
end

Pagination Configuration (--paginator)

Enable or disable pagination using Pagy.

With Pagination (Default) 

rails generate fluxbit:scaffold Product name:string --paginator

Features:

  • Uses Pagy for fast, lightweight pagination
  • Configurable per-page limits
  • Responsive pagination controls
  • Search and filter integration
  • Per-page selector dropdown

Generated code:

# Controller
def index
  Pagy::DEFAULT[:limit] = (params[:per_page].presence || 5).to_i
  @pagy, @products = pagy(@products)
end

&lt;!-- View --&gt;
&lt;%= fx_pagination(@pagy) if @pagy.pages &gt; 1 %&gt;

Without Pagination 

rails generate fluxbit:scaffold Product name:string --no-paginator

Use cases:

  • Small datasets that don’t need pagination
  • Custom pagination implementation
  • API-only applications
  • Simple list displays

Generated code:

# Controller (no pagination)
def index
  @products = policy_scope(Product).all
end

Authorization Configuration (--pundit)

Controls whether Pundit authorization is included.

With Pundit (Default) 

rails generate fluxbit:scaffold Product name:string --pundit

Features:

  • Policy-based authorization
  • Secure by default
  • Fine-grained permissions
  • Separation of concerns

Generated files:

  • app/policies/product_policy.rb

Controller integration:

class ProductsController < ApplicationController
  include Pundit::Authorization
  
  before_action :set_product, only: [:show, :edit, :update, :destroy]
  after_action :verify_authorized, except: :index
  after_action :verify_policy_scoped, only: :index

  def index
    @products = policy_scope(Product).all
  end

  def show
    authorize @product
  end
end

Without Pundit 

rails generate fluxbit:scaffold Product name:string --no-pundit

Features:

  • Simpler controllers
  • No authorization checks
  • Suitable for internal tools
  • Faster development

Generated code:

class ProductsController < ApplicationController
  def index
    @products = Product.all  # No policy scope
  end

  def show
    # No authorize call
  end
end

Attribute Type Handling

The generator intelligently handles different attribute types:

String and Text Fields 

rails generate fluxbit:scaffold Product name:string description:text

Generated form:

&lt;%= fx_text_field(:name, form: f, required: true) %>
&lt;%= fx_text_area(:description, form: f, rows: 3) %>

Search functionality:

# LIKE queries for partial matching
@products = @products.where("name LIKE ?", "%#{@q}%") if @q.present?

Numeric Fields 

rails generate fluxbit:scaffold Product price:decimal stock:integer

Generated form:

&lt;%= fx_number_field(:price, form: f, step: 0.01) %>
&lt;%= fx_number_field(:stock, form: f) %>

Range filtering:

# Greater than or equal filtering
@products = @products.where("price >= ?", @price) if @price.present?

Boolean Fields 

rails generate fluxbit:scaffold Product featured:boolean active:boolean

Generated form:

&lt;%= fx_checkbox(:featured, form: f) %>
&lt;%= fx_toggle(:active, form: f) %>

Date and DateTime Fields 

rails generate fluxbit:scaffold Event start_date:date created_at:datetime

Generated form:

&lt;%= fx_date_field(:start_date, form: f) %>
&lt;%= fx_datetime_local_field(:created_at, form: f) %>

Advanced Configuration

Custom Form Components

Create custom mappings for specific field types:

# config/initializers/fluxbit_generators.rb
Fluxbit::Generators::FormBuilder.field_mappings.merge!({
  email: :fx_email_field,
  url: :fx_url_field,
  phone: :fx_tel_field,
  currency: :fx_currency_field
})

Controller Customization

Override controller templates by copying them to your application:

# Copy templates to customize
mkdir -p lib/templates/fluxbit/scaffold
cp $(bundle show fluxbit_view_components)/lib/generators/fluxbit/templates/controller.rb.tt \
   lib/templates/fluxbit/scaffold/controller.rb.tt

# Customize the template
# The generator will now use your custom template

View Customization

Similarly, customize view templates:

# Copy view templates
mkdir -p lib/templates/fluxbit/scaffold
cp -r $(bundle show fluxbit_view_components)/lib/generators/fluxbit/templates/*.html.erb.tt \
      lib/templates/fluxbit/scaffold/

# Customize as needed

I18n Customization

Customize translation templates:

# Copy i18n templates
cp $(bundle show fluxbit_view_components)/lib/generators/fluxbit/templates/i18n.en.yml.tt \
   lib/templates/fluxbit/scaffold/i18n.en.yml.tt

# Add your custom translations

Environment-Specific Configuration

Development Configuration 

# config/environments/development.rb
config.generators do |g|
  g.fluxbit_ui = :modal
  g.fluxbit_turbo = true
  g.fluxbit_paginator = true
  g.fluxbit_pundit = false  # Disable for faster development
end

Production Configuration 

# config/environments/production.rb
config.generators do |g|
  g.fluxbit_ui = :modal
  g.fluxbit_turbo = true
  g.fluxbit_paginator = true
  g.fluxbit_pundit = true   # Always enable in production
end

Configuration Validation

Add validation to ensure proper configuration:

# config/initializers/fluxbit_generators.rb
Rails.application.config.after_initialize do
  # Validate Turbo configuration
  if Rails.application.config.generators.options[:fluxbit]&.fetch(:turbo, true)
    unless defined?(Turbo)
      Rails.logger.warn "Fluxbit generators configured for Turbo but Turbo is not available"
    end
  end
  
  # Validate Pundit configuration
  if Rails.application.config.generators.options[:fluxbit]&.fetch(:pundit, true)
    unless defined?(Pundit)
      Rails.logger.warn "Fluxbit generators configured for Pundit but Pundit is not available"
    end
  end
end

Best Practices

1. Start with Defaults

Begin with default options and customize as needed:

rails generate fluxbit:scaffold Product name:string

2. Consistent Configuration

Use initializers to maintain consistent options across your team:

# config/initializers/fluxbit_generators.rb
Rails.application.config.generators do |g|
  g.fluxbit_ui = :modal
  g.fluxbit_turbo = true
  g.fluxbit_paginator = true
  g.fluxbit_pundit = true
end

3. Environment-Appropriate Settings

  • Development: May disable Pundit for faster iteration
  • Production: Always enable security features

4. Document Your Choices

Document generator configuration in your README:

## Generator Configuration

This project uses:
- Modal UI for forms
- Turbo Streams for dynamic updates  
- Pagy for pagination
- Pundit for authorization

5. Test Generated Code

Always test the generated scaffolds to ensure they work with your application’s specific needs and configurations.