Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

rox-ssr

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

rox-ssr

Rollout.io ROX JS SDK Client for SSR

4.8.3
Source
npm

Version published: 5 years ago

Weekly downloads: 1.8K; increased by26.76%

Maintainers: 1

Weekly downloads

Created: 5 years ago

Source

Rollout

Rollout is a Secure Feature Managment 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 how to add Rollout to your project.

Documentation

Getting started guide, use cases, examples and videos can be found at Rollout support site

Rollout JS Server Side Rendering (SSR) SDK 🦆

Rollout JavaScript SSR SDK for web applications that use server side rendering. Define and use simple and advanced feature flags, remote configuration variables, static and computed custom properties in code. Control your application features via Rollout's dashboard.

Installation

npm i rox-ssr --save

Usage

Basic Usage

Obtain an application key by registering at Rollout.io.

import {Configuration, Flag, Rox} from 'rox-ssr';

const appSettingsContainer = {
  shouldShowWelcome: new Flag(),
  textColor: new Configuration('black')
};

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

    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 Rollout 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:

import {Rox} from 'rox-ssr';

// ...
// Your component render() method
render() {
  return (
    <html>
      <head>
        <script type='text/javascript' dangerouslySetInnerHTML={{ __html: `window.rolloutData = ${Rox.rolloutData};` }} />
      <head>
    </html>)
  }

The SDK will automatically use the data inside window.rolloutData instead of fetching the configuration from Rollout's servers.

Configure the SDK with different options

Override the default configuration by prodiving predefined configuration preset for Rox.setup.

For example:

import {Rox} from 'rox-ssr';

/*
- roxOptions.distinctId
- roxOptions.version
- roxOptions.syncComplitionHandler
*/

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

Rollout client 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@rollout.io

Keywords

FAQs

What is rox-ssr?

Is rox-ssr popular?

Is rox-ssr well maintained?

Package last updated on 22 Nov 2019

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