Class Module<StaticProps, ChangeableProps, CallbacksTypes>

A base class for modules that handle responsive properties, event listeners, and custom callbacks. This class provides a structure for modules that can dynamically respond to viewport changes, property mutations, and various lifecycle events.

Example

interface IStaticProps extends NModule.IStaticProps {
  staticName: 'My name';
}

interface IChangeableProps extends NModule.IChangeableProps {
  weight: number;
  height: number;
}

interface ICallbacks extends NModule.ICallbacksTypes {}

const module = new Module<IStaticProps, IChangeableProps, ICallbacks>({
  staticName: 'My name',
  weight: 70,
  height: 175,
}, false);

module.addResponsiveProps({
  breakpoint: 'viewport_phone',
  settings: {
    weight: 80,
  },
});

module.init();

module.addCallback('propsMutate', () => console.log('mutate props'));
module.addCallback('destroy', () => console.log('destroy'));

Type Parameters

StaticProps extends NModule.IStaticProps = NModule.IStaticProps
ChangeableProps extends NModule.IChangeableProps = NModule.IChangeableProps
CallbacksTypes extends NModule.ICallbacksTypes = NModule.ICallbacksTypes

Hierarchy

Module
- Component
- Plugin

Index

Constructors

constructor

new Module<StaticProps, ChangeableProps, CallbacksTypes>(initialProps?, canInit?): Module<StaticProps, ChangeableProps, CallbacksTypes>
Creates a new instance of the Module class.
Type Parameters
- StaticProps extends NModule.IStaticProps = NModule.IStaticProps
- ChangeableProps extends NModule.IChangeableProps = NModule.IChangeableProps
- CallbacksTypes extends NModule.ICallbacksTypes = NModule.ICallbacksTypes
Parameters
- Optional initialProps: StaticProps & ChangeableProps
  
  The initial static and changeable properties to be used by the module.
- canInit: boolean = true
  
  Whether to automatically initialize the module after construction. Set this to false if you want to add responsive properties before initializing.
Returns Module<StaticProps, ChangeableProps, CallbacksTypes>
- Defined in src/base/Module/index.ts:128

Accessors

callbacks

get callbacks(): Callbacks<CallbacksTypes>
Retrieves the module's registered callbacks.

Returns Callbacks<CallbacksTypes>
- Defined in src/base/Module/index.ts:79

isDestroyed

get isDestroyed(): boolean
Checks if the module has been destroyed.

Returns boolean
- Defined in src/base/Module/index.ts:118

isInitialized

get isInitialized(): boolean
Checks if the module has been initialized.

Returns boolean
- Defined in src/base/Module/index.ts:108

name

get name(): string
The name of the module, derived from the class name

Returns string
- Defined in src/base/Module/index.ts:93

prefix

get prefix(): string
Optional prefix for class names used by the module

Returns string
- Defined in src/base/Module/index.ts:98

props

get props(): TRequiredModuleProp<StaticProps & ChangeableProps>
The current properties of the module, which include both static and changeable properties. These can be retrieved dynamically during the module's lifecycle.

Returns TRequiredModuleProp<StaticProps & ChangeableProps>
- Defined in src/base/Module/index.ts:64

Methods

addCallback

addCallback<T>(target, action, settings?): IAddedCallback
Adds a custom callback to the module.
Type Parameters
- T extends string | number | symbol
Parameters
- target: T
  
  The event type to listen for (e.g., 'propsChange', 'destroy').
- action: TAction<CallbacksTypes[T]>
  
  The function to execute when the event is triggered.
- settings: ISettings = {}
  
  Additional settings for the callback.
Returns IAddedCallback
- Defined in src/base/Module/index.ts:245

addEventListener

addEventListener<Target, Listener>(element, target, callback, options?): (() => void)
Adds a DOM event listener that will be automatically removed when the module is destroyed.
Type Parameters
- Target extends keyof HTMLElementEventMap
- Listener extends ((event) => void)
Parameters
- element: Document | Element | Window
  
  The target element for the event listener.
- target: Target
  
  The event type to listen for (e.g., 'click', 'resize').
- callback: Listener
  
  The callback function to execute when the event is triggered.
- Optional options: boolean | AddEventListenerOptions
  
  Additional options for the event listener.
Returns (() => void)
- - (): void
  - Returns void
- Defined in src/base/Module/index.ts:261

addResponsiveProps

addResponsiveProps(rules): void
Adds responsive property rules to the module. This must be done before initialization.
Parameters
- rules: IResponsive<ChangeableProps>
  
  The responsive property rules to be added.
Returns void
- Defined in src/base/Module/index.ts:159

addViewportCallback

addViewportCallback(target, action, data?): void
Adds a viewport callback that will be automatically removed when the module is destroyed.
Parameters
- target: keyof IViewportCallbackTypes
  
  The viewport target (e.g., width or height).
- action: (() => void)
  
  The callback function to execute when the viewport target changes.
  - - (): void
    - Returns void
- data: undefined | ISettings = {}
  
  Additional data for the callback.
Returns void
- Defined in src/base/Module/index.ts:225

changeProps

changeProps(props): void
Updates the changeable properties of the module.
Parameters
- props: Partial<ChangeableProps>
  
  The properties to be updated.
Returns void
- Defined in src/base/Module/index.ts:174

destroy

destroy(): void
Destroys the module, cleaning up resources, callbacks, and event listeners.

Returns void
- Defined in src/base/Module/index.ts:310

init

init(): void
Initializes the module. Calls the internal _init method and marks the module as initialized.

Returns void
- Defined in src/base/Module/index.ts:194

Class Module<StaticProps, ChangeableProps, CallbacksTypes>

Example

Type Parameters

StaticProps extends NModule.IStaticProps = NModule.IStaticProps

ChangeableProps extends NModule.IChangeableProps = NModule.IChangeableProps

CallbacksTypes extends NModule.ICallbacksTypes = NModule.ICallbacksTypes

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

StaticProps extends NModule.IStaticProps = NModule.IStaticProps

ChangeableProps extends NModule.IChangeableProps = NModule.IChangeableProps

CallbacksTypes extends NModule.ICallbacksTypes = NModule.ICallbacksTypes

Parameters

Optional initialProps: StaticProps & ChangeableProps

canInit: boolean = true

Returns Module<StaticProps, ChangeableProps, CallbacksTypes>

Accessors

callbacks

Returns Callbacks<CallbacksTypes>

isDestroyed

Returns boolean

isInitialized

Returns boolean

name

Returns string

prefix

Returns string

props

Returns TRequiredModuleProp<StaticProps & ChangeableProps>

Methods

addCallback

Type Parameters

T extends string | number | symbol

Parameters

target: T

action: TAction<CallbacksTypes[T]>

settings: ISettings = {}

Returns IAddedCallback

addEventListener

Type Parameters

Target extends keyof HTMLElementEventMap

Listener extends ((event) => void)

Parameters

element: Document | Element | Window

target: Target

callback: Listener

Optional options: boolean | AddEventListenerOptions

Returns (() => void)

Returns void

addResponsiveProps

Parameters

rules: IResponsive<ChangeableProps>

Returns void

addViewportCallback

Parameters

target: keyof IViewportCallbackTypes

action: (() => void)

Returns void

data: undefined | ISettings = {}

Returns void

changeProps

Parameters

props: Partial<ChangeableProps>

Returns void

destroy

Returns void

init

Returns void

Settings

Member Visibility

Theme

On This Page

`Optional` initialProps: StaticProps & ChangeableProps

`Optional` options: boolean | AddEventListenerOptions