Pro6PP Infer Core

The headless logic engine behind the Pro6PP Infer SDKs. Use this package if you are building a custom integration for a framework, or if you need to run Infer in a non-standard environment.

Note: Use @pro6pp/infer-react for React applications. For all other frameworks or Vanilla JS, use @pro6pp/infer-js.

Installation

Package Manager

npm install @pro6pp/infer-core

CDN

You can also load the Core SDK directly in the browser via a CDN:

<script src="https://unpkg.com/@pro6pp/infer-core"></script>

<script src="https://cdn.jsdelivr.net/npm/@pro6pp/infer-core"></script>

When loaded via a script tag, the library is available through the global Pro6PPCore object.

Usage

The core logic is exposed via the InferCore class. It manages the API requests, state and parses input.

Using ES Modules

import { InferCore } from '@pro6pp/infer-core';

const core = new InferCore({
  authKey: 'YOUR_AUTH_KEY',
  country: 'NL',
  onStateChange: (state) => {
    // suggestions, isLoading, isValid, value, selectedSuggestionIndex, etc.
    console.log('Current State:', state);
  },
  onSelect: (result) => {
    console.log('User selected:', result);
  },
});

Using via script tag (global)

const core = new Pro6PPCore.InferCore({
  authKey: 'YOUR_AUTH_KEY',
  country: 'NL',
  onSelect: (result) => console.log(result),
});

Event handling

Once initialized, pass your input and keyboard events to the core instance to manage state.

const input = document.querySelector('#my-input');

// pass input events to the core
input.addEventListener('input', (e) => {
  core.handleInput(e.target.value);
});

// pass keyboard events
input.addEventListener('keydown', (e) => {
  core.handleKeyDown(e);
});

// handle clicks
function onSuggestionClick(item) {
  core.selectItem(item);
}