@ev-uk/risk-rating-quick-tool NPM

EValue widget: Risk Rating Quick Tool

Description
Install
Usage
Parameters

Description

@ev-uk/risk-rating-quick-tool is an EValue widget that can be added to an existing website

Install

The widget can be installed by running one of the following commands

npm i @ev-uk/risk-rating-quick-tool
yarn add @ev-uk/risk-rating-quick-tool

Usage

The widget can be imported into a TypeScript project as follows:

import type { TConfig, TRiskRatingQuickToolProps } from '@ev-uk/risk-rating-quick-tool';
import { RiskRatingQuickToolWidget } from '@ev-uk/risk-rating-quick-tool';

const config: TConfig = {
  accessToken: '<ACCESS_TOKEN>',
  apiUrl: '<API_URL>',
  ...other parameters...
}

const props: TRiskRatingQuickToolProps = {
  config
}

export const App = () => {
  return (
    RiskRatingQuickToolWidget(props)
  )
}

Parameters

Name	Type	Required	Effects	Description
accessToken	string	✓	API	Authenticates requests to the API
apiUrl	string	✓	API	The url address to send API requests to

wordsColor	string		Widget	Colour of the widget text. Valid HTML color codes. For example "#FF5733"
symbolsColor	string		Widget	Colour of the widget icons. Valid HTML color codes. For example "#FF5733"
title	string		Widget	Widget title, default value "Fund risk ratings"
objectiveInput	string		Widget	Objective input label, default value "Objective"
benchmarkInput	string		Widget	Risk benchmark input label, default value "Risk benchmark"
riskInput	string		Widget	Risk level input label, default value "Risk level"
termInput	string		Widget	Term input label, default value "Investment term"
fundManagerInput	string		Widget	Fund manager group dropdown label, default value "Fund manager group"
fundNameInput	string		Widget	Fund name label text field label, default value "Fund name"
calculateButton	string		Widget	Search button text, default value "Search"
filterSearchButton	string		Widget	Text of the button to open filters in the mobile version, default value "Filter search"
tableFooter	string		Widget	Table footer text, default value "Rows per page"
tableDefaultWording	string		Widget	Text is displayed until the search is performed, default value "Set your parameters and search for the relevant funds"
objectiveInfoHeader	string		Widget	"Objective" modal window title, default value "Objective"
dataLevelInfoHeader	string		Widget	"Data level" modal window title, default value "Data Quality"