quidphp-navigation - npm Package Compare versions

Comparing version 5.31.6 to 5.31.7

package.json

 {
     "name": "quidphp-navigation",
-    "version": "5.31.6",
-    "description": "Javascript module for a website navigation without reloading",
+    "version": "5.31.7",
+    "description": "Javascript module for navigating a website without reloading",
     "main": "index.js",
@@ -31,4 +31,3 @@ "type": "module",
     "dependencies": {
-        "quidphp-browser": "5.31.*",
-        "quidphp-javascript": "5.31.*"
+        "quidphp-browser": "5.31.*"
     },
@@ -35,0 +34,0 @@ "devDependencies": {

README.md

@@ -7,3 +7,3 @@ # QuidPHP/Navigation
 ## About
-**QuidPHP/Navigation** contains a JavaScript module for a website navigation without reloading.
+**QuidPHP/Navigation** contains a Javascript module for navigating a website without reloading.
 
@@ -13,5 +13,48 @@ ## License
 
+## Documentation
+**QuidPHP/Navigation** documentation is available at [QuidPHP/Docs](https://github.com/quidphp/docs).
+
 ## Installation
-**QuidPHP/Navigation** can be easily installed with [Composer](https://getcomposer.org). It is available on [Packagist](https://packagist.org/packages/quidphp/navigation).
+**QuidPHP/Navigation** can be easily installed with [NPM](https://www.npmjs.com/package/quidphp-navigation).
 ``` bash
-$ composer require quidphp/navigation
+$ npm install quidphp-navigation
+```
+Once installed, the package will be available within your *node_modules* folder.
+
+## Dependency
+**QuidPHP/Navigation** has the following dependency:
+- [quidphp-browser](https://github.com/quidphp/browser) - JavaScript module with helpers for use within the browser
+
+All dependencies will be resolved by using the [NPM](https://www.npmjs.com) 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 3 JavaScript files. Here is an overview:
+- [doc](src/doc.js) - Root component for a document node
+- [history](src/history.js) - Component managing site navigation with the HistoryAPI
+- [windowUnload](src/windowUnload.js) - Component to manage the unload notification with the window object
+
+## Styling
+**QuidPHP/Navigation** also contains 2 SCSS files. Here is an overview:
+- [document](css/document.scss) - Stylesheet for the document component, includes many style reset
+- [init](css/init.scss) - Stylesheet containing default variables and a set of helpers mixins
+
+### Distributable
+**QuidPHP/Navigation** contains 2 scripts that can be used in the browser.
+- [navigation](dist/navigation.js) - Minified and transpiled script ready for production
+- [navigation-test](dist/navigation-test.js) - Same as navigation.js but also contains the module tests
+
+### Testing
+**QuidPHP/Navigation** contains 2 test scripts:
+- [navigation](test/navigation.js) - Script to test the navigation module
+- [run](test/run.js) - File to run the testsuite in navigation
+
+**QuidPHP/Navigation** testsuite can be run in the browser by creating a new [QuidPHP/Assert](https://github.com/quidphp/assert) project. Some tests can also be run in Node with the command: 
+``` bash
+$ npm run test
+```

src/doc.js

 /*
  * This file is part of the QuidPHP package <https://quidphp.com>
  * Author: Pierre-Philippe Emond <[e-mail]>
- * License: https://github.com/quidphp/front/blob/master/LICENSE
+ * License: https://github.com/quidphp/navigation/blob/master/LICENSE
  */
@@ -6,0 +6,0 @@

src/history.js

 /*
  * This file is part of the QuidPHP package <https://quidphp.com>
  * Author: Pierre-Philippe Emond <[e-mail]>
- * License: https://github.com/quidphp/front/blob/master/LICENSE
+ * License: https://github.com/quidphp/navigation/blob/master/LICENSE
  */
@@ -6,0 +6,0 @@

src/windowUnload.js

 /*
  * This file is part of the QuidPHP package <https://quidphp.com>
  * Author: Pierre-Philippe Emond <[e-mail]>
- * License: https://github.com/quidphp/front/blob/master/LICENSE
+ * License: https://github.com/quidphp/navigation/blob/master/LICENSE
  */
@@ -6,0 +6,0 @@

test/navigation.js

 /*
  * This file is part of the QuidPHP package <https://quidphp.com>
  * Author: Pierre-Philippe Emond <[e-mail]>
- * License: https://github.com/quidphp/browser/blob/master/LICENSE
+ * License: https://github.com/quidphp/navigation/blob/master/LICENSE
  */
@@ -6,0 +6,0 @@

test/run.js

 /*
  * This file is part of the QuidPHP package <https://quidphp.com>
  * Author: Pierre-Philippe Emond <[e-mail]>
- * License: https://github.com/quidphp/browser/blob/master/LICENSE
+ * License: https://github.com/quidphp/navigation/blob/master/LICENSE
  */
@@ -6,0 +6,0 @@

No alert changes

Improved metrics

Total package byte prevSize

228367

increased by0.85%

Dependency count

1

decreased by-50%

Number of lines in readme file

58

increased by286.67%

Dependency changes

• - Removedquidphp-javascript@5.31.*