@phantomstudios/ft-react-components
Advanced tools
Readme
A collection of React/NextJS UI and utility components for Phantom FT sites.
Currently implemented:
Install this package with npm.
npm i @phantomstudios/ft-react-components
Add the provider to _app.tsx, pass the site's page content to PageViewData
import { FTTrackerProvider } from "@phantomstudios/ft-react-components";
.
.
.
return (
<FTTrackerProvider>
<PageViewData pageProps={pageProps} />
<Component {...pageProps} />;
</FTTrackerProvider>
)
Construct the pageViewData object from the site content data. use setPageViewData and setTrackingOptions to update the tracker provider. See the Phantom FT partner tracking implementation guide for the full config object schema. TODO - consider moving to this lib with empty/default values and adding Yup validation to console error/eslint when incomplete.
import { useFTTracker, TrackingOptions, ConfigType } from "@phantomstudios/ft-react-components";
.
.
const { setPageViewData, setTrackingOptions } = useFTTracker();
useEffect(() => {
const globals = pageProps.globals;
const article = pageProps.article;
const category = pageProps.category;
setTrackingOptions({
scrollTrackerSelector: "#o_tracker_scroll",
isCustomGTMEvent: true,
sendGTMPageViewYN: true,
});
const errorValue = "404";
if (!setPageViewData) return;
setPageViewData({
advertiserIndustry: (globals && globals.sitewide.industry) || errorValue,
app:
(article && article.content_type) ||
(globals && globals.sitewide.homepage_label) ||
errorValue,
articleName:
(article && article.title) ||
(globals && globals.sitewide.homepage_label) ||
errorValue,
author:
.
.
.
} as ConfigType);
}, [pageProps]);
Video event tracking is handled by the videoTracker instance available from the useFTTracker hook. It is currently only compatible with react-player implementations which is the current standard player implementation for Phantom NextJS sites.
import { useFTTracker } from "@phantomstudios/ft-react-components";
import ReactPlayer from "react-player";
.
.
const { videoTracker } = useFTTracker();
.
.
<ReactPlayer
controls
height="100%"
style={{ position: "absolute", top: 0, left: 0 }}
onDuration={videoTracker?.setDuration}
onEnded={videoTracker?.trackEnded}
onPause={videoTracker?.trackPause}
onPlay={videoTracker?.trackPlay}
onProgress={videoTracker?.trackProgress}
width="100%"
url={fileToURL(article.video)}
light={fileToURL(article.image)}
playIcon={<PlayIconCircle />}
onClick={handlePlayButtonClick}
/>
Loads the external permutive scripts, requires Permutive project specific IDs (environment variables) - add to the sites' _document.tsx
import { PermutiveSetup } from "@phantomstudios/ft-react-components";
.
.
// Permutive tracking
const PERMUTIVE_PROJECT_ID = process.env.PERMUTIVE_PROJECT_ID || "";
const PERMUTIVE_PUBLIC_API_KEY = process.env.PERMUTIVE_PUBLIC_API_KEY || "";
.
.
render() {
return (
<Html lang="en">
<Head>
<FontPreloadEmbed />
<FaviconEmbed />
<TrackingHeadScript id={GA_TRACKING_ID} />
<PermutiveSetup
projectID={PERMUTIVE_PROJECT_ID}
publicAPIKey={PERMUTIVE_PUBLIC_API_KEY}
/>
.
.
Render in an appropriate page level component. FTPartnerContent requires 3 props as below to display the site's required partner links. It has optional disclaimer (controls the on/off tooltip state) and author (determines 1 of 4 tooltip texts) props.
import {
CookieMessage,
FTHeader,
FTFooter,
FTPartnerContent,
} from "@phantomstudios/ft-react-components";
.
.
<Container>
<FTHeader />
<FTPartnerContent
siteUrl={globals.sitewide.url}
siteTitle={globals.sitewide.title}
partner={{
title: "Zurich",
url: "https://www.zurich.com/",
}}
/>
{showHero && <CategoryHero />}
<Navbar categories={globals.categories} selected={category} />
<div id="o_tracker_scroll">{children}</div>
<CookieMessage />
<FTFooter />
</Container>
NOTE: all 4 components rely on a single global .scss styles file, which needs to be loaded in _app.tsx as a global import:
//load combined FT components styles as global
import "@phantomstudios/ft-react-components/src/components/ft/styles/app.scss";
Additionally, some the components use styling from the @financial-times root components, so adding a node_modules sass path to NextJS's next.config.js is required:
module.exports = {
//other config
sassOptions: {
includePaths: [
// Required by the @financial-times/o-<component> sass
path.resolve(__dirname, "./node_modules/@financial-times"),
],
},
};
Currently, the partner header icons need to be copied to the NextJS sites' /public/ft/partner-content folder
Implements the placeholder div and initialisation for Brandmetrics surveys.
NOTE: Surveys also require the separate Brandmetrics external CDN script to be loaded and available on window.
import { BrandMetricsSurvey } from "@phantomstudios/ft-react-components";
.
.
{article.brandmetrics_survey_id && (
<BrandMetricsSurvey surveyId={article.brandmetrics_survey_id}
/>
)}
Renders a styled img with with display:hidden and height:0
import { TrackingPixel } from "@phantomstudios/ft-react-components";
.
.
{article.brandmetrics_pixel_url && (
<TrackingPixel src={article.brandmetrics_pixel_url} />
)}
FAQs
A collection of UI/utility React/NextJS components for Phantom FT sites
We found that @phantomstudios/ft-react-components demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.