class RailsMiniProfiler::UserInterface

Configure various aspects about Rails Mini Profilers UI.

@!attribute badge_enabled

@see Badge
@return [Boolean] if the badge should be enabled

@!attribute badge_position

@see Badge
@return [String] the position of the interactive HTML badge

@!attribute page_size

@return [Integer] how many items to render per page in list views

Attributes

badge_enabled[RW]
badge_position[RW]
page_size[RW]

Public Class Methods

configuration() click to toggle source

Construct a new UI configuration instance

@return [UserInterface] a new storage configuration

# File lib/rails_mini_profiler/configuration/user_interface.rb, line 19
def configuration
  @configuration ||= new
end
configure() { |configuration| ... } click to toggle source

Configure how profiling data is shown to the user

@yieldreturn [UserInterface] a new UI configuration object

# File lib/rails_mini_profiler/configuration/user_interface.rb, line 26
def configure
  yield(configuration)
  configuration
end
new(**kwargs) click to toggle source
# File lib/rails_mini_profiler/configuration/user_interface.rb, line 36
def initialize(**kwargs)
  defaults!
  kwargs.each { |key, value| instance_variable_set("@#{key}", value) }
end

Public Instance Methods

defaults!() click to toggle source

Reset the configuration to default values

# File lib/rails_mini_profiler/configuration/user_interface.rb, line 42
def defaults!
  @badge_enabled = true
  @badge_position = 'top-left'
  @page_size = 25
end