Skip to main content

Getting Started

The easiest way to get started is to install via NPM.

Install via NPM#

npm i @motor-js/core

Include in your HTML#

<script src="https://unpkg.com/@motor-js/core"></script>
<script crossorigin src="https://unpkg.com/react@16/umd/react.production.min.js"></script>
<script crossorigin src="https://unpkg.com/react-dom@16/umd/react-dom.production.min.js"></script>

Usage#

We recommend you start by wrapping your React document with the Motor parent component. This handles two things:

  • Connection to the Qlik Engine (you can pass configuration or the engine object directly)
  • Theming

You can then import the desired React component from the package and you're good to go. Check out the full list of props and theming options for each component in these docs.

info

The connection example below is pointing to Qlik's demo site. All examples in these docs use dimensions from this application

import { Motor } from '@motor-js/core'
<Motor
config={{
host: "sense-demo.qlik.com",
secure: true,
port: 443,
prefix: "",
appId: "372cbc85-f7fb-4db6-a620-9a5367845dce"
}}
>
// ...
</Motor>

Usage with Qlik Sense Cloud#

If you are connecting to a Qlik cloud SAAS instance, your configuration will look slightly different. We need to set the qcs entry to true and also add the web integration id, generated in your Qlik site. See below for an example:

import { Motor } from '@motor-js/core'
<Motor
config={{
host: 'juno-ui.eu.qlikcloud.com',
secure: true,
port: null,
prefix: '',
appId: '39e218c1-42ee-4f38-9451-1b8f850505d5',
webIntId: '...',
qcs: true,
}}>
>
// ...
</Motor>

For more information on how to generate your first web integration id in Qlik SAAS, head to the Qlik docs.

Examples#

Motor Starter Project --> https://github.com/motor-js/motor-starter#

Edit this page