https://github.com/recogito/recogito-js

A JavaScript library for text annotation
https://github.com/recogito/recogito-js

annotation annotation-tool text-annotation

Last synced: 3 months ago
JSON representation

A JavaScript library for text annotation

• Host: GitHub
• URL: https://github.com/recogito/recogito-js
• Owner: recogito
• License: bsd-3-clause
• Created: 2020-04-04T06:34:38.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-03-28T17:50:43.000Z (8 months ago)
• Last Synced: 2024-07-19T11:48:13.406Z (4 months ago)
• Topics: annotation, annotation-tool, text-annotation
• Language: JavaScript
• Homepage:
• Size: 2.77 MB
• Stars: 353
• Watchers: 12
• Forks: 38
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - recogito/recogito-js - A JavaScript library for text annotation (others)

README

        


  


  

  





A JavaScript library for text annotation. Use it to add annotation functionality to a web page, or as a toolbox 

for building your own, completely custom annotation apps. Try the [online demo](https://recogito.github.io/recogito-js/)

or see the [API reference](https://github.com/recogito/recogito-js/wiki/API-Reference).




![Screenshot](screenshot.png)




## Installing

If you use npm, `npm install @recogito/recogito-js` and 

```javascript

import { Recogito } from '@recogito/recogito-js';

import '@recogito/recogito-js/dist/recogito.min.css';

const r = new Recogito({ content: 'my-content' });

```

Otherwise download the [latest release](https://github.com/recogito/recogito-js/releases/latest) and

include it in your web page.

```html

```

## Using

```html

  
My text to annotate.

  

    (function() {

      var r = Recogito.init({

        content: document.getElementById('my-content') // ID or DOM element

      });


      // Add an event handler  

      r.on('createAnnotation', function(annotation) { /** **/ });

    })();

  

```

Full documentation is [on the Wiki](https://github.com/recogito/recogito-js/wiki). Questions? Feedack? Feature requests? Join the 

[RecogitoJS chat on Gitter](https://gitter.im/recogito/recogito-js).

[![Join the chat at https://gitter.im/recogito/recogito-js](https://badges.gitter.im/recogito/recogito-js.svg)](https://gitter.im/recogito/recogito-js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

## License

[BSD 3-Clause](LICENSE) (= feel free to use this code in whatever way

you wish. But keep the attribution/license file, and if this code

breaks something, don't complain to us :-)