The Veams Modules Plugin provides a whole system to initialize, render, save and destroy your modules.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
.gitignore
.npmignore
CHANGELOG.md
LICENSE
README.md
package.json
tsconfig.json
yarn.lock

README.md

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

Option Type Default Description
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