@financial-times/n-content-decorator

1.0.5 • Public • Published

Coverage Status

#n-content-decorator

Provides decoration for content sourced either directly from the next Elastic Search cluster, or via the next-graphql-api, for compatibility for rendering content cards.

##Options supported;

###Decoration type

mutateOriginal: true will mutate the object passed to it.

mutateOriginal: false will return the decoration object, which can be merged in with the original object by the calling application (eg. `Object.assign(original, decoration)``).

false is the default option and need not be passed in.

###Excluded Taxonomies

excludeTaxonomies: true prevents specific taxonomies (organisations, regions, people) from appearing in the tag that is returned.

excludeTaxonomies: false leaves taxonomies unaffected.

false is the default and need not be passed in.

###Minor Branding

Determines how brand (if content is associated with a brand) is displayed.

minorBranding: true brand appears below standfirst and primary Tag is shown eg. as on stream list.

minorBranding: false brand replaces primary Tag at the top of the card.

false is the default option and need not be passed in.

(NOTE: the intention is to migrate this display option to n-card rather than handle it here)

##Example usage

###With an array of content items

####With mutateOriginal: false

const decoration = require('ft-n-content-decoration');

contentArray.map(content => Object.assign(content, decoration(content, {options})));

####With mutateOriginal: true

const decorateContent = require('ft-n-content-decoration');

contentArray.map(content => decorateContent(content, {options}));

Readme

Keywords

none

Package Sidebar

Install

npm i @financial-times/n-content-decorator

Weekly Downloads

0

Version

1.0.5

License

MIT

Last publish

Collaborators

  • robertboulton
  • seraph2000
  • hamza.samih
  • notlee
  • emmalewis
  • aendra
  • the-ft
  • rowanmanning
  • chee
  • alexwilson