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, defaultnull
): The authentication token for access to the installation atserverUrl
.viewType
(["HOME"
,"FULL_SIZE"
or"DETAILS"
]] - optional, default"FULL_SIZE"
): Which view to open on.searchType
(["PROASIS_ID"
,"TEXT"
or"LIGAND_ID"
] - optional, defaultnull
): Which search type to perform usingsearchText
.searchText
(String - optional, defaultnull
): What to search for.session
(String - optional, defaultnull
): Session id to load.onSelect
(Function - optional, defaultnull
): An event for a structure being selected. Receives one argument (the structure)onDeselect
(Function - optional, defaultnull
): An event for a structure being deselected. Receives one argument (the structure)interactionsVisible
(Boolean - optional, defaultfalse
): Whether to show interactions in the display.flexibilityVisible
(Boolean - optional, defaultfalse
): Whether to show flexibility in the display.
Search Example
ReactDOM
Session Example
ReactDOM
Development
Requirements
Setting Up Dev
yarn
Running Tests
yarn lintyarn test
Publishing a New Version
yarn publish
License
MIT