@ev-uk/retirement-forecast v0.0.7-bacfdedda4525a1b0956000c4204333eff0ac86b

EValue widget: Retirement Forecast

Contents

• Description
• Install
• Usage
• Parameters

Description

@ev-uk/retirement-forecast 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/retirement-forecast
yarn add @ev-uk/retirement-forecast

Usage

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

import type { TApiParameter, TInitConfig, TRetirementForecastProps } from '@ev-uk/retirement-forecast';
import { RetirementForecastWidget } from '@ev-uk/retirement-forecast';

const api: TApiParameter = {
  annuityUrl: '<ANNUITY_URL>'
}

const config: TInitConfig = {
  api,
  ...other parameters...
}

const props: TRetirementForecastProps = {
  config
}

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

Parameters

| | riskLevels | number | | User |