Coder Social home page Coder Social logo

plugin-notifications's Introduction

Athena Notification Plugin

Athena Notification Plugin is a plugin for the Athena framework that allows you to display notifications in your application.

Usage

Adding a Notification

You can add a notification by calling the addNotification method provided by the plugin. Here's an example of how to use it:

Serverside

const Notify = await Athena.systems.plugins.useAPI('notification-api');
Notify.addNotification(player, {
    icon: '๐Ÿค‘',
    title: 'Open Source Shopg',
    message: `You've successfully bought x${items} for ${totalPrice}$!`,
    duration: 5000,
});

Clientside

  • Will Follow

Params

  • icon: The emoji to display in the notification.
  • title: The title of the notification.
  • message: The notification message.
  • duration: The duration in milliseconds for how long the notification should be displayed.

License

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

Getting Started

To get started with the Athena Notification Plugin, you can clone it from the source code.

  1. Clone the repository:
git clone https://github.com/Booster1212/plugin-notifications.git

Acknowledgments

  • This project was inspired by the need for a simple and customizable notification system in Athena applications.

Authors

Support

For support, bug reports, or feature requests, please create an issue here on GitHub.

Release History

  • 1.0.0
    • Initial release

Changelog

See the CHANGELOG.md file for details about changes between versions.

plugin-notifications's People

Contributors

booster1212 avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Forkers

jenex85

plugin-notifications's Issues

Plugin's css classes won't working

When I'm trying to put the plugin in, the notification styles are disappear. I see in the code there are uses of classes flex items-center w-full etc. I understand that under the hood tailwindcss is used, which is not loaded with the plugin. Please, fix.

image

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.