This package has been deprecated

Author message:

This package is no longer maintained

ft-n-content-model

2.2.1 • Public • Published

Coverage Status

#n-content-model

#v2

Transforms content sourced either directly from the next Elastic Search cluster, or via the next-graphql-api, into summarised form for use in rendering content cards.

##Options supported;

###Use cases;

useCase: 'article-card' compatible with n-section card usage

useCase: 'stream-list-card' used for card in stream list on stream page.

###Excluded Taxonomies

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

##Example usage

###With an array of content items

const contentModel = require('ft-n-content-model');

const transformedContentArray = contentArray.map(content => {
  contentModel(content, {options});
});

##Key changes from v1

  • no-image variant for article card not supported - recommend either remove image from content or don't provide image options when configuring content for n-section

#v1

Transforms content from Elastic Search into summarised form for specified use-cases.

Use cases supported;

article-card : compatible with n-section usage

article-card-no-image : as article card, but with main image removed

stream-list-card : used for card in stream list on stream page.

Example usage

With an array of content items

const contentModel = require('ft-n-content-model');

const transformedContentArray = contentArray.map(content => {
  contentModel(content, 'use-case');
});

Readme

Keywords

none

Package Sidebar

Install

npm i ft-n-content-model

Weekly Downloads

44

Version

2.2.1

License

none

Last publish

Collaborators

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