Origami Frontend Components & Services

SassDoc: o-teaser

oTeaser(opts)

Output all styles for teasers.

parameter type default description
opts (optional) all A map of teaser options. Includes an 'elements' key, to list which teaser elements will be used; and a 'themes' key, to list whilst themes will be used to modify the included teaser elements.

Links

oButtonsGetColor(...)

Gets the color of a button property for a given theme and state.

parameter type default description
state
property
type
theme A theme string or a custom theme map.

Returns

Color - The hex colour for a button property.

Examples

Example #1

background: oButtonsGetColor($state: 'default', $property: 'color', $type: 'primary');

Example #2

background: oButtonsGetColor($state: 'hover', $property: 'border', $type: 'secondary');

Links

oVisualEffectsShadowContent(elevation, color)

Elevation

A repeating linear gradient background

parameter type default description
elevation 'ultra', 'low', 'mid' or 'high'
color

Links

oVisualEffectsShadow(elevation, color)

Elevation

parameter type default description
elevation 'ultra', 'low', 'mid' or 'high'
color

Returns

Links

o-teaser-is-silent

Is silent setting

Links

oTeaserHeading

Teaser heading styles. Including styles for a nested link.

Links

oTeaser(opts)

Output all styles for teasers.

parameter type default description
opts (optional) all A map of teaser options. Includes an 'elements' key, to list which teaser elements will be used; and a 'themes' key, to list whilst themes will be used to modify the included teaser elements.

Links

Status
active
Switch component view

GitHub: o-teaser@6.2.7

Install o-teaser

If using the Build Service, add o-teaser@^6.2.7 to your link tag.

If using the npm package manager for a Manual Build, run npm install --save-peer "@financial-times/o-teaser@^6.2.7".

Help & Support

o-teaser is maintained directly by the Origami team. If you have any questions about o-teaser or Origami in general, we are happy to help. 😊

Slack: #origami-support
Email: origami.support@ft.com

Feedback / Issues

To report a bug or request features please create an issue on Github. For support or general feedback please get in touch 😊

Slack: #origami-support
Email: origami.support@ft.com