vue-block-system

Easily create block based websites!

The block system uses the vue-transition-component to handle all component transitions. If you want to read more about this see the documentation. All blocks are transitioned when they enter the viewport. This is done using the vue-block-system.

Global note:

All examples below are based on the vue-skeleton by hjeti.

Installation

yarn / npm

yarn add vue-block-system

npm i -S vue-block-system

Example

I've included an example setup where you can see the loader in action, to run the project follow these steps:

• git clone https://github.com/larsvanbraam/vue-block-system.git
• cd vue-block-system/example
• yarn
• yarn dev
• Open your browser localhost:8080

or click this link to preview online

Usage

Detailed documentation and examples are located in the wiki!

Check the wiki!

Building

In order to build vue-block-system, ensure that you have Git and Node.js installed.

Clone a copy of the repo:

git clone https://github.com/larsvanbraam/vue-block-system.git

Change to the vue-block-system directory:

cd vue-block-system

Install dev dependencies:

yarn

Use one of the following main scripts:

yarn build           # build this project 
yarn dev             # run dev-watch mode, serving example/index.html in the browser 
yarn generate        # generate all artifacts (compiles ts, webpack, docs and coverage) 
yarn test:unit       # run the unit tests 
yarn validate        # runs validation scripts, including test, lint and coverage check 
yarn lint            # run tslint on this project 
yarn doc             # generate typedoc documentation 

When installing this module, it adds a pre-push hook, that runs the validate script before committing, so you can be sure that everything checks out.

If you want to create the distribution files yourself, you can run the build-dist script, and the following files will get generated in the dist folder:

• /dist/vue-block-system.js: bundled with webpack, can be loaded from a script tag, available as window.SengScrollTracker
• /dist/vue-block-system.min.js: same as above, but minified
• /dist/vue-block-system-amd.js: bundled with webpack, can be used with e.g. requirejs
• /dist/vue-block-system-commonjs.js: bundled with webpack, can be used in systems that support commonjs, but you should just use npm
• /dist/vue-block-system-umd.js: bundled with webpack, works in the browser, with requirejs, and in a commonjs system
• /dist/vue-block-system-umd.min.js: same as above, but minified
• /dist/vue-block-system-system.js: bundled with typescript, can be used in systems that support systemjs
• /dist/vue-block-system-es6.zip: transpiled with typescript, only types are removed from the source files

Authors

View AUTHORS.md

Contribute

View CONTRIBUTING.md

License

MIT © Lars van Braam