Table of contents
The package is deprecated
The package has been moved. Please use @adobe/aem-spa-model-manager
Installation
npm install @adobe/cq-spa-page-model-manager
Usage
This module provides the API to manage the model representation of the pages that are composing a SPA.
// index.html
<head>
...
<meta property="cq:pagemodel_root_url" content="... .model.json"/>
...
</head>
...
// Bootstrap: index.js
import { ModelManager } from '@adobe/cq-spa-page-model-manager';
ModelManager.initialize().then((model) => {
// Render the App content using the provided model
render(model);
});
// Loading a specific portion of model
ModelManager.getData("/content/site/page/jcr:content/path/to/component").then(...);
API
@adobe/cq-spa-page-model-manager 1.1.7
Documentation
The technical documentation is already available, but if you are unable to solve your problem or you found a bug you can always contact us and ask for help!
Changelog
1.1.5 - 24 August 2020
1.1.4 - 24 August 2020
- Renaming the package, please use aem-spa-page-model-manager@1.0.0
1.1.3 - 5 June 2020
- Support Launches content paths
1.1.2 - 19 May 2020
- Do not fetch excluded routes on model manager initialization
1.1.1 - 17 January 2020
- Fixed:
- Page crashes on link containing query parameter without html extension
1.1.0 - 19 December 2019
- Improve URL sanitizing behavior for
model.jsonrequests - Make
clonea dependency instead of a peer dependency - Remove optional dependencies
1.0.7 - 4 April 2019
- no functional changes
1.0.6 - 6 March 2019
- ModelManager#initialze to consistently return the same type of object
- ModelManager#initialze to fire a cq-pagemodel-loaded event
1.0.5 - 12 December 2018
- ModelClient fetch: added default credentials for the request
1.0.4 - 9 November 2018
- support path ending the jcr:content when getting the data from the ModelStore
1.0.3 - 11 October 2018
- Un-found remote model entry point rejection handling
- README update
1.0.1 - 28 September 2018
- BREAKING CHANGE API refactoring for a better modularization
-
BREAKING CHANGE SSR refactoring
- Added support for setting apiHost, in order to force absolute url requests on Node server
- Added support for initializing with an existing model. This is useful when we initialize in the client, the state from the server.
- Guarding for dispatching & listening events only in browser context.
- Fixed race conditions with
initmethod when called fromgetData
Removed
- unnecessary and misleading event triggering resulting in the Page Editor not to have overlays
0.0.24 - 22 June 2018
Public release of cq-spa-page-model-manager, which provides:
- support for context path
- BREAKING CHANGE change routing method to support History API by default (hash routing support has been removed)
0.0.23 - 15 May 2018
Public release of cq-spa-page-model-manager, which provides:
- Support for the latest version of the
com.adobe.cq.export.json.hierarchyAPI- Support and usage of the
:pathand:childrenfields to identify a page and its child pages
- Support and usage of the
- Support for URLs containing a context path
- The
PageModelManagercan now be used in conjunction with URLs including a context path
- The
0.0.22 - 20 April 2018
Initial public release of cq-spa-page-model-manager, which provides:
- Updated
PageModelManagerAPI, now able to manage the model of multiple pages stored in AEM:-
getData(),addListeners()andremoveListeners()expect a config parameter that specifies thepagePathanddataPath -
getData()supports aforceReloadparameter -
cq-pagemodel-updateevent listener expectspagePathanddataPathin the event data object
-
- New
ModelRouter, which reacts to hash changes and triggers the reload of the corresponding model asynchronously-
cq-pagemodel-route-changedevent indicates route changes after successful model update
-