immersive-reader-sdk/js

Azure Applied AI Immersive Reader - Immersive Reader SDK

The Immersive Reader JavaScript SDK is a JavaScript library that allows you to easily and quickly integrate the Immersive Reader into your web application.

Usage

Usage of this SDK requires an Azure subscription to Immersive Reader. Follow these instructions to create an Immersive Reader resource and configure Azure Active Directory authentication. Save the output of your session into a text file for future reference.

You can find examples of how to acquire an authentication token in the samples.

Include the library of the stable build in your web application:

<script type='text/javascript' src='https://ircdname.azureedge.net/immersivereadersdk/immersive-reader-sdk.1.4.0.js'></script>

npm install @microsoft/immersive-reader-sdk

yarn add @microsoft/immersive-reader-sdk

Add an HTML element to your webpage with the immersive-reader-button class attribute.

<div class='immersive-reader-button' onclick='launchImmersiveReader()'></div>

Next, invoke the Immersive Reader when the button is clicked:

function launchImmersiveReader() {
    const content = {
        title: 'Immersive Reader',
        chunks: [ {
            content: 'Hello, world!'
        } ]
    };
    ImmersiveReader.launchAsync(YOUR_TOKEN, YOUR_SUBDOMAIN, content);
}

Take a look at the samples for examples of a full end-to-end integration.

The Immersive Reader may use persistent cookies to maintain user preferences and track feature usage. When embedding the Immersive Reader into applications, please consider the requirements of EU Cookie Compliance Policy. Setting the cookiePolicy option to CookiePolicy.Enable will enable the Immersive Reader to use cookies. It is the responsibility of the host application to obtain any necessary user consent in accordance with EU Cookie Compliance Policy.

Building

In order to build the SDK, ensure that you have Git, Node.js, and Yarn installed.

Clone a copy of the repo:

git clone https://github.com/microsoft/immersive-reader-sdk

Change to the immersive-reader-sdk directory:

cd immersive-reader-sdk

Install dependencies:

yarn

Build and test:

yarn run build
yarn run test