npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

vue-snacks

v1.0.1

Published

![Cover](https://github.com/KlaytonJr/vue-snacks/blob/main/src/assets/vue-snacks-cover.jpg?raw=true)

Downloads

10

Readme

Cover

Vue Snacks

Vue Snacks is a toast notification component for Vue.js 3, developed with TypeScript. It offers a simple and flexible way to display temporary "toast" style notifications in your application.

Installation

First, install the package via npm:

npm install vue-snacks

Configuration

In the main.ts file, import and register the Vue Snacks plugin in the main Vue instance:

import { createApp } from 'vue';
import App from './App.vue';
import VSnacks from 'vue-snacks/dist';

const app = createApp(App);
app.use(VSnacks);
app.mount('#app');

Usage

Inside a Vue component, you can display a notification by calling the $snack.notify method:

import { defineComponent, getCurrentInstance } from 'vue';

export default defineComponent({
  setup() {
    const { proxy } = getCurrentInstance() as any;

    const showNotification = () => {
      proxy.$snack.notify({
        position: 'top-center',
        type: 'success',
        duration: 3000,
        title: 'Success!',
        message: 'The operation was successfully completed.',
      });
    };

    return { showNotification };
  },
});

Customization

Vue Snacks provides a range of options to tailor notifications to your specific needs. You can adjust the following parameters:

  • position: Controls where the notification appears on the screen. Options include:

    • 'top-left': Top left corner
    • 'top-center': Top center of the screen
    • 'top-right': Top right corner
    • 'bottom-left': Bottom left corner
    • 'bottom-center': Bottom center of the screen
    • 'bottom-right': Bottom right corner
  • type: Defines the visual style of the notification to convey the appropriate message:

    • 'success': Green background, used for success messages
    • 'error': Red background, used for error messages
    • 'warning': Orange background, used for warnings
    • 'info': Blue background, used for informational messages
    • 'details': Gray background, for detailed or neutral information
  • duration: Sets the length of time (in milliseconds) the notification remains visible. For example, a value of 3000 keeps the notification displayed for 3 seconds before it fades out. If not set, the default duration is used.

  • title: The main headline of the notification. This is typically a brief, attention-grabbing phrase that conveys the core message.

  • message: The detailed text of the notification. This should provide additional context or information related to the title.

By fine-tuning these parameters, you can create a notification system that fits seamlessly with your application's design and user experience.

Color Documentation

| Type | Color | Description | |------------|------------|----------------------------| | success | Green (#4caf50) | Used for success messages to indicate a positive outcome. | | error | Red (#f44336) | Used for error messages to signal a problem or failure. | | warning | Yellow (#ff9800) | Used for warning messages to draw attention to potential issues. | | info | Blue (#2196f3) | Used for informational messages to provide general updates or notifications. | | details | Gray (#757575) | Used for neutral or detailed information that doesn't fall into the other categories. |

Contributing

Contributions are welcome! If you find a bug or have a suggestion, feel free to open an issue or submit a pull request.

License

MIT License. See the LICENSE file for more details.