Home

Awesome

<p align="center"> <img src="https://i.imgur.com/ngMRSPs.png" alt="Logo" /> </p> <p align="center"> <a href="https://www.npmjs.com/package/@leonardssh/use-lanyard"> <img src="https://img.shields.io/npm/v/@leonardssh/use-lanyard.svg?maxAge=3600&color=crimson&logo=npm" alt="NPM version" /> </a> <a href="https://www.npmjs.com/package/@leonardssh/use-lanyard"> <img src="https://img.shields.io/npm/dt/@leonardssh/use-lanyard.svg?maxAge=3600&logo=npm" alt="NPM downloads" /> </a> </p> <h3 align="center"><b>Vue Use Lanyard</b></h3> <p align="center"> Use Lanyard API easily in your Vue app! <br /> <br /> <a href="https://github.com/LeonardSSH/use-lanyard/issues">Report Bug</a> ยท <a href="https://github.com/LeonardSSH/use-lanyard/issues">Request Feature</a> ยท <a href="https://github.com/Phineas/lanyard">What Is Lanyard</a> </p> <br>

Remember to ๐ŸŒŸ this Github if you ๐Ÿ’– it.

<br>

๐Ÿ“ฆ Installation

๐Ÿค“ Usage

โœจ This plugin supports both REST and WebSocket methods.

Using without websocket:

import { useLanyard } from '@leonardssh/use-lanyard';

const { success, data, error } = await useLanyard({
	userId: 'USER_ID'
});

Using with websocket:

import { useLanyard, LanyardData } from '@leonardssh/use-lanyard';

await useLanyard({
	userId: 'USER_ID',
	socket: true,
	onPresenceUpdate(presence: LanyardData) {
		...
	}
});

๐ŸŽ‰ Thanks

๐Ÿ‘จโ€๐Ÿ’ป Contributing

To contribute to this repository, feel free to create a new fork of the repository and submit a pull request.

  1. Fork / Clone and select the main branch.
  2. Create a new branch in your fork.
  3. Make your changes.
  4. Commit your changes, and push them.
  5. Submit a Pull Request here!

๐Ÿ“‹ License

This project is licensed under the MIT License - see the LICENSE file for details.