@arc-core-components/content-source_story-feed_sections-v4
v1.0.6-beta.0
Published
Returns a feed of stories from one or more sections. Offers ability to exclude sections.
Downloads
144
Maintainers
Keywords
Readme
Content Source: Story Feed, Sections v4 endpoint
This is the Arc Core Component representing a content source that hooks into the Content API portion of the Arc Suite and returns a feed of stories from one or multiple sections.
The most important part is the pattern. This defines the endpoint that PageBuilder Fusion uses to look up content.
This Core Component takes advantage of PageBuilder Fusion's ability to use CONTENT_BASE to define the credentials for a Content API, ensuring that no private secrets are exposed.
Pattern:
/content/v4/search/published?body=${encodedBody}&website=${website}&size=${feedSize}&from=${feedOffset}&sort=display_date:desc
Parameters:
This content source takes four parameters:
- includeSections - the sections you want to be included within your feed. Enter
this as a comma-separated list of the Site Service IDs. Quotes are optional.
- Example:
"/news","/politics"
will return a feed from the news and politics sections.
- Example:
- excludeSections - the sections you want to be excluded from your feed. If a
story is tagged with multiple sections, the stories with these sections will
not appear.
- Example:
"/entertainment/movies"
would ensure that stories with the section"/entertainment/movies"
are not returned in the feed.
- Example:
- feedSize - the number of stories you would like returned in the feed
- feedOffset - the number of stories you want to be offset from the start of the feed
Getting started
This Core Component must be used within a Fusion project.
- Add this schema as a dependency of the repo.
npm install @arc-core-components/content-source_story-feed_sections-v4
- Create a file of your desired content source name within the
/content/sources
folder. For this content source, the suggested name isstory-feed-sections-v4.js
- This is the name you should use when referencing this content source in any content config within a custom field.
- Paste the following into
story-feed-sections-v4.js
:
import source from "@arc-core-components/content-source_story-feed_sections-v4";
export default source;
What does this content source return?
This will return a feed of stories in one or multiple sections.
Using this content source with a schema
This content source can be used with the ans-feed
schema. This schema is
defined as a Core Component here.