@bettercode/react-app-version-checker

This module checks to update the code when the React App is redeployed.

Requirements

You need a REST API to query the app version. The Http response value should be as follows.

{
 "version": 2
}

Getting started

Install

# Using npm
npm install --save @bettercode/react-app-version-checker

# Using yarn
yarn add @bettercode/react-app-version-checker

Usage

import React from 'react'

import { AppVersionChecker } from '@bettercode/react-app-version-checker'

const App = () => {
  return <AppVersionChecker
                message={'Updated to new version. Click \'OK\' to use the latest version.'}
                minuteInterval={1}
                versionApiEndPoint="http://localhost:3000/version.json"/>
}

Component Properties

| Property | Description | Default Value | |--------------------|---------------------------------------|--------------------------| | message | The text of the message area | | | minuteInterval | check cycle | | | versionApiEndPoint | version checking REST API endpoint | | | onOk | Set the handler to handle click event | window.location.reload() | | okText | The text of the Ok button | Ok | | zIndex | CSS z-index value | 1 | | bgColor | Background color | #ffc75f |