Simple.mvc.js version 1.0.10
The View (UI) should always be synchronised with the Model (data) and optionally the other way around. Many other libraries already solve this problem, but in many cases it's not enough to know JavaScript, HTML & CSS. Read more about the philosophy behind Simple.mvc below.
#Philosophy
Ease of use Easy to get started (less than 5 minutes).
One goal Keep the View synchronised with the Model and therefore should not handle routing, local storage, etc. by keeping things simple and not add unnecessary/extravagance functionality. However, I haven't decided yet whether some of these functionalities will be implemented later. If that's the case, it will probably be as an extension and not as a core part of the library.
Light weight Keep the code as light weight as possible. The library is currently ~12KB minified (4-5x lighter than other libraries).
Standards Use existing HTML elements and attributes instead of a templating system.
Cross-browser (back to IE6) Simple.mvc uses jQuery as the only dependency to ensure cross-browser compatibility & rapid development (+less code maintenance and the need for testing new code which has already been tested/used). The tradeoff is, that newer versions (>1.9.0) of jQuery only support modern browsers (IE>8). Simple.mvc supports ancient web browsers such as IE6 and FF 3.5, and of course also all modern web browsers (desktop/mobile).
Notes:
- Simple.mvc requires jQuery >=1.4.3, and should work with any newer version .
- Support for old web browsers requires jQuery 1.9.0 and jQuery migrate 1.0.0. Read more here
MVC design pattern There are many views on how to interpret Model-View-Controller, but in this case it should be understood simply by asking the question:
How can my HTML code interact with my JavaScript code and be kept in sync?
The goal is to bind the Model (data) with the View (UI). Hence, Simple.mvc can be considered as the C in MVC - the controller - which binds it together and keeps things in sync.
Separation of Concerns
Never mix HTML code with JavaScript code.
function getHtml() { return '<div>this is bad</div>'; }
I personally don't like mixing HTML, CSS & JS, and I am well aware of some of the arguments such as packaging everything in module can be tempting, but keeping HTML, CSS & JS separate makes the code more (re-)usable, debuggable, readable, (more -able?). I won't argue for or against, as this is a religion amongst most programmers.
Read more about separation of concerns
Code quality High code quality using Test Driven Development with unit testing. A behavior-driven development framework called Jasmine has been used for testing. Run Unit Tests
Free & Open Source It's free & Open Source (MIT licence).
Chaining Run multiple methods (on the same element) within a single statement.
Docs + Examples Well documented and has many real-world examples. Todo App Demo: Simple - Advanced API documentation
#Installation
##Download (the old way) Download jQuery 1.9.0 works with IE>=6 or jQuery 1.12.1. Download jQuery migrate 1.0.0 (works with IE>=6) or jQuery migrate 1.12.1 (optional). Download simple.mvc.min.js to be used in production or simple.mvc.js with comments to be used in development while debugging.
##The new way Simple.mvc is available through Bower package manager and NPM.
Learn more about using and installing Bower at http://bower.io To add Simplemvc to your application, you can run:
bower install simple.mvc
Learn more about using and installing NPM at https://nodejs.org/en/download To add Simplemvc to your application, you can run:
npm install simple.mvc
##Installation
Reference the JavaScript file using a <script> tag somewhere on your HTML pages. For example,
<script type='text/javascript' src='jquery-1.9.0.min.js'></script>
<script type='text/javascript' src='jquery-migrate-1.0.0.min.js'></script>
<script type='text/javascript' src='simple.mvc.min.js'></script>
#Copyright and licence Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.