import {Module} from '@crispcode/modux/scripts/libs/module.js'

public class | source

Module

The main class, used to create a Modux module. You can think of this as the main application

Constructor Summary

Public Constructor
public	constructor(name: String) Creates an instance of Module

Public Members
public	store: Store Contains a new instance of @crispcode/pushstore which is passed on to all components.

Public Methods
public	addDependency(name: String, dependency: Component): Module A method used to add components to the Module
public	bootstrap(element: HTMLElement, component: Component) Initializes the Module on a specific HTMLElement and loads the specified Component for it
public	createComponent(node: HTMLElement) Renders an HTMLElement to a Component as if it was a part of this module
public	destroy() Destroy the current module.
public	removeDependency(name: String): Module A method used to remove components from the Module

Creates an instance of Module

Name	Type	Attribute	Description
name	String	optional	A unique name for the module, for easier management

Contains a new instance of @crispcode/pushstore which is passed on to all components. See https://www.npmjs.com/package/@crispcode/pushstore

A method used to add components to the Module

Name	Type	Attribute	Description
name	String		The name under which the Component will be known as
dependency	Component		The Component to be added

The instance of Module

Initializes the Module on a specific HTMLElement and loads the specified Component for it

Name	Type	Attribute	Description
element	HTMLElement		The HTMLElement used as the wrapper for the Module
component	Component		The Component to be used as the main Component

Renders an HTMLElement to a Component as if it was a part of this module

Name	Type	Attribute	Description
node	HTMLElement		The HTMLElement to be converted to a Component

Destroy the current module. This will also destroy all the components created and disconnect the MutationObserver

A method used to remove components from the Module

Name	Type	Attribute	Description
name	String		The name of the Component to be removed

The instance of Module