Skip to content

Commit

Permalink
docs(components): mention how to install and use the components in th…
Browse files Browse the repository at this point in the history
…e Storybook introduction
  • Loading branch information
fengelniederhammer committed Oct 21, 2024
1 parent 3a98258 commit 1796fe7
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions components/src/web-components/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,21 @@ import { Meta } from '@storybook/blocks';

# Introduction

<a
style={{ display: 'flex', 'align-items': 'center', 'justify-content': 'right' }}
href='https://github.com/GenSpectrum/dashboard-components'
>
<svg style={{ width: '3%', height: '3%' }} viewBox='0 0 98 96' xmlns='http://www.w3.org/2000/svg'>
<path
fill-rule='evenodd'
clip-rule='evenodd'
d='M48.854 0C21.839 0 0 22 0 49.217c0 21.756 13.993 40.172 33.405 46.69 2.427.49 3.316-1.059 3.316-2.362 0-1.141-.08-5.052-.08-9.127-13.59 2.934-16.42-5.867-16.42-5.867-2.184-5.704-5.42-7.17-5.42-7.17-4.448-3.015.324-3.015.324-3.015 4.934.326 7.523 5.052 7.523 5.052 4.367 7.496 11.404 5.378 14.235 4.074.404-3.178 1.699-5.378 3.074-6.6-10.839-1.141-22.243-5.378-22.243-24.283 0-5.378 1.94-9.778 5.014-13.2-.485-1.222-2.184-6.275.486-13.038 0 0 4.125-1.304 13.426 5.052a46.97 46.97 0 0 1 12.214-1.63c4.125 0 8.33.571 12.213 1.63 9.302-6.356 13.427-5.052 13.427-5.052 2.67 6.763.97 11.816.485 13.038 3.155 3.422 5.015 7.822 5.015 13.2 0 18.905-11.404 23.06-22.324 24.283 1.78 1.548 3.316 4.481 3.316 9.126 0 6.6-.08 11.897-.08 13.526 0 1.304.89 2.853 3.316 2.364 19.412-6.52 33.405-24.935 33.405-46.691C97.707 22 75.788 0 48.854 0z'
fill='#24292f'
/>
</svg>
<span style={{ 'margin-left': '4px' }}>Visit on GitHub</span>
</a>

This package provides a collection of web components to build interactive dashboards that visualize
data of a specific instance of [LAPIS](https://github.com/GenSpectrum/LAPIS).

Expand All @@ -13,3 +28,34 @@ We primarily provide two kinds of components:
Those components fetch data from the LAPIS instance and visualize it.
- Input components that let you specify sequence filters for the LAPIS requests.
Input changes will fire events that can be listened to by the visualization components. It is the responsibility of the dashbaord maintainer to listen to those events and to wire the data correctly into the visualization components.

## Installation

```bash
npm i @genspectrum/dashboard-components
```

## Usage

All components must be children of a `gs-app` element.

```html
<gs-app lapis="https://url.to.lapis">
<gs-location-filter
fields='["region", "country"]'
initialValue="Europe / Switzerland"
width="100%"
placeholderText="Enter a location"
></gs-location-filter>
<gs-aggregate
fields='["division", "host"]'
filter='{"country": "USA"}'
views='["table"]'
width="100%"
height="700px"
initialSortField="count"
initialSortDirection="descending"
pageSize="10"
></gs-aggregate>
</gs-app>
```

0 comments on commit 1796fe7

Please sign in to comment.