Skip to content

Commit

Permalink
feat: rename to react-api
Browse files Browse the repository at this point in the history
  • Loading branch information
etowahadams committed Jun 7, 2024
1 parent 6d3ad22 commit b33139c
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ How is the Gosling grammar used in practice? A Gosling visualization is defined

<img src='/img/spec-vis.png'/>

## Javascript API
## React Component API

**Gosling.js** takes the Gosling specification as an input and creates the visualization defined by it. You can programmatically interact with this visualization using **Javascript API functions**.
**Gosling.js** takes the Gosling specification as an input and creates the visualization defined by it. You can programmatically interact with this visualization using the [React component API](react-api).

For example, you can use an API function to make the visualization zoom to a particular genomic position, or you can subscribe to click events in the visualization. This is useful to building your own interactive visualizations with Gosling!
2 changes: 1 addition & 1 deletion docs/js-api.md → docs/react-api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: JavaScript API
title: React Component API
---

## GoslingComponent
Expand Down
4 changes: 2 additions & 2 deletions sidebarDocs.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ module.exports = {
},
{
type: 'doc',
label: 'JavaScript API',
id: 'js-api',
label: 'React Component API',
id: 'react-api',
},
{
type: 'doc',
Expand Down

0 comments on commit b33139c

Please sign in to comment.