## SipaPage SipaPage Tool class with page loader with included router * [SipaPage](#SipaPage) * [.config](#SipaPage.config) : SipaPage.Config * [.load(page_id, options)](#SipaPage.load) * [.extractIdOfTemplate(template, options)](#SipaPage.extractIdOfTemplate) → string * [.getClassNameOfTemplate(template, options)](#SipaPage.getClassNameOfTemplate) → string * [.typeOptions(type)](#SipaPage.typeOptions) → TypeOptionsType * [.currentPageId()](#SipaPage.currentPageId) → string * [.currentPageClass()](#SipaPage.currentPageClass) → SipaBasicView * [.currentLayoutId()](#SipaPage.currentLayoutId) → string * [.loadLayout(layout_id, options)](#SipaPage.loadLayout) * [.callMethodOfPage(page_id, method_name, parameters)](#SipaPage.callMethodOfPage) * [.callMethodOfLayout(layout_id, method_name, parameters)](#SipaPage.callMethodOfLayout) * [.initHistoryState()](#SipaPage.initHistoryState) * [.stackHistoryState(state, replace_state)](#SipaPage.stackHistoryState) * [.setConfig(config)](#SipaPage.setConfig) * [.isInitialized()](#SipaPage.isInitialized) → boolean * [.reset()](#SipaPage.reset) * [.PageType](#SipaPage.PageType) : Object ### SipaPage.config : SipaPage.Config **Kind**: static property of [SipaPage](#SipaPage) ### SipaPage.load(page_id, options) Load given page by page_id | Param | Type | Default | Description | | --- | --- | --- | --- | | page_id | string | | to load | | options | Object | | | | options.layout_id | string | | specify custom layout, overwrite default layout | | options.force_load | boolean | false | force to load the page again, even if it is already loaded | | options.fade_effect | boolean | true | use fade effect for the page container | | options.stack_page | boolean | true | stack page in page history | | options.params | Object | | parameters to be set at the new page | | options.keep_params | boolean | true | keep parameters when loading other page | | options.anchor | string | | anchor to be set at the new page | | options.keep_anchor | boolean | false | keep current anchor when loading other page | | options.remove_params | Array.<String> | | parameters to be removed at the new page | | options.success | function | | function to be called after successful loading | | options.error | function | | function to be called after loading fails | | options.always | function | | function to be called always after successful/erroneous loading | **Example** ```js SipaPage.load('home', { layout_id: 'default', // optional, default layout is used if not given force_load: false, // optional, default false fade_effect: true, // optional, default true stack_page: true, // optional, default true params: { lang: 'de' }, // optional, default null keep_params: true, // optional, default true success: (data, text, response) => { console.log("page loaded successfully"); }, error: (response, text, data) => { console.error("error loading page"); }, always: (data, text, response) => { console.log("page load finished"); } }); ``` ### SipaPage.extractIdOfTemplate(template, options) → string Get the id only of the given template. **Returns**: string - absolute path | Param | Type | Default | Description | | --- | --- | --- | --- | | template | string | | id or path of page or layout | | options | Object | | | | options.type | [PageType](#SipaPage.PageType) | 'page' | | **Example** ```js SipaPage.extractIdOfTemplate('views/pages/home/home.html'); // => 'home' SipaPage.extractIdOfTemplate('views/pages/home'); // => 'home' SipaPage.extractIdOfTemplate('views/pages/some/nested/nested.html'); // => 'some/nested' ``` ### SipaPage.getClassNameOfTemplate(template, options) → string Get the class name of the given template. **Returns**: string - class name | Param | Type | Default | Description | | --- | --- | --- | --- | | template | string | | id or path of page or layout | | options | Object | | | | options.type | [PageType](#SipaPage.PageType) | 'page' | | **Example** ```js SipaPage.getClassNameOfTemplate('views/pages/home/home.html'); // => 'HomePage' SipaPage.getClassNameOfTemplate('views/pages/home'); // => 'HomePage' SipaPage.getClassNameOfTemplate('views/pages/some/nested/nested.html'); // => 'SomeNestedPage' ``` ### SipaPage.typeOptions(type) → TypeOptionsType Get the options of the given type. **Returns**: TypeOptionsType - type options | Param | Type | | --- | --- | | type | [PageType](#SipaPage.PageType) | **Example** ```js SipaPage.typeOptions('page') // => { prefix: 'views/pages/', file_ext: '.html' } SipaPage.typeOptions('layout') // => { prefix: 'views/layouts/', file_ext: '.html' } ``` ### SipaPage.currentPageId() → string Get page id of current loaded page. **Returns**: string - page id **Example** ```js // 'views/pages/home/home.html' is loaded SipaPage.currentPageId() // => 'home' // 'views/pages/some/nested/nested.html' is loaded SipaPage.currentPageId() // => 'some/nested' ``` ### SipaPage.currentPageClass() → SipaBasicView Get current page class. **Example** ```js // 'views/pages/home/home.html' is loaded SipaPage.currentPageClass() // => HomePage // 'views/pages/some/nested/nested.html' is loaded SipaPage.currentPageClass() // => SomeNestedPage ``` ### SipaPage.currentLayoutId() → string Get layout id of current loaded layout. **Example** ```js // 'views/layouts/default/default.html' is loaded SipaPage.currentLayoutId() // => 'default' // 'views/layouts/mini-dialog/mini-dialog.html' is loaded SipaPage.currentLayoutId() // => 'mini-dialog' ``` ### SipaPage.loadLayout(layout_id, options) Load the given layout. | Param | Type | Default | Description | | --- | --- | --- | --- | | layout_id | string | | to load | | options | Object | | | | options.fade_effect | boolean | true | fade effect on layout change | | options.keep_page | boolean | false | keep the loaded page, but change the layout only | **Example** ```js SipaPage.loadLayout('default', { fade_effect: true, // optional, default true success: (data, text, response) => { console.log("layout loaded successfully"); }, error: (response, text, data) => { console.error("error loading layout"); }, always: (data, text, response) => { console.log("layout load finished"); } }); ``` ### SipaPage.callMethodOfPage(page_id, method_name, parameters) Call the given method of the given page with given (optional) parameters. | Param | Type | | --- | --- | | page_id | string | | method_name | string | | parameters | Array | **Example** ```js class HomePage extends SipaBasicView { static someMethod(param1, param2) { console.log("someMethod called with", param1, param2); } } SipaPage.callMethodOfPage('home', 'someMethod', ['hello', 42]); // => "someMethod called with hello 42" ``` ### SipaPage.callMethodOfLayout(layout_id, method_name, parameters) Call the given method of the given layout with given (optional) parameters. | Param | Type | | --- | --- | | layout_id | string | | method_name | string | | parameters | Array | **Example** ```js class DefaultLayout extends SipaBasicView { static someMethod(param1, param2) { console.log("someMethod called with", param1, param2); } } SipaPage.callMethodOfLayout('default', 'someMethod', ['hello', 42]); // => "someMethod called with hello 42" ``` ### SipaPage.initHistoryState() Initialize the router for single page app browser history. This method is called automatically when setting the config of SipaPage. ### SipaPage.stackHistoryState(state, replace_state) Stack the current page and layout state to the browser history. | Param | Type | Default | | --- | --- | --- | | state | Object | | | state.page_id | string | | | state.layout_id | string | | | state.options | Object | | | replace_state | boolean | false | **Example** ```js SipaPage.stackHistoryState({ page_id: 'home', layout_id: 'default', options: { fade_effect: true, stack_page: true } }); ``` ### SipaPage.setConfig(config) Set the configuration of pages and layouts | Param | Type | | --- | --- | | config | SipaPage.Config | **Example** ```js SipaPage.setConfig({ // default layout for all pages default_layout: 'default', // specific layouts for some pages { : } default_layouts: { // overwrites the layout for the page 'login-page' with layout 'mini-dialog' 'login-page': 'mini-dialog' } }); ``` ### SipaPage.isInitialized() → boolean Check if SipaPage was initialized with a config. ### SipaPage.reset() Reset all states Useful for unit testing ### SipaPage.PageType : Object Custom type definitions for excellent IDE auto complete support | Param | Type | | --- | --- | | default_layout | string | | default_layouts | Object | | keep_anchor | boolean | **Properties** | Name | Type | | --- | --- | | prefix | string | | file_ext | string |