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

overlay-manager-vue

v0.3.3-beta.3

Published

Vue overlay component manager

Downloads

15

Readme

overlay-manager-vue

A plugin for managing overlay components in Vue 3.

Korean Version (한글 버전)

Installation

Using npm:

npm install overlay-manager-vue

Using yarn:

yarn add overlay-manager-vue

Usage

Setup

  1. Configure in your main.ts/js file:
import { createApp } from 'vue';
import App from './App.vue';
import { overlayManagerPlugin } from 'overlay-manager-vue';

const app = createApp(App);
app.use(overlayManagerPlugin());
app.mount('#app');
  1. Set up overlay rendering in App.vue

Add the following code to render overlays in your App.vue file:

<template>
  <!-- Existing app content -->
  <component
    v-for="overlay in overlays"
    :key="overlay.id"
    :is="overlay.content"
    :open="overlay.state"
    :data="overlay.data"
    :close="overlay.close"
  />
</template>

<script setup lang="ts">
import { useOverlayManager } from 'overlay-manager-vue';

const { overlays } = useOverlayManager();
</script>

Basic Usage

  1. Create an example overlay component
  • Using radix-vue AlertDialog:
<template>
  <AlertDialog v-bind:open="props.open">
    <AlertDialogContent>
      <h2>{{ title }}</h2>
      <p>{{ data.message }}</p>
      <Button @click="handleClose">Close</Button>
    </AlertDialogContent>
  </AlertDialog>
</template>

<script lang="ts" setup>
import { defineProps } from 'vue';
import type { OverlayContentProps } from 'overlay-manager-vue';
import { AlertDialog, AlertDialogContent } from '@/components/ui/alert-dialog';
import { Button } from '@/components/ui/button';
const props = defineProps<OverlayContentProps>();
const title = 'Example Overlay';

const handleClose = () => {
  props.close();
};
</script>
  1. Use the overlay in a component:

Here's how to use the overlay in other components:

<script setup lang="ts">
import { useOverlayManager } from 'overlay-manager-vue';
import ExampleOverlay from './ExampleOverlay.vue';

const { overlayOpen } = useOverlayManager();

const openOverlay = () => {
  overlayOpen({
    content: ExampleOverlay,
    data: { message: 'This is an overlay created by overlay manager.' },
  });
};
</script>

<template>
  <button @click="openOverlay">Open Overlay</button>
</template>

API

overlayManagerPlugin

A Vue plugin that sets up the overlay manager.

useOverlayManager

A composable that provides access to overlay manager functionality.

Returns:

  • overlays: Array of active overlays
  • overlayOpen: Function to open a new overlay

overlayOpen(options)

Opens a new overlay.

Parameters:

  • options: An object with the following properties:
    • content: The overlay component to render
    • data: (optional) Data to pass to the overlay component

Overlay Component Props

When creating an overlay component, it will receive the following props:

  • open: Boolean indicating if the overlay should be displayed
  • data: Any data passed when opening the overlay
  • close: Function to close the overlay

License

MIT License