Embedded components
Our embedded components allow you to use JBrowse in your application
@jbrowse/react-app
This component embodies the entire jbrowse-web application as a NPM installable react component
- @jbrowse/react-app jbrowse app component on NPM
- Storybook - docs for the app component
Here is a table of different usages of the @jbrowse/react-app using different
bundlers
| Bundler | Demo | Source code | Note |
|---|---|---|---|
| create-react-app v5 | demo | source code | for create-react-app v5, we use craco to update the webpack config to polyfill some node modules. This demo also uses webworkers, which is a unique ability with webpack 5. See https://jbrowse.org/storybook/app/main/ for details |
| next.js | demo | source code | uses next.js 13. Currently is hardcoded to use /demos/app-nextjs/ as sub-uri, update next.config.js to customize as needed |
| vite | demo | source code | |
| vanillajs | demo | source code |
@jbrowse/react-linear-genome-view
This NPM package consists of a single linear genome view that is usable as a React component
- @jbrowse/react-linear-genome-view linear genome view React component on NPM
- Storybook - docs for the linear genome view React component
Here is a table of different usages of the @jbrowse/react-linear-genome-view
using different bundlers
| Bundler | Demo | Source code | Note |
|---|---|---|---|
| create-react-app v4 | demo | source code | no polyfills needed in create-react-app v4. on newer versions of node, you can need to use export NODE_OPTIONS=--openssl-legacy-provider before building cra4 apps |
| create-react-app v5 | demo | source code | for create-react-app v5, we use craco to update the webpack config to polyfill some node modules. This demo also uses webworkers, which is a unique ability with webpack 5. See https://jbrowse.org/storybook/lgv/main/ for details |
| vite | demo | source code | for vite, we use rollup to polyfill some node polyfills similar to craco in create-react-app v5. |
| next.js | demo | source code | uses next.js 13. Currently is hardcoded to use /demos/lgv-nextjs/ as sub-uri, update next.config.js to customize as needed |
| vanilla js | demo | source code | uses a script tag to include a UMD bundle, and doesn't require any transpilation or bundling. see also dev tutorial here https://jbrowse.org/jb2/docs/tutorials/embed_linear_genome_view/01_introduction/ |
@jbrowse/react-circular-genome-view
This component consists of a single JBrowse 2 circular view.
- @jbrowse/react-circular-genome-view circular genome view React component on NPM
- Storybook - docs for the circular genome view React component
Here is a table of different usages of the @jbrowse/react-circular-genome-view
using different bundlers
| Syntax | Demo | Source code | Note |
|---|---|---|---|
| create-react-app v4 | demo | source code | no polyfills needed in create-react-app v4. on newer versions of node, you can need to use export NODE_OPTIONS=--openssl-legacy-provider before building cra4 apps |
| create-react-app v5 | demo | source code | for create-react-app v5, we use craco to update the webpack config to polyfill some node modules |
| vanilla js | demo | source code | uses a script tag to include a UMD bundle, and doesn't require any transpilation or bundling |
| nextjs | demo | source code | uses next.js |