Skip to content

RyanEaves/DynamicLoadJS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 

Repository files navigation

Parameters

  • DynamicElementSelector
    • Default: #dynamicContent
    • Description: Used to specify the name of the container that will be swapped on dynamic load
  • SkipDynamicLoadSelector
    • Default: .SkipDynamicLoad
    • Description: Used to specify elements that will not be hijacked to perform a dynamic load
  • UseAPI
    • Default: true
    • Description: Identify whether requests will be made to a REST API or plain old pages
  • APIUrlSalt
    • Default: /api/contentfilter/
    • Description: Defines the change to the URL made to made a REST API request rather than a full page request.
    • Example: /api/contentfilter/ == http://www.yourdomain.com/api/contentfilter/pageid
  • HttpHeaderNameDynamicElementSelector
    • Default: X-DynamicLoad-Element-Selector
    • Description: Define the HTTP header used to send the value of DynamicElementSelector to the REST API
  • HttpHeaderNamePageTitle
    • Default: X-Page-Title
    • Description: Define the HTTP header used by the REST API to send the page title back to DynamicLoadJS
  • CallbackBeforeLoad
    • Default: null
    • Parameters:
      • Url: The path portion of the requested url
    • Description: Define a function to callback before a dynamic load request is made for content
  • CallbackAfterContentInject
  • Default null
  • Parameters:
    • Url: The path portion of the requested url
    • $oldContainer: A jQuery object of the old container that will be replaced
    • $newContainer: A jQuery object of the new container that will replace the old container
    • callback: This is a reference to callback to dynamicLoadJS. This must be executed when the transition is complete.
      • Example: callback();
  • Description: Use to allow the complate control of the transition. In this event
  • CallbackAfterLoadSuccess
    • Default: null
    • Parameters:
      • Url: The path portion of the requested url
    • Description: Define a function to callback after a dynamic load request is successfully made for content
  • CallbackAfterLoadFail
    • Default: null
    • Parameters:
      • Url: The path portion of the requested url
    • Description: Define a function to callback after a dynamic load request is made for content, but fails
  • CallbackAfterLoadAlways
    • Default: null
    • Parameters:
      • Url: The path portion of the requested url
    • Description: Define a function to callback after a dynamic load request is made for content, regardless of success

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published