https://github.com/curtiscde/tab-notifier

📫 JS Library for managing your browser title notifications
https://github.com/curtiscde/tab-notifier

document-title js-library

Last synced: about 1 month ago
JSON representation

📫 JS Library for managing your browser title notifications

• Host: GitHub
• URL: https://github.com/curtiscde/tab-notifier
• Owner: curtiscde
• Created: 2019-06-27T06:30:16.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-19T09:32:45.000Z (almost 2 years ago)
• Last Synced: 2024-11-06T17:53:27.522Z (about 2 months ago)
• Topics: document-title, js-library
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/tab-notifier
• Size: 1.32 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Tab Notifier

  [![Coverage Status](https://coveralls.io/repos/github/curtistimson/tab-notifier/badge.svg?branch=ci)](https://coveralls.io/github/curtistimson/tab-notifier?branch=ci)

## Usage

```

import TabNotifier from 'tab-notifier';

```

### `notify()`

Prefixes the document title with a number

```

TabNotifier.notify(); // prefixes title with (1)

TabNotifier.notify(1); // prefixes title with (1)

TabNotifier.notify(2); // prefixes title with (2)

```

### `notifyMessage()`

Updates the document title to a specific message and alternates every 1 second by default

```

TabNotifier.notifyMessage('New Message Received!');

```

Options:

```

TabNotifier.notifyMessage('New Message Received!', {

  intervalSpeed: 1000

});

```

### `reset()`

Resets the title back to the original document title

```

TabNotifier.reset();

```

## Development

```

npm start

```

## Build

```

npm run build

```