# @financial-times/dotcom-ui-flags This package provides methods for integrating flags data into your server-side rendered pages and safely retrieving it again in the browser. ## Getting started This package is compatible with Node 12+ and is distributed on npm. ```sh npm install --save @financial-times/dotcom-ui-flags ``` After installing the package you can use it to embed flags data into your pages on the server-side. This data can then be retrieved and used in your client-side code using the included flags client. ### Server-side integration If you are using React to render your app you should use the `FlagsEmbed` component to integrate the flags data with your pages: ```jsx import { FlagsEmbed } from '@financial-times/dotcom-ui-flags' export default (props) => ( My Amazing Website ... ) ``` Otherwise you can insert a JSON formatted string into a ` ` } ``` ### Client-side integration Once you are delivering the flags data with your pages you can use the flags client in your client-side code. The flags client provides methods for safely retrieving the status of individual flags. ```js import * as flags from '@financial-times/dotcom-ui-flags' const flagsClient = flags.init() if (flagsClient.get('myAmazingFeature')) { ... } ``` ## Client-side API ### `init()` Initialises and returns a new [flags client](#flags-client-api) which can be used to safely access the status of individual flags. ### `loadFlags()` Finds and parses the formatted flags data embedded in the page and returns the flags data object if successful. _Please note_ the formatted flags data must be present in a `