https://github.com/commitd/annotation-viewer

UI components for viewing annotated text
https://github.com/commitd/annotation-viewer

Last synced: 5 months ago
JSON representation

UI components for viewing annotated text

• Host: GitHub
• URL: https://github.com/commitd/annotation-viewer
• Owner: commitd
• License: mit
• Created: 2019-09-02T11:07:17.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2023-02-04T03:35:08.000Z (over 3 years ago)
• Last Synced: 2025-08-08T14:50:12.008Z (11 months ago)
• Language: TypeScript
• Homepage: annotations.committed.software
• Size: 12.6 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# @committed/annotation-viewer

> Annotation Viewer

[![Committed Badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fcommitted.io%2Fbadge)](https://committed.io)

[![Storybook](https://cdn.jsdelivr.net/gh/storybookjs/brand@master/badge/badge-storybook.svg)](https://committed.software/annotation-viewer)

![](images/example.png)

## Install

```bash

yarn add @committed/annotation-viewer

```

## Usage

```tsx

import React from 'react'

import { AnnotationViewer } from '@committed/annotation-viewer'

class Example extends React.Component {

  render() {

    return (

      

    )

  }

}

```

> NB The committed component `ThemeProvider` must be in the react component stack. (Future versions may remove these pees dependencies.)

Further examples of use and configuration options can be seen in the [storybook](https://committed.software/annotation-viewer).

## Development

The main build is currently performed using Rollup and `yarn build`.

We use storybook to develop and document the components, this is run in development using

```bash

yarn storybook

```

and to create a production version

```bash

yarn build-storybook

```

## Example

To run the example:

```bash

yarn

yarn build

cd example

yarn

yarn start

```

## License

[MIT](/LICENSE) - © Committed Software 2021 https://committed.io