quidphp-navigation

QuidPHP/Navigation

About

QuidPHP/Navigation contains a Javascript module for navigating a website without reloading.

License

QuidPHP/Navigation is available as an open-source package under the MIT license.

Documentation

QuidPHP/Navigation documentation is available at QuidPHP/Docs.

NPM Installation

QuidPHP/Navigation can be easily installed with NPM.

$ npm install quidphp-navigation

Once installed, the package will be available within your node_modules folder.

Composer Installation

QuidPHP/Core can also be installed with Composer. It is available on Packagist.

$ composer require quidphp/navigation

Once installed, the package will be available within your vendor folder.

Dependency

QuidPHP/Navigation has the following dependency:

• quidphp-browser - JavaScript module with helpers for use within the browser

All dependencies will be resolved by using the NPM installation process.

Requirement

QuidPHP/Navigation requires any modern browser (not Internet Explorer).

Comment

QuidPHP/Navigation code is commented and all methods are explained (in French).

Overview

QuidPHP/Navigation contains one entry file.

• index - Entry file for the module

Source

QuidPHP/Navigation contains 3 JavaScript files. Here is an overview:

• doc - Root component for a document node
• history - Component managing site navigation with the HistoryAPI
• windowUnload - Component to manage the unload notification with the window object

Styling

QuidPHP/Navigation also contains 2 SCSS files. Here is an overview:

• document - Stylesheet for the document component, includes many style reset
• init - Stylesheet containing default variables and a set of helpers mixins

Distributable

QuidPHP/Navigation contains 2 scripts that can be used in the browser.

• navigation - Minified and transpiled script ready for production
• navigation-test - Same as navigation.js but also contains the module tests

Testing

QuidPHP/Navigation contains 2 test scripts:

• navigation - Script to test the navigation module
• run - File to run the testsuite in navigation

QuidPHP/Navigation testsuite can be run in the browser by creating a new QuidPHP/Assert project. Some tests can also be run in Node with the command:

$ npm run test