Class: AdminSuite::Renderer

Inherits:

Object

• Object
• AdminSuite::Renderer

Defined in:

lib/admin_suite/renderer.rb

Overview

Base class for panel renderers.

Host apps subclass this in app/admin/renderers/*.rb and reference it from a show panel:

panel :costs, title: "Provider Costs", render: :provider_costs
# => Admin::Renderers::ProviderCostsRenderer

Subclasses implement #render and may use the primitives below rather than hand-building markup, so panels stay visually consistent with the rest of the admin UI.

Direct Known Subclasses

AdminSuite::Renderers::CodeRenderer, AdminSuite::Renderers::JsonRenderer, AdminSuite::Renderers::KeyValueRenderer, AdminSuite::Renderers::LegacyGleania::MessagesPreviewRenderer, AdminSuite::Renderers::LegacyGleania::PromptTemplateRenderer, AdminSuite::Renderers::LegacyGleania::ToolArgsRenderer, AdminSuite::Renderers::LegacyGleania::TurnMessagesRenderer, AdminSuite::Renderers::TableFromRenderer

Instance Attribute Summary

• #options ⇒ Object readonly

  Returns the value of attribute options.

• #record ⇒ Object readonly

  Returns the value of attribute record.

• #view ⇒ Object readonly

  Returns the value of attribute view.

Instance Method Summary

• #initialize(record, view, options = {}) ⇒ Renderer constructor

  A new instance of Renderer.

• #render ⇒ String

  HTML-safe markup for the panel body.

Constructor Details

#initialize(record, view, options = {}) ⇒ Renderer

Returns a new instance of Renderer.

Parameters:

• record (Object) —

  the resource being rendered

• view (ActionView::Base) —

  the calling view/helper context

• options (Hash) (defaults to: {}) —

  leftover panel DSL options (e.g. source:, columns:, empty:, language:) forwarded from ShowSectionDefinition#options. Defaults to {} so Task 3's two-arg construction keeps working.

# File 'lib/admin_suite/renderer.rb', line 23

def initialize(record, view, options = {})
  @record = record
  @view = view
  @options = options || {}
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.

# File 'lib/admin_suite/renderer.rb', line 16

def options
  @options
end

#record ⇒ Object (readonly)

Returns the value of attribute record.

# File 'lib/admin_suite/renderer.rb', line 16

def record
  @record
end

#view ⇒ Object (readonly)

Returns the value of attribute view.

# File 'lib/admin_suite/renderer.rb', line 16

def view
  @view
end

Instance Method Details

#render ⇒ String

Returns HTML-safe markup for the panel body.

Returns:

• (String) —

  HTML-safe markup for the panel body

Raises:

• (NotImplementedError)

# File 'lib/admin_suite/renderer.rb', line 30

def render
  raise NotImplementedError, "#{self.class.name} must implement #render"
end