Skip to content

fe-home 1.5.4

Install from the command line:
Learn more about npm packages
$ npm install @openimis/fe-home@1.5.4
Install via package.json:
"@openimis/fe-home": "1.5.4"

About this version

openIMIS Frontend Home reference module

This repository holds the files of the openIMIS Frontend Home reference module. It is dedicated to be deployed as a module of openimis-fe_js.

License: AGPL v3 Total alerts

Other Contributions

  • core.Router: registering the home route in openIMIS client-side router.

Available Contribution Points

  • home.HomePage.Container: Use to extend the container of the homepage completely (default: display home.HomePage.Blocks)
  • home.HomePage.Blocks: Blocks displayed on the homepage. The current user is passed to each contribution. An example of block can be found on the Claim management module
  • home.HomePage.customDashboard: A contribution key that enables rendering a custom dashboard as the homepage. To activate this, a component must be provided with the home.HomePage.customDashboard contribution key, and the HomePage.enableCustomDashboard configuration must be set to true in the database.

Configurations Options

  • HomePageContainer.showHomeMessage: a boolean configuration flag that determines whether or not a special message will be displayed on the home page. If set to true, the application will fetch and display HTML content based on the URL specified in HomePageContainer.homeMessageURL. By default, this is set to false. It means that no additional message will be displayed on the home page.
  • HomePageContainer.homeMessageURL: a string configuration that specifies the URL from which to fetch the HTML payload for display on the home page. By default, this is set to an empty string (""), meaning no URL is specified. This URL is used only when HomePageContainer.showHomeMessage is set to true.
  • HomePageContainer.showHealthFacilityMessage: boolean to show HF status information. It shows days to the end of the contract of a HF assigned to a current user. Default false.
  • HomePage.enableCustomDashboard: a boolean configuration flag that exposes the home.HomePage.customDashboard contribution key. This key allows overriding the default homepage to render a custom dashboard. NOTE: The custom page will not be rendered unless a component is provided with the home.HomePage.customDashboard contribution key.

Details


Assets

  • fe-home-1.5.4.tgz

Download activity

  • Total downloads 0
  • Last 30 days 0
  • Last week 0
  • Today 0