Call-To-Action

Description

The CTA component is a powerful one. It can be used as simple link or button component. But it can also be used as data-js-item in other components or as data-js-module.

When you are using this component as data-js-module the component can fire global events. That means you can just listen in other modules on this event and work with the provided data.

Nice examples for the cta component as data-js-module are:

• a simple toggler (mobile navigation, search toggler)
• overlay opener with custom data

Requirements

• Veams >= v5.0.0 - Veams Framework.

Installation

Installation with Veams

veams install vc cta

Fields

cta.hbs

Settings

• settings.ctaButton {Boolean} [a] - Define a button or link as cta.
• settings.ctaContextClass {String} [default] - Context class of the cta.
• settings.ctaClass {String} - Modifier classes for the cta.
• settings.ctaTarget {String} - You can define a target when using an a-tag.
• settings.ctaJsItem {String} - You can add this component as data-js-item.
• settings.ctaJsModule {Boolean} - You can add this component as data-js-module.
• settings.ctaJsOptions {Object} - You can add options to the cta. This object get stringified in your mark-up.

Content

• content.ctaTitle {String} - You should define a title when using an a-tag.

cta__content.hbs

Settings

• settings.ctaIcon {Boolean} - Renders .cta__icon into the mark-up if set to true.
• settings.ctaContentJsItem {Boolean} - Renders data-js-item="cta-content" into the mark-up if set to true.

Content

• content.ctaContent {String} - Content of the cta.

JavaScript Options

• activeClass {String} [is-active] - Active class for cta if its clicked.
• clickHandler {String} [click] - Click handler like touchstart.
• closedLabel {String} [null] - Optional label for button while not active.
• ctaContent {String} ['[data-js-item="cta-content"]'] - Element selector for cta content (used for updating button text).
• globalEvent {String} [cta:click] - Global event triggered on click.
• openedLabel {String} [null] - Optional label for button while active.