@leonardssh/use-lanyard

🚀 Lanyard with Composition API for Vue

Usage no npm install needed!

<script type="module">
  import leonardsshUseLanyard from 'https://cdn.skypack.dev/@leonardssh/use-lanyard';
</script>

README

Logo

NPM version NPM downloads

Vue Use Lanyard

Use Lanyard API easily in your Vue app!

Report Bug · Request Feature · What Is Lanyard


Remember to 🌟 this Github if you 💖 it.


📦 Installation

  • Using yarn: yarn add @leonardssh/use-lanyard
  • Using npm: npm i @leonardssh/use-lanyard
  • Using pnpm: pnpm add @leonardssh/use-lanyard

🤓 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.