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

@veams/plugin-modules

v1.2.0

Published

The Veams Modules Plugin provides a whole system to initialize, render, save and destroy your modules.

Downloads

427

Readme

Veams Modules Plugin (@veams/plugin-modules)

The Veams Modules Plugin provides a whole system to initialize, render, save and destroy your modules.

It uses mutation observer to observe added and removed nodes and handles your components, as long as the component has the same API like VeamsComponent.

TypeScript is supported.

Installation

NPM

npm install @veams/plugin-modules --save

Yarn

yarn add @veams/plugin-modules

Usage

import Veams from '@veams/core';
import VeamsModules from '@veams/plugin-modules';

// Intialize core of Veams
Veams.onInitialize(() => {
   	// Add plugins to the Veams system
	Veams.use(VeamsModules, {
		// my custom options can be placed here
	});
});

Options

  • attrPrefix {String} ['data-js'] - You can override the javascript module indicator in your markup which will be searched in the context.
  • attrName {String} ['module'] - You can override the attribute name for module identification.
  • attrOptions {String} ['options'] - You can override the attribute name for options identification.
  • internalCacheOnly {Boolean} [true] - Hold internal cache in plugin and do not expose to the Veams object.
  • internalRegisterOnly {Boolean} [false] - Hold internal register in plugin and do not expose to the Veams object.
  • logs {Boolean} [false] - Hide or print the logs to the console.
  • useMutationObserver {Boolean} [true] - You can set this option to true to use mutation observer for ajax handling. You can also use Veams.EVENTS.DOMchanged as before.

API

When enabled you can register a module/component like that:

import CustomModule from './modules/custom';
import AnotherCustomModule from './modules/another-custom';
import ThirdCustomComponent from './components/third-custom';


// Register all at once
Veams.modules.register([
	{
        namespace: 'custom',
        module: CustomModule
    },
    {
        namespace: 'another-custom',
        module: AnotherCustomModule,
        conditions: () => {
            return Veams.detections.width < 768;
        },
        conditionsListenOn: [
            Veams.EVENTS.resize
        ]
    }
]);

// Or register single module 
Veams.modules.add({
	namespace: 'third-custom',
	module: ThirdCustomComponent
})

Parameters provided by Plugin

The plugin initializes your module and provides parameters to it:

  1. obj - Generic Object which contains
    • el - Node/element which is found by the plugin.
    • namespace - Namespace which is associated with the module.
    • options - Options object which is defined in the register process (also called default module options).
    • context - The context object is your custom Veams object.
  2. options - Markup Options which are read out by this plugin