/lxltools-js

JavaScript tools for the Libris XL infrastructure.

Primary LanguageJavaScript

🔥 THIS REPOSITORY HAS MOVED 🔥

Now exists as package in https://github.com/libris/lxlviewer/

lxltools-js

JavaScript tools for the Libris XL infrastructure.

Installation

Install from git repo like so

npm install libris/lxltools-js --save
yarn add libris/lxltools-js --save

Specifiy version as usual if needed

Development

When developing these files and testing changes to this repo in the applications that depend on it, use yarn link or npm link.

Contents

Display

Functions related to fresnel.

Vocab

Functions related to class structures of our base vocabulary.

String

String conversions etc.

Common parameters

The settings parameter

The settings parameter should at least contain the property language (sv, en etc). This could be the same object that you use for general settings in your application, if you follow the same pattern.

The resources parameter

The resources parameter should be an object. Not all functions require all properties to be present, but a full version contains the following properties:

Depending on your application, you may want to enrich the resources object with other things. This is generally not a problem, as long as the properties mentioned above aren't used for this.