@financial-times/x-article-save-button v14.7.4
Article Save Button
This module provides a template for myFT save article buttons, and is intended to replace the legacy handlebars component in n-myft-ui.
Installation
npm install --save @financial-times/x-article-save-button
Props
(Some of the properties don't influence the way button looks or acts, but can be used for e.g. client-side Javascript in the apps).
Feature | Type | Required | Default value | Description |
---|---|---|---|---|
contentId | String | yes | none | UUID of the article |
contentTitle | String | yes | none | Title of the article |
saved | Boolean | no | false | Whether the article is saved or not. |
csrfToken | String | no | none | CSRF token (will be included in a hidden form field). |
trackableId | String | no | 'save-for-later' | Identifier for tracking purposes |
Usage
The components provided by this module are all functions that expect a map of teaser properties. They can be used with vanilla JavaScript or JSX (If you are not familiar check out WTF is JSX first). For example if you were writing your application using React you could use the component like this:
import React from 'react';
import { ArticleSaveButton } from '@financial-times/x-article-save-button';
// A == B == C
const a = ArticleSaveButton(props);
const b = <ArticleSaveButton {...props} />;
const c = React.createElement(ArticleSaveButton, props);
All x-
components are designed to be compatible with a variety of runtimes, not just React. Check out the x-engine
documentation for a list of recommended libraries and frameworks.
Client side behaviour
For users with JavaScript enabled, the default form submit action is prevented, and a custom event (named 'x-article-save-button') will be dispatched on the form element.
This custom event will contain the following in its detail
object:
Property | Value |
---|---|
action | add or remove |
actorType | user |
relationshipName | saved |
subjectType | content |
subjectId | the value of the contentId prop |
token | the value of the csrfToken prop |
It is up to the consumer of this component to listen for the x-article-save-button
event, and use this data, along with the user's ID, and carry out the appropriate action.
For example, if using next-myft-client
:
import nextMyftClient from 'next-myft-client';
document.body.addEventListener('x-article-save-button', ({ detail }) => {
nextMyftClient[detail.action](detail.actorType, null, detail.relationshipName, detail.subjectType, detail.subjectId, {
token: detail.token
});
});
1 day ago
7 days ago
22 days ago
1 month ago
1 month ago
1 month ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
3 months ago
3 months ago
3 months ago
3 months ago
4 months ago
4 months ago
4 months ago
4 months ago
5 months ago
11 months ago
10 months ago
11 months ago
6 months ago
6 months ago
6 months ago
10 months ago
10 months ago
9 months ago
11 months ago
11 months ago
9 months ago
8 months ago
9 months ago
8 months ago
9 months ago
8 months ago
7 months ago
12 months ago
11 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
6 years ago
6 years ago
6 years ago
6 years ago