Skip to content

Commit

Permalink
Add note on embeddability
Browse files Browse the repository at this point in the history
  • Loading branch information
cmdcolin committed Dec 23, 2020
1 parent 8733aeb commit e1dff03
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions website/src/pages/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ view types
| Can connect to UCSC track hubs | :heavy_check_mark: [^1] | :x: |
| Can load plugins at run-time instead of build time | :heavy_check_mark: [^2] | :x: |
| Non-admin users can open tracks and share them with others | :heavy_check_mark: [^3] | :x: |
| Re-usable NPM package | :heavy_check_mark: [^3] | :x: |
| Name searching e.g. ability to type a gene name/ID to search for it | :x: | :heavy_check_mark: |
| URL query params API e.g. specifying ?loc=chr1:1-100 in URL bar | :x: | :heavy_check_mark: |

Expand All @@ -76,3 +77,21 @@ Here is a short list of current data format support
- Indexed FASTA/BGZip indexed FASTA
- 2bit
- .hic (Hi-C contact matrix visualization)

## Embeddability

JBrowse 1 has some notion of being embeddable in a `<div>` element, but it is
generally recommended to embed it in an `<iframe>` and the installation is not
very optimal from being installed via NPM

With JBrowse 2 we have some new concepts for embeddability. For example, we can
install just the linear-genome-view and use it as a react component.

The @jbrowse/react-linear-genome-view is specialized for certain use cases and
is not hooked up to session sharing, URL params, or anything but instead is a
simple React component

See here for more details https://www.npmjs.com/package/@jbrowse/react-linear-genome-view

Note that the entire jbrowse-web app that contains multiple views can't
currently be installed via NPM though

0 comments on commit e1dff03

Please sign in to comment.