@alphasense/embedded-widgets
v0.3.1
Published
The AlphaSense Widget SDK allows you to easily integrate AlphaSense widgets into your web applications.
Downloads
34
Readme
AlphaSense Widget SDK
The AlphaSense Widget SDK allows you to easily integrate AlphaSense widgets into your web applications.
Installation
You can install the AlphaSense Widget SDK using npm:
npm install @alphasense/embedded-widgetsAlternatively, you can use the SDK via a CDN:
<script src="https://unpkg.com/@alphasense/embedded-widgets@latest/dist/index.min.js"></script>You can change the version in the URL to the version you want to use.
e.g
<script src="https://unpkg.com/@alphasense/[email protected]/dist/index.min.js"></script>Quick Start
Install the SDK using one of the methods above.
Import and initialize the SDK in your project:
import { AlphaSenseWidget } from '@alphasense/embedded-widgets';
const widget = new AlphaSenseWidget({
// Configuration options
});Example:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>AlphaSense Widget SDK</title>
</head>
<body>
<div class="container">
<div id="widget"></div>
</div>
<script src="https://unpkg.com/@alphasense/embedded-widgets@latest/dist/index.min.js"></script>
<script>
new AlphaSenseWidget({
target: '#widget',
widgetType: 'companySummary',
companyParams: {
tickerCode: 'AAPL'
},
width: '300px',
height: '500px',
authToken: 'test-token',
widgetUrl: 'http://localhost:9000/',
onInit: () => {
console.log('Widget initialized');
},
}).init();
</script>
</body>
</html>Configuration
When initializing the AlphaSenseWidget, you can pass the following options:
| Option | Type | Required | Description |
| ------------ | ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| authToken | string | Yes | The authentication token for the widget. |
| target | string | HTMLElement | No | The target element to render the widget into. Can be a CSS selector string or an HTMLElement. If not provided, a default container will be created. |
| widgetType | WidgetType | Yes | The type of widget to render. Possible values are defined in the WidgetType enum. |
| widgetUrl | string | No | The URL of the widget. If not provided, it will use the default FALLBACK_WIDGET_URL. |
| companyParams | object | No | Parameters specific to the target company identification. See below for details. |
| version | string | No | The version of the widget to render. |
| height | string | No | The height of the widget. Defaults to '100%'. |
| width | string | No | The width of the widget. Defaults to '100%'. |
| onInit | () => void | No | Callback function that is called when the widget is initialized. |
| onDestroy | () => void | No | Callback function that is called when the widget is destroyed. |
| onResize | () => void | No | Callback function that is called when the widget is resized. |
| onError | (error: Error) => void | No | Callback function that is called when an error occurs in the widget. |
companyParams
For now it is optional, since tickerCode has a default value but in the future companyParams might be required (for example if we decide not to use the fallback tickerCode value or another params will be added).
The companyParams object can include the following properties:
| Parameter | Type | Description |
| ------------ | ------ | ----------------------------------------------- |
| tickerCode | string | The ticker code for the company (e.g., 'AAPL', 'NVDA', 'TSLA'). |
Contributing
Check out the development guide to get started.
License
This project is licensed under the AlphaSense License. See the LICENSE file for more details.