Package Health Score

75 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
2.1.0	\|	12/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.0.2	\|	07/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.2.6	\|	06/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.1	\|	05/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (4,056)

GitHub Stars: 278
Forks: 28
Contributors: 20

Direct Usage Popularity

The npm package notiwind receives a total of 4,056 downloads a week. As such, we scored notiwind popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package notiwind, we found that it has been starred 278 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the notiwind repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like notiwind is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 12 days ago
Last Commit: 12 days ago

Further analysis of the maintenance status of notiwind based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that notiwind demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 4 years
Dependencies: 1 Direct
Versions: 14
Install Size: 37.1 kB
Dist-tags: 1
# of Files: 16
Maintainers: 1
TS Typings: No

notiwind has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Notiwind

A headless Vue 3 notification library to use with Tailwind CSS. This is a fork and port of vue3-vt-notifications created and modified by killmenot to support Vue 3. Initially created by sansil.

🌟 Features

100% Customizable
Composition API support
Create different groups of notifications
Permanent and stay on hover options

🤖 Demo

Live Preview

⚡️ Installation

pnpm add notiwind

npm i notiwind

You can then register Notifications as a Vue plugin:

import { createApp } from 'vue'
import Notifications from 'notiwind'
import App from './App.vue'

createApp(App).use(Notifications).mount('#app')

🍞 How to use

Add the notification components to your main layout or in App.vue:


  
  ...
  
    
    ...

Then, trigger notifications from your .vue files:

Options API

this.$notify(
  {
    group: 'foo',
    title: 'Success',
    text: 'Your account was registered!',
  },
  2000,
) // 2s

Composition API

import { notify } from 'notiwind'

notify(
  {
    group: 'foo',
    title: 'Success',
    text: 'Your account was registered!',
  },
  4000,
) // 4s

Basic example

For example in your App.vue


  <div class="fixed inset-0 flex items-start justify-end p-6 px-4 py-6 pointer-events-none">
    <div class="w-full max-w-sm">
      
        <div class="flex w-full max-w-sm mx-auto mt-4 overflow-hidden bg-white rounded-lg shadow-md">
          <div class="flex items-center justify-center w-12 bg-green-500">
            <svg xmlns="https://www.w3.org/2000/svg" viewBox="0 0 40 40" class="w-6 h-6 text-white fill-current">
              <path d="M20 3.33331C10.8 3.33331 3.33337 10.8 3.33337 20C3.33337 29.2 10.8 36.6666 20 36.6666C29.2 36.6666 36.6667 29.2 36.6667 20C36.6667 10.8 29.2 3.33331 20 3.33331ZM16.6667 28.3333L8.33337 20L10.6834 17.65L16.6667 23.6166L29.3167 10.9666L31.6667 13.3333L16.6667 28.3333Z"></path>
            </svg>
          </div>

          <div class="px-4 py-2 -mx-3">
            <div class="mx-3">
              <span class="font-semibold text-green-500">{{ notification.title }}</span>
              <p class="text-sm text-gray-600">{{ notification.text }}</p>
            </div>
          </div>
        </div>
      
    </div>
  </div>

Then in any of your .vue files:

this.$notify(
  {
    group: 'foo',
    title: 'Success',
    text: 'Your account was registered!',
  },
  2000,
) // 2s

The first argument is an object containing the data for the Notification element, it's important to specify the group where the notificatoins are going to be displayed, the second argument is the timeout. The default timeout is 3 seconds.

If you need to keep the notification on the screen forever use -1 as a timeout:

this.$notify(
  {
    group: 'foo',
    title: 'Success',
    text: 'Your account was registered!',
  },
  -1,
) // it's not going to disappear automatically

Example with differents groups

You can use the NotificationGroup component to have different types of notifications. For example, notifications error messages in top center and generic app notifications in bottom-right corner.


  <div class="fixed inset-0 flex items-start justify-end p-6 px-4 py-6 pointer-events-none">
    <div class="w-full max-w-sm">
      
        <div class="flex w-full max-w-sm mx-auto mt-4 overflow-hidden bg-white rounded-lg shadow-md">
        <div class="flex items-center justify-center w-12 bg-red-500">
          <svg xmlns="https://www.w3.org/2000/svg" viewBox="0 0 40 40" class="w-6 h-6 text-white fill-current">
            <path d="M20 3.36667C10.8167 3.36667 3.3667 10.8167 3.3667 20C3.3667 29.1833 10.8167 36.6333 20 36.6333C29.1834 36.6333 36.6334 29.1833 36.6334 20C36.6334 10.8167 29.1834 3.36667 20 3.36667ZM19.1334 33.3333V22.9H13.3334L21.6667 6.66667V17.1H27.25L19.1334 33.3333Z"></path>
          </svg>
        </div>

        <div class="px-4 py-2 -mx-3">
          <div class="mx-3">
            <span class="font-semibold text-red-500">{{ notification.title }}</span>
            <p class="text-sm text-gray-600">{{ notification.text }}</p>
          </div>
        </div>
        </div>
      
    </div>
  </div>



  <div class="fixed inset-0 flex items-start justify-end p-6 px-4 py-6 pointer-events-none">
    <div class="w-full max-w-sm">
      
        <div class="flex w-full max-w-sm mx-auto mt-4 overflow-hidden bg-white rounded-lg shadow-md">
          <div class="flex items-center justify-center w-12 bg-blue-500">
            <svg xmlns="https://www.w3.org/2000/svg" viewBox="0 0 40 40" class="w-6 h-6 text-white fill-current">
              <path d="M20 3.33331C10.8 3.33331 3.33337 10.8 3.33337 20C3.33337 29.2 10.8 36.6666 20 36.6666C29.2 36.6666 36.6667 29.2 36.6667 20C36.6667 10.8 29.2 3.33331 20 3.33331ZM21.6667 28.3333H18.3334V25H21.6667V28.3333ZM21.6667 21.6666H18.3334V11.6666H21.6667V21.6666Z"></path>
            </svg>
          </div>

          <div class="px-4 py-2 -mx-3">
            <div class="mx-3">
              <span class="font-semibold text-blue-500">{{ notification.title }}Info</span>
              <p class="text-sm text-gray-600">{{ notification.text }}</p>
            </div>
          </div>
        </div>
      
    </div>
  </div>

Then in any of your .vue files:

// Error notification
this.$notify(
  {
    group: 'error',
    title: 'Error',
    text: 'Your email is already used!',
  },
  4000,
)

// Generic notification
this.$notify(
  {
    group: 'generic',
    title: 'Info',
    text: 'This channel archived by the owner',
  },
  4000,
)

Using different types of notifications

You can render different types of notifications in the same group using a conditional, for example v-if="notification.type === 'info'"


  <div class="fixed inset-0 flex items-start justify-end p-6 px-4 py-6 pointer-events-none">
    <div class="w-full max-w-sm">
      
        <div>
          <div class="flex w-full max-w-sm mx-auto mt-4 overflow-hidden bg-white rounded-lg shadow-md">
            <div class="flex items-center justify-center w-12 bg-blue-500">
              <svg xmlns="https://www.w3.org/2000/svg" viewBox="0 0 40 40" class="w-6 h-6 text-white fill-current">
                <path d="M20 3.33331C10.8 3.33331 3.33337 10.8 3.33337 20C3.33337 29.2 10.8 36.6666 20 36.6666C29.2 36.6666 36.6667 29.2 36.6667 20C36.6667 10.8 29.2 3.33331 20 3.33331ZM21.6667 28.3333H18.3334V25H21.6667V28.3333ZM21.6667 21.6666H18.3334V11.6666H21.6667V21.6666Z"></path>
              </svg>
            </div>

            <div class="px-4 py-2 -mx-3">
              <div class="mx-3">
                <span class="font-semibold text-blue-500">{{ notification.title }}</span>
                <p class="text-sm text-gray-600">{{ notification.text }}</p>
              </div>
            </div>
          </div>

          <div class="flex w-full max-w-sm mx-auto mt-4 overflow-hidden bg-white rounded-lg shadow-md">
            <div class="flex items-center justify-center w-12 bg-yellow-500">
              <svg xmlns="https://www.w3.org/2000/svg" viewBox="0 0 40 40" class="w-6 h-6 text-white fill-current">
                <path d="M20 3.33331C10.8 3.33331 3.33337 10.8 3.33337 20C3.33337 29.2 10.8 36.6666 20 36.6666C29.2 36.6666 36.6667 29.2 36.6667 20C36.6667 10.8 29.2 3.33331 20 3.33331ZM21.6667 28.3333H18.3334V25H21.6667V28.3333ZM21.6667 21.6666H18.3334V11.6666H21.6667V21.6666Z"></path>
              </svg>
            </div>

            <div class="px-4 py-2 -mx-3">
              <div class="mx-3">
                <span class="font-semibold text-yellow-500">{{ notification.title }}</span>
                <p class="text-sm text-gray-600">{{ notification.text }}</p>
              </div>
            </div>
          </div>
        </div>
      
    </div>
  </div>

Then in any of your .vue files:

// Error notification
this.$notify(
  {
    title: 'Info',
    text: 'This channel archived by the owner!',
    type: 'info',
    group: 'foo',
  },
  4000,
)

// Generic notification
this.$notify(
  {
    title: 'Warning',
    text: 'Your image size is too large!',
    type: 'warning',
    group: 'foo',
  },
  4000,
)

Props

Props for the `Notification` component, all are optional.

Name	Type	Default	Description
maxNotifications	Number	10	Maximum notifications displayed simultaneously
enter	String	""	enter-active-class transition classes. Applied during the entire entering phase.
enterFrom	String	""	enter-from-class transition classes. Starting state for enter.
enterTo	String	""	enter-to-class transition classes. Ending state for enter.
leave	String	""	leave-active-class transition classes. Applied during the entire leaving phase.
leaveFrom	String	""	leave-from-class transition classes. Starting state for leave.
leaveTo	String	""	leave-to-class transition classes. Ending state for leave.
move	String	""	move-class transition classes. Added when items are changing positions.
moveDelay	String	""	Delay between the position change. `delay-300` recommended value.

Check the Vue docs to know more about Enter & Leave Transitions and List Move Transitions.

Props for `NotificationGroup` component, all are optional.

Name	Type	Description
position	String	"bottom" or "top" are the posible values.
group	String	Name of the group of notifications.

Defualt scoped slots

Scope props:

Name	Type	Description
notifications	Array	Array of notification objects.
close	Function	Closes the notification. Expects the notification ID as parameter
hovering	Function	Prevents notification from closing if being hovered. Expected the notification ID, the hover value (true or false) and optionally, a timeout to be used in the mouse leave (hover ended).

Example


  <div role="alert" class="relative px-4 py-3 mt-4 text-red-700 bg-red-100 border border-red-400 rounded">
    <strong class="font-bold">Holy smokes!</strong>
    <span class="block sm:inline">Something seriously bad happened.</span>

    <button class="absolute top-0 bottom-0 right-0 px-4 py-3">
      <svg viewBox="0 0 20 20" xmlns="https://www.w3.org/2000/svg" role="button" class="w-6 h-6 text-red-500 fill-current">
        <title>Close</title>
        <path d="M14.348 14.849a1.2 1.2 0 0 1-1.697 0L10 11.819l-2.651 3.029a1.2 1.2 0 1 1-1.697-1.697l2.758-3.15-2.759-3.152a1.2 1.2 0 1 1 1.697-1.697L10 8.183l2.651-3.031a1.2 1.2 0 1 1 1.697 1.697l-2.758 3.152 2.758 3.15a1.2 1.2 0 0 1 0 1.698z"></path>
      </svg>
    </button>
  </div>

Typescript

Typed notifications supported using the Composition API only.

// notiwind.ts
import { createNotifier, NotificationGroup, defineNotificationComponent } from 'notiwind'

export type NotificationSchema = {
  title: string
  text: string
}

export const notify = createNotifier()
export const Notification = defineNotificationComponent()
export { NotificationGroup }



<template>
  
    
      
    
  
</template>

TODO

Add tests

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Added some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

License

MIT

notiwind dependencies

mitt

notiwind development dependencies

@babel/core @babel/preset-env @vitejs/plugin-vue @vue/compiler-sfc @vue/eslint-config-prettier @vue/eslint-config-typescript eslint eslint-plugin-vue prettier typescript vite-plugin-dts vue-tsc vite

FAQs

What is notiwind?

A headless Vue 3 notification library to use with Tailwind CSS. Visit Snyk Advisor to see a full health score report for notiwind, including popularity, security, maintenance & community analysis.

Is notiwind popular?

The npm package notiwind receives a total of 4,056 weekly downloads. As such, notiwind popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is notiwind well maintained?

We found that notiwind demonstrated a healthy version release cadence and project activity. It has a community of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is notiwind safe to use?

The npm package notiwind was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 22 December-2024, at 20:55 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (4,056)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Notiwind

🌟 Features

🤖 Demo

⚡️ Installation

🍞 How to use

Options API

Composition API

Basic example

Example with differents groups

Using different types of notifications

Props

Props for the Notification component, all are optional.

Props for NotificationGroup component, all are optional.

Defualt scoped slots

Example

Typescript

TODO

Contributing

License

notiwind dependencies

notiwind development dependencies

FAQs

What is notiwind?

Is notiwind popular?

Is notiwind well maintained?

Is notiwind safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

Props for the `Notification` component, all are optional.

Props for `NotificationGroup` component, all are optional.