Class Peek::Views::View
In: lib/peek/views/view.rb
Parent: Object

Methods

context   context?   context_id   defer_key   dom_id   enabled?   key   new   parse_options   partial_path   results   results?   subscribe  

Public Class methods

Public Instance methods

context()

Additional context for any view to render tooltips for.

Returns Hash.

context_id()

The context id that is derived from the classname.

Examples: 

  Peek::Views::PerformanceBar => "peek-context-performance-bar"
  Peek::Views::Resque => "peek-context-resque"

Returns String.

defer_key()

Alias for key

dom_id()

The wrapper ID for the individual view in the Peek bar.

Returns String.

enabled?()

Conditionally enable views based on any gathered data. Helpful if you don‘t want views to show up when they return 0 or are touched during the request.

Returns true.

key()

The defer key that is derived from the classname.

Examples: 

  Peek::Views::PerformanceBar => "performance-bar"
  Peek::Views::Resque => "resque"

Returns String.

parse_options()

Where any subclasses should pick and pull from @options to set any and all instance variables they like.

Returns nothing.

partial_path()

The path to the partial that will be rendered to the Peek bar.

Examples: 

  Peek::Views::PerformanceBar.partial_path => "peek/views/performance_bar"
  CustomResque.partial_path => "performance_bar"

Returns String.

results()

The data results that are inserted at the end of the request for use in deferred placeholders in the Peek the bar.

Returns Hash.

[Validate]