React Proasis

A React component which embeds a Proasis Application. For more information see the DesertSci - Proasis Website.

Installation

React Proasis requires React 15.0.0 or later.

npm install --save react-proasis 

Documentation

Props

• serverUrl (String - required): The url pointing to your Proasis app. If you're unsure then ask DesertSci.
• token (String - optional, default null): The authentication token for access to the installation at serverUrl.
• viewType (["HOME", "FULL_SIZE" or "DETAILS"]] - optional, default "FULL_SIZE"): Which view to open on.
• searchType (["PROASIS_ID", "TEXT" or "LIGAND_ID"] - optional, default null): Which search type to perform using searchText.
• searchText (String - optional, default null): What to search for.
• session (String - optional, default null): Session id to load.
• onSelect (Function - optional, default null): An event for a structure being selected. Receives one argument (the structure)
• onDeselect (Function - optional, default null): An event for a structure being deselected. Receives one argument (the structure)
• interactionsVisible (Boolean - optional, default false): Whether to show interactions in the display.
• flexibilityVisible (Boolean - optional, default false): Whether to show flexibility in the display.

Search Example

import React from 'react'
import ReactDOM from 'react-dom'
import Proasis from 'react-proasis'

ReactDOM.render(
  <Proasis 
      serverUrl="http://myproasisserver.com/proasis"
      token="letmein"
      viewType="FULL_SIZE"
      searchType="PROASIS_ID"
      searchText="1nnc"
      onSelect={(structure) => console.log('Selected', structure)}
      onDeselect={(structure) => console.log('Deselected', structure)}
  />,
  document.getElementById('main')
)

Session Example

import React from 'react'
import ReactDOM from 'react-dom'
import Proasis from 'react-proasis'

ReactDOM.render(
  <Proasis 
      serverUrl="http://myproasisserver.com/proasis"
      token="letmein"
      viewType="FULL_SIZE"
      session="P4_20200817_023227"
  />,
  document.getElementById('main')
)

Development

Requirements

• NodeJS (Tested with 9.8.0)
• Yarn (Tested with 1.5.1)

Setting Up Dev

yarn

Running Tests

yarn lint
yarn test

Publishing a New Version

yarn publish

License

MIT