❤
npm
Sign UpSign In

veams

5.1.1 • Public • Published

Head to the site for detailed instructions.

Gitter Chat

What is Veams?

Veams is one of the most flexible and efficient system to build scalable Web Apps, HTML5 web interfaces and Prototypes. It is extremely extensible and efficiently architected.

Veams contains various (pluggable) instruments which are controlled by our custom command line interface.

Overview

  1. Veams as Framework
  2. Veams-Cli
  3. Veams-Generator
  4. Veams-Methodology
  5. Veams-Components

Veams as Framework

Veams exposes a framework which you can use as a simple starting point. This starting point can be enhanced and extended by an easy plugin system.

The purpose of Veams is to individually build up a project based framework in a simple, fast, scalable and understandable way.

It is not opinionated, means use the stack which fits best to your project, in example Backbone, React, Foundation or something else.

Table of Content

  1. Typical Use Cases for Veams
  2. Usage
  3. Core
  4. Plugins
  5. Common
  6. Services
  7. Roadmap of Veams

Typical Use Cases

Veams is used in many projects in the agency I work for.

The majority of projects are portal like websites, they are mostly static (CMS) and get enhanced with (a lot of) JavaScript.

That's why all plugins or components are heavily optimised for that project type.

Usage

To use Veams as framework just install and import the library:

Installation

npm install veams --save
yarn install veams

Import

JavaScript

import Veams from 'veams';

Then initialize the core:

Veams.initialize();

SCSS

// Reset (veams-reset or veams-normalize) 
@import "./node_modules/veams/src/scss/veams-reset";
@import "./node_modules/veams/src/scss/veams";

That's it. The framework is integrated.

Veams Core

The core of Veams is nothing more than a simple object (Veams). In general Veams comes with some empty and predefined objects and a basic API.

Veams Core API

Veams.addHelper('name', helperFunction)
  • @param {String} name - Helper name which will be used in the registration process.
  • @param {Function} helperFunction - The helper function.

The method allows the registration of provided or custom helpers.

Veams.use(plugin)
  • @param {Object} plugin - Plugin object which extends the Veams object.

This method provides the possibility to register a plugin, see section Creation of plugins.

Veams Core Object

Veams.EVENTS {Object}

The events object can be used to communicate between modules. It can be extended with further custom events. Just see VeamsVent.

Veams.base.version {String}

Display the current Veams version.

Veams.dectections {Object}

The detections object contains the current width and height, as well as if you are on a touch device or not.

The detections object will be updated when you use VeamsMediaQueryHandler.

Veams.helpers {Object}

Veams has some helpers which you can use. Some of the helpers are optional, others are requirements, see Veams Helpers.

Veams.options {Object}

Veams provides some general options. These are:

  • namespace {String} ['Veams'] - The custom namespace of your application.
  • addToGlobal {Boolean} [false] - Add the namespace to the global window object.
Veams.Plugins {Object}

All named plugins will be saved in this object. In the beginning it is empty.

Veams Helpers

The helpers are saved in src/js/utils/helpers/.

The following helper are provided as default helpers:

Additional helpers can be imported by you:

These helpers need to be imported into your project and can be added to the Veams.helper object by using the provided Veams.addHelper() method.

Example:

import transitionEndHelper from 'veams/src/utils/helpers/transition-end';
 
// Simple use a function and a helper name
Veams.addHelper('transitionEnd', transitionEndHelper);
 
// Or pass an object to the method with your helpers in it
Veams.addHelper({
    transitionEnd: transitionEndHelper
});

Veams.helpers.extend(a, b)

  • @param {Object} a - object which will be extended.
  • @param {Object} b - object which extending a.

Simple extend method to extend the properties of the object a with b. It overrides existing values of a.

Veams.helpers.forEach(array, callback, scope)

  • @param {Array} array - array of objects
  • @param {function} callback - callback function
  • @param {string} scope - scope of function

Simple forEach method which can be used to iterate over an array.

Veams.helpers.isTouch()

Touch detection helper which returns a boolean.

Veams.helpers.makeId(segments = 1)

  • @param {Number} [segments=1] - number of segments of generated id (segments consist of 10 digits, separated by '-').

Generates numeric id and returns a string.

Veams.helpers.methodExtend(to, from, methodName)

  • @param {Object} to - view which will be extended.
  • @param {Object} from - methods which comes from mixin.
  • @param {String} methodName - function name.

Helper method to extend an already existing method.

Veams.helpers.mixin(from, methods = ['initialize', 'render'])

  • @param {Object} from - Mixin object which will be merged via Helpers.defaults with the methods of our class
  • @param {Array} [methods] - Array of method names which will be extended.

Merge method functions. As second paramater you can provide an array of method names which will be extended.

Veams.helpers.querySelectorArray(sel, context)

  • @param {String} elem - Required: selector
  • @param {Object} [context] - Optional: context

Get dom elements in an array in a specific context. If context is not provided it uses document as context.

Veams.helpers.throttle(func, wait, immediate)

  • @param {function} func - Function which will be executed.
  • @param {number} wait - number to wait in milliseconds.
  • @param {boolean} immediate - execute function immediately.

Throttle method for resize events and more.

Veams.helpers.animationEndEvent()

Detect animationend event.

Veams.helpers.checkElementInContext(elem, context)

  • @param {Object} elem - Element, which will be checked.
  • @param {Object} context - Context element, in which our element could persists.

Check if element is in a specific context and return state as boolean.

Veams.helpers.detectSwipe(el, threshold)

  • @param {Object} el - element to detect swipes on
  • @param {Number} threshold - threshold for swipe (in px)

Detect swipe gestures.

Veams.helpers.getParamFromUrl(url, param)

  • @param {String} url - given url
  • @param {String} param - parameter (name)

Get value of parameter for given url.

Veams.helpers.indexOf(array, item)

  • @param {Array} array - array in which we search for
  • @param {Object} item - item which will be searched

Find index of a specific item in an array.

Veams.helpers.isInViewport(elem, useBounds)

  • @param {Object} elem - Object, which we want to check
  • @param {boolean} useBounds - if true, whole element must be visible

Check if element is in viewport.

Veams.helpers.transitionEndEvent()

Detect transition end event.

Veams.helpers.updateUrl(url, params)

  • @param {String} url - url on which parameters should be added / updated
  • @param {Object} params - parameters (name/value)

Add/Update multiple parameters for given url and returns a resulting URL string.

Plugins

In general the plugin system is a really simple one.

Usage of a plugin

When you want to use a plugin you first need to import the plugin and then just execute the use method of Veams:

import VeamsLogger from 'veams-plugin-logger';
 
// Add plugins to the Veams system
Veams.use(VeamsLogger);

You can pass in options to the plugin just by adding other parameters:

import VeamsMediaQueryHandler from 'veams-plugin-media-query-handler';
 
// Add plugins to the Veams system
Veams.use(VeamsMediaQueryHandler, {
    delay: 200
});

Creation of plugins

When you want to create a plugin you only need to export an object with an initialize method in it. It is really easy.

Let's say you want to add jQuery as DOM handler in Veams:

  1. First you need to import the jQuery library
  2. Then you create a simple object
    • The pluginName is optional
    • Into the initialize method there will be passed the Veams object
  3. Execute use of Veams.
import $ from 'jquery';
 
let DomPlugin = {
    pluginName: '$',
    initialize: function(Veams) {
        Veams.$ = $;
    }
};
 
Veams.use(DomPlugin);

That's it. You extended the general Veams object.

Available plugins

There are multiple plugins available.

  1. VeamsDOM
  2. VeamsVent
  3. VeamsLogger
  4. VeamsModules
  5. VeamsMediaQueryHandler
  6. VeamsTemplater
  7. VeamsMixins

Please keep in mind that the order of the initialisation of your used plugins can be important. In general it makes sense to use the following order:

// Intialize core of Veams
Veams.onInitialize(() => {
 
    // Add plugins to the Veams system
    Veams.use(VeamsDOM, {
        DOM: $
    });
    Veams.use(VeamsVent); // VeamsVent enhances VeamsModules and VeamsMediaQueryHandler
    Veams.use(VeamsLogger);
    Veams.use(VeamsModules);
    Veams.use(VeamsMediaQueryHandler);
});
 

Common

Veams provide some common classes.

VeamsComponent

  • import VeamsComponent from 'veams/lib/common/component'

The class provides a base system to build components. It merges options, bind and unbind events without worrying about that, subscribe to global events and renders templates with data.

Services

VeamsHttp

  • import VeamsHttp from 'veams/lib/services/http'

The class provides a simple ajax system (.get(), .post()) which returns a promise.

Roadmap

There are many things left. So here you can see a short overview:

  1. Extend/Enhance Plugins Repository
    • React Plugin
    • Lazyload Modules Handler Plugin
    • Extend Templater Plugin to support server side templates
    • Add VDOM plugin for templater
  2. Enhance Commons and Services
    • Create a native VeamsComponent
    • Create a11y service
  3. Extend Helpers Repository
    • Add more useful helpers
    • Update existing ones
  4. Write tests

If you have other ideas, please open an issue on github, I would appreciate that!

Veams-Cli

Veams-Cli is a command line interface for scaffolds and build processes. The key benefit is the rapid setup time. You can easily create complex application setups with Veams-Cli in a few minutes.

Repository and Options

Veams-Generator

Veams-Cli uses Yeoman, Inserter, generator-veams and some other modules to provide a nice base.

Veams-Generator is a module based on Yeoman. We use this generator to scaffold applications or blueprints. You want to know more?

Repository and Options

Veams-Methodology

Veams-Methodology is a system for your whole frontend stack. Typical questions - which Veams-Methodology is solving - are:

  1. How to scope and differentiate units (Components, Utilities, Regions) in your HTML?
  2. How to bind JavaScript to your DOM elements?
  3. How to structure layouts?
  4. How to write your classes?
  5. How to extend your project?

Documentation

Veams-Components

Veams-Components is a building blocks library to speed up templating in projects.

All components can be found here: https://github.com/Veams

Do you want to see the components in action? Here you go: http://examples.veams.org/

veams.org

The website is built with Veams, of course. Here ist the repository: https://github.com/Sebastian-Fitzner/veams.org

Readme

Keywords

Package Sidebar

Install

npm i veams

Repository

github.com/veams/veams

Homepage

veams.org/

Weekly Downloads

5

Version

5.1.1

License

MIT

Last publish

Collaborators

  • andy-gutsche
  • sebastian-fitzner
Try on RunKit
Report malware