Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new embeddable React Circular Genome View #2163

Merged
merged 4 commits into from
Aug 23, 2021
Merged

Add new embeddable React Circular Genome View #2163

merged 4 commits into from
Aug 23, 2021

Conversation

garrettjstevens
Copy link
Collaborator

This adds a React circular genome view component that is very similar to the React linear genome view component. It also includes a UMD build for plain-js embedding. See the README and example. Storybook is also included.

image

There is some duplication of components between this and the React LGV that could be factored out into a separate shared package.

@garrettjstevens garrettjstevens self-assigned this Jul 27, 2021
@github-actions github-actions bot added the needs label triage Needs a label to show in changelog (breaking, enhancement, bug, documentation, or internal) label Jul 27, 2021
@codecov
Copy link

codecov bot commented Jul 27, 2021

Codecov Report

Merging #2163 (65a591a) into main (7d4e500) will decrease coverage by 0.29%.
The diff coverage is 35.58%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2163      +/-   ##
==========================================
- Coverage   61.77%   61.48%   -0.30%     
==========================================
  Files         476      485       +9     
  Lines       22620    22901     +281     
  Branches     5303     5226      -77     
==========================================
+ Hits        13974    14080     +106     
- Misses       8365     8545     +180     
+ Partials      281      276       -5     
Impacted Files Coverage Δ
...owse-react-circular-genome-view/src/loadPlugins.ts 0.00% <0.00%> (ø)
...-genome-view/src/createModel/createSessionModel.ts 10.34% <10.34%> (ø)
...view/src/JBrowseCircularGenomeView/ModalWidget.tsx 33.33% <33.33%> (ø)
...ew/src/JBrowseCircularGenomeView/ViewContainer.tsx 54.54% <54.54%> (ø)
...r-genome-view/src/createModel/createConfigModel.ts 55.55% <55.55%> (ø)
...ircular-genome-view/src/createModel/createModel.ts 59.25% <59.25%> (ø)
...cular-view/src/CircularView/models/CircularView.ts 72.13% <88.88%> (+1.44%) ⬆️
...-react-circular-genome-view/src/createViewState.ts 90.47% <90.47%> (ø)
...seCircularGenomeView/JBrowseCircularGenomeView.tsx 92.30% <92.30%> (ø)
...owse-react-circular-genome-view/src/corePlugins.ts 100.00% <100.00%> (ø)
... and 20 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7d4e500...65a591a. Read the comment docs.

@rbuels rbuels added enhancement New feature or request and removed needs label triage Needs a label to show in changelog (breaking, enhancement, bug, documentation, or internal) labels Jul 30, 2021
@rbuels rbuels changed the title Add React Circular Genome View Add new embeddable React Circular Genome View Jul 30, 2021
@garrettjstevens garrettjstevens marked this pull request as ready for review August 20, 2021 15:38
@cmdcolin
Copy link
Collaborator

Should it be called just jbrowse-react-circular-view?

@cmdcolin
Copy link
Collaborator

Is the storybook online anywhere to look at yet?

@garrettjstevens
Copy link
Collaborator Author

Should it be called just jbrowse-react-circular-view?

I was going for parallel naming to jbrowse-react-linear-genome-view

Is the storybook online anywhere to look at yet?

No, could possible add to push.yml, but for now it's not.

@cmdcolin
Copy link
Collaborator

I would be consistent with our current naming scheme, so I would say CircularView -> jbrowse-react-circular-view

@garrettjstevens
Copy link
Collaborator Author

I'd prefer the package name be @jbrowse/react-circular-genome-view since I prefer creating a consistent naming scheme for users of our React components to remember, even if it doesn't match some of our internal naming.

@rbuels
Copy link
Contributor

rbuels commented Aug 23, 2021

While it’s nice to keep it consistent with our internal naming, the external naming is more visible to users so keeping that consistent is probably a little more important. I’d vote for react-circular-genome-view

@rbuels rbuels merged commit 190c903 into main Aug 23, 2021
@rbuels rbuels deleted the react_cgv branch August 23, 2021 19:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants