# rox-ssr

> CloudBees Feature Management JavaScript SDK for Server-Side Rendering

Latest version **6.0.16** (published 2026-07-23) · SEE LICENSE IN LICENSE license · 0 weekly downloads

## Install

```sh
npm install rox-ssr
pnpm add rox-ssr
yarn add rox-ssr
bun add rox-ssr
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 6.0.16 |
| Published | 2026-07-23 |
| First published | 2019-11-22 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN LICENSE |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 61.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | CloudBees, Inc. |
| Maintainers | cloudbees-owner, asaf_rollout, markwm, ankurv0202 |
| Keywords | feature-flag, feature-flags, cloudbees, cloudbees.io, rox, ssr, flags, flag, configuration, remote-control, feature-management |

## Links

- npm: https://www.npmjs.com/package/rox-ssr
- Repository: https://github.com/rollout/roxjs
- Homepage: https://www.cloudbees.com/products/feature-management
- Issues: https://github.com/rollout/roxjs/issues
- npm.io page: https://npm.io/package/rox-ssr

## Dependencies (2)

- [rox-node](https://npm.io/package/rox-node.md) ^6.0.16
- [rox-browser](https://npm.io/package/rox-browser.md) ^6.0.16

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 6.0.16 (latest) — 2026-07-23
- 6.0.15 — 2026-07-06
- 6.0.14 — 2026-06-29
- 6.0.13 — 2026-05-15
- 6.0.11 — 2026-05-14
- 6.0.10 — 2026-05-08
- 6.0.8 — 2025-11-04
- 6.0.7 — 2025-10-13
- 6.0.6 — 2025-09-10
- 6.0.5 — 2025-09-08
- 6.0.4 — 2025-09-04
- 6.0.3 — 2025-06-03
- 6.0.2 — 2025-02-11
- 6.0.1 — 2024-07-24
- 6.0.0 — 2024-06-28
- … 43 more at https://npm.io/package/rox-ssr/versions

## README

# CloudBees Feature Management - Server Side Rendering (SSR) SDK 🦆

CloudBees Feature Management is a secure feature management solution for the enterprise.

> Accelerate development and minimize the risk of deploying new code with simple to create feature flags, controlled rollouts, advanced target groups & deployment rules.

## Getting Started

Please see the detailed instructions in our docs on how to [add CloudBees Feature Management to your project](https://docs.cloudbees.com/docs/cloudbees-feature-management/).

## Documentation

Getting started guide, use cases, examples and videos can be found at [CloudBees Feature Management documentation](https://docs.cloudbees.com/docs/cloudbees-feature-management/).

## About

CloudBees Feature Management JavaScript SSR SDK for web applications that use server side rendering. Define and use simple and advanced feature flags, static and computed custom properties in code. Control your application features via CloudBees Feature Management dashboard.

## Installation
```
npm i rox-ssr --save
```

## TypeScript Support

This package includes TypeScript definitions. Import and use with full type safety:

```typescript
import {RoxString, RoxNumber, Flag, Rox} from 'rox-ssr';
```

## Usage
### Basic Usage
Obtain an application key by registering at [CloudBees Unify](https://cloudbees.io). 

```javascript
import {RoxString, RoxNumber, Flag, Rox} from 'rox-ssr';

const appSettingsContainer = {
  shouldShowWelcome: new Flag(),
  textColor: new RoxString('red', ['green', 'blue']),
  textSize: new RoxNumber(15, [20, 45])
};

const onRoxReady = () => {
  if (appSettingsContainer.shouldShowWelcome.isEnabled()) {
    const color = appSettingsContainer.textColor.getValue()
    const size = appSettingsContainer.textSize.getValue()
    const div = document
      .createElement('div')
      .textContent('Hello world!')
      .setAttribute('style', `color: ${color}; font-size: ${size}px`)

    const body = document.getElementsByTagName('body')[0]
    body.appendChild(div)
  }
};

Rox.register('settingsNamespace', appSettingsContainer);
Rox.setup('<app key>', {
  configurationFetchedHandler: onRoxReady
});
```

### Hydrate browser-side Rox with flag configuration
In order to ensure the consistency of feature flags between the server and the web clients,
the CloudBees Feature Management configuration can easily be sent to the clients.

React example, assuming you already have initialized Rox. Add this to the server-side code, within the `<head>` tag:
```javascript
import {Rox} from 'rox-ssr';

// ...
// Your component render() method
render() {
  return (
    <html>
      <head>
        <script type='text/javascript' dangerouslySetInnerHTML={{ __html: `window.rolloutData = ${JSON.stringify(Rox.rolloutData)};` }} />
      <head>
    </html>)
  }
```
The SDK will automatically use the data inside `window.rolloutData` instead of fetching the configuration from CloudBees Feature Management servers.

### Configure the SDK with different options
Override the default configuration by providing predefined configuration preset for `Rox.setup`.

For example:
```javascript
import {Rox} from 'rox-ssr';

/*
- roxOptions.distinctId
- roxOptions.version
- roxOptions.configurationFetchedHandler
*/

const roxOptions = {
  distinctId: 'sessionDistinctId',
  version: '1.0',
  configurationFetchedHandler: () => {}
};

Rox.setup('<app key>', roxOptions);
```

### Activating Manual Overrides UI

When running in the browser, you can override flags manually using a built-in UI debug utility that can be activated by invoking `Rox.showOverrides()`.

Running it will display a UI element that allows to explicitly set values of flags.
Available UI location of the UI element:
- `'top left'`
- `'top right'`
- `'bottom left'`
- `'bottom right' (default)`

## LICENSE

CloudBees Feature Management JavaScript Server Side Rendering SDK is free-to-use, proprietary software.
Please see the full license found under the LICENSE file for more details.

## Feedback

Feedback is always welcomed
[support@cloudbees.com](mailto:support@cloudbees.com)

---
_Source: https://npm.io/package/rox-ssr · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._