| 1 | {"name":"aurelia-history-browser","children":[{"id":29,"name":"BrowserHistory","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"An implementation of the basic history API."},"children":[{"id":31,"name":"constructor","kind":512,"kindString":"Constructor","flags":{"isExported":true},"comment":{"shortText":"Creates an instance of BrowserHistory"},"signatures":[{"id":32,"name":"new BrowserHistory","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"shortText":"Creates an instance of BrowserHistory"},"parameters":[{"id":33,"name":"linkHandler","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"An instance of LinkHandler.\n"},"type":{"type":"reference","name":"LinkHandler","id":6}}],"type":{"type":"reference","name":"BrowserHistory","id":29}}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":109,"character":21}]},{"id":30,"name":"inject","kind":1024,"kindString":"Property","flags":{"isStatic":true,"isExported":true},"sources":[{"fileName":"aurelia-history-browser.d.ts","line":109,"character":15}],"type":{"type":"instrinct","name":"any"}},{"id":34,"name":"activate","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":35,"name":"activate","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Activates the history object.","returns":"Whether or not activation occurred.\n"},"parameters":[{"id":36,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The set of options to activate history with."},"type":{"type":"reference","name":"Object"}}],"type":{"type":"instrinct","name":"boolean"},"overwrites":{"type":"reference","name":"History.activate"}}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":122,"character":10}],"overwrites":{"type":"reference","name":"History.activate"}},{"id":37,"name":"deactivate","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":38,"name":"deactivate","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Deactivates the history object."},"type":{"type":"instrinct","name":"void"},"overwrites":{"type":"reference","name":"History.deactivate"}}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":127,"character":12}],"overwrites":{"type":"reference","name":"History.deactivate"}},{"id":39,"name":"getAbsoluteRoot","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":40,"name":"getAbsoluteRoot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the fully-qualified root of the current history object.","returns":"The absolute root of the application.\n"},"type":{"type":"instrinct","name":"string"},"overwrites":{"type":"reference","name":"History.getAbsoluteRoot"}}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":133,"character":17}],"overwrites":{"type":"reference","name":"History.getAbsoluteRoot"}},{"id":60,"name":"getHistoryIndex","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":61,"name":"getHistoryIndex","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the current index in the navigation history.","returns":"The current index.\n"},"type":{"type":"instrinct","name":"number"},"overwrites":{"type":"reference","name":"History.getHistoryIndex"}}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":178,"character":17}],"overwrites":{"type":"reference","name":"History.getHistoryIndex"}},{"id":57,"name":"getState","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":58,"name":"getState","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets a key in the history page state.","returns":"The value for the key.\n"},"parameters":[{"id":59,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The key for the value."},"type":{"type":"instrinct","name":"string"}}],"type":{"type":"instrinct","name":"any"},"overwrites":{"type":"reference","name":"History.getState"}}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":172,"character":10}],"overwrites":{"type":"reference","name":"History.getState"}},{"id":62,"name":"go","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":63,"name":"go","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Move to a specific position in the navigation history."},"parameters":[{"id":64,"name":"movement","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The amount of steps, positive or negative, to move.\n"},"type":{"type":"instrinct","name":"number"}}],"type":{"type":"instrinct","name":"void"},"overwrites":{"type":"reference","name":"History.go"}}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":184,"character":4}],"overwrites":{"type":"reference","name":"History.go"}},{"id":41,"name":"navigate","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":42,"name":"navigate","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Causes a history navigation to occur.","returns":"Promise if triggering navigation, otherwise true/false indicating if navigation occurred.\n"},"parameters":[{"id":43,"name":"fragment","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The history fragment to navigate to."},"type":{"type":"instrinct","name":"string"}},{"id":44,"name":"__namedParameters","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"originalName":"__1","type":{"type":"reflection","declaration":{"id":45,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":47,"name":"replace","kind":32,"kindString":"Variable","flags":{},"sources":[{"fileName":"aurelia-history-browser.d.ts","line":144,"character":11}],"type":{"type":"instrinct","name":"any"}},{"id":46,"name":"trigger","kind":32,"kindString":"Variable","flags":{},"sources":[{"fileName":"aurelia-history-browser.d.ts","line":143,"character":11}],"type":{"type":"instrinct","name":"any"}}],"groups":[{"title":"Variables","kind":32,"children":[47,46]}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":142,"character":29}]}}}],"type":{"type":"instrinct","name":"boolean"},"overwrites":{"type":"reference","name":"History.navigate"}}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":142,"character":10}],"overwrites":{"type":"reference","name":"History.navigate"}},{"id":48,"name":"navigateBack","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":49,"name":"navigateBack","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Causes the history state to navigate back."},"type":{"type":"instrinct","name":"void"},"overwrites":{"type":"reference","name":"History.navigateBack"}}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":153,"character":14}],"overwrites":{"type":"reference","name":"History.navigateBack"}},{"id":53,"name":"setState","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":54,"name":"setState","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets a key in the history page state."},"parameters":[{"id":55,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The key for the value."},"type":{"type":"instrinct","name":"string"}},{"id":56,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to set.\n"},"type":{"type":"instrinct","name":"any"}}],"type":{"type":"instrinct","name":"void"},"overwrites":{"type":"reference","name":"History.setState"}}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":165,"character":10}],"overwrites":{"type":"reference","name":"History.setState"}},{"id":50,"name":"setTitle","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":51,"name":"setTitle","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the document title."},"parameters":[{"id":52,"name":"title","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"instrinct","name":"string"}}],"type":{"type":"instrinct","name":"void"},"overwrites":{"type":"reference","name":"History.setTitle"}}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":158,"character":10}],"overwrites":{"type":"reference","name":"History.setTitle"}}],"groups":[{"title":"Constructors","kind":512,"children":[31]},{"title":"Properties","kind":1024,"children":[30]},{"title":"Methods","kind":2048,"children":[34,37,39,60,57,62,41,48,53,50]}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":108,"character":35}],"extendedTypes":[{"type":"reference","name":"History"}]},{"id":12,"name":"DefaultLinkHandler","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The default LinkHandler implementation. Navigations are triggered by click events on\nanchor elements with relative hrefs when the history instance is using pushstate."},"children":[{"id":13,"name":"constructor","kind":512,"kindString":"Constructor","flags":{"isExported":true},"comment":{"shortText":"Creates an instance of DefaultLinkHandler."},"signatures":[{"id":14,"name":"new DefaultLinkHandler","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"shortText":"Creates an instance of DefaultLinkHandler."},"type":{"type":"reference","name":"DefaultLinkHandler","id":12}}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":56,"character":61}]},{"id":15,"name":"activate","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":16,"name":"activate","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Activate the instance."},"parameters":[{"id":17,"name":"history","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The BrowserHistory instance that navigations should be dispatched to.\n"},"type":{"type":"reference","name":"BrowserHistory","id":29}}],"type":{"type":"instrinct","name":"void"},"overwrites":{"type":"reference","name":"LinkHandler.activate","id":7}}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":68,"character":10}],"overwrites":{"type":"reference","name":"LinkHandler.activate","id":7}},{"id":18,"name":"deactivate","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":19,"name":"deactivate","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Deactivate the instance. Event handlers and other resources should be cleaned up here."},"type":{"type":"instrinct","name":"void"},"overwrites":{"type":"reference","name":"LinkHandler.deactivate","id":10}}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":73,"character":12}],"overwrites":{"type":"reference","name":"LinkHandler.deactivate","id":10}},{"id":23,"name":"findClosestAnchor","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":24,"name":"findClosestAnchor","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Finds the closest ancestor that's an anchor element.","returns":"The link element that is the closest ancestor.\n"},"parameters":[{"id":25,"name":"el","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The element to search upward from."},"type":{"type":"reference","name":"Element"}}],"type":{"type":"reference","name":"Element"}}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":88,"character":26}]},{"id":20,"name":"getEventInfo","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":21,"name":"getEventInfo","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the href and a \"should handle\" recommendation, given an Event."},"parameters":[{"id":22,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The Event to inspect for target anchor and href.\n"},"type":{"type":"reference","name":"Event"}}],"type":{"type":"reference","name":"AnchorEventInfo","id":2}}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":80,"character":21}]},{"id":26,"name":"targetIsThisWindow","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":27,"name":"targetIsThisWindow","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets a value indicating whether or not an anchor targets the current window.","returns":"True if the target of the link element is this window; false otherwise.\n"},"parameters":[{"id":28,"name":"target","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The anchor element whose target should be inspected."},"type":{"type":"reference","name":"Element"}}],"type":{"type":"instrinct","name":"boolean"}}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":96,"character":27}]}],"groups":[{"title":"Constructors","kind":512,"children":[13]},{"title":"Methods","kind":2048,"children":[15,18,23,20,26]}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":56,"character":39}],"extendedTypes":[{"type":"reference","name":"LinkHandler","id":6}]},{"id":6,"name":"LinkHandler","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"Class responsible for handling interactions that should trigger browser history navigations."},"children":[{"id":7,"name":"activate","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":8,"name":"activate","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Activate the instance."},"parameters":[{"id":9,"name":"history","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The BrowserHistory instance that navigations should be dispatched to.\n"},"type":{"type":"reference","name":"BrowserHistory","id":29}}],"type":{"type":"instrinct","name":"void"}}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":40,"character":10}]},{"id":10,"name":"deactivate","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":11,"name":"deactivate","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Deactivate the instance. Event handlers and other resources should be cleaned up here."},"type":{"type":"instrinct","name":"void"}}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":45,"character":12}]}],"groups":[{"title":"Methods","kind":2048,"children":[7,10]}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":33,"character":32}],"extendedBy":[{"type":"reference","name":"DefaultLinkHandler","id":12}]},{"id":2,"name":"AnchorEventInfo","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Provides information about how to handle an anchor event."},"children":[{"id":5,"name":"anchor","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The anchor element or null if not-applicable."},"sources":[{"fileName":"aurelia-history-browser.d.ts","line":27,"character":8}],"type":{"type":"reference","name":"Element"}},{"id":4,"name":"href","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The href of the link or null if not-applicable."},"sources":[{"fileName":"aurelia-history-browser.d.ts","line":22,"character":6}],"type":{"type":"instrinct","name":"string"}},{"id":3,"name":"shouldHandleEvent","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Indicates whether the event should be handled or not."},"sources":[{"fileName":"aurelia-history-browser.d.ts","line":17,"character":19}],"type":{"type":"instrinct","name":"boolean"}}],"groups":[{"title":"Properties","kind":1024,"children":[5,4,3]}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":12,"character":40}]},{"id":65,"name":"configure","kind":64,"kindString":"Function","flags":{"isExported":true},"signatures":[{"id":66,"name":"configure","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Configures the plugin by registering BrowserHistory as the implementation of History in the DI container."},"parameters":[{"id":67,"name":"config","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The FrameworkConfiguration object provided by Aurelia.\n"},"type":{"type":"reference","name":"Object"}}],"type":{"type":"instrinct","name":"void"}}],"sources":[{"fileName":"aurelia-history-browser.d.ts","line":103,"character":33}]}],"groups":[{"title":"Classes","kind":128,"children":[29,12,6]},{"title":"Interfaces","kind":256,"children":[2]},{"title":"Functions","kind":64,"children":[65]}]} |