https://github.com/OswaldLabsOpenSource/agastya

♿ Oswald Labs' web accessibility plugin
https://github.com/OswaldLabsOpenSource/agastya

a11y accessibility javascript library plugin web-accessibility widget

Last synced: 4 months ago
JSON representation

♿ Oswald Labs' web accessibility plugin

• Host: GitHub
• URL: https://github.com/OswaldLabsOpenSource/agastya
• Owner: OswaldLabsOpenSource
• License: mit
• Created: 2018-12-21T21:50:41.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T01:40:26.000Z (about 2 years ago)
• Last Synced: 2024-07-30T21:02:20.433Z (6 months ago)
• Topics: a11y, accessibility, javascript, library, plugin, web-accessibility, widget
• Language: TypeScript
• Homepage: https://oswaldlabs.com/platform/agastya/?utm_source=github&utm_medium=repository&utm_campaign=agastya&utm_term=description-link
• Size: 3.58 MB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ♿ Agastya

![Travis CI](https://travis-ci.org/OswaldLabsOpenSource/agastya.svg?branch=master)

![Dependencies](https://img.shields.io/david/OswaldLabsOpenSource/agastya.svg)

![Dev dependencies](https://img.shields.io/david/dev/OswaldLabsOpenSource/agastya.svg)

[![License](https://img.shields.io/github/license/OswaldLabsOpenSource/agastya.svg)](https://github.com/OswaldLabsOpenSource/agastya/blob/master/LICENSE)

![Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/OswaldLabsOpenSource/agastya.svg)

![Bundle size](https://img.shields.io/bundlephobia/minzip/agastya.svg)

## 📦 Get Started

```bash

yarn add agastya

```

```js

// Import or require Agastya

import Agastya from "agastya";

// Initialize Agastya with your API key

const agastya = new Agastya("API_KEY");

```

Optionally, you can use a specific channel:

```js

const agastya = new Agastya("API_KEY", "production"); // Production (default)

const agastya = new Agastya("API_KEY", "beta"); // Beta (stable)

const agastya = new Agastya("API_KEY", "dev"); // Nighly/development (breaking changes)

```

You can also use the official CDN instead:

```html

```

Once you've created the Agastya object, you can start using the API:

```js

agastya.open(); // Open the Agastya widget

agastya.api("enableMode", "read-aloud"); // Start read aloud mode

agastya.secureTrack({ hello: "world" }); // Track a custom event

```

## [API Documentation](https://help.oswaldlabs.com/developers/)

- [Getting started](https://help.oswaldlabs.com/developers/)

- [Installation](https://help.oswaldlabs.com/developers/installation.html)

- [API basics](https://help.oswaldlabs.com/developers/api.html)

- [Widget manipulation](https://help.oswaldlabs.com/developers/widget.html)

- [Listening for events](https://help.oswaldlabs.com/developers/events.html)

- [Tracking and data](https://help.oswaldlabs.com/developers/tracking.html)

- [Apps and modes](https://help.oswaldlabs.com/developers/modes.html)

- [Integrations](https://help.oswaldlabs.com/developers/integrations.html)

- [Embeds](https://help.oswaldlabs.com/developers/embeds.html)