Have ideas to improve npm?Join in the discussion! »

    @jbrowse/react-linear-genome-view
    TypeScript icon, indicating that this package has built-in type declarations

    1.3.0 • Public • Published

    @jbrowse/react-linear-genome-view

    JBrowse 2 linear genome view React component

    JBrowse 2 is a pluggable open-source platform for visualizing, integrating, and sharing biological data. This component consists of a single JBrowse 2 linear view.

    Usage

    import React from 'react'
    import 'fontsource-roboto'
    import {
      createViewState,
      createJBrowseTheme,
      JBrowseLinearGenomeView,
      ThemeProvider,
    } from '@jbrowse/react-linear-genome-view'
    
    const theme = createJBrowseTheme()
    
    function View() {
      const state = createViewState({
        assembly: {
          /* assembly */
        },
        tracks: [
          /* tracks */
        ],
      })
      return (
        <ThemeProvider theme={theme}>
          <JBrowseLinearGenomeView viewState={state} />
        </ThemeProvider>
      )
    }

    For a full working example, see this example.

    Install

    With yarn:

    $ yarn add @jbrowse/react-linear-genome-view
    

    Or with npm:

    $ npm install @jbrowse/react-linear-genome-view
    

    Documentation

    The latest Storybook documentation for the component is hosted here.

    Note on fonts

    Roboto is the recommended font for JBrowse, and this component will use that font if it is available. The easiest way to add it is to add the fontsource-roboto package to your project and import it in your root index.js.

    Academic Use

    This package was written with funding from the NHGRI as part of the JBrowse project. If you use it in an academic project that you publish, please cite the most recent JBrowse paper, which will be linked from jbrowse.org.

    License

    MIT

    Install

    npm i @jbrowse/react-linear-genome-view

    DownloadsWeekly Downloads

    207

    Version

    1.3.0

    License

    MIT

    Unpacked Size

    718 kB

    Total Files

    41

    Homepage

    jbrowse.org

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar