Please note the initial goal of this package is to centralise all of the required pieces for the progressive font loading technique provided by o-typography and create a placeholder for the future inclusion of global styles from n-ui-foundations.

Getting started

This package is compatible with Node 12+ and is distributed on npm.

npm install --save @financial-times/dotcom-ui-base-styles

After installing the package you can use it to embed the progressive font loading hooks and document styles into your pages on the server-side and initialise the font loading on client-side.

Server-side

If you are using React to render your app you should use the LoadFontsEmbed component along with the loadCustomFontsClassNames and documentStyles variables to integrate font loading and document styles with your pages:

import {
  documentStyles
  LoadFontsEmbed,
  loadCustomFontsClassNames
} from '@financial-times/dotcom-ui-base-styles'

export default (props) => (
  <html className={loadCustomFontsClassNames} style={documentStyles}>
    <head>
      <meta charSet="utf-8" />
      <title>My Amazing Website</title>
      <LoadFontsEmbed />
    </head>
    <body>
      ...
    </body>
  </html>
)

Otherwise you can insert the code snippet into a <script> element:

const {
  documentStyles
  loadCustomFontsJS,
  loadCustomFontsClassNames
} = require('@financial-times/dotcom-ui-base-styles')

function page() {
  return `<!DOCTYPE html>
    <html className=${loadCustomFontsClassNames} style=${documentStyles}>
    <head>
      <meta charset="utf-8">
      <title>My Amazing Website</title>
      <script>${loadCustomFontsJS}</script>
    </head>
    <body>
      ...
    </body>
  </html>`
}

Client-side

Once you are rendering the styles, class names, and code snippets in your page you will need to initialise the client-side code.

To initialise the client-side JavaScript import the package and call the .init() method:

import * as baseStyles from '@financial-times/dotcom-ui-base-styles'

baseStyles.init()

This component also provides styles written in Sass which should be imported into your application's main Sass stylesheet:

@import '@financial-times/dotcom-ui-base-styles/styles';

FAQs

What is @financial-times/dotcom-ui-base-styles?

Is @financial-times/dotcom-ui-base-styles popular?

Is @financial-times/dotcom-ui-base-styles well maintained?

Last updated on 27 Feb 2024

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.

Install

@financial-times/dotcom-ui-base-styles