Guide to Loris React components - aces/Loris GitHub Wiki

This page is deprecated - contact the LORIS team for more information

Note: this guide assumes a basic understanding of React concepts and lifecycle.
For React documentation click here.

You can find a set of reusable components under jsx/ directory of your Loris installation. The list is continuously expanding, so watch out for updates.

1. StaticDataTable.js
2. DynamicDataTable.js
3. Form.js
   • FormElement
   • SelectElement
   • TextboxElement
   • TextareaElement
   • DateElement
   • NumericElement
   • FileElement
   • StaticElement
   • ButtonElement
   • LorisElement
4. FilterForm.js 🆕
5. Tabs.js 🆕
6. Panel.js 🆕
7. Breadcrumbs.js
8. PaginationLinks.js
9. Markdown.js
10. MultiSelectDropdown.js (Currently only used by DQT, ask Jordan for details)

Static Data Table displays a set of data that is receives via props.

API

Optional props are in [] brackets.

Usage

<StaticDataTable
    Headers={['ID', 'First Name', 'Last Name']}
    Data=[[1, 'Ted', 'Mosby'], [2, 'Barney', 'Stinson'], [3, 'Robin', 'Scherbatsky']]
    getFormattedCell={formatColumn}
    freezeColumn="ID"
/>

Note: formatColumn() is usually declared in a separate file, typically named columnFormatter.js

DynamicDataTable is a wrapper around StaticDataTable

Instead of raw Data and Headers, it expects a URL pointing to JSON data which it retrieves and passes down to StaticDataTable. All other properties are the same as in StaticDataTable as they are passed down to it.

Usage

<DynamicDataTable
  DataURL="https://loris.ca/media/?format=json",
  getFormattedCell={formatColumn},
  freezeColumn="File Name"
/>

Form.js contains a collection of components commonly used to built interactive forms.

FormElement is a React wrapper around HTML <form> element.

API

SelectElement is a react wrapper around HTML <select>.

API

TextboxElement is a react wrapper around HTML <input type="text">.

API

TextareaElement element is a react wrapper around HTML <textarea>.

API

DateElement is a react wrapper around HTML <input type="date">.

API

NumericElement is a react wrapper around HTML <input type="number">.

API

FileElement renders custom HTML used to upload files.

API

StaticElement is a react wrapper around HTML <label>.

API

ButtonElement is a react wrapper around HTML <button>.

API

Loris element is a generic component that receives a JSON representation of the element and renders an appropriate component from the list above. It infers the type of the element to be rendered from element.type property.

Usage

// The element will typically be received in the PHP LorisForm format, 
// but can also be defined as a Javascript object.

const el = {
  type: "select",
  // other props
}

<LorisElement
  element={element}          // JSON representation of a form element
  onUserInput={function(){}} // Optional callback function
  value={"123"}              // Optional props supported by the target element.
/>

Overview

FilterForm component renders a 'Selection Filter' panel with form elements, as seen in the screenshot below.

Main functionality

• Adds onUpdate callbacks to all children elements and passes them to FormElement for proper form rendering.
• Updates filter object values to correspond to formElement values and propagates changes to parent component on every update. (This is particularly useful to filter StaticDataTable by filter values).
• Updates browser query string using QueryString utility class in order to have persistent data in form fields across page updates

API

Usage

1. Passing form elements as a prop.
   • Particularly useful when converting existing Loris selection filters from PHP to React.
   • In the example below, this.state.Data.form contains JSON encoded value of $this->form->form returned from PHP backend.

// Renders a Selection Filter (as seen on the screenshot above)
// Form elements are passed to <FilterForm /> as a formElements prop.
<FilterForm
  Module="media"
  name="media_filter"
  id="media_filter"
  columns={3}
  formElements={this.state.Data.form}
  onUpdate={this.updateFilter}    // Update filter on FilterForm update
  filter={this.state.filter}	  // Keep track of filter in the parent class
>
  <br/>
  <ButtonElement type="reset" label="Clear Filters" />
</FilterForm>

2. Passing form elements as children of <FilterForm />

// Renders a Selection Filter 
// Form elements are passed as children element of the <FilterForm />
<FilterForm
  Module="dicom_archive"
  name="dicom_filter"
  id="dicom_filter"
  columns={2}
  onUpdate={this.updateFilter}  // Update filter on FilterForm update
  filter={this.state.filter}    // Keep track of filter in the parent class
>
  <TextboxElement
    name={patientName}
    label="Patient Name"
  />
  <SelectElement
    name={site}
    label="Sites"
    options={siteList}
  />
  <ButtonElement
    label="Clear Filters"
    type="reset"
  />
</FilterForm>

Tabs.js consist of two React components <Tabs/> and <TabPane/> that are used together to render a Bootstrap tab UI with dynamic content. The screenshot below demonstrates an example of React tabs as used in media module.

API

Tabs

TabPane

Usage

1. Define an array of tabs with unique IDs and labels

const tabList = [{id: "tab1", label: "This is tab title"}];`

2. Pass tabList as <Tab> prop and <TabPane> as a child

<Tabs tabs={tabList} defaultTab="tab1">
  
  <TabPane TabId={tabList[0].id}>
  // Tab content goes here
  </TabPane>
  
  // Add a <TabPane/> component per tab
  
</Tabs>

Note: when a large number of tabs is required, the creation of tab panes can be automated in a loop. See CandidateParameters for an example of such usage.

Wrapper around bootstrap panel. Can be used as a standalone component or nested inside a parent (example FilterForm)

API

Usage

<Panel id="log_panel" title="Log Viewer">
  // Children components shown inside the panel
</Panel>

Wrapper around bootstrap breadcrumbs used for uniquely navigation on Loris website. For usage see htdocs/main.tpl

Component used by StaticDataTable to add pagination to table results.

API

Usage

<PaginationLinks
  Total={100}
  RowsPerPage={20}
  Active={1}
  onChangePage={this.changePage} // Defined within parent
/>

Markdown component is used to render markdown text into HTML by way of JSX.

Only very basic markdown is supported. In particular:

1. Paragraphs can be delineated with an empty line.
2. **text** or __text__ will bold the text. *text* or _text_ will italicize it.
3. Up to six header levels can be supported by starting a paragraph with (up to 6) # characters.
4. Links can be added with [text](url)

This should be enough to write help documents in Markdown, even without the more complicated features that markdown should support.

API

Used uniquely by Data Query Tool.

• For generic <select/> and multiselect dropdown, use SelectElement from Form.js
• To investigate functionality of MultiSelectDropdown or any other questions contact the LORIS team

This page is deprecated.