Module: CCS::FrontendHelpers::CCSFrontend::DashboardSection

Included in:
CCS::FrontendHelpers::CCSFrontend
Defined in:
lib/ccs/frontend_helpers/ccs_frontend/dashboard_section.rb

Overview

CCS Dashboard Section

This helper is used for generating the dashboard section component

Instance Method Summary collapse

Instance Method Details

#ccs_dashboard_section(dashboard_section_panels, title_text = nil, **options) ⇒ ActiveSupport::SafeBuffer

Generates the HTML for the CCS Dashboard Section component

Parameters:

  • dashboard_section_panels (Array<Hash>)

    An array of options for the dashboard section panels, See Panel#initialize for details of the items in the array.

  • title_text (String) (defaults to: nil)

    text for the title of a dashboard section

  • options (Hash)

    options that will be used in customising the HTML

Options Hash (**options):

  • :classes (String)

    additional CSS classes for the dashboard section HTML

  • :width (String) — default: default: 'full'

    the width of the dashboard section

  • :attributes (Hash)

    any additional attributes that will added as part of the HTML

Returns:

  • (ActiveSupport::SafeBuffer)


21
22
23
# File 'lib/ccs/frontend_helpers/ccs_frontend/dashboard_section.rb', line 21

def ccs_dashboard_section(dashboard_section_panels, title_text = nil, **options)
  Components::CCS::DashboardSection.new(context: self, dashboard_section_panels: dashboard_section_panels, title_text: title_text, **options).render
end