cidgoh / DataHarmonizer

A standardized browser-based spreadsheet editor and validator that can be run offline and locally, and which includes templates for SARS-CoV-2 and Monkeypox sampling data. This project, created by the Centre for Infectious Disease Genomics and One Health (CIDGOH), at Simon Fraser University, is now an open-source collaboration with contributions from the National Microbiome Data Collaborative (NMDC), the LinkML development team, and others.
MIT License
91 stars 23 forks source link

Add help sidebar component #393

Closed pkalita-lbl closed 1 year ago

pkalita-lbl commented 1 year ago

This adds a HelpSidebar component. Since I'm assuming most clients will want to use it by default I'm having DataHarmonizer instances create and configure a HelpSidebar instance (as opposed to leaving that up to the client application).

The help sidebar can be disabled by providing the following configuration when constructing the DataHarmonizer instance:

new DataHarmonizer(dhRoot, {
  helpSidebar: {
    enabled: false
  }
})

All other configuration in the helpSidebar option is passed to the HelpSidebar constructor (see defaults here). For example to change the width of the sidebar:

new DataHarmonizer(dhRoot, {
  helpSidebar: {
    width: 200
  }
})

Fixes #392