Z-MVC-Lib

I wanted to write a simple, and extensible MVC library.

Install

Firstly, you should probably download the package.

npm

npm install --save z-mvc-lib

yarn

yarn add z-mvc-lib

TODO

These are the tasks I want to complete on this library.

• Finish readme
• Implement functionality for use in a website

Components

The library is split into the following components:

• BaseView
• BaseModel
• BaseController
• utils

These can all be required using:

const { Component } = require('z-mvc-lib')

BaseView

BaseView is a class that should be extended to create new views.

constructor(model, controller)

Functions

visible(value) - Takes true/false and sets view visibility, should be extended to work with the implementation of draw

draw() - A placeholder function that should be extended

dispose() - Essentially calls utils.dispose(viewName)

Variables

model - Instance of the model class

controller - Instance of the controller class

visibility - true/false value indicating view visibility

BaseModel

BaseModel is a class that should be extended to create new models.

constructor(name)

Functions

setValue(name, value) - Sets a value in model.values

getValue(name) - Gets a value from model.values

Variables

values - Object that stores key/value pairs

Default values

name - The current name that is passed to constructor

BaseController

BaseController is a class that should be extended to create new conrollers.

constructor(model)

utils

utils provides some functions to use the MVC.

MVCError

An extension of the Error class for use in this library.

Errors

registerView

getView

dispose