Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/imRohan/tabbyjs

🐈 An easy-to-use js library to add tabby cats to your site. Simply include the js library and hit [Tab + b].
https://github.com/imRohan/tabbyjs

cats easter egg javascript

Last synced: 18 days ago
JSON representation

🐈 An easy-to-use js library to add tabby cats to your site. Simply include the js library and hit [Tab + b].

Host: GitHub
URL: https://github.com/imRohan/tabbyjs
Owner: imRohan
License: mit
Created: 2021-07-21T13:12:42.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2021-08-19T18:13:32.000Z (about 3 years ago)
Last Synced: 2024-09-18T09:38:04.323Z (about 2 months ago)
Topics: cats, easter, egg, javascript
Language: JavaScript
Homepage:
Size: 55.7 KB
Stars: 7
Watchers: 2
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

![demoGif](https://user-images.githubusercontent.com/3347296/130115149-37bfed5a-2ee9-4b4f-aa45-2f0cb643e1b9.gif)
## Tabby.js
[![](https://data.jsdelivr.com/v1/package/npm/tabby-dot-js/badge?style=rounded)](https://www.jsdelivr.com/package/npm/tabby-dot-js)

An easy-to-use js library to add tabby cats to your site. Simply include the js library and hit [Tab + b] to add some cats to any page!

[Live Demo](https://rohanlikhite.com/projects/tabby/)

## How to use Tabby.js

#### CDN

Tabby.js built files are available through [jsDelivr](https://www.jsdelivr.com/package/npm/tabby-dot-js?path=dist)

```
https://cdn.jsdelivr.net/npm/tabby-dot-js/dist/tabby.js
```

#### Browser

```html

Tabby.start()

```

You can also pass in an array of images if you'd like to override the defaults.

```html

Tabby.start([
"https://website.com/image1.png",
"https://website.com/image2.png",
"https://website.com/image3.png"
])

```

## Development

#### Clone the repo
`git clone https://github.com/imRohan/tabbyjs.git && cd tabbyjs`

#### Install Dependencies

`yarn`

#### Build using Rollup

`yarn run build` or `yarn run autobuild` (to watch for changes)

#### Open Example HTML page

Open `example/index.html` in the browser of your choice

## MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.