# @financial-times/dotcom-ui-bootstrap
This package provides a JavaScript bootstrap for your client-side code which can be embedded in your HTML pages. The bootstrap implements feature detection ([cuts the mustard](#cutting-the-mustard)) to determine if the browser should receive a core or enhanced experience, and the capability to load script files as appropriate.
## Getting started
This package is compatible with Node 12+ and is distributed on npm.
```sh
npm install --save @financial-times/dotcom-ui-bootstrap
```
After installing the package you can use it to embed the bootstrap data into your pages.
### Client-side integration
After installing the package you should add `no-js` and `core` class names to your document element (``). These can be used as hooks for styling elements when providing a non-enhanced, core experience. They will be swapped with `js` and `enhanced` class names if the bootstrap runs successfully.
```diff
-
+
```
Because the bootstrap is intended to load scripts asynchronously and as early as possible you should always check that the DOM is ready before initialising your client-side code. We recommend using the [ready-state] library which provides a promise-based interface for this:
```js
import readyState from 'ready-state'
readyState.domready.then(() => {
console.log('Ready!')
})
```
[ready-state]: https://www.npmjs.com/package/ready-state
### Server-side integration
_Please note_ that the bootstrap code should be embedded in the `` section of your pages to ensure scripts begin downloading as soon as possible.
If you are using React to render your app you can use the `Bootstrap` component:
```jsx
import { Bootstrap } from '@financial-times/dotcom-ui-bootstrap'
export default (props) => (
My Amazing Website
...
)
```
Otherwise this package provides two methods to manually integrate the bootstrap code into your templates. First you must insert a JSON formatted string of configuration into a `
...
`
}
```
## Client-side API
There is no client-side integration required. The bootstrap component can only be used on the server-side.
## Server-side API
### `formatConfigJSON(coreScripts, enhancedScripts, trackErrors)`
Returns a JSON formatted string representing the configuration for the bootstrap snippet. This must be inserted into a `