skypager-client

universal skypager client

Usage no npm install needed!

<script type="module">
  import skypagerClient from 'https://cdn.skypack.dev/skypager-client';
</script>

README

Skypager Universal Client

The universal client will configure itself automatically based on a skypager project bundle which contains settings and copy configuration data. The universal client is designed to provide a consistent interface for react applications, whether they are react-dom or react-native or any other type of platform.

Usage

Creating an instance of the skypager-client is easiest when using an application bundle:

const client = require('skypager-client').create({
    bundle: require('./app-bundle.json')
  })

The client will attempt to automatically configure itself based on the contents of bundle.

Settings API

Overriding contents of the bundle settings, or supplying your own values can be done at creation time or by using the settings interface. In development, it is possible to treat the bundle as an observable object so that you can preview settings changes in a way that feels exactly like normal Hot Module Loading that is expected when working on react and react-native projects. Whether these settings changes occur as a result of actual code changes, or through changes to application state, the application runtime does not care.

This allows us to create an interface for changing the behavior or appearance of our application that integrates with tools such as our desktop app, or our live mobile sandbox preview application, or a number of other possible tools.

Copy API

The labels and strings -- aka copy -- of our application UI is delivered through an internationalization (i18n) framework that can be manipulated and persisted outside of the development environment. This allows for total control over surface content in a way that is not dependent on making changes to running code.