rizzo-next

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../../"> <title data-ice="title">src/core/component.js | API Document</title> <link type="text/css" rel="stylesheet" href="css/style.css"> <link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css"> <script src="script/prettify/prettify.js"></script> <script src="script/manual.js"></script> <link data-ice="userStyle" rel="stylesheet" href="user/css/0-docs.css"> </head> <body class="layout-container" data-ice="rootContainer"> <header> <a href="./">Home</a> <a href="identifiers.html">Reference</a> <a href="source.html">Source</a> <a href="test.html" data-ice="testLink">Test</a> <a data-ice="repoURL" href="https://github.com/lonelyplanet/rizzo-next.git" class="repo-url-github">Repository</a> <div class="search-box"> <img src="./image/search.png"> <input class="search-input"> <ul class="search-result"></ul> </div> </header> <nav class="navigation" data-ice="nav"><div> <ul> <li data-ice="doc">V<a href="variable/index.html#static-variable-rizzo">rizzo</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/action_sheet</div>C<a href="class/src/components/action_sheet/index.js~ActionSheetComponent.html">ActionSheetComponent</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-actionSheetComponent">actionSheetComponent</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/article_body</div>C<a href="class/src/components/article_body/index.js~ArticleBodyComponent.html">ArticleBodyComponent</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/articles</div>C<a href="class/src/components/articles/index.js~ArticlesComponent.html">ArticlesComponent</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-articlesComponent">articlesComponent</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/footer</div>C<a href="class/src/components/footer/footer_component.js~Footer.html">Footer</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-footer">footer</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/header</div>C<a href="class/src/components/header/header_component.js~Header.html">Header</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-header">header</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/hotels</div>C<a href="class/src/components/hotels/hotels_widget.js~HotelsWidget.html">HotelsWidget</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-hotelsWidget">hotelsWidget</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/image_gallery</div>C<a href="class/src/components/image_gallery/image_gallery.js~ImageGalleryComponent.html">ImageGalleryComponent</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/login</div>C<a href="class/src/components/login/login_manager.js~LoginManager.html">LoginManager</a></li> <li data-ice="doc">C<a href="class/src/components/login/user.js~User.html">User</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/map</div>C<a href="class/src/components/map/interactive-map.js~InteractiveMap.html">InteractiveMap</a></li> <li data-ice="doc">C<a href="class/src/components/map/map_component.js~MapComponent.html">MapComponent</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-MapActions">MapActions</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-MapAPI">MapAPI</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-interactiveMap">interactiveMap</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-mapComponent">mapComponent</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-MapState">MapState</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/map/mapbox</div>C<a href="class/src/components/map/mapbox/index.js~MapProvider.html">MapProvider</a></li> <li data-ice="doc">C<a href="class/src/components/map/mapbox/markerset.js~MarkerSet.html">MarkerSet</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-mapProvider">mapProvider</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-markerSet">markerSet</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/map/views</div>C<a href="class/src/components/map/views/about-panel.jsx~AboutPanel.html">AboutPanel</a></li> <li data-ice="doc">C<a href="class/src/components/map/views/alert.jsx~AlertView.html">AlertView</a></li> <li data-ice="doc">C<a href="class/src/components/map/views/item.jsx~ItemView.html">ItemView</a></li> <li data-ice="doc">C<a href="class/src/components/map/views/main.jsx~MainView.html">MainView</a></li> <li data-ice="doc">C<a href="class/src/components/map/views/map.jsx~MapView.html">MapView</a></li> <li data-ice="doc">C<a href="class/src/components/map/views/panel.jsx~PanelView.html">PanelView</a></li> <li data-ice="doc">C<a href="class/src/components/map/views/pin.jsx~PinView.html">PinView</a></li> <li data-ice="doc">C<a href="class/src/components/map/views/sidebar-details.jsx~SidebarDetailsView.html">SidebarDetailsView</a></li> <li data-ice="doc">C<a href="class/src/components/map/views/sidebar-dropdown.jsx~SidebarDropdown.html">SidebarDropdown</a></li> <li data-ice="doc">C<a href="class/src/components/map/views/sidebar-fetching.jsx~SidebarFetchingView.html">SidebarFetchingView</a></li> <li data-ice="doc">C<a href="class/src/components/map/views/sidebar.jsx~SidebarView.html">SidebarView</a></li> <li data-ice="doc">C<a href="class/src/components/map/views/tab.jsx~TabView.html">TabView</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/masthead</div>C<a href="class/src/components/masthead/masthead_component.js~MastheadComponent.html">MastheadComponent</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/navigation</div>C<a href="class/src/components/navigation/navigation_component.js~NavigationComponent.html">NavigationComponent</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-NavigationActions">NavigationActions</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-navigationComponent">navigationComponent</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-NavigationState">NavigationState</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/notification</div>C<a href="class/src/components/notification/notification.js~Notification.html">Notification</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-notification">notification</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/overlay</div>C<a href="class/src/components/overlay/index.js~Overlay.html">Overlay</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-overlay">overlay</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/related_guidebook</div>C<a href="class/src/components/related_guidebook/index.js~RelatedGuidebookComponent.html">RelatedGuidebookComponent</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-relatedGuidebookComponent">relatedGuidebookComponent</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/search</div>C<a href="class/src/components/search/search_component.js~SearchComponent.html">SearchComponent</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-SearchActions">SearchActions</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-SearchApi">SearchApi</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-searchComponent">searchComponent</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-SearchServerActions">SearchServerActions</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-SearchState">SearchState</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/search/search_item</div>C<a href="class/src/components/search/search_item/index.js~SearchItemComponent.html">SearchItemComponent</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-searchItemComponent">searchItemComponent</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/slideshow</div>C<a href="class/src/components/slideshow/slide_component.js~SlideComponent.html">SlideComponent</a></li> <li data-ice="doc">C<a href="class/src/components/slideshow/slideshow.js~Slideshow.html">Slideshow</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-slideComponent">slideComponent</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/stacks</div>C<a href="class/src/components/stacks/stack_component.js~Stack.html">Stack</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-StackActions">StackActions</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-stack">stack</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-StackState">StackState</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/sub_nav</div>C<a href="class/src/components/sub_nav/index.js~SubNav.html">SubNav</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/tabs</div>C<a href="class/src/components/tabs/tabs_component.js~Tabs.html">Tabs</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/things_to_do</div>C<a href="class/src/components/things_to_do/things_to_do.js~ThingsToDo.html">ThingsToDo</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-thingsToDo">thingsToDo</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/tooltip</div>C<a href="class/src/components/tooltip/tooltip.js~Tooltip.html">Tooltip</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-tooltip">tooltip</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/top_places</div>C<a href="class/src/components/top_places/top_places_component.js~TopPlaces.html">TopPlaces</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-topPlaces">topPlaces</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/tours</div>C<a href="class/src/components/tours/index.js~ToursComponent.html">ToursComponent</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-toursComponent">toursComponent</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/usabilla</div>C<a href="class/src/components/usabilla/index.js~Usabilla.html">Usabilla</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-usabilla">usabilla</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">components/video</div>C<a href="class/src/components/video/brightcove.js~Brightcove.html">Brightcove</a></li> <li data-ice="doc">C<a href="class/src/components/video/index.js~Video.html">Video</a></li> <li data-ice="doc">C<a href="class/src/components/video/video_player.js~VideoPlayer.html">VideoPlayer</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-brightcove">brightcove</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-video">video</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-videoPlayer">videoPlayer</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">core</div>C<a href="class/src/core/component.js~Component.html">Component</a></li> <li data-ice="doc">C<a href="class/src/core/component_registry.js~ComponentRegistry.html">ComponentRegistry</a></li> <li data-ice="doc">C<a href="class/src/core/cookie_util.js~CookieUtil.html">CookieUtil</a></li> <li data-ice="doc">C<a href="class/src/core/logger.js~Logger.html">Logger</a></li> <li data-ice="doc">C<a href="class/src/core/mobile_util.js~MobileUtil.html">MobileUtil</a></li> <li data-ice="doc">C<a href="class/src/core/perf_monitor.js~PerfMonitor.html">PerfMonitor</a></li> <li data-ice="doc">C<a href="class/src/core/rizzo.js~Rizzo.html">Rizzo</a></li> <li data-ice="doc">C<a href="class/src/core/shop_cookie_util.js~ShopCookieUtil.html">ShopCookieUtil</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-Arkham">Arkham</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-mobileUtil">mobileUtil</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-shopCookieUtil">shopCookieUtil</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">core/decorators</div>F<a href="function/index.html#static-function-channel">channel</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-publish">publish</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-subscribe">subscribe</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">core/mixins</div>V<a href="variable/index.html#static-variable-Events">Events</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">core/utils</div>F<a href="function/index.html#static-function-highlight">highlight</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-getScrollbarWidth">getScrollbarWidth</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-mark">mark</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-measure">measure</a></li> </ul> </div> </nav> <div class="content" data-ice="content"><h1 data-ice="title">src/core/component.js</h1> <pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">import $ from "jquery"; import Events from "./mixins/events"; import assign from "lodash/object/assign"; import pick from "lodash/object/pick"; import bind from "lodash/function/bind"; import each from "lodash/collection/each"; import uniqueId from "lodash/utility/uniqueId"; import postal from "postal/lib/postal.lodash"; // Can pass in options that contains these keys. They will automatically be added to `this` let listOfOptions = [ "el", "events", "container" ]; // Regex for the "click .foo .bar" in the events let delegateEventSplitter = /^(\S+)\s*(.*)$/; /** * The main class that will be extended when a new componenet is created. * Extend this class with es6 syntax. * @example * import { Component } from "./core/bane" * * class ArticlesComponent extends Component { * initialize() { * this.events = { * "click .foo": "fooClicked" * } * } * render() { * //... * } * fooClicked() { * //... * } * } */ export default class Component { /** * Constructs a component * @param {[Options]} options An options object * @param {Element} options.el An element to attatch this component to * @param {Object} options.events A key value pair of events */ constructor(options) { this.cid = uniqueId("comp"); this.channel = "components"; // Assign things from the passed in options to `this` assign(this, pick(options, listOfOptions)); this._ensureElement(); this.initialize.apply(this, arguments); this._delegateEvents(); } initialize() { // Overwrite the initialize method in your component for initial setup } /** * Override this method with custom rendering logic * @return {Object} Instance of the component */ render() { // Overwrite me with awesomesauce return this; } /** * This method actually builds the template and inserts the HTML into the DOM * @param {Object} data The data to pass to a template function * @return {jQuery} Returns the element */ build(data) { if (this.el) { return this.$el.html(typeof this.template === "function" ? this.template(data) : this.template); } } /** * Pull data off of a custom data attribute `data-lp-initial-abc`. * This allows for server side JSON data to be embeded in the document. * @example <caption>HTML</caption> * <div data-lp-initial-cards="{{cards}}"></div> * * @example <caption>JavaScript</caption> * let state = this.getInitialState(); * state.cards; // { cards: ... } * * @return {Object} The parsed JSON data */ getInitialState() { if (this.__initialState__) { return this.__initialState__; } let state = this.__initialState__ = {}; each(this.$el.data(), (val, key) => { if (key.indexOf("lpInitial") > -1) { let parsed = null; // No...no... please god no... nooooooooooooo. try { if (val.source) { let tmp = []; each(val.source, function(str) { tmp.push(JSON.parse(str)); }); val = tmp; } parsed = JSON.parse(val); } catch (e) { parsed = val; } let cleanKey = key.replace("lpInitial", "").toLowerCase(); state[cleanKey] = parsed; this.$el.removeAttr(`data-lp-initial-${cleanKey}`); } }); return state; } /** * Allows you to delegate events to the element the component is attached to. In the `initialize` method of your * component, simply add an `events` object to `this * @example * initialize() { * this.events = { * "click": "someMethod", * "click .button": "anotherMethod" * } * } */ _delegateEvents(events) { if (!(events || (events = this.events))) { return this; } this._undelegateEvents(); for (let key in events) { let method = events[key]; if (typeof method !== "function") { method = this[events[key]]; } if (!method) { continue; } let match = key.match(delegateEventSplitter); let eventName = match[1], selector = match[2]; method = bind(method, this); eventName += ".delegateEvents" + this.cid; if (selector === "") { this.$el.on(eventName, method); } else { this.$el.on(eventName, selector, method); } } return this; } /** * Turns off event delegation for the component * @return {Object} The component instance */ _undelegateEvents() { this.$el.off(".delegateEvents" + this.cid); return this; } // Wraps `this.el` with jQuery _ensureElement() { if (this.el) { this.$el = $(this.el); } else { this.$el = $("<div/>"); this.el = this.$el[0]; } this.$el.addClass("lp-component") .data("lpComponent", this); } /** * Publish an event on the `components` channel * @param {String} topic Topic to publish * @param {Object} data Data to publish on the channel */ publish(topic, data) { postal.channel("components").publish(topic, data); } } assign(Component.prototype, Events); </code></pre> </div> <footer class="footer"> Generated by <a href="https://esdoc.org">ESDoc(0.4.3)</a> </footer> <script src="script/search_index.js"></script> <script src="script/search.js"></script> <script src="script/pretty-print.js"></script> <script src="script/inherited-summary.js"></script> <script src="script/test-summary.js"></script> <script src="script/inner-link.js"></script> <script src="script/patch-for-local.js"></script> </body> </html>