Skip to content
Official NDX Javascript SDK
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist
images
types
.gitignore
.npmignore
LICENSE
README.md
index.js
package.json

README.md



NPM Version GitHub top language GitHub License Dependencies


NDX is the industry's new standard for connecting information to movies and television. NDX improves the TV viewing experience by connecting audiences with more information about the actors and locations they see on screen.

Installation

Using either NPM or Yarn:

npm install @ndxlabs/ndx-js
yarn add @ndxlabs/ndx-js

Usage

Javascript

<div class="ndx-embed"></div>

<script src="https://unpkg.com/@ndxlabs/ndx-js"></script>
<script>

  ndx.configure({
    apiKey: 'ab3rGRg4iwC5Qy...'
  });

  const tech = ndx.Tech('.ndx-embed', '1234567...', {
    list: {
      orientation: ndx.HORIZONTAL,
      view: ndx.LIST,
      style: {
        position: 'absolute',
        bottom: '2em',
        left: '0'
      }
    },
    detail: {
      relatedContent: true
    }
  });

  tech.list.show().updateTime(5);

</script>

React

import React from 'react';
import { withRouter } from 'react-router';
import { NDX, ndx } from '@ndxlabs/ndx-js';

import Controls from '../../components/Controls';
import Player from '../../components/Player';

const Watch = withRouter(({ match, store }) => {
  const { videoId } = match.params;
  const { playing, currentTime } = store.getState().player;

  return (
    <div className="watch-page">
      <NDX apiKey={process.env.REACT_APP_NDX_API_KEY} />
      <Player>
        <Controls />
        <NDX.Tech 
          videoId={videoId} 
          show={!playing}
          currentTime={currentTime}
          list={{
            orientation={ndx.HORIZONTAL}
            style: {
              position: 'absolute',
              bottom: '2em',
              left: '0'
            }
          }} />
      </Player>
    </div>
  );
});
You can’t perform that action at this time.