QuidPHP/Browser
About
QuidPHP/Browser is a JavaScript module with helpers for use within the browser.
License
QuidPHP/Browser is available as an open-source package under the MIT license.
Documentation
QuidPHP/Browser documentation is available at QuidPHP/Docs.
Installation
QuidPHP/Browser can be easily installed with NPM.
$ npm install quidphp-browser
Once installed, the package will be available within your node_modules folder.
Dependency
QuidPHP/Browser has the following dependency:
- quidphp-javascript - JavaScript module useful for both the front-end & back-end
All dependencies will be resolved by using the NPM installation process.
Requirement
QuidPHP/Browser requires any modern browser (not Internet Explorer).
Comment
QuidPHP/Browser code is commented and all methods are explained (in French).
Overview
QuidPHP/Browser contains one entry file.
- index - Entry file for the module
Source
QuidPHP/Browser contains 16 JavaScript files. Here is an overview:
- browser - Script with a some functions related to browsers detection
- data - Script for storing datas within targets
- doc - Object for document and document fragment targets
- dom - Script with functions related to html and dom
- ele - Script with many functions related to element nodes
- evt - Script containing event management functions
- handler - Script for handler management (functions stored in targets)
- historyState - Script with functions related to the history states
- listener - Script containing event listeners functions for target elements
- nod - Object for element, text and document nodes
- request - Script with functions related to the current request
- selector - Script with methods related to selecting and matching nodes
- target - Script with basic functions related to event targets elements
- uri - Script with a set of helper functions related to uri management
- win - Object for window target
- xhr - Script with some logic for ajax calls and xhr object
Distributable
QuidPHP/Browser contains 2 scripts that can be used in the browser.
- browser - Minified and transpiled script ready for production
- browser-test - Same as browser.js but also contains the module tests
Testing
QuidPHP/Browser contains 2 test scripts:
QuidPHP/Browser 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