Annotorious 3: Vue/Angular/Solid/etc. integrations

[rsimon]

Important this issue is about Annotorious v3, which is currently a separate branch in this repository.

Annotorious is about to get a new major release. Annotorious 3 is a complete re-write, and will fix many of the issues that people had with the previous version. In particular, it will simplify integration with different JavaScript frameworks.

The @annotorious/annotorious package provides a vanilla JavaScript API. The goal is to offer additional packages which wrap the vanilla JS API and provide easy-to-use integrations with different frameworks.

So far, two such packages exists: @annotorious/react and @annotorious/svelte. At the moment, none of this is documented. One goal would be to write documentation: see related issues are here and here.

Another goal would be to build at least some first scaffolding for integrations with different frameworks like Angular, Vue, Solid etc. Ping me if you want to help out!

[Tholkappiar]

Hello Maintainers , can i work on this issue ? if yes , how can the users add text , is that functionality not avail yet ?

[rsimon]

Hi @Tholkappiar,

absolutely! BTW for Svelte bindings, I've a made a bit of progress myself over the past days. If you want to contribute there, feel free to fork:
https://github.com/annotorious/annotorious-v3/tree/main/packages/annotorious-svelte

If you want to work on another framework, then the Svelte code might perhaps provide some inspiration on how to wrap things in principle. (P.S.: a small real-world project that uses the Svelte bindings is here.)

Concerning adding text: Annotorious v3 will be "headless" by default. Which means it will be up to the developer to build their own comment popup. However, my goal is to provide a default popup (more or less identical to the original Annotorious popup) as an additional package. I haven't startet this yet, however. If you want to work on that: this would also be super useful!

[rsimon]

P.S.: I added an issue about a "default popup" module here: #297

[rsimon]

Sorry for the hassle: but I moved the active work branch for Annotorious here:
https://github.com/annotorious/annotorious/tree/3.x

The reason is that I always planned to merge this codebase here with the 'canonical' Annotorious repository, and archive/delete this repositry, since it's just temporary work in progress. I thought I might just as well make the jump now, before Hacktoberfest. This way, the history of your contributions will be recorded in the main repo.

[shyamal890]

Would love to see Angular package