Nutmeg Plundering Muse

    @algoan/connect
    TypeScript icon, indicating that this package has built-in type declarations

    6.2.0 • Public • Published

    @algoan/connect

    Library for Algoan Connect

    Installation

    • Using the script:
    <script type="text/javascript" src="https://js.algoan.com/connect/algoan-connect.js"></script>
    • Using the package:
    npm install @algoan/connect

    Basic usage

    Place a div with the id algoan-connect where you want the button to appear:

    <div id="algoan-connect"></div>

    Then, you can invoke the Algoan Connect library:

    • If you are using the script:
    <script>
      AlgoanConnect.addWidget({ apiKey: '<Your API key>', customIdentifier: '<Your unique user identifier>' });
    </script>
    • If you are using the package:
    import { addWidget } from '@algoan/connect';
    
    addWidget({ apiKey: '<Your API key>', customIdentifier: '<Your unique user identifier>' });

    Configuration

    It is possible to configure some aspect of the Algoan Connect button. You can refer to the connect customization file for the list of every configuration possible.

    Personal details

    Once the widget is added to your user interface, it is possible to pass extra information to each aggregation request. For this use case, you can use setCustomerPersonalDetails.

    Contributing

    Install

    npm install

    Build

    npm run build

    Compile

    npm run compile

    Development server

    npm run dev

    This command will start a webserver listening at http://localhost:3002/. It will serve the dev/dev-server-template.html file with the library already injected.

    Keywords

    none

    Install

    npm i @algoan/connect

    DownloadsWeekly Downloads

    22

    Version

    6.2.0

    License

    ISC

    Unpacked Size

    61.9 kB

    Total Files

    64

    Last publish

    Collaborators

    • algoanbot
    • fabong
    • na-ji