1.0.2 • Published 5 months ago

@cluster-data-experience/qlik-modules v1.0.2

Weekly downloads
-
License
-
Repository
-
Last release
5 months ago

@cluster/qlik-modules

A collection of React components, hooks, and utilities for working with Qlik applications.

Installation

npm install @cluster/qlik-modules

Features

This package provides tools for:

  • Qlik session and app management
  • Handling Qlik engine API
  • Ready-to-use visualizations like:
    • Charts
    • Tables
    • KPIs
    • Filters
    • List objects
    • And more!

Usage

QlikProvider

import { QlikProvider, useQlik } from "@cluster/qlik-modules";

const App = () => {
  return (
    <QlikProvider
      config={{
        url: "https://your-qlik-server.com",
        webIntegrationId: "your-web-integration-id",
      }}
    >
      <YourApp />
    </QlikProvider>
  );
};

const YourApp = () => {
  const { session } = useQlik();
  // Use Qlik session...
};

Visualizations

import { useTable } from "@cluster/qlik-modules";

const MyTableComponent = () => {
  const { data, loading, error } = useTable({
    appId: "your-app-id",
    objectId: "your-hypercube-id",
  });

  if (loading) return <div>Loading...</div>;
  if (error) return <div>Error: {String(error)}</div>;

  return <table>{/* Render your table using data */}</table>;
};

API Documentation

For detailed API documentation, please see the comments in the source code or the TypeScript type definitions.