tapspace/README.md

A zoomable user interface lib for web apps

# ![tapspace.js](docs/tapspace-banner-2022.png?raw=true)

[![NPM Version](https://img.shields.io/npm/v/tapspace/alpha?color=7FCD0F)](https://www.npmjs.com/package/tapspace)
[![Build Status](https://img.shields.io/travis/com/taataa/tapspace)](https://travis-ci.com/github/taataa/tapspace)

We believe **zoomable user interfaces** to be the best way for humans to explore and manipulate two-dimensional content. Therefore we built **Tapspace.js**, a **JavaScript** library dedicated for building such **dynamic front-ends**. It provides an **infinite, scalable, and rotatable space** for you to represent **HTML content** and for your users to play with. Tapspace.js uses **pure CSS3 and DOM** instead of Canvas or WebGL and therefore is able to handle any HTML content you throw at it, including iframes and SVG, and also Canvas- and WebGL-rendered elements. And of course, we provide a clean, documented API for you to **build your best**.

## Install

With [npm](https://www.npmjs.com/package/tapspace) or [yarn](https://yarnpkg.com/en/package/tapspace):

    $ npm install tapspace@alpha
    $ yarn add tapspace@alpha

This installs an alpha version of Tapspace.js 2.x. For the earlier and stable Tapspace.js 1.x, see [1.6-stable](https://github.com/taataa/tapspace/tree/1.6-stable) branch.

## Documentation

See [taataa.github.io/tapspace](http://taataa.github.io/tapspace) for:
- [Tutorial](http://taataa.github.io/tapspace/tutorial)
- [Features](http://taataa.github.io/tapspace#features)
- [Example applications](http://taataa.github.io/tapspace#examples)
- [API Reference](https://taataa.github.io/tapspace/api/v2/)
- [Developer's Cheat Sheet](http://taataa.github.io/tapspace/dev)

## Supporters

We have developed Tapspace.js in collaboration with the following organizations.

<a href="https://lincsproject.ca/" target="_blank"><img src="docs/collaborators/lincs_logo.png" alt="Linked Infrastructure for Networked Cultural Scholarship" style="width: 45%;"></a>
<a href="https://www.uoguelph.ca/" target="_blank"><img src="docs/collaborators/university_of_guelph_logo.png" alt="University of Guelph" style="width: 45%;"></a>
<a href="https://codhr.dh.tamu.edu/" target="_blank"><img src="docs/collaborators/CoDHR_logo.png" alt="Center of Digital Humanities Research" style="width: 45%;"></a>
<a href="https://www.tamu.edu/" target="_blank"><img src="docs/collaborators/texas_am_university_logo.png" alt="Texas A+M University" style="width: 45%;"></a>
<a href="https://www.tuni.fi/en" target="_blank"><img src="docs/collaborators/tampere_university_logo.png" alt="Tampere University" style="width: 45%;"></a>

## Contribute

Pull requests and [bug reports](https://github.com/taataa/tapspace/issues) are highly appreciated. Please test your contribution with the following scripts:

Run test suite:

    $ npm run test

Run only linter:

    $ npm run lint

See [testing docs](https://taataa.github.io/tapspace/dev/#testing) for details.

## License

[MIT](LICENSE)