Giter Club home page Giter Club logo

hamus.js's Introduction

CircleCI Coverage Status

corectl

hamus.js is a collection of React hooks for sharing reusable functionality used when dealing with Qlik Associative Engine projects.

  • useModel — creates a session object from a definition.
  • useLayout — fetches the layout from a model, and updates the layout on model changes.
  • usePicasso — renders a picasso.js visualization to an element.

Usage

You need to have React 16.8.1 or later installed to use the React Hooks API. Some of the hooks requires other packages as well, see each hook individually above.

This module uses ES6 import syntax, which means that you need Babel to transpile the code.

You can import each hook individually, e.g import useModel from 'hamus.js/src/use-model',

or you can use ES6 named imports, e.g. import { useModel } from 'hamus.js'.

When using ES6 named imports you might run into missing dependency errors from hooks that you don't actually use in your project. To resolve these errors, you either have to install the dependencies, or you can tranform the named import statements to individual import statements with [babel-plugin-import](https://github.com/ant-design/babel-plugin-import). The .babelrc file will look something like this:

  "plugins": [
    ["import", { "libraryName": "hamus.js", "libraryDirectory": "src"}] 
  ]

Example

The example app uses the hooks to connect to a Qlik Associative Engine running on localhost:9076, loads a csv file that is mounted into the docker container running the engine, creates a session app and renders a bar chart. The example is run with:

ACCEPT_EULA=yes docker-compose up -d
npm install
npm run example

hamus.js's People

Contributors

axelssonhakan avatar dependabot[bot] avatar qlikossbuild avatar renovate[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

hamus.js's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.