Module: CCS::FrontendHelpers::GovUKFrontend::PhaseBanner

Included in:

CCS::FrontendHelpers::GovUKFrontend

Defined in:

lib/ccs/frontend_helpers/govuk_frontend/phase_banner.rb

Overview

GOV.UK Phase banner

This helper is used for generating the phase banner component from the GDS - Components - Phase banner

Instance Method Summary

• #govuk_phase_banner(tag_options, text = nil, **options) { ... } ⇒ ActiveSupport::SafeBuffer

  Generates the HTML for the GOV.UK Phase banner component.

Instance Method Details

#govuk_phase_banner(tag_options, text = nil, **options) { ... } ⇒ ActiveSupport::SafeBuffer

Generates the HTML for the GOV.UK Phase banner component

Parameters:

• tag_options (Hash) —

  paramters for the govuk tag (see Tag). options are:

  • text

  • colour

  • options

• text (String) (defaults to: nil) —

  the text for the phase banner. If nil, then a block will be rendered

• options (Hash) —

  options that will be used in customising the HTML

Options Hash (**options):

• :classes (String) —

  additional CSS classes for the phase banner HTML

• :attributes (Hash) — default: {} —

  any additional attributes that will added as part of the HTML

Yields:

• HTML that will be used in the phase banner. Ignored if text is passed.

Returns:

• (ActiveSupport::SafeBuffer)

# File 'lib/ccs/frontend_helpers/govuk_frontend/phase_banner.rb', line 24

def govuk_phase_banner(tag_options, text = nil, **options, &)
  Components::GovUK::PhaseBanner.new(context: self, tag_options: tag_options, text: text, **options).render(&)
end