diff --git a/README.md b/README.md index a649779c58..4da51767d5 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,15 @@ Framework! ## Events -__navbegin__: The user clicked an internal webapp link, which triggers this event before the next page is either requested or retrieved from the cache. +### Page Events -__pageshow__: A page has been requested by the user, the new page was received from the server or cache, it has been placed into the DOM, and the page transition has completed, and the old page was removed from the DOM. +Page events happen in the order shown and described below: + + 1. __pageinit__: The user clicked an internal webapp link, which triggers this event before the next page to show is either requested from the server or retrieved from the cache. + 2. __pageload__: The new page to show the user has already been received from the server or cache, and has been placed into the DOM. However, it has not started or ended the page transition, it is not being shown to the user, and the old page it's replacing is still being shown to the user. + 3. __pageshow__: The new page to show the user has already been received from the server or cache, it has been placed into the DOM, the page transition has completed, and the old page has been removed from the DOM. + + +### WebApp Events __ready__: The DOM is ready.