The file property matches where the documentation for a class is declared\nin the source files. It is set automatically.
\n",
"itemtype": "property",
"name": "file",
"type": "{string}",
"default": "''",
"class": "FountainheadClass.Meta",
"srcFileId": "addon_components_fountainhead-class_meta.js"
},
{
"file": "addon/components/fountainhead-class/meta.js",
"line": 51,
"description": "The line property matches the line where documentation for a class is\ndeclared in the source files. It is set automatically.
\n",
"itemtype": "property",
"name": "line",
"type": "{?number}",
"default": "null",
"class": "FountainheadClass.Meta",
"srcFileId": "addon_components_fountainhead-class_meta.js"
},
{
"file": "addon/components/fountainhead-class/meta.js",
"line": 43,
"description": "scrFile id is set by the data scripts. It is a snake case version of the\nfile path and should be used for calling for the file
\n",
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "srcFileId",
"type": "{string}",
"default": "''",
"class": "FountainheadClass.Meta",
"srcFileId": "addon_components_fountainhead-class_meta.js"
},
{
"file": "addon/components/fountainhead-class/meta.js",
"line": 68,
"description": "Creates meta information for a documentation class.
\n}",
"default": "['fh-class-meta']",
"class": "FountainheadClass.Meta",
"srcFileId": "addon_components_fountainhead-class_meta.js"
},
{
"file": "addon/components/fountainhead-class/meta.js",
"line": 27,
"description": "The value property is set by using the @extends tag. Any class used in\nan extends tag will be linked to.
\n",
"itemtype": "property",
"name": "extends",
"type": "{string}",
"default": "''",
"class": "FountainheadClass.Meta",
"srcFileId": "addon_components_fountainhead-class_meta.js"
},
{
"file": "addon/components/fountainhead-class/meta.js",
"line": 35,
"description": "The file property matches where the documentation for a class is declared\nin the source files. It is set automatically.
\n",
"itemtype": "property",
"name": "file",
"type": "{string}",
"default": "''",
"class": "FountainheadClass.Meta",
"srcFileId": "addon_components_fountainhead-class_meta.js"
},
{
"file": "addon/components/fountainhead-class/meta.js",
"line": 51,
"description": "The line property matches the line where documentation for a class is\ndeclared in the source files. It is set automatically.
\n",
"itemtype": "property",
"name": "line",
"type": "{?number}",
"default": "null",
"class": "FountainheadClass.Meta",
"srcFileId": "addon_components_fountainhead-class_meta.js"
},
{
"file": "addon/components/fountainhead-class/meta.js",
"line": 43,
"description": "The module property is set by using the @module tag. Any module used in\na module tag will be linked to.
\n",
"itemtype": "property",
"name": "module",
"type": "{string}",
"default": "''",
"class": "FountainheadClass.Meta",
"srcFileId": "addon_components_fountainhead-class_meta.js"
},
{
"file": "addon/components/fountainhead-class/meta.js",
"line": 59,
"description": "scrFile id is set by the data scripts. It is a snake case version of the\nfile path and should be used for calling for the file
\n",
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "srcFileId",
"type": "{string}",
"default": "''",
"class": "FountainheadClass.Meta",
"srcFileId": "addon_components_fountainhead-class_meta.js"
},
{
"file": "addon/components/fountainhead-class/meta.js",
"line": 68,
"description": "The submodule property is set by using the @submodule tag. Any submodule\nused in a submodule tag will be linked to.
\n",
"itemtype": "property",
"name": "submodule",
"type": "{string}",
"default": "''",
"class": "FountainheadClass.Meta",
"srcFileId": "addon_components_fountainhead-class_meta.js"
},
{
"file": "addon/components/fountainhead-class/meta.js",
"line": 93,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "'div'",
"class": "FountainheadClass.Meta",
"srcFileId": "addon_components_fountainhead-class_meta.js"
},
{
"file": "addon/components/fountainhead-class/meta.js",
"line": 76,
"description": "The uses array is set by using one or more @uses tags. Any class used in\na uses tag will be linked to.
\n",
"itemtype": "property",
"name": "uses",
"type": "{Array}",
"default": "[]",
"class": "FountainheadClass.Meta",
"srcFileId": "addon_components_fountainhead-class_meta.js"
}
],
"event": [],
"srcFileId": "addon_components_fountainhead-class_meta.js"
},
"FountainheadClass.PropertyLink": {
"name": "FountainheadClass.PropertyLink",
"shortname": "FountainheadClass.PropertyLink",
"classitems": [
{
"file": "addon/components/fountainhead-class/property-link.js",
"line": 30,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "FountainheadClass.PropertyLink",
"srcFileId": "addon_components_fountainhead-class_property-link.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/fountainhead-class/property-link.js",
"line": 5,
"description": "Creates the property link used in the index tab for a class. Renders either an\nanchor or button based on consuming app's location type:
\n\nHistory Location: An anchor with a href fragment matching the property name for\nthe link and an action for selecting the tab for that property. \nHash Location: Button with an action for selecting the tab for that property and\nthen calling {{c-l class='Fountainhead'}} to update id query param to match\nproperty name. \n \nIn both cases, the tab for the property must be selected first so that when the\nurl updates and the app then updates the property with the matching id is in DOM.
\nFor the anchor, this just means selecting the tab. The anchor click then bubbles\nand the browser handles scrolling to the matching id that is now in DOM b/c the\ncorrect tab has been selected.
\nFor the button, we have to manually DDAU the event. The correct tab is selected\nand query param id is then updated. The changed query param then triggers the\nclass page to scroll to the new id.
\n",
"is_constructor": 1,
"extends": "Ember.Component",
"method": [],
"property": [
{
"file": "addon/components/fountainhead-class/property-link.js",
"line": 30,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "FountainheadClass.PropertyLink",
"srcFileId": "addon_components_fountainhead-class_property-link.js"
}
],
"event": [],
"srcFileId": "addon_components_fountainhead-class_property-link.js"
},
"FountainheadPages.APIIndex": {
"name": "FountainheadPages.APIIndex",
"shortname": "FountainheadPages.APIIndex",
"classitems": [
{
"file": "addon/components/fountainhead-pages/api-index.js",
"line": 16,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "FountainheadPages.APIIndex",
"srcFileId": "addon_components_fountainhead-pages_api-index.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/fountainhead-pages/api-index.js",
"line": 5,
"description": "Fountainhead /api index page component
\n",
"is_constructor": 1,
"extends": "Ember.Component",
"method": [],
"property": [
{
"file": "addon/components/fountainhead-pages/api-index.js",
"line": 16,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "FountainheadPages.APIIndex",
"srcFileId": "addon_components_fountainhead-pages_api-index.js"
}
],
"event": [],
"srcFileId": "addon_components_fountainhead-pages_api-index.js"
},
"FountainheadPages.API": {
"name": "FountainheadPages.API",
"shortname": "FountainheadPages.API",
"classitems": [
{
"file": "addon/components/fountainhead-pages/api.js",
"line": 31,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "FountainheadPages.API",
"srcFileId": "addon_components_fountainhead-pages_api.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/fountainhead-pages/api.js",
"line": 5,
"description": "Fountainhead /api page component handles rendering the API sidebar, welcome\nmessaging and all API related subroutes including modules, classes and source\nfiles. The outlet for this route is yielded by this component, which\nis how we use components to handle rendering all of our pages, even with\nsubroutes.
\nBecause we want the default setup of Fountainhead to look like it's own app\nwe render everything in a fh-page-in-page-wrapper wrapper which is position\nfixed to cover the entire screen. This allows us to have our own header and\nfooter even if a consuming application has one in their application.hbs\ntemplate.
\nPage data is passed from the fountainhead service, which is the primary\nstore for the addon and handles fetching the meta data for the API docs.
\n",
"uses": [
"FountainheadRepoLink",
"FountainheadSidebar.Sidebar"
],
"is_constructor": 1,
"extends": "Ember.Component",
"method": [],
"property": [
{
"file": "addon/components/fountainhead-pages/api.js",
"line": 31,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "FountainheadPages.API",
"srcFileId": "addon_components_fountainhead-pages_api.js"
}
],
"event": [],
"srcFileId": "addon_components_fountainhead-pages_api.js"
},
"FountainheadPages.BasePage": {
"name": "FountainheadPages.BasePage",
"shortname": "FountainheadPages.BasePage",
"classitems": [
{
"file": "addon/components/fountainhead-pages/base-page.js",
"line": 53,
"description": "Anytime the model or the fragmentId changes send a scroll event to\n{{c-l class='Fountainhead'}} service. This handles auto-scrolling to ids that\nare not in DOM when the page loads and handles scrolling to ids when the browser\nback button is clicked.
\n",
"itemtype": "event",
"name": "didReceiveAttrs",
"class": "FountainheadPages.BasePage",
"srcFileId": "addon_components_fountainhead-pages_base-page.js"
},
{
"file": "addon/components/fountainhead-pages/base-page.js",
"line": 21,
"description": "Route target of either the hash fragment id or the id query param. Whenever the\ntarget changes it will trigger a {{c-l 'didReceiveAttrs'}} that handles\nscrolling the page to the new target (or back to top if the target changes to\nempty).
\n",
"itemtype": "property",
"name": "fragmentId",
"passed": "",
"type": "{?string}",
"default": "null",
"class": "FountainheadPages.BasePage",
"srcFileId": "addon_components_fountainhead-pages_base-page.js"
},
{
"file": "addon/components/fountainhead-pages/base-page.js",
"line": 35,
"description": "Internal tracker for previous {{c-l 'fragmentId'}}. Needed to check if the\nscroll target has changed in the {{c-l 'didReceiveAttrs'}} hook.
\n",
"itemtype": "property",
"name": "previousFragmentID",
"access": "protected",
"tagname": "",
"type": "{?string}",
"default": "null",
"class": "FountainheadPages.BasePage",
"srcFileId": "addon_components_fountainhead-pages_base-page.js"
},
{
"file": "addon/components/fountainhead-pages/base-page.js",
"line": 44,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "FountainheadPages.BasePage",
"srcFileId": "addon_components_fountainhead-pages_base-page.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/fountainhead-pages/base-page.js",
"line": 6,
"description": "Base component that pages with targeted routing extend. Each page is passed a\n{{c-l 'fragmentId'}} of the route scroll target. A copy of this property is stored\nas {{c-l 'previousFragmentID'}} and used in {{c-l 'didReceiveAttrs'}} to check for\na change in the route target. When it changes, the page is scrolled to the new\ntarget.
\n",
"is_constructor": 1,
"extends": "Ember.Component",
"method": [],
"property": [
{
"file": "addon/components/fountainhead-pages/base-page.js",
"line": 21,
"description": "Route target of either the hash fragment id or the id query param. Whenever the\ntarget changes it will trigger a {{c-l 'didReceiveAttrs'}} that handles\nscrolling the page to the new target (or back to top if the target changes to\nempty).
\n",
"itemtype": "property",
"name": "fragmentId",
"passed": "",
"type": "{?string}",
"default": "null",
"class": "FountainheadPages.BasePage",
"srcFileId": "addon_components_fountainhead-pages_base-page.js"
},
{
"file": "addon/components/fountainhead-pages/base-page.js",
"line": 35,
"description": "Internal tracker for previous {{c-l 'fragmentId'}}. Needed to check if the\nscroll target has changed in the {{c-l 'didReceiveAttrs'}} hook.
\n",
"itemtype": "property",
"name": "previousFragmentID",
"access": "protected",
"tagname": "",
"type": "{?string}",
"default": "null",
"class": "FountainheadPages.BasePage",
"srcFileId": "addon_components_fountainhead-pages_base-page.js"
},
{
"file": "addon/components/fountainhead-pages/base-page.js",
"line": 44,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "FountainheadPages.BasePage",
"srcFileId": "addon_components_fountainhead-pages_base-page.js"
}
],
"event": [
{
"file": "addon/components/fountainhead-pages/base-page.js",
"line": 53,
"description": "Anytime the model or the fragmentId changes send a scroll event to\n{{c-l class='Fountainhead'}} service. This handles auto-scrolling to ids that\nare not in DOM when the page loads and handles scrolling to ids when the browser\nback button is clicked.
\n",
"itemtype": "event",
"name": "didReceiveAttrs",
"class": "FountainheadPages.BasePage",
"srcFileId": "addon_components_fountainhead-pages_base-page.js"
}
],
"srcFileId": "addon_components_fountainhead-pages_base-page.js"
},
"FountainheadPages.Class": {
"name": "FountainheadPages.Class",
"shortname": "FountainheadPages.Class",
"classitems": [
{
"file": "addon/components/fountainhead-pages/class.js",
"line": 14,
"description": "Class model content.
\n",
"itemtype": "property",
"name": "class",
"type": "{?Object}",
"passed": "",
"class": "FountainheadPages.Class",
"srcFileId": "addon_components_fountainhead-pages_class.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/fountainhead-pages/class.js",
"line": 4,
"description": "Fountainhead /api/class page component.
\n",
"is_constructor": 1,
"extends": "FountainheadPages.BasePage",
"method": [],
"property": [
{
"file": "addon/components/fountainhead-pages/class.js",
"line": 14,
"description": "Class model content.
\n",
"itemtype": "property",
"name": "class",
"type": "{?Object}",
"passed": "",
"class": "FountainheadPages.Class",
"srcFileId": "addon_components_fountainhead-pages_class.js"
}
],
"event": [],
"srcFileId": "addon_components_fountainhead-pages_class.js"
},
"FountainheadPages.File": {
"name": "FountainheadPages.File",
"shortname": "FountainheadPages.File",
"classitems": [
{
"file": "addon/components/fountainhead-pages/file.js",
"line": 14,
"description": "JSON stringified file generated by documentation script.
\n",
"itemtype": "property",
"name": "file",
"type": "{string}",
"default": "''",
"class": "FountainheadPages.File",
"srcFileId": "addon_components_fountainhead-pages_file.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/fountainhead-pages/file.js",
"line": 4,
"description": "Fountainhead /doc/file page component
\n",
"is_constructor": 1,
"extends": "FountainheadPages.BasePage",
"method": [],
"property": [
{
"file": "addon/components/fountainhead-pages/file.js",
"line": 14,
"description": "JSON stringified file generated by documentation script.
\n",
"itemtype": "property",
"name": "file",
"type": "{string}",
"default": "''",
"class": "FountainheadPages.File",
"srcFileId": "addon_components_fountainhead-pages_file.js"
}
],
"event": [],
"srcFileId": "addon_components_fountainhead-pages_file.js"
},
"FountainheadPages.Guide": {
"name": "FountainheadPages.Guide",
"shortname": "FountainheadPages.Guide",
"classitems": [
{
"file": "addon/components/fountainhead-pages/guide.js",
"line": 15,
"description": "Guide backing model matching structure:
\n{ \n id\n attributes\n body, \n} \nFountainhead /guide page component
\n",
"is_constructor": 1,
"extends": "FountainheadPages.BasePage",
"experimental": "",
"method": [],
"property": [
{
"file": "addon/components/fountainhead-pages/guide.js",
"line": 15,
"description": "Guide backing model matching structure:
\n{ \n id\n attributes\n body, \n} \nHandle nulling out properties submodules and classes if they don't have\nany keys.
\n",
"itemtype": "event",
"name": "didReceiveAttrs",
"class": "FountainheadPages.Module",
"srcFileId": "addon_components_fountainhead-pages_module.js"
},
{
"file": "addon/components/fountainhead-pages/module.js",
"line": 14,
"description": "Module model content
\n",
"itemtype": "property",
"name": "module",
"type": "{string}",
"default": "''",
"class": "FountainheadPages.Module",
"srcFileId": "addon_components_fountainhead-pages_module.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/fountainhead-pages/module.js",
"line": 4,
"description": "Fountainhead /doc/module page component
\n",
"is_constructor": 1,
"extends": "FountainheadPages.BasePage",
"method": [],
"property": [
{
"file": "addon/components/fountainhead-pages/module.js",
"line": 14,
"description": "Module model content
\n",
"itemtype": "property",
"name": "module",
"type": "{string}",
"default": "''",
"class": "FountainheadPages.Module",
"srcFileId": "addon_components_fountainhead-pages_module.js"
}
],
"event": [
{
"file": "addon/components/fountainhead-pages/module.js",
"line": 24,
"description": "Handle nulling out properties submodules and classes if they don't have\nany keys.
\n",
"itemtype": "event",
"name": "didReceiveAttrs",
"class": "FountainheadPages.Module",
"srcFileId": "addon_components_fountainhead-pages_module.js"
}
],
"srcFileId": "addon_components_fountainhead-pages_module.js"
},
"NavigationAPI.Logo": {
"name": "NavigationAPI.Logo",
"shortname": "NavigationAPI.Logo",
"classitems": [
{
"file": "addon/components/navigation-api/logo.js",
"line": 18,
"description": "Path to a custom logo, can be set in your\nfountainhead.js
\n",
"itemtype": "property",
"name": "logo",
"type": "{?string}",
"passed": "NavigationAPI",
"class": "NavigationAPI.Logo",
"srcFileId": "addon_components_navigation-api_logo.js"
},
{
"file": "addon/components/navigation-api/logo.js",
"line": 29,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "NavigationAPI.Logo",
"srcFileId": "addon_components_navigation-api_logo.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/navigation-api/logo.js",
"line": 4,
"description": "The logo at the top of the API navigation is a component so that you can\neasily extend it for custom logos that can't be contained in a merge image.
\nIf {{c-l 'meta' class='Fountainhead'}} has a logo, that will be used\notherwise we fall back to the Fountainhead logo.
\n",
"is_constructor": 1,
"extends": "Ember.Component",
"method": [],
"property": [
{
"file": "addon/components/navigation-api/logo.js",
"line": 18,
"description": "Path to a custom logo, can be set in your\nfountainhead.js
\n",
"itemtype": "property",
"name": "logo",
"type": "{?string}",
"passed": "NavigationAPI",
"class": "NavigationAPI.Logo",
"srcFileId": "addon_components_navigation-api_logo.js"
},
{
"file": "addon/components/navigation-api/logo.js",
"line": 29,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "NavigationAPI.Logo",
"srcFileId": "addon_components_navigation-api_logo.js"
}
],
"event": [],
"srcFileId": "addon_components_navigation-api_logo.js"
},
"NavigationAPI.SearchBar": {
"name": "NavigationAPI.SearchBar",
"shortname": "NavigationAPI.SearchBar",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/navigation-api/search-bar.js",
"line": 4,
"description": "Not operational sidebar search component
\n",
"is_constructor": 1,
"extends": "Ember.Component",
"method": [],
"property": [],
"event": [],
"srcFileId": "addon_components_navigation-api_search-bar.js"
},
"NavigationAPI.Section": {
"name": "NavigationAPI.Section",
"shortname": "NavigationAPI.Section",
"classitems": [
{
"file": "addon/components/navigation-api/section.js",
"line": 45,
"itemtype": "property",
"name": "classNames",
"type": "{Array}",
"default": "['nav-section']",
"class": "NavigationAPI.Section",
"srcFileId": "addon_components_navigation-api_section.js"
},
{
"file": "addon/components/navigation-api/section.js",
"line": 18,
"description": "Array of documentation items to create links for. Each item should be of\nform:
\n{ \n name: 'Item name - used as text for anchor' , \n type: 'Either classes or modules' \n} \nSection header text content
\n",
"itemtype": "property",
"name": "title",
"type": "{string}",
"passed": "",
"optional": 1,
"default": "''",
"class": "NavigationAPI.Section",
"srcFileId": "addon_components_navigation-api_section.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/navigation-api/section.js",
"line": 4,
"description": "Component creates a section for the {{c-l class='NavigationAPI'}}. Accepts\na {{c-l 'title'}} and an {{c-l 'items'}} array, both optional.
\nComponent can be used in block form if just the wrapping section markup is\nneeded with a header.
\n",
"is_constructor": 1,
"extends": "Ember.Component",
"method": [],
"property": [
{
"file": "addon/components/navigation-api/section.js",
"line": 45,
"itemtype": "property",
"name": "classNames",
"type": "{Array}",
"default": "['nav-section']",
"class": "NavigationAPI.Section",
"srcFileId": "addon_components_navigation-api_section.js"
},
{
"file": "addon/components/navigation-api/section.js",
"line": 18,
"description": "Array of documentation items to create links for. Each item should be of\nform:
\n{ \n name: 'Item name - used as text for anchor' , \n type: 'Either classes or modules' \n} \nSection header text content
\n",
"itemtype": "property",
"name": "title",
"type": "{string}",
"passed": "",
"optional": 1,
"default": "''",
"class": "NavigationAPI.Section",
"srcFileId": "addon_components_navigation-api_section.js"
}
],
"event": [],
"srcFileId": "addon_components_navigation-api_section.js"
},
"CrossLink": {
"name": "CrossLink",
"shortname": "CrossLink",
"classitems": [
{
"file": "addon/components/cross-link.js",
"line": 106,
"description": "Computed model ID passed to rendered link-to defined in {{c-l 'init'}}
\n",
"itemtype": "property",
"name": "_modelID",
"type": "{?string}",
"access": "private",
"tagname": "",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
},
{
"file": "addon/components/cross-link.js",
"line": 99,
"description": "Computed route passed to rendered link-to defined in {{c-l 'init'}}
\n",
"itemtype": "property",
"name": "_route",
"type": "{?string}",
"access": "private",
"tagname": "",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
},
{
"file": "addon/components/cross-link.js",
"line": 75,
"description": "Documentation Class to crosslink to.
\n",
"itemtype": "property",
"name": "class",
"type": "{?string}",
"passed": "",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
},
{
"file": "addon/components/navigation-guides/group.js",
"line": 14,
"description": "Protected tracking prop for guide group state.
\n",
"itemtype": "property",
"name": "expanded",
"type": "Boolean",
"access": "protected",
"tagname": "",
"default": "false",
"class": "CrossLink",
"srcFileId": "addon_components_navigation-guides_group.js"
},
{
"file": "addon/components/navigation-guides/group.js",
"line": 7,
"itemtype": "property",
"name": "guideGroup",
"type": "Object",
"access": "public",
"tagname": "",
"class": "CrossLink",
"srcFileId": "addon_components_navigation-guides_group.js"
},
{
"file": "addon/components/cross-link.js",
"line": 122,
"description": "Handle setting a route and model for the template when appropriate + set text\nfor cross link for when component is used in inline form.
\n",
"itemtype": "method",
"name": "init",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
},
{
"file": "addon/components/cross-link.js",
"line": 82,
"description": "Optionally specify an item (property/method) to cross link to on a class.
\n",
"itemtype": "property",
"name": "item",
"type": "{?string}",
"passed": "",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
},
{
"file": "addon/components/cross-link.js",
"line": 89,
"description": "Documentation module to crosslink to.
\n",
"itemtype": "property",
"name": "module",
"type": "{?string}",
"passed": "",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
},
{
"file": "addon/components/cross-link.js",
"line": 167,
"description": "Ember strips out hash fragments from link-tos, which means that when consumers\nwith History location click a cross-link pointing to a different route, Ember\nwill strip the hash.
\n'Fix' this by setting crossLinkFragmentOverride on the route. When the\nroute didTransition fires, it will see the override and update the history +\nscroll to the cross link target.
\n",
"itemtype": "method",
"name": "setFragmentOverride",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
},
{
"file": "addon/components/cross-link.js",
"line": 113,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
},
{
"file": "addon/components/navigation-guides/group.js",
"line": 25,
"description": "Called on click of group trigger, toggles height animation of group container\nand toggles {{c-l 'expanded'}} value.
\n",
"itemtype": "method",
"name": "toggle",
"class": "CrossLink",
"srcFileId": "addon_components_navigation-guides_group.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/cross-link.js",
"line": 6,
"description": "The \\{{cross-link}} component lets you easily reference other classes,\nmodules, properties and methods in your documentation. It handles creating the\nappropriate link depending on application routing type and presence of a\nclass property. The cross link component is also available using the shorthand\nsyntax: \\{{c-l}}.
\n{{#fountainhead-alert brand='info' dismiss=false}}\n{{fountainhead-svg svgId='info'}} The cross link component is also available as\n\\{{c-l}} for terseness.\n{{/fountainhead-alert}}
\n{{#fountainhead-header tagName=\"h4\" elementId=\"same-class-cross-linking\"}}Same Class Cross Linking{{/fountainhead-header}}\nQuickly link to a property in the same class using positional params: \nTake a look at the { { c- l 'init' } } method to see how the { { c- l '_route' } } property\nis set . \nQuickly link to a property in the same class using positional params:\nTake a look at the {{c-l 'init'}} method to see how the {{c-l '_route'}} property\nis set.
\n{{#fountainhead-header tagName=\"h4\" elementId=\"other-class-cross-linking\"}}Other Class Cross Linking{{/fountainhead-header}}\nLink to any other class , module, property, or method by passing a `class` `module` : \nTake a look at the { { c- l 'setFragmentId' class = 'Fountainhead' } } method to see\nhow the URL hash is set . \nLink to any other class, module, property, or method by passing a class or\nmodule property:\nTake a look at the {{c-l 'setFragmentId' class='Fountainhead'}} method to see\nhow the URL hash is set.
\n{{#fountainhead-header tagName=\"h4\" elementId=\"block-form\"}}Block Form{{/fountainhead-header}}\nWhen used as an inline component, the rendered link-to's text will be the\nID of the module or class along with any passed query params. If you want\ndifferent link text you can use the component in block form.
\n\n\n\nProperty \nDescription \n \n \n\n\nclassDocumentation class to link to \n \n\nmoduleDocumentation module to link to \n \n\nitemSpecific documentation item to link to, appended as a query param \n \n \n
\n{{! --------------------------------------------------------------------- }}\n{{! TEST CASES: B/c Ember Integration Tests + link-to === 💣 }}\n{{! Uncomment cases below and check in browser }}\n{{! --------------------------------------------------------------------- }}\n{{! Postional Params }}\n{{! ## Testing }}\n{{!-- {{c-l 'init'}}
\n",
"access": "public",
"tagname": "",
"is_constructor": 1,
"extends": "Ember.Component",
"method": [
{
"file": "addon/components/cross-link.js",
"line": 122,
"description": "Handle setting a route and model for the template when appropriate + set text\nfor cross link for when component is used in inline form.
\n",
"itemtype": "method",
"name": "init",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
},
{
"file": "addon/components/cross-link.js",
"line": 167,
"description": "Ember strips out hash fragments from link-tos, which means that when consumers\nwith History location click a cross-link pointing to a different route, Ember\nwill strip the hash.
\n'Fix' this by setting crossLinkFragmentOverride on the route. When the\nroute didTransition fires, it will see the override and update the history +\nscroll to the cross link target.
\n",
"itemtype": "method",
"name": "setFragmentOverride",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
},
{
"file": "addon/components/navigation-guides/group.js",
"line": 25,
"description": "Called on click of group trigger, toggles height animation of group container\nand toggles {{c-l 'expanded'}} value.
\n",
"itemtype": "method",
"name": "toggle",
"class": "CrossLink",
"srcFileId": "addon_components_navigation-guides_group.js"
}
],
"property": [
{
"file": "addon/components/cross-link.js",
"line": 106,
"description": "Computed model ID passed to rendered link-to defined in {{c-l 'init'}}
\n",
"itemtype": "property",
"name": "_modelID",
"type": "{?string}",
"access": "private",
"tagname": "",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
},
{
"file": "addon/components/cross-link.js",
"line": 99,
"description": "Computed route passed to rendered link-to defined in {{c-l 'init'}}
\n",
"itemtype": "property",
"name": "_route",
"type": "{?string}",
"access": "private",
"tagname": "",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
},
{
"file": "addon/components/cross-link.js",
"line": 75,
"description": "Documentation Class to crosslink to.
\n",
"itemtype": "property",
"name": "class",
"type": "{?string}",
"passed": "",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
},
{
"file": "addon/components/navigation-guides/group.js",
"line": 14,
"description": "Protected tracking prop for guide group state.
\n",
"itemtype": "property",
"name": "expanded",
"type": "Boolean",
"access": "protected",
"tagname": "",
"default": "false",
"class": "CrossLink",
"srcFileId": "addon_components_navigation-guides_group.js"
},
{
"file": "addon/components/navigation-guides/group.js",
"line": 7,
"itemtype": "property",
"name": "guideGroup",
"type": "Object",
"access": "public",
"tagname": "",
"class": "CrossLink",
"srcFileId": "addon_components_navigation-guides_group.js"
},
{
"file": "addon/components/cross-link.js",
"line": 82,
"description": "Optionally specify an item (property/method) to cross link to on a class.
\n",
"itemtype": "property",
"name": "item",
"type": "{?string}",
"passed": "",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
},
{
"file": "addon/components/cross-link.js",
"line": 89,
"description": "Documentation module to crosslink to.
\n",
"itemtype": "property",
"name": "module",
"type": "{?string}",
"passed": "",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
},
{
"file": "addon/components/cross-link.js",
"line": 113,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
}
],
"event": [],
"srcFileId": "addon_components_cross-link.js"
},
"FHHref": {
"name": "FHHref",
"shortname": "FHHref",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/fh-href.js",
"line": 5,
"description": "Extend Ember link-to for URLs with a hash fragment available for History\nlocation consumers.
\nNOTE: If we can figure out how to pass a model to a link-to with a hash fragment,\nthis component is not needed, eg:\n\\{{link-to 'Prop' 'api.classes' 'someClass#prop'}}
\n",
"is_constructor": 1,
"extends": "Ember.LinkComponent",
"access": "private",
"tagname": "",
"method": [],
"property": [],
"event": [],
"srcFileId": "addon_components_fh-href.js"
},
"FountainheadAlert": {
"name": "FountainheadAlert",
"shortname": "FountainheadAlert",
"classitems": [
{
"file": "addon/components/fountainhead-alert.js",
"line": 99,
"description": "Allows for quick and easy dismissal of the alert. The alert is faded from\nview, then totally removed from the DOM and the component instance is\ndestroyed.
\n",
"itemtype": "method",
"name": "_selfDestruct",
"return": {
"description": "",
"type": "Undefined"
},
"class": "FountainheadAlert",
"srcFileId": "addon_components_fountainhead-alert.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 118,
"description": "Actions hash
\n",
"itemtype": "property",
"name": "actions",
"type": "{Object}",
"class": "FountainheadAlert",
"srcFileId": "addon_components_fountainhead-alert.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 68,
"itemtype": "property",
"name": "attributeBindings",
"type": "{Array}",
"default": "['role']",
"class": "FountainheadAlert",
"srcFileId": "addon_components_fountainhead-alert.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 15,
"description": "Specify brand, component handles assigning correct css class
\n",
"itemtype": "property",
"name": "brand",
"default": "''",
"type": "{string}",
"access": "public",
"tagname": "",
"class": "FountainheadAlert",
"srcFileId": "addon_components_fountainhead-alert.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 54,
"description": "Computed css class bound to component. Handled by component to allow for\nflexibility in future updates to branding class names
\n",
"itemtype": "property",
"name": "brandClass",
"type": "{string}",
"access": "private",
"tagname": "",
"class": "FountainheadAlert",
"subprops": [
{
"name": "'brand'",
"description": ""
}
],
"srcFileId": "addon_components_fountainhead-alert.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 23,
"description": "Whether this alert can be dismissed via the close button in the upper right\ncorner. Defaults to true. Adds an interactive close button to the alert.
\nUsage: \nOverride by passing false into this param in your handlebars template:
\n{ { #fountainhead- alert canDismiss= false } } \n { { ! Standard template content goes here } } \n{ { / fountainhead- alert} } \nA proxy action for the selfDestruct method
\n",
"itemtype": "method",
"name": "dismiss",
"return": {
"description": "",
"type": "Undefined"
},
"class": "FountainheadAlert",
"srcFileId": "addon_components_fountainhead-alert.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 42,
"description": "Contains optional action that is executed when the alert is dismissed.\nThis action will be executed before the alert is destroyed.
\n",
"itemtype": "property",
"name": "onDismiss",
"type": "{function}",
"default": "() => {}",
"access": "public",
"tagname": "",
"class": "FountainheadAlert",
"srcFileId": "addon_components_fountainhead-alert.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 89,
"description": "A++ accessibility. Tells a screen this component is an alert.
\n",
"itemtype": "property",
"name": "role",
"type": "{string}",
"default": "'alert'",
"class": "FountainheadAlert",
"srcFileId": "addon_components_fountainhead-alert.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/fountainhead-alert.js",
"line": 5,
"description": "Fountainhead Alert Component copied from Radical
\n",
"is_constructor": 1,
"extends": "Ember.Component",
"method": [
{
"file": "addon/components/fountainhead-alert.js",
"line": 99,
"description": "Allows for quick and easy dismissal of the alert. The alert is faded from\nview, then totally removed from the DOM and the component instance is\ndestroyed.
\n",
"itemtype": "method",
"name": "_selfDestruct",
"return": {
"description": "",
"type": "Undefined"
},
"class": "FountainheadAlert",
"srcFileId": "addon_components_fountainhead-alert.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 124,
"description": "A proxy action for the selfDestruct method
\n",
"itemtype": "method",
"name": "dismiss",
"return": {
"description": "",
"type": "Undefined"
},
"class": "FountainheadAlert",
"srcFileId": "addon_components_fountainhead-alert.js"
}
],
"property": [
{
"file": "addon/components/fountainhead-alert.js",
"line": 118,
"description": "Actions hash
\n",
"itemtype": "property",
"name": "actions",
"type": "{Object}",
"class": "FountainheadAlert",
"srcFileId": "addon_components_fountainhead-alert.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 68,
"itemtype": "property",
"name": "attributeBindings",
"type": "{Array}",
"default": "['role']",
"class": "FountainheadAlert",
"srcFileId": "addon_components_fountainhead-alert.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 15,
"description": "Specify brand, component handles assigning correct css class
\n",
"itemtype": "property",
"name": "brand",
"default": "''",
"type": "{string}",
"access": "public",
"tagname": "",
"class": "FountainheadAlert",
"srcFileId": "addon_components_fountainhead-alert.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 54,
"description": "Computed css class bound to component. Handled by component to allow for\nflexibility in future updates to branding class names
\n",
"itemtype": "property",
"name": "brandClass",
"type": "{string}",
"access": "private",
"tagname": "",
"class": "FountainheadAlert",
"subprops": [
{
"name": "'brand'",
"description": ""
}
],
"srcFileId": "addon_components_fountainhead-alert.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 23,
"description": "Whether this alert can be dismissed via the close button in the upper right\ncorner. Defaults to true. Adds an interactive close button to the alert.
\nUsage: \nOverride by passing false into this param in your handlebars template:
\n{ { #fountainhead- alert canDismiss= false } } \n { { ! Standard template content goes here } } \n{ { / fountainhead- alert} } \nContains optional action that is executed when the alert is dismissed.\nThis action will be executed before the alert is destroyed.
\n",
"itemtype": "property",
"name": "onDismiss",
"type": "{function}",
"default": "() => {}",
"access": "public",
"tagname": "",
"class": "FountainheadAlert",
"srcFileId": "addon_components_fountainhead-alert.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 89,
"description": "A++ accessibility. Tells a screen this component is an alert.
\n",
"itemtype": "property",
"name": "role",
"type": "{string}",
"default": "'alert'",
"class": "FountainheadAlert",
"srcFileId": "addon_components_fountainhead-alert.js"
}
],
"event": [],
"srcFileId": "addon_components_fountainhead-alert.js"
},
"FountainheadButton": {
"name": "FountainheadButton",
"shortname": "FountainheadButton",
"classitems": [
{
"file": "addon/components/fountainhead-button.js",
"line": 67,
"description": "ALLLLLLLLLLL the attributes you might need.\nNOTE: role should not be bound here. You can set the role of a button\nby passing an ariaRole prop.
\n",
"itemtype": "property",
"name": "attributeBindings",
"type": "{Array}",
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 32,
"description": "Pass a brand to have btn-${brand} class applied
\n",
"itemtype": "property",
"name": "brand",
"type": "{string}",
"passed": "",
"optional": 1,
"default": "''",
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 54,
"description": "Computed css class bound to component. Handled by component to allow for\nflexibility in future updates to branding class names
\n",
"itemtype": "property",
"name": "brandClass",
"type": "{string}",
"class": "FountainheadButton",
"subprops": [
{
"name": "'brand'",
"description": ""
}
],
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 95,
"description": "Handle binding brand and link related css class names
\n",
"itemtype": "property",
"name": "classNameBindings",
"type": "{Array}",
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 85,
"description": "Bind standard core classname for component: fountainhead-button
\n",
"itemtype": "property",
"name": "classNames",
"type": "{Array}",
"default": "['fh-button', 'btn']",
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 41,
"description": "Pass true to create a button that looks and behaves like a link. This is\nuseful for creating accessible interaction targets.
\n",
"itemtype": "property",
"name": "link",
"type": "{Boolean}",
"passed": "",
"optional": 1,
"default": "false",
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 121,
"description": "The mouseDown event is used for some utility/housekeeping methods because\nwe use the click event to pass in actions.
\nHandle setting the outline on this element to none because we know this\nevent is only triggered by actual mouse clicks. Keyboard events don't trigger\nit, which is a convenient way to know we're good to hide the outline and\nmaintain usability for keyboard users. A++ accessibility!
\nHandle checking for a tagging category and if one exists, fire a tag.
\nIf you need to override this event, be sure to call this._super();
\n",
"itemtype": "event",
"name": "mouseDown",
"return": {
"description": "",
"type": "Undefined"
},
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 104,
"description": "Button DOM element
\n",
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "'button'",
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 111,
"description": "Include type button for usability.
\n",
"itemtype": "property",
"name": "type",
"type": "{string}",
"default": "'button'",
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/fountainhead-button.js",
"line": 7,
"description": "Fountainhead button component pulled from ember-radical addon.\nTODO: One day use nested addons, trepidation
\nHere, this is a button:
\n{ { #fountainhead- button} } Check me out{ { / fountainhead- button} } \n{{#fountainhead-button}}Check me out{{/fountainhead-button}}
\nThis button will not get auto-rendered, as it is just an example:
\n{ { #fountainhead- button} } NO DICE, HOMBRE{ { / fountainhead- button} } \nALLLLLLLLLLL the attributes you might need.\nNOTE: role should not be bound here. You can set the role of a button\nby passing an ariaRole prop.
\n",
"itemtype": "property",
"name": "attributeBindings",
"type": "{Array}",
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 32,
"description": "Pass a brand to have btn-${brand} class applied
\n",
"itemtype": "property",
"name": "brand",
"type": "{string}",
"passed": "",
"optional": 1,
"default": "''",
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 54,
"description": "Computed css class bound to component. Handled by component to allow for\nflexibility in future updates to branding class names
\n",
"itemtype": "property",
"name": "brandClass",
"type": "{string}",
"class": "FountainheadButton",
"subprops": [
{
"name": "'brand'",
"description": ""
}
],
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 95,
"description": "Handle binding brand and link related css class names
\n",
"itemtype": "property",
"name": "classNameBindings",
"type": "{Array}",
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 85,
"description": "Bind standard core classname for component: fountainhead-button
\n",
"itemtype": "property",
"name": "classNames",
"type": "{Array}",
"default": "['fh-button', 'btn']",
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 41,
"description": "Pass true to create a button that looks and behaves like a link. This is\nuseful for creating accessible interaction targets.
\n",
"itemtype": "property",
"name": "link",
"type": "{Boolean}",
"passed": "",
"optional": 1,
"default": "false",
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 104,
"description": "Button DOM element
\n",
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "'button'",
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 111,
"description": "Include type button for usability.
\n",
"itemtype": "property",
"name": "type",
"type": "{string}",
"default": "'button'",
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
}
],
"event": [
{
"file": "addon/components/fountainhead-button.js",
"line": 121,
"description": "The mouseDown event is used for some utility/housekeeping methods because\nwe use the click event to pass in actions.
\nHandle setting the outline on this element to none because we know this\nevent is only triggered by actual mouse clicks. Keyboard events don't trigger\nit, which is a convenient way to know we're good to hide the outline and\nmaintain usability for keyboard users. A++ accessibility!
\nHandle checking for a tagging category and if one exists, fire a tag.
\nIf you need to override this event, be sure to call this._super();
\n",
"itemtype": "event",
"name": "mouseDown",
"return": {
"description": "",
"type": "Undefined"
},
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
}
],
"srcFileId": "addon_components_fountainhead-button.js"
},
"FountainheadGetStarted": {
"name": "FountainheadGetStarted",
"shortname": "FountainheadGetStarted",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/fountainhead-get-started.js",
"line": 4,
"description": "Component determines the 'Getting Started' message displayed to consumers\nthat don't have documentation meta available.
\n",
"is_constructor": 1,
"extends": "Ember.Component",
"method": [],
"property": [],
"event": [],
"srcFileId": "addon_components_fountainhead-get-started.js"
},
"FounatianheadHeader": {
"name": "FounatianheadHeader",
"shortname": "FounatianheadHeader",
"classitems": [
{
"file": "addon/components/fountainhead-header.js",
"line": 59,
"description": "Copies the current url to the clipboard by updating the value of the off-screen\ninput to the url, selecting it and then calling exec copy.
\n",
"itemtype": "method",
"name": "_copyToClipboard",
"class": "FounatianheadHeader",
"srcFileId": "addon_components_fountainhead-header.js"
},
{
"file": "addon/components/fountainhead-header.js",
"line": 50,
"itemtype": "property",
"name": "classNames",
"type": "{string}",
"default": "'fh-header'",
"class": "FounatianheadHeader",
"srcFileId": "addon_components_fountainhead-header.js"
},
{
"file": "addon/components/fountainhead-header.js",
"line": 35,
"description": "Specific element id is passed to click-to-copy elements in the template.
\n",
"itemtype": "property",
"name": "elementId",
"type": "{string}",
"class": "FounatianheadHeader",
"srcFileId": "addon_components_fountainhead-header.js"
},
{
"file": "addon/components/fountainhead-header.js",
"line": 81,
"description": "Copy to clipboard method must run in next event loop so that the anchor click\ncan bubble and the browser can update the url before we grab it and copy it.
\n",
"itemtype": "method",
"name": "handleCopy",
"action": "",
"class": "FounatianheadHeader",
"srcFileId": "addon_components_fountainhead-header.js"
},
{
"file": "addon/components/fountainhead-header.js",
"line": 41,
"description": "The tagName is passed to specify header size.
\n",
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"class": "FounatianheadHeader",
"srcFileId": "addon_components_fountainhead-header.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/fountainhead-header.js",
"line": 6,
"description": "This component is used for any header that should include a click-to-copy scroll target.\nFor any header in a Fountainhead Guide or Docblock, the\n{{c-l class='parseMarkdown'}} method automatically handles creating instances\nby adding new render\nrules for the heading_open and heading_close tokens generated by markdown-it.
\nThis automatically creates headers with fragment ids and\nclick to copy targets for grabbing the anchor for any header in your documentation!
\nThe heading_open token contains the HTML tag element for each header, it is\npassed in as the tagName property, which creates the correct header element.
\nThe {{c-l class='FountainheadCopyableLinkTo'}} component returns a text value\nmatching the href to copy, and is invoked differently depending on if the consuming\napp is using hash routing or not. If not, we use hash fragment ids like a normal\nweb page. If they are, a query param id is used. The\n{{c-l class='Fountainhead'}} service handles checking which target to use when\nscrolling to ids on page 'load' (which is actually any page component's\ndidInsertElement hook) .
\n",
"is_constructor": 1,
"extends": "Ember.Component",
"method": [
{
"file": "addon/components/fountainhead-header.js",
"line": 59,
"description": "Copies the current url to the clipboard by updating the value of the off-screen\ninput to the url, selecting it and then calling exec copy.
\n",
"itemtype": "method",
"name": "_copyToClipboard",
"class": "FounatianheadHeader",
"srcFileId": "addon_components_fountainhead-header.js"
},
{
"file": "addon/components/fountainhead-header.js",
"line": 81,
"description": "Copy to clipboard method must run in next event loop so that the anchor click\ncan bubble and the browser can update the url before we grab it and copy it.
\n",
"itemtype": "method",
"name": "handleCopy",
"action": "",
"class": "FounatianheadHeader",
"srcFileId": "addon_components_fountainhead-header.js"
}
],
"property": [
{
"file": "addon/components/fountainhead-header.js",
"line": 50,
"itemtype": "property",
"name": "classNames",
"type": "{string}",
"default": "'fh-header'",
"class": "FounatianheadHeader",
"srcFileId": "addon_components_fountainhead-header.js"
},
{
"file": "addon/components/fountainhead-header.js",
"line": 35,
"description": "Specific element id is passed to click-to-copy elements in the template.
\n",
"itemtype": "property",
"name": "elementId",
"type": "{string}",
"class": "FounatianheadHeader",
"srcFileId": "addon_components_fountainhead-header.js"
},
{
"file": "addon/components/fountainhead-header.js",
"line": 41,
"description": "The tagName is passed to specify header size.
\n",
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"class": "FounatianheadHeader",
"srcFileId": "addon_components_fountainhead-header.js"
}
],
"event": [],
"srcFileId": "addon_components_fountainhead-header.js"
},
"FountainheadRepoLink": {
"name": "FountainheadRepoLink",
"shortname": "FountainheadRepoLink",
"classitems": [
{
"file": "addon/components/fountainhead-repo-link.js",
"line": 14,
"description": "Repository URL from fountainhead configurations. If a URL has been specified\nin the configs or the package.json this github logo will show with a link\nto the repo
\n",
"itemtype": "property",
"name": "repository",
"type": "{string}",
"default": "''",
"class": "FountainheadRepoLink",
"srcFileId": "addon_components_fountainhead-repo-link.js"
},
{
"file": "addon/components/fountainhead-repo-link.js",
"line": 26,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "FountainheadRepoLink",
"srcFileId": "addon_components_fountainhead-repo-link.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [
"FountainheadPages.API"
],
"module": "Addon",
"file": "addon/components/fountainhead-repo-link.js",
"line": 4,
"description": "Github octocat logo in the top right corner.
\n",
"is_constructor": 1,
"extends": "Ember.Component",
"method": [],
"property": [
{
"file": "addon/components/fountainhead-repo-link.js",
"line": 14,
"description": "Repository URL from fountainhead configurations. If a URL has been specified\nin the configs or the package.json this github logo will show with a link\nto the repo
\n",
"itemtype": "property",
"name": "repository",
"type": "{string}",
"default": "''",
"class": "FountainheadRepoLink",
"srcFileId": "addon_components_fountainhead-repo-link.js"
},
{
"file": "addon/components/fountainhead-repo-link.js",
"line": 26,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "FountainheadRepoLink",
"srcFileId": "addon_components_fountainhead-repo-link.js"
}
],
"event": [],
"srcFileId": "addon_components_fountainhead-repo-link.js"
},
"FountainheadRuntimeDescription": {
"name": "FountainheadRuntimeDescription",
"shortname": "FountainheadRuntimeDescription",
"classitems": [
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 179,
"description": "Given a descriptions string, extracts data tags, parses JSON\nand adds the properties to this component, allowing them\nto be used in code examples.
\nIf we have a glimmer block which has data={'colors': ['red', 'green', 'blue']}\nthis will add a property colors to the component with the value ['red', 'green', 'blue']
\nPresents users with an error message if the JSON cannot be parsed
\n",
"itemtype": "method",
"name": "_addDataTagVariables",
"params": [
{
"name": "docString",
"description": null,
"type": "String"
}
],
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 65,
"description": "Looks through the passed-in template string and checks for action helpers;\nwhen it finds some, it checks for the actions referenced and registers no-ops\nfor them on this component's context so that the application doesn't explode\nwhen trying to reference a non-existent action.
\n",
"itemtype": "method",
"name": "_checkActionRefs",
"params": [
{
"name": "templateString",
"description": "The template string to run the check for action matches on
\n",
"type": "String"
}
],
"return": {
"description": "",
"type": "Undefined"
},
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 98,
"description": "Grabs the input from the parent instance's code editor, compiles it into a\nreal-live HTMLBars template, registers it on the container as a partial\nand makes it available as output for the preview component's template to\nrender.
\nNew partials are created for every change, using a date string as the\npartial name to avoid collisions.
\nTODO: Use lookup partial names that can be mapped and retrieved instead of\nmaking new ones each time
\n",
"itemtype": "method",
"name": "_generateDescription",
"params": [
{
"name": "templateString",
"description": "String to generate template from
\n",
"type": "String"
}
],
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 169,
"description": "Given a description string strips any\ndata tags from the code example.
\n",
"itemtype": "method",
"name": "_stripDataTags",
"return": {
"description": "",
"type": "String"
},
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 41,
"itemtype": "property",
"name": "classNames",
"type": "{Array}",
"default": "['fh-description']",
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 47,
"description": "If there is a parsing error during the template compilation the catch block\nwill set it as the compilerError. This parsing error is rendered for\neasier debugging of invalid content.
\n",
"itemtype": "property",
"name": "compilerError",
"type": "{?string}",
"default": "null",
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 22,
"description": "The content string that should be rendered. This string is passed to the\nruntime compiler and registered as a partial if compilation is successful.
\n",
"itemtype": "property",
"name": "content",
"type": "{string}",
"default": "''",
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 30,
"description": "The string that should be converted to a partial
\n",
"itemtype": "property",
"name": "description",
"type": "{string}",
"default": "''",
"deprecated": true,
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 156,
"description": "Whenever attrs are received fire the _generateDescription method to\ngenerate a partial that will be rendered.
\n",
"itemtype": "event",
"name": "didReceiveAttrs",
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 133,
"description": "On init we map the passed contextActions to real actions in this\ncomponent's actions hash to ensure they're available at compile time.
\n",
"itemtype": "method",
"name": "init",
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 56,
"description": "Name of generated partial that is used in the template.
\n",
"itemtype": "property",
"name": "partialName",
"type": "{string}",
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/fountainhead-runtime-description.js",
"line": 8,
"description": "Generates a description during runtime by using HTMLBars to compile any\nstring to a partial. This allows us to create descriptions from JSON\nresponses with components inside of them.
\nTODO: Name partials by class+type+name for re-use
\n",
"is_constructor": 1,
"extends": "Ember.Component",
"method": [
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 179,
"description": "Given a descriptions string, extracts data tags, parses JSON\nand adds the properties to this component, allowing them\nto be used in code examples.
\nIf we have a glimmer block which has data={'colors': ['red', 'green', 'blue']}\nthis will add a property colors to the component with the value ['red', 'green', 'blue']
\nPresents users with an error message if the JSON cannot be parsed
\n",
"itemtype": "method",
"name": "_addDataTagVariables",
"params": [
{
"name": "docString",
"description": null,
"type": "String"
}
],
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 65,
"description": "Looks through the passed-in template string and checks for action helpers;\nwhen it finds some, it checks for the actions referenced and registers no-ops\nfor them on this component's context so that the application doesn't explode\nwhen trying to reference a non-existent action.
\n",
"itemtype": "method",
"name": "_checkActionRefs",
"params": [
{
"name": "templateString",
"description": "The template string to run the check for action matches on
\n",
"type": "String"
}
],
"return": {
"description": "",
"type": "Undefined"
},
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 98,
"description": "Grabs the input from the parent instance's code editor, compiles it into a\nreal-live HTMLBars template, registers it on the container as a partial\nand makes it available as output for the preview component's template to\nrender.
\nNew partials are created for every change, using a date string as the\npartial name to avoid collisions.
\nTODO: Use lookup partial names that can be mapped and retrieved instead of\nmaking new ones each time
\n",
"itemtype": "method",
"name": "_generateDescription",
"params": [
{
"name": "templateString",
"description": "String to generate template from
\n",
"type": "String"
}
],
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 169,
"description": "Given a description string strips any\ndata tags from the code example.
\n",
"itemtype": "method",
"name": "_stripDataTags",
"return": {
"description": "",
"type": "String"
},
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 133,
"description": "On init we map the passed contextActions to real actions in this\ncomponent's actions hash to ensure they're available at compile time.
\n",
"itemtype": "method",
"name": "init",
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
}
],
"property": [
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 41,
"itemtype": "property",
"name": "classNames",
"type": "{Array}",
"default": "['fh-description']",
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 47,
"description": "If there is a parsing error during the template compilation the catch block\nwill set it as the compilerError. This parsing error is rendered for\neasier debugging of invalid content.
\n",
"itemtype": "property",
"name": "compilerError",
"type": "{?string}",
"default": "null",
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 22,
"description": "The content string that should be rendered. This string is passed to the\nruntime compiler and registered as a partial if compilation is successful.
\n",
"itemtype": "property",
"name": "content",
"type": "{string}",
"default": "''",
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 30,
"description": "The string that should be converted to a partial
\n",
"itemtype": "property",
"name": "description",
"type": "{string}",
"default": "''",
"deprecated": true,
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 56,
"description": "Name of generated partial that is used in the template.
\n",
"itemtype": "property",
"name": "partialName",
"type": "{string}",
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
}
],
"event": [
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 156,
"description": "Whenever attrs are received fire the _generateDescription method to\ngenerate a partial that will be rendered.
\n",
"itemtype": "event",
"name": "didReceiveAttrs",
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
}
],
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
"FountainheadState": {
"name": "FountainheadState",
"shortname": "FountainheadState",
"classitems": [
{
"file": "addon/components/fountainhead-state.js",
"line": 73,
"description": "Actions hash
\n",
"itemtype": "property",
"name": "actions",
"type": "{Object}",
"class": "FountainheadState",
"srcFileId": "addon_components_fountainhead-state.js"
},
{
"file": "addon/components/fountainhead-state.js",
"line": 52,
"description": "Boolean state tracking property. Use this to handle show/hide status.\n{{if state 'state' 'no-state'}}\n{{#fountainhead-button click=stateActions.toggleState}}Click{{/fountainhead-button}}
\n",
"itemtype": "property",
"name": "active",
"type": "{Boolean}",
"class": "FountainheadState",
"srcFileId": "addon_components_fountainhead-state.js"
},
{
"file": "addon/components/fountainhead-state.js",
"line": 79,
"description": "Sets the {{c-l 'active'}} property to false.
\n",
"itemtype": "method",
"name": "closeModal",
"class": "FountainheadState",
"srcFileId": "addon_components_fountainhead-state.js"
},
{
"file": "addon/components/fountainhead-state.js",
"line": 86,
"description": "Sets the {{c-l 'active'}} property to true.
\n",
"itemtype": "method",
"name": "openModal",
"class": "FountainheadState",
"srcFileId": "addon_components_fountainhead-state.js"
},
{
"file": "addon/components/fountainhead-state.js",
"line": 60,
"description": "Rad State is a purely functional component with no rendered output of its\nown, so it doesn't need a root element cluttering up the DOM when it's\nbeing used.\n{{if state 'state' 'no-state'}}\n{{#fountainhead-button click=stateActions.toggleState}}Click{{/fountainhead-button}}
\n",
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"class": "FountainheadState",
"srcFileId": "addon_components_fountainhead-state.js"
},
{
"file": "addon/components/fountainhead-state.js",
"line": 93,
"description": "Sets the {{c-l 'active'}} property to passed state.
\n",
"itemtype": "method",
"name": "toggleState",
"params": [
{
"name": "state",
"description": "State to set active to
\n",
"type": "Boolean"
}
],
"class": "FountainheadState",
"srcFileId": "addon_components_fountainhead-state.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/fountainhead-state.js",
"line": 4,
"description": "{{#fountainhead-header tagName=\"h2\" elementId=\"ember-radical-`rad-state`-component\"}}Ember-Radical rad-state Component{{/fountainhead-header}}\nComponent that can be used for tracking state changes with modals or drawers.\nWrap either in one of these and use the yielded state and actions to handle\nshowing/hiding/controlling your component.
\nUseful mainly for demonstration/documentation purposes, but also handy for\nwhen you don't have a convenient place to store state (particularly during\nearly development stages). It's also kind of nice for not cluttering up your\nparent scope with a bunch of extra state and actions you might not want to\nhang onto. Go nuts!
\n{{#fountainhead-header tagName=\"h2\" elementId=\"usage\"}}Usage{{/fountainhead-header}}\nInstances of rad-state yield an active property and a hash of actions\nfor manipulating that state: open, close, and toggleState.
\n{ { #rad- state as | state stateActions| } } \n { { bank- vault\n isOpen= state\n closeVault= stateActions. close\n openVault= stateActions. open} } \n{ { / rad- state} } \nOr for a smipler toggling implementation:
\n{ { #rad- state as | switchState switchActions| } } \n { { light- switch isOn= switchState toggleSwitch= switchActions. toggleState} } \n{ { / rad- state} } \nThe actions in the actions hash have already been yielded via the action\nhelper, so it is not necessary to continue using that helper when passing\nactions into child components as properties (but you totally still can if\nyou would prefer to.
\n",
"is_constructor": 1,
"extends": "EmberRadical.RadState",
"method": [
{
"file": "addon/components/fountainhead-state.js",
"line": 79,
"description": "Sets the {{c-l 'active'}} property to false.
\n",
"itemtype": "method",
"name": "closeModal",
"class": "FountainheadState",
"srcFileId": "addon_components_fountainhead-state.js"
},
{
"file": "addon/components/fountainhead-state.js",
"line": 86,
"description": "Sets the {{c-l 'active'}} property to true.
\n",
"itemtype": "method",
"name": "openModal",
"class": "FountainheadState",
"srcFileId": "addon_components_fountainhead-state.js"
},
{
"file": "addon/components/fountainhead-state.js",
"line": 93,
"description": "Sets the {{c-l 'active'}} property to passed state.
\n",
"itemtype": "method",
"name": "toggleState",
"params": [
{
"name": "state",
"description": "State to set active to
\n",
"type": "Boolean"
}
],
"class": "FountainheadState",
"srcFileId": "addon_components_fountainhead-state.js"
}
],
"property": [
{
"file": "addon/components/fountainhead-state.js",
"line": 73,
"description": "Actions hash
\n",
"itemtype": "property",
"name": "actions",
"type": "{Object}",
"class": "FountainheadState",
"srcFileId": "addon_components_fountainhead-state.js"
},
{
"file": "addon/components/fountainhead-state.js",
"line": 52,
"description": "Boolean state tracking property. Use this to handle show/hide status.\n{{if state 'state' 'no-state'}}\n{{#fountainhead-button click=stateActions.toggleState}}Click{{/fountainhead-button}}
\n",
"itemtype": "property",
"name": "active",
"type": "{Boolean}",
"class": "FountainheadState",
"srcFileId": "addon_components_fountainhead-state.js"
},
{
"file": "addon/components/fountainhead-state.js",
"line": 60,
"description": "Rad State is a purely functional component with no rendered output of its\nown, so it doesn't need a root element cluttering up the DOM when it's\nbeing used.\n{{if state 'state' 'no-state'}}\n{{#fountainhead-button click=stateActions.toggleState}}Click{{/fountainhead-button}}
\n",
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"class": "FountainheadState",
"srcFileId": "addon_components_fountainhead-state.js"
}
],
"event": [],
"srcFileId": "addon_components_fountainhead-state.js"
},
"FountainheadSVG": {
"name": "FountainheadSVG",
"shortname": "FountainheadSVG",
"classitems": [
{
"file": "addon/components/fountainhead-svg.js",
"line": 32,
"itemtype": "property",
"name": "attributeBindings",
"type": "{Array}",
"default": "['data-test']",
"class": "FountainheadSVG",
"srcFileId": "addon_components_fountainhead-svg.js"
},
{
"file": "addon/components/fountainhead-svg.js",
"line": 44,
"itemtype": "property",
"name": "classNameBindings",
"type": "{Array}",
"default": "['svgId']",
"class": "FountainheadSVG",
"srcFileId": "addon_components_fountainhead-svg.js"
},
{
"file": "addon/components/fountainhead-svg.js",
"line": 38,
"itemtype": "property",
"name": "classNames",
"type": "{Array}",
"default": "['fh-svg']",
"class": "FountainheadSVG",
"srcFileId": "addon_components_fountainhead-svg.js"
},
{
"file": "addon/components/fountainhead-svg.js",
"line": 13,
"description": "File path to svg definitions file
\n",
"itemtype": "property",
"name": "filePath",
"type": "{string}",
"passed": "",
"optional": 1,
"default": "assets/svg-defs.svg",
"class": "FountainheadSVG",
"srcFileId": "addon_components_fountainhead-svg.js"
},
{
"file": "addon/components/fountainhead-svg.js",
"line": 22,
"description": "External SVG definitions file reference SVG id.
\n",
"itemtype": "property",
"name": "svgId",
"type": "{string}",
"passed": "",
"required": 1,
"class": "FountainheadSVG",
"srcFileId": "addon_components_fountainhead-svg.js"
},
{
"file": "addon/components/fountainhead-svg.js",
"line": 50,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "'svg'",
"class": "FountainheadSVG",
"srcFileId": "addon_components_fountainhead-svg.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/fountainhead-svg.js",
"line": 4,
"is_constructor": 1,
"extends": "Ember.Component",
"method": [],
"property": [
{
"file": "addon/components/fountainhead-svg.js",
"line": 32,
"itemtype": "property",
"name": "attributeBindings",
"type": "{Array}",
"default": "['data-test']",
"class": "FountainheadSVG",
"srcFileId": "addon_components_fountainhead-svg.js"
},
{
"file": "addon/components/fountainhead-svg.js",
"line": 44,
"itemtype": "property",
"name": "classNameBindings",
"type": "{Array}",
"default": "['svgId']",
"class": "FountainheadSVG",
"srcFileId": "addon_components_fountainhead-svg.js"
},
{
"file": "addon/components/fountainhead-svg.js",
"line": 38,
"itemtype": "property",
"name": "classNames",
"type": "{Array}",
"default": "['fh-svg']",
"class": "FountainheadSVG",
"srcFileId": "addon_components_fountainhead-svg.js"
},
{
"file": "addon/components/fountainhead-svg.js",
"line": 13,
"description": "File path to svg definitions file
\n",
"itemtype": "property",
"name": "filePath",
"type": "{string}",
"passed": "",
"optional": 1,
"default": "assets/svg-defs.svg",
"class": "FountainheadSVG",
"srcFileId": "addon_components_fountainhead-svg.js"
},
{
"file": "addon/components/fountainhead-svg.js",
"line": 22,
"description": "External SVG definitions file reference SVG id.
\n",
"itemtype": "property",
"name": "svgId",
"type": "{string}",
"passed": "",
"required": 1,
"class": "FountainheadSVG",
"srcFileId": "addon_components_fountainhead-svg.js"
},
{
"file": "addon/components/fountainhead-svg.js",
"line": 50,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "'svg'",
"class": "FountainheadSVG",
"srcFileId": "addon_components_fountainhead-svg.js"
}
],
"event": [],
"srcFileId": "addon_components_fountainhead-svg.js"
},
"FountainheadTabsContent": {
"name": "FountainheadTabsContent",
"shortname": "FountainheadTabsContent",
"classitems": [
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 81,
"description": "Computed _hidden accounts for whether the tab is selected (by checking\nactiveId) && if this tab has been flagged to be hidden with property\nhidden
\n",
"itemtype": "property",
"name": "_hidden",
"return": {
"description": "String of true/false for use with `aria-hidden` binding",
"type": "String"
},
"class": "FountainheadTabsContent",
"subprops": [
{
"name": "activeId",
"description": "",
"type": "String"
},
{
"name": "hidden",
"description": "",
"type": "Boolean"
}
],
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 37,
"description": "The id of the currently active tab in the scope of the\nfountainhead-tabs component. This is provided privately in the\nfountainhead-tabs yield hash.
\n",
"itemtype": "property",
"name": "activeId",
"type": "{String}",
"default": "''",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 60,
"description": "Aria role tabpanel is bound for A++ accessibility.
\n",
"itemtype": "property",
"name": "ariaRole",
"type": "{string}",
"default": "tabpanel",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 67,
"description": "Bound attributes:
\n\ndata-test: for precise testing identification_hidden: to hide this tab if it is not selected or if prop hidden is true \n",
"itemtype": "property",
"name": "attributeBindings",
"type": "{Array}",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 75,
"description": "Class names: tabs-content
\n",
"itemtype": "property",
"name": "classNames",
"type": "{Array}",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 136,
"description": "Actions Up: When something changes in this component we need to let the\ncontainer tabs know by firing the updateTab closure action with this\ntabs changed data.
\n(Currently the only change we're notifying on is the hidden prop)
\n",
"itemtype": "event",
"name": "didUpdateAttrs",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 46,
"description": "Whether this tab should be hidden from view. Useful for situations where\na tab needs to exist in a particular place in the tab ordering but may\nnot have the data it needs to display information at the time when\nregisterTab is invoked. This allows you to make sure your tab can be\nhidden while preserving its place in the list.
\n",
"itemtype": "property",
"name": "hidden",
"type": "{Boolean}",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 118,
"description": "Handle registering with the tabs container on int by firing registerTab\nclosure action with this tab's data.
\n",
"itemtype": "event",
"name": "init",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 97,
"description": "The button label text of this tab. This will be passed up via a closure\naction to the containing fountainhead-tabs component.
\n",
"itemtype": "property",
"name": "label",
"type": "{String}",
"default": "''",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 106,
"description": "Use this attribute to place a custom data-test attribute on the tab button\nfor this tab. This will allow easier, specific/direct targeting of clicking\nthis tab in automated testing.
\n",
"itemtype": "property",
"name": "tabDataTest",
"type": "{string}",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/fountainhead-tabs-content.js",
"line": 7,
"description": "This component is yielded by the fountainhead-tabs component. The activeId and\nactions registerTab and updateTab are privately bound for internal use.
\nOn init each tab will register itself with the fountainhead-tabs wrapping container,\npassing all its data. The fountainhead-tabs container uses this to build out the\ntab buttons.
\n{ { #fountainhead- tabs defaultTab= \"dumpsterShrimp\" as | components| } } \n { { #components. content label= \"Shrimp\" elementId= \"dumpsterShrimp\" tabDataTest= \"a-nifty-tab-button\" } } \n BRINGO! There's some pretty good lil' shrimpers in here, lets check it out. \n { { / components. content} } \n{ { / fountainhead- tabs} } \n\n\n\nConfiguration \nType \nDefault \nDescription \n \n \n\n\nlabelstring \nnull \nText label of the tab button for this panel \n \n\nelementIdstring \nnull \nSet a specific id for this component when using container defaultTab \n \n\ntabDataTeststring \nnull \ndata-test for the tab button \n \n
\n",
"is_constructor": 1,
"extends": "Ember.Component",
"method": [],
"property": [
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 81,
"description": "Computed _hidden accounts for whether the tab is selected (by checking\nactiveId) && if this tab has been flagged to be hidden with property\nhidden
\n",
"itemtype": "property",
"name": "_hidden",
"return": {
"description": "String of true/false for use with `aria-hidden` binding",
"type": "String"
},
"class": "FountainheadTabsContent",
"subprops": [
{
"name": "activeId",
"description": "",
"type": "String"
},
{
"name": "hidden",
"description": "",
"type": "Boolean"
}
],
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 37,
"description": "The id of the currently active tab in the scope of the\nfountainhead-tabs component. This is provided privately in the\nfountainhead-tabs yield hash.
\n",
"itemtype": "property",
"name": "activeId",
"type": "{String}",
"default": "''",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 60,
"description": "Aria role tabpanel is bound for A++ accessibility.
\n",
"itemtype": "property",
"name": "ariaRole",
"type": "{string}",
"default": "tabpanel",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 67,
"description": "Bound attributes:
\n\ndata-test: for precise testing identification_hidden: to hide this tab if it is not selected or if prop hidden is true \n",
"itemtype": "property",
"name": "attributeBindings",
"type": "{Array}",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 75,
"description": "Class names: tabs-content
\n",
"itemtype": "property",
"name": "classNames",
"type": "{Array}",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 46,
"description": "Whether this tab should be hidden from view. Useful for situations where\na tab needs to exist in a particular place in the tab ordering but may\nnot have the data it needs to display information at the time when\nregisterTab is invoked. This allows you to make sure your tab can be\nhidden while preserving its place in the list.
\n",
"itemtype": "property",
"name": "hidden",
"type": "{Boolean}",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 97,
"description": "The button label text of this tab. This will be passed up via a closure\naction to the containing fountainhead-tabs component.
\n",
"itemtype": "property",
"name": "label",
"type": "{String}",
"default": "''",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 106,
"description": "Use this attribute to place a custom data-test attribute on the tab button\nfor this tab. This will allow easier, specific/direct targeting of clicking\nthis tab in automated testing.
\n",
"itemtype": "property",
"name": "tabDataTest",
"type": "{string}",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
}
],
"event": [
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 136,
"description": "Actions Up: When something changes in this component we need to let the\ncontainer tabs know by firing the updateTab closure action with this\ntabs changed data.
\n(Currently the only change we're notifying on is the hidden prop)
\n",
"itemtype": "event",
"name": "didUpdateAttrs",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 118,
"description": "Handle registering with the tabs container on int by firing registerTab\nclosure action with this tab's data.
\n",
"itemtype": "event",
"name": "init",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
}
],
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
"FountainheadTabs": {
"name": "FountainheadTabs",
"shortname": "FountainheadTabs",
"classitems": [
{
"file": "addon/components/fountainhead-tabs.js",
"line": 166,
"description": "Internal method that can be used with a run.once call to only add new tabs\nonce per run loop. Simply iterates through _tabsToCreate and pushes them\ninto the tabList. This is needed to prevent multiple renders in a single\nrun loop when all of the content subcomponents register themselves with\nthe container during init.
\n",
"itemtype": "method",
"name": "_createTabsList",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 87,
"description": "The elementId of the currently opened tab. This determines which tab is active and\nwhich tab's content to display. If this is empty, no tabs are open.
\n",
"itemtype": "property",
"name": "activeId",
"type": "{String}",
"default": "''",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 142,
"description": "Bound attributes:
\n\ndata-test: for precise testing identification \n",
"itemtype": "property",
"name": "attributeBindings",
"type": "{Array}",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 95,
"description": "Pass false to use tab style without primary color tabs.
\n",
"itemtype": "property",
"name": "buttonStyle",
"type": "{Boolean}",
"default": "true",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 149,
"description": "Class names: fountainhead-tabs
\n",
"itemtype": "property",
"name": "classNames",
"type": "{Array}",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 102,
"description": "The optional elementId of the tab that should be shown by default. This is\nuseful for cases where the user has come into a page and is expecting one\nof the tabs to be shown by default.
\n",
"itemtype": "property",
"name": "defaultTab",
"type": "{String}",
"default": "''",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 183,
"description": "When the component initializes, we set the tabList property to an array.\nThis prevents multiple instances of fountainhead-tabs on a given page\nfrom inheriting the same tabList array through prototype inheritance.
\n",
"itemtype": "event",
"name": "init",
"return": {
"description": "",
"type": "Undefined"
},
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 111,
"description": "Optional closure action that will be called whenever a tab is opened with\nthe id of that tab. Use this to create a controlled tabs instance.
\n",
"itemtype": "property",
"name": "onChange",
"type": "{function}",
"default": "null",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 229,
"description": "Closure action passed to content subcomponents that is called on init.\nEach child tab will register itself with this container. To ensure the\ntabList is only updated once per render, we proxy new tabs to the\n_tabsToCreate array and then push all of them to tabList using a\nrun.once call to _createTabsList
\n",
"itemtype": "method",
"name": "registerTab",
"params": [
{
"name": "tab",
"description": "Object model of tab to be registered
\n",
"type": "Object"
}
],
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 119,
"description": "Whether the page should scroll the tab context back to the top when one of\nthe tabs is clicked. This can be a nice convenience for usabilitee.
\n",
"itemtype": "property",
"name": "scrollOnClick",
"type": "{Boolean}",
"default": "false",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 127,
"description": "What the target of the scrollOnClick behavior should be. By default,\nthe entire page/body scrolls, however if this instance of\nfountainhead-tabs is contained within a modal or some other scrollable\nsub-container, it may be more desirable to execute a scroll against that\ninstead of the entire page. Simply pass a standard jQuery-like selector in\nas a string.
\n",
"itemtype": "property",
"name": "scrollTarget",
"type": "{string}",
"default": "'body, html'",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 207,
"description": "Action to show a tab. Set activeId to the passed elementId. activeId\nis passed down to children content components
\n",
"itemtype": "method",
"name": "showTab",
"params": [
{
"name": "elementId",
"description": "HTML id of the tab to show
\n",
"type": "String"
}
],
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 155,
"description": "List of tabs to display. This is iterated through in the template to\nrendered the buttons that are used to change tabs.
\n",
"itemtype": "property",
"name": "tabList",
"type": "{Array.}",
"default": "null",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 243,
"description": "Closure action passed to content subcomponents that is called whenever\na tab has updated in a way this container needs to know of. Currently\nthis is only when a tab's hidden status changes.
\n",
"itemtype": "method",
"name": "updateTab",
"params": [
{
"name": "tab",
"description": null,
"type": "Object",
"props": [
{
"name": "elementId",
"description": "HTML id of tab to update",
"type": "String"
},
{
"name": "hidden",
"description": "Hidden status of changed tab",
"type": "Boolean"
}
]
}
],
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/fountainhead-tabs.js",
"line": 10,
"description": "A++ Accessible tabs. The fountainhead-tabs component is the parent\ncontainer for a given set of tabs and handles managing the active state of\nthe tabs and tab panels. The fountainhead-tabs component yields a content\ncontextual component inside of the components hash.
\n{{#fountainhead-header tagName=\"h4\" elementId=\"usage\"}}Usage{{/fountainhead-header}}\n{ { #fountainhead- tabs as | components| } } \n { { #components. content label= \"Delgrango's\" } } \n This is my favorite resaurant at the marinara, name of Delgrango's\n { { / components. content} } \n { { #components. content label= \"Fresh Water\" } } \n Boy I sure did work up a thirst after eating all them shramps. Time to\n wash it down with a cool glass of marina water. \n { { / components. content} } \n{ { / fountainhead- tabs} } \nYou can include any number of components.content contextual components.\n(However keep in mind that adding too many content components may result in\nthe tab labels becoming unreadable depending on the space alotted for\ndisplaying them.)
\nYou can also specify a default tab by setting the defaultTab parameter to\nmatch one of content components' HTML id property:
\n{ { #fountainhead- tabs defaultTab= \"shrimpers\" as | components| } } \n { { #components. content label= \"Shrimp\" elementId= \"shrimpers\" } } \n BRINGO! There's some pretty good lil' shrimpers in here, lets check it out. \n { { / components. content} } \n { { #components. content label= \"Delgrango's\" } } \n This is my favorite resaurant at the marinara, name of Delgrango's\n { { / components. content} } \n{ { / fountainhead- tabs} } \nIf you need to programatically open tabs within your application you can\ncreate a controlled instance of fountainhead-tabs by specifying the\nactiveId for the component. This means that you need to track the\nactiveId in a parent component or service and pass it down into the\ncontrolled tab instance. To do this pass an onChange closure into the\ncomponent. It will be called with the elementId of the selected tab any\ntime a user changes tabs.
\nTODO: Template & JS Examples
\nConfiguration | Type | Default | Description\n— | — | —\nactiveId | string | null | The elementId of the tab that should be opened\nbuttonStyle | boolean | true | Set to false for tab buttons without primary background-color\ndefaultTab | string | null | Tab to render shown by default\nonChange | function | null | Optional closure that will be called when any tab is opened\nscrollOnClick | boolean | false | Set to true to scroll page to top on tab click\nscrollTarget | jQuery selector | 'body, html' | Specify scroll animation target
\n{{#fountainhead-header tagName=\"h3\" elementId=\"a++-accessibility\"}}A++ Accessibility{{/fountainhead-header}}\n\nTabs have aria-controls set to the elementId of the tabpanel they show. \nTabs have role=tab for role identification \nTabs are instances of fountainhead-button for keyboard access \nShow/hide of tabs and panels are managed through aria-hidden attr \n \n{{#fountainhead-header tagName=\"h3\" elementId=\"feature-notes:\"}}Feature Notes:{{/fountainhead-header}}\n\nThe tab list is a flexbox container with flex-grow 1 for each tab. This auto\nmagically grows the tabs to fill the entire width of tab container. \n \n",
"is_constructor": 1,
"extends": "Ember.Component",
"method": [
{
"file": "addon/components/fountainhead-tabs.js",
"line": 166,
"description": "Internal method that can be used with a run.once call to only add new tabs\nonce per run loop. Simply iterates through _tabsToCreate and pushes them\ninto the tabList. This is needed to prevent multiple renders in a single\nrun loop when all of the content subcomponents register themselves with\nthe container during init.
\n",
"itemtype": "method",
"name": "_createTabsList",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 229,
"description": "Closure action passed to content subcomponents that is called on init.\nEach child tab will register itself with this container. To ensure the\ntabList is only updated once per render, we proxy new tabs to the\n_tabsToCreate array and then push all of them to tabList using a\nrun.once call to _createTabsList
\n",
"itemtype": "method",
"name": "registerTab",
"params": [
{
"name": "tab",
"description": "Object model of tab to be registered
\n",
"type": "Object"
}
],
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 207,
"description": "Action to show a tab. Set activeId to the passed elementId. activeId\nis passed down to children content components
\n",
"itemtype": "method",
"name": "showTab",
"params": [
{
"name": "elementId",
"description": "HTML id of the tab to show
\n",
"type": "String"
}
],
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 243,
"description": "Closure action passed to content subcomponents that is called whenever\na tab has updated in a way this container needs to know of. Currently\nthis is only when a tab's hidden status changes.
\n",
"itemtype": "method",
"name": "updateTab",
"params": [
{
"name": "tab",
"description": null,
"type": "Object",
"props": [
{
"name": "elementId",
"description": "HTML id of tab to update",
"type": "String"
},
{
"name": "hidden",
"description": "Hidden status of changed tab",
"type": "Boolean"
}
]
}
],
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
}
],
"property": [
{
"file": "addon/components/fountainhead-tabs.js",
"line": 87,
"description": "The elementId of the currently opened tab. This determines which tab is active and\nwhich tab's content to display. If this is empty, no tabs are open.
\n",
"itemtype": "property",
"name": "activeId",
"type": "{String}",
"default": "''",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 142,
"description": "Bound attributes:
\n\ndata-test: for precise testing identification \n",
"itemtype": "property",
"name": "attributeBindings",
"type": "{Array}",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 95,
"description": "Pass false to use tab style without primary color tabs.
\n",
"itemtype": "property",
"name": "buttonStyle",
"type": "{Boolean}",
"default": "true",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 149,
"description": "Class names: fountainhead-tabs
\n",
"itemtype": "property",
"name": "classNames",
"type": "{Array}",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 102,
"description": "The optional elementId of the tab that should be shown by default. This is\nuseful for cases where the user has come into a page and is expecting one\nof the tabs to be shown by default.
\n",
"itemtype": "property",
"name": "defaultTab",
"type": "{String}",
"default": "''",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 111,
"description": "Optional closure action that will be called whenever a tab is opened with\nthe id of that tab. Use this to create a controlled tabs instance.
\n",
"itemtype": "property",
"name": "onChange",
"type": "{function}",
"default": "null",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 119,
"description": "Whether the page should scroll the tab context back to the top when one of\nthe tabs is clicked. This can be a nice convenience for usabilitee.
\n",
"itemtype": "property",
"name": "scrollOnClick",
"type": "{Boolean}",
"default": "false",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 127,
"description": "What the target of the scrollOnClick behavior should be. By default,\nthe entire page/body scrolls, however if this instance of\nfountainhead-tabs is contained within a modal or some other scrollable\nsub-container, it may be more desirable to execute a scroll against that\ninstead of the entire page. Simply pass a standard jQuery-like selector in\nas a string.
\n",
"itemtype": "property",
"name": "scrollTarget",
"type": "{string}",
"default": "'body, html'",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 155,
"description": "List of tabs to display. This is iterated through in the template to\nrendered the buttons that are used to change tabs.
\n",
"itemtype": "property",
"name": "tabList",
"type": "{Array.}",
"default": "null",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
}
],
"event": [
{
"file": "addon/components/fountainhead-tabs.js",
"line": 183,
"description": "When the component initializes, we set the tabList property to an array.\nThis prevents multiple instances of fountainhead-tabs on a given page\nfrom inheriting the same tabList array through prototype inheritance.
\n",
"itemtype": "event",
"name": "init",
"return": {
"description": "",
"type": "Undefined"
},
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
}
],
"srcFileId": "addon_components_fountainhead-tabs.js"
},
"FountainheadWelcome": {
"name": "FountainheadWelcome",
"shortname": "FountainheadWelcome",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/fountainhead-welcome.js",
"line": 4,
"description": "Component determines the 'Welcome' message displayed to consumers that have\nsuccessfuly generated documentation data.
\n",
"is_constructor": 1,
"extends": "Ember.Component",
"method": [],
"property": [],
"event": [],
"srcFileId": "addon_components_fountainhead-welcome.js"
},
"NavigationAPI": {
"name": "NavigationAPI",
"shortname": "NavigationAPI",
"classitems": [
{
"file": "addon/components/navigation-api.js",
"line": 37,
"description": "Method to filter on doc elements for search.
\n",
"itemtype": "method",
"name": "doFilter",
"params": [
{
"name": "query",
"description": "The search query to filter on
\n",
"type": "String"
}
],
"return": {
"description": "",
"type": "Undefined"
},
"class": "NavigationAPI",
"srcFileId": "addon_components_navigation-api.js"
},
{
"file": "addon/components/navigation-api.js",
"line": 16,
"description": "Fountainhead meta passed from service
\n",
"itemtype": "property",
"name": "meta",
"type": "{Object}",
"passed": "Fountainhead",
"required": 1,
"class": "NavigationAPI",
"srcFileId": "addon_components_navigation-api.js"
},
{
"file": "addon/components/navigation-api.js",
"line": 27,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "NavigationAPI",
"srcFileId": "addon_components_navigation-api.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/navigation-api.js",
"line": 4,
"description": "Parent navigation component for API route. Requires the entire docs meta\nobject.
\n",
"is_constructor": 1,
"extends": "Ember.Component",
"method": [
{
"file": "addon/components/navigation-api.js",
"line": 37,
"description": "Method to filter on doc elements for search.
\n",
"itemtype": "method",
"name": "doFilter",
"params": [
{
"name": "query",
"description": "The search query to filter on
\n",
"type": "String"
}
],
"return": {
"description": "",
"type": "Undefined"
},
"class": "NavigationAPI",
"srcFileId": "addon_components_navigation-api.js"
}
],
"property": [
{
"file": "addon/components/navigation-api.js",
"line": 16,
"description": "Fountainhead meta passed from service
\n",
"itemtype": "property",
"name": "meta",
"type": "{Object}",
"passed": "Fountainhead",
"required": 1,
"class": "NavigationAPI",
"srcFileId": "addon_components_navigation-api.js"
},
{
"file": "addon/components/navigation-api.js",
"line": 27,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "NavigationAPI",
"srcFileId": "addon_components_navigation-api.js"
}
],
"event": [],
"srcFileId": "addon_components_navigation-api.js"
},
"NavigationGuides": {
"name": "NavigationGuides",
"shortname": "NavigationGuides",
"classitems": [
{
"file": "addon/components/navigation-guides.js",
"line": 16,
"description": "Fountainhead documentation meta. Component uses the guides meta to create\nlinks to each guide page.
\n",
"itemtype": "property",
"name": "meta",
"type": "{Object}",
"passed": "Fountainhead",
"required": 1,
"class": "NavigationGuides",
"srcFileId": "addon_components_navigation-guides.js"
},
{
"file": "addon/components/navigation-guides.js",
"line": 28,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "NavigationGuides",
"srcFileId": "addon_components_navigation-guides.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/components/navigation-guides.js",
"line": 4,
"description": "Guides page navigation is distinct from the API navigation. The Fountainhead\nmeta object is passed into this component.
\n",
"is_constructor": 1,
"extends": "Ember.Component",
"experimental": "",
"method": [],
"property": [
{
"file": "addon/components/navigation-guides.js",
"line": 16,
"description": "Fountainhead documentation meta. Component uses the guides meta to create\nlinks to each guide page.
\n",
"itemtype": "property",
"name": "meta",
"type": "{Object}",
"passed": "Fountainhead",
"required": 1,
"class": "NavigationGuides",
"srcFileId": "addon_components_navigation-guides.js"
},
{
"file": "addon/components/navigation-guides.js",
"line": 28,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "NavigationGuides",
"srcFileId": "addon_components_navigation-guides.js"
}
],
"event": [],
"srcFileId": "addon_components_navigation-guides.js"
},
"Guides": {
"name": "Guides",
"shortname": "Guides",
"classitems": [
{
"file": "addon/routes/guides.js",
"line": 14,
"description": "When in Fountainhead we need to pass down id query param OR the hash depending\non LocationType. Kick off hash tracking on activate.
\n",
"itemtype": "method",
"name": "activate",
"class": "Guides",
"srcFileId": "addon_routes_guides.js"
},
{
"file": "addon/routes/guides.js",
"line": 22,
"description": "We check for and fetch meta data if needed in the parent routes of\nFountainhead. This lets consumers overwrite the apiNamespace if they\nneed before we request the meta data that drives Fountainhead.
\nNOTE: We only fetch meta data if it isn't present yet.
\n",
"itemtype": "method",
"name": "beforeModel",
"return": {
"description": "",
"type": "Promise|true"
},
"class": "Guides",
"srcFileId": "addon_routes_guides.js"
},
{
"file": "addon/routes/guides.js",
"line": 38,
"description": "Fetches modules's JSON at: ${this.get('fountainhead.apiNamespace')}/modules/${params.file_id}.json
\n",
"itemtype": "method",
"name": "model",
"params": [
{
"name": "params",
"description": null,
"type": "Object",
"props": [
{
"name": "guide_id",
"description": "Name of this class, use to fetch data",
"type": "String"
}
]
}
],
"return": {
"description": "jQuery ajax promise",
"type": "Promise"
},
"class": "Guides",
"srcFileId": "addon_routes_guides.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/routes/guides.js",
"line": 4,
"description": "Fountainhead guides route.
\n",
"is_constructor": 1,
"extends": "BaseController",
"method": [
{
"file": "addon/routes/guides.js",
"line": 14,
"description": "When in Fountainhead we need to pass down id query param OR the hash depending\non LocationType. Kick off hash tracking on activate.
\n",
"itemtype": "method",
"name": "activate",
"class": "Guides",
"srcFileId": "addon_routes_guides.js"
},
{
"file": "addon/routes/guides.js",
"line": 22,
"description": "We check for and fetch meta data if needed in the parent routes of\nFountainhead. This lets consumers overwrite the apiNamespace if they\nneed before we request the meta data that drives Fountainhead.
\nNOTE: We only fetch meta data if it isn't present yet.
\n",
"itemtype": "method",
"name": "beforeModel",
"return": {
"description": "",
"type": "Promise|true"
},
"class": "Guides",
"srcFileId": "addon_routes_guides.js"
},
{
"file": "addon/routes/guides.js",
"line": 38,
"description": "Fetches modules's JSON at: ${this.get('fountainhead.apiNamespace')}/modules/${params.file_id}.json
\n",
"itemtype": "method",
"name": "model",
"params": [
{
"name": "params",
"description": null,
"type": "Object",
"props": [
{
"name": "guide_id",
"description": "Name of this class, use to fetch data",
"type": "String"
}
]
}
],
"return": {
"description": "jQuery ajax promise",
"type": "Promise"
},
"class": "Guides",
"srcFileId": "addon_routes_guides.js"
}
],
"property": [],
"event": [],
"srcFileId": "addon_routes_guides.js"
},
"BaseController": {
"name": "BaseController",
"shortname": "BaseController",
"classitems": [
{
"file": "addon/controllers/base-controller.js",
"line": 23,
"itemtype": "property",
"name": "id",
"type": "{?string}",
"default": "null",
"class": "BaseController",
"srcFileId": "addon_controllers_base-controller.js"
},
{
"file": "addon/controllers/base-controller.js",
"line": 17,
"itemtype": "property",
"name": "queryParams",
"type": "{Array}",
"default": "['item']",
"class": "BaseController",
"srcFileId": "addon_controllers_base-controller.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/controllers/base-controller.js",
"line": 4,
"description": "Due to an edge case with Ember query params\n(github ) ,\nwe need to define the id query param controllers otherwise the\ncross-link component will render ?item=null when used to cross link to other\nroutes.
\n",
"is_constructor": 1,
"extends": "Ember.Controller",
"method": [],
"property": [
{
"file": "addon/controllers/base-controller.js",
"line": 23,
"itemtype": "property",
"name": "id",
"type": "{?string}",
"default": "null",
"class": "BaseController",
"srcFileId": "addon_controllers_base-controller.js"
},
{
"file": "addon/controllers/base-controller.js",
"line": 17,
"itemtype": "property",
"name": "queryParams",
"type": "{Array}",
"default": "['item']",
"class": "BaseController",
"srcFileId": "addon_controllers_base-controller.js"
}
],
"event": [],
"srcFileId": "addon_controllers_base-controller.js"
},
"Helper.Eq": {
"name": "Helper.Eq",
"shortname": "Helper.Eq",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/helpers/eq.js",
"line": 3,
"description": "Helper to compare two values to see if they are equal. Values must be of the same type.
\n",
"is_constructor": 1,
"params": [
{
"name": "args",
"description": "Positional args passed to helper should be compared",
"type": "Array"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"method": [],
"property": [],
"event": [],
"srcFileId": "addon_helpers_eq.js"
},
"API.Classes": {
"name": "API.Classes",
"shortname": "API.Classes",
"classitems": [
{
"file": "addon/routes/api/classes.js",
"line": 11,
"description": "Fetches class' JSON at: ${this.get('fountainhead.apiNamespace')}/classes/${params.class_id}.json
\n",
"itemtype": "method",
"name": "model",
"params": [
{
"name": "params",
"description": null,
"type": "Object",
"props": [
{
"name": "class_id",
"description": "Name of this class, use to fetch data",
"type": "String"
}
]
}
],
"return": {
"description": "jQuery ajax promise",
"type": "Promise"
},
"class": "API.Classes",
"srcFileId": "addon_routes_api_classes.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/routes/api/classes.js",
"line": 4,
"description": "Route handles fetching data for an individual class.
\n",
"is_constructor": 1,
"extends": "Ember.Route",
"method": [
{
"file": "addon/routes/api/classes.js",
"line": 11,
"description": "Fetches class' JSON at: ${this.get('fountainhead.apiNamespace')}/classes/${params.class_id}.json
\n",
"itemtype": "method",
"name": "model",
"params": [
{
"name": "params",
"description": null,
"type": "Object",
"props": [
{
"name": "class_id",
"description": "Name of this class, use to fetch data",
"type": "String"
}
]
}
],
"return": {
"description": "jQuery ajax promise",
"type": "Promise"
},
"class": "API.Classes",
"srcFileId": "addon_routes_api_classes.js"
}
],
"property": [],
"event": [],
"srcFileId": "addon_routes_api_classes.js"
},
"API.Files": {
"name": "API.Files",
"shortname": "API.Files",
"classitems": [
{
"file": "addon/routes/api/files.js",
"line": 11,
"description": "Fetches file's JSON at: ${this.get('fountainhead.apiNamespace')}/files/${params.file_id}.json
\n",
"itemtype": "method",
"name": "model",
"params": [
{
"name": "params",
"description": null,
"type": "Object",
"props": [
{
"name": "file_id",
"description": "Name of this class, use to fetch data",
"type": "String"
}
]
}
],
"return": {
"description": "jQuery ajax promise",
"type": "Promise"
},
"class": "API.Files",
"srcFileId": "addon_routes_api_files.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/routes/api/files.js",
"line": 4,
"description": "Route handles fetching data for a source file.
\n",
"is_constructor": 1,
"extends": "Ember.Route",
"method": [
{
"file": "addon/routes/api/files.js",
"line": 11,
"description": "Fetches file's JSON at: ${this.get('fountainhead.apiNamespace')}/files/${params.file_id}.json
\n",
"itemtype": "method",
"name": "model",
"params": [
{
"name": "params",
"description": null,
"type": "Object",
"props": [
{
"name": "file_id",
"description": "Name of this class, use to fetch data",
"type": "String"
}
]
}
],
"return": {
"description": "jQuery ajax promise",
"type": "Promise"
},
"class": "API.Files",
"srcFileId": "addon_routes_api_files.js"
}
],
"property": [],
"event": [],
"srcFileId": "addon_routes_api_files.js"
},
"API.Modules": {
"name": "API.Modules",
"shortname": "API.Modules",
"classitems": [
{
"file": "addon/routes/api/modules.js",
"line": 11,
"description": "Fetches modules's JSON at: ${this.get('fountainhead.apiNamespace')}/modules/${params.file_id}.json
\n",
"itemtype": "method",
"name": "model",
"params": [
{
"name": "params",
"description": null,
"type": "Object",
"props": [
{
"name": "module_id",
"description": "Name of this class, use to fetch data",
"type": "String"
}
]
}
],
"return": {
"description": "jQuery ajax promise",
"type": "Promise"
},
"class": "API.Modules",
"srcFileId": "addon_routes_api_modules.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/routes/api/modules.js",
"line": 4,
"description": "Route to be created for handling modules
\n",
"is_constructor": 1,
"extends": "Ember.Route",
"method": [
{
"file": "addon/routes/api/modules.js",
"line": 11,
"description": "Fetches modules's JSON at: ${this.get('fountainhead.apiNamespace')}/modules/${params.file_id}.json
\n",
"itemtype": "method",
"name": "model",
"params": [
{
"name": "params",
"description": null,
"type": "Object",
"props": [
{
"name": "module_id",
"description": "Name of this class, use to fetch data",
"type": "String"
}
]
}
],
"return": {
"description": "jQuery ajax promise",
"type": "Promise"
},
"class": "API.Modules",
"srcFileId": "addon_routes_api_modules.js"
}
],
"property": [],
"event": [],
"srcFileId": "addon_routes_api_modules.js"
},
"Docs.Classes": {
"name": "Docs.Classes",
"shortname": "Docs.Classes",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/routes/docs/classes.js",
"line": 3,
"description": "Docs route for classes
\n",
"is_constructor": 1,
"extends": "Ember.Route",
"deprecated": true,
"method": [],
"property": [],
"event": [],
"srcFileId": "addon_routes_docs_classes.js"
},
"Docs.Files": {
"name": "Docs.Files",
"shortname": "Docs.Files",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/routes/docs/files.js",
"line": 3,
"description": "Docs route for files
\n",
"is_constructor": 1,
"extends": "Ember.Route",
"deprecated": true,
"method": [],
"property": [],
"event": [],
"srcFileId": "addon_routes_docs_files.js"
},
"Docs.Modules": {
"name": "Docs.Modules",
"shortname": "Docs.Modules",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/routes/docs/modules.js",
"line": 3,
"description": "Docs Route for modules
\n",
"is_constructor": 1,
"extends": "Ember.Route",
"deprecated": true,
"method": [],
"property": [],
"event": [],
"srcFileId": "addon_routes_docs_modules.js"
},
"API": {
"name": "API",
"shortname": "API",
"classitems": [
{
"file": "addon/routes/api.js",
"line": 13,
"description": "When in Fountainhead we need to pass down id query param OR the hash depending\non LocationType. Kick off hash tracking on activate.
\n",
"itemtype": "method",
"name": "activate",
"class": "API",
"srcFileId": "addon_routes_api.js"
},
{
"file": "addon/routes/api.js",
"line": 21,
"description": "We check for and fetch meta data if needed in the parent routes of\nFountainhead. This lets consumers overwrite the apiNamespace if they\nneed before we request the meta data that drives Fountainhead.
\nNOTE: We only fetch meta data if it isn't present yet.
\n",
"itemtype": "method",
"name": "beforeModel",
"return": {
"description": "",
"type": "Promise|true"
},
"class": "API",
"srcFileId": "addon_routes_api.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/routes/api.js",
"line": 3,
"description": "The /api route is the parent route for module and class documentation.
\n",
"is_constructor": 1,
"extends": "Ember.Route",
"method": [
{
"file": "addon/routes/api.js",
"line": 13,
"description": "When in Fountainhead we need to pass down id query param OR the hash depending\non LocationType. Kick off hash tracking on activate.
\n",
"itemtype": "method",
"name": "activate",
"class": "API",
"srcFileId": "addon_routes_api.js"
},
{
"file": "addon/routes/api.js",
"line": 21,
"description": "We check for and fetch meta data if needed in the parent routes of\nFountainhead. This lets consumers overwrite the apiNamespace if they\nneed before we request the meta data that drives Fountainhead.
\nNOTE: We only fetch meta data if it isn't present yet.
\n",
"itemtype": "method",
"name": "beforeModel",
"return": {
"description": "",
"type": "Promise|true"
},
"class": "API",
"srcFileId": "addon_routes_api.js"
}
],
"property": [],
"event": [],
"srcFileId": "addon_routes_api.js"
},
"BaseRoute": {
"name": "BaseRoute",
"shortname": "BaseRoute",
"classitems": [
{
"file": "addon/routes/base-route.js",
"line": 20,
"description": "Required for History consumers when cross linking to a different class (Ember\nstrips hash from the {{c-l class='FHHref'}} component) . When a cross link with\na property is clicked, the cross link will set this property to notify the route\nthat there is a fragment that should be observed on transition.
\n",
"itemtype": "property",
"name": "crossLinkFragmentOverride",
"type": "{?string}",
"access": "protected",
"tagname": "",
"default": "null",
"class": "BaseRoute",
"srcFileId": "addon_routes_base-route.js"
},
{
"file": "addon/routes/base-route.js",
"line": 55,
"description": "On transition, handle resetting scroll position as well as updating\n{{c-l class='Fountainhead'}} service that a transition has occurred so that\nthe new location can be checked for a scroll target hash.
\n",
"itemtype": "event",
"name": "didTransition",
"class": "BaseRoute",
"srcFileId": "addon_routes_base-route.js"
},
{
"file": "addon/routes/base-route.js",
"line": 34,
"description": "We don't want the id query param to be sticky. If it is, then if you\nhave an id scroll target for a class, navigate elsewhere and then click that\nclass again in the api-nav, the sticky query param will set the id to the\nprevious scroll target, 😣.
\nThe resetController hook is called anytime a route's model changes or the\nroute is exited, and is the recommended time to reset query param values on\na controller.
\n",
"itemtype": "method",
"name": "resetController",
"params": [
{
"name": "controller",
"description": null,
"type": "Object"
},
{
"name": "isExiting",
"description": null,
"type": "Boolean"
},
{
"name": "transition",
"description": null,
"type": "Object"
}
],
"class": "BaseRoute",
"srcFileId": "addon_routes_base-route.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/routes/base-route.js",
"line": 6,
"description": "The Fountainhead base route class contains handlers for targeted scrolling\nincluding {{c-l 'resetController'}} (to clear sticky parameters),\n{{c-l 'crossLinkFragmentOverride'}} (for History consumers using a cross link),\nand {{c-l 'didTransition'}} (to update application hash tracker).
\n",
"is_constructor": 1,
"extends": "Ember.Route",
"method": [
{
"file": "addon/routes/base-route.js",
"line": 34,
"description": "We don't want the id query param to be sticky. If it is, then if you\nhave an id scroll target for a class, navigate elsewhere and then click that\nclass again in the api-nav, the sticky query param will set the id to the\nprevious scroll target, 😣.
\nThe resetController hook is called anytime a route's model changes or the\nroute is exited, and is the recommended time to reset query param values on\na controller.
\n",
"itemtype": "method",
"name": "resetController",
"params": [
{
"name": "controller",
"description": null,
"type": "Object"
},
{
"name": "isExiting",
"description": null,
"type": "Boolean"
},
{
"name": "transition",
"description": null,
"type": "Object"
}
],
"class": "BaseRoute",
"srcFileId": "addon_routes_base-route.js"
}
],
"property": [
{
"file": "addon/routes/base-route.js",
"line": 20,
"description": "Required for History consumers when cross linking to a different class (Ember\nstrips hash from the {{c-l class='FHHref'}} component) . When a cross link with\na property is clicked, the cross link will set this property to notify the route\nthat there is a fragment that should be observed on transition.
\n",
"itemtype": "property",
"name": "crossLinkFragmentOverride",
"type": "{?string}",
"access": "protected",
"tagname": "",
"default": "null",
"class": "BaseRoute",
"srcFileId": "addon_routes_base-route.js"
}
],
"event": [
{
"file": "addon/routes/base-route.js",
"line": 55,
"description": "On transition, handle resetting scroll position as well as updating\n{{c-l class='Fountainhead'}} service that a transition has occurred so that\nthe new location can be checked for a scroll target hash.
\n",
"itemtype": "event",
"name": "didTransition",
"class": "BaseRoute",
"srcFileId": "addon_routes_base-route.js"
}
],
"srcFileId": "addon_routes_base-route.js"
},
"Fountainhead": {
"name": "Fountainhead",
"shortname": "Fountainhead",
"classitems": [
{
"file": "addon/services/fountainhead.js",
"line": 24,
"description": "All Fountainhead API requests are prefixed with this namespace. If you\nexport your docs JSON files to a non-default location, or your application\nis served under a url namespace, you can overwrite this property to match your\nendpoint's root url namespace.
\n",
"itemtype": "property",
"name": "apiNamespace",
"type": "{string}",
"access": "public",
"tagname": "",
"default": "'/docs'",
"class": "Fountainhead",
"srcFileId": "addon_services_fountainhead.js"
},
{
"file": "addon/services/fountainhead.js",
"line": 102,
"description": "Fires request for documentation meta data and returns the promise. This\nmethod is called in the beforeModel of either the docs or guides\nroute, whichever is entered first.
\n{{#fountainhead-alert brand='info' dismiss=false}}\n{{fountainhead-svg svgId='info'}} If the request fails {{cross-link item='metaError'}} will be set to true.\n{{/fountainhead-alert}}
\n",
"itemtype": "method",
"name": "fetchMeta",
"access": "public",
"tagname": "",
"return": {
"description": "",
"type": "Promise"
},
"class": "Fountainhead",
"srcFileId": "addon_services_fountainhead.js"
},
{
"file": "addon/services/fountainhead.js",
"line": 35,
"description": "When using the History Location type, this will match the hash fragment that is\nused for linking to specific documentation headers/properties. Ember Router\ndoesn't seem to notice these changes? so we track them and pass them down to the\npage components where they trigger page scrolls when the back button is used.
\n",
"itemtype": "property",
"name": "fragmentId",
"access": "protected",
"tagname": "",
"type": "{string}",
"default": "''",
"class": "Fountainhead",
"srcFileId": "addon_services_fountainhead.js"
},
{
"file": "addon/services/fountainhead.js",
"line": 46,
"description": "Documentation meta fetched from /meta.json. Contains high level map\nof modules, classes and guides available in documentation. Is generated in\n{{c-l module='Lib'}}.
\n// meta.json Object Shape: \n{ \n classes: [ ] , \n description: '' , \n guides: [ ] , \n hashRouting: boolean\n modules: [ ] , \n name: '' , \n parser: '' , \n repository: '' , \n version: '' \n} \nhashRouting and Page Load Scrolling With Fragment Ids{{/fountainhead-header}}\nFountainhead has automatic scrolling on page load for links with a target id in\nthem. For consuming applications using history location we use fragments ids for\nthe target:\nhttps://yourdocs.com/guides/your-guide#scroll-target
\nFor consuming applications using hash location, the meta response will have\nproperty hashRouting set to true. This flags Fountainhead to use a query\nparameter for the scroll target:\nhttps://yourdocs.com/#/guides/your-guide?id=scroll-target
\nAlthough this requires generating different link text and handling scrolling\ntargets two different ways, it allows us to have clean urls with fragments for\napps that have updated to history location while still supporting apps\nwith hash location routing.
\nThis property is used throughout Fountainhead when checking which routing the\nconsuming app is using.
\n",
"itemtype": "property",
"name": "meta",
"type": "{?Object}",
"default": "null",
"class": "Fountainhead",
"srcFileId": "addon_services_fountainhead.js"
},
{
"file": "addon/services/fountainhead.js",
"line": 89,
"description": "Set to true if the call for documentation meta data fails. Almost always this\nmeans the user has not generated documentation yet, so the {{c-l class='Route.API'}}\nroute uses this to show getting started instructions when there is an error.
\n",
"itemtype": "property",
"name": "metaError",
"type": "{Boolean}",
"access": "public",
"tagname": "",
"default": "false",
"class": "Fountainhead",
"srcFileId": "addon_services_fountainhead.js"
},
{
"file": "addon/services/fountainhead.js",
"line": 124,
"description": "Reset the tracked fragment. Should be called when leaving routes b/c a hash\nchange event will not fire fire for the new clicked
\n",
"itemtype": "method",
"name": "setFragmentId",
"class": "Fountainhead",
"srcFileId": "addon_services_fountainhead.js"
},
{
"file": "addon/services/fountainhead.js",
"line": 132,
"description": "Begins tracking the location.hash to pass down to page components. See\n{{c-l 'fragmentId'}} for details.
\n",
"itemtype": "method",
"name": "trackHash",
"access": "public",
"tagname": "",
"action": "",
"class": "Fountainhead",
"srcFileId": "addon_services_fountainhead.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Addon",
"file": "addon/services/fountainhead.js",
"line": 6,
"description": "This is the primary service backing Fountianhead and handles configurations,\naddon methods and storage of the generated documentation meta data. Important\nmembers include:
\n\n{{c-l 'apiNamespace'}}: Configures fetch service namespace \n{{c-l 'meta'}}: Generated documentation metadata \n{{c-l 'fetchMeta'}}: Public method called in the beforeModel of either the\napi or guides route and fetches documentation meta data \n{{c-l 'checkScrollToSection'}}: Action called when checking for auto scroll\ntarget \n \n",
"is_constructor": 1,
"extends": "Ember.Service",
"method": [
{
"file": "addon/services/fountainhead.js",
"line": 102,
"description": "Fires request for documentation meta data and returns the promise. This\nmethod is called in the beforeModel of either the docs or guides\nroute, whichever is entered first.
\n{{#fountainhead-alert brand='info' dismiss=false}}\n{{fountainhead-svg svgId='info'}} If the request fails {{cross-link item='metaError'}} will be set to true.\n{{/fountainhead-alert}}
\n",
"itemtype": "method",
"name": "fetchMeta",
"access": "public",
"tagname": "",
"return": {
"description": "",
"type": "Promise"
},
"class": "Fountainhead",
"srcFileId": "addon_services_fountainhead.js"
},
{
"file": "addon/services/fountainhead.js",
"line": 124,
"description": "Reset the tracked fragment. Should be called when leaving routes b/c a hash\nchange event will not fire fire for the new clicked
\n",
"itemtype": "method",
"name": "setFragmentId",
"class": "Fountainhead",
"srcFileId": "addon_services_fountainhead.js"
},
{
"file": "addon/services/fountainhead.js",
"line": 132,
"description": "Begins tracking the location.hash to pass down to page components. See\n{{c-l 'fragmentId'}} for details.
\n",
"itemtype": "method",
"name": "trackHash",
"access": "public",
"tagname": "",
"action": "",
"class": "Fountainhead",
"srcFileId": "addon_services_fountainhead.js"
}
],
"property": [
{
"file": "addon/services/fountainhead.js",
"line": 24,
"description": "All Fountainhead API requests are prefixed with this namespace. If you\nexport your docs JSON files to a non-default location, or your application\nis served under a url namespace, you can overwrite this property to match your\nendpoint's root url namespace.
\n",
"itemtype": "property",
"name": "apiNamespace",
"type": "{string}",
"access": "public",
"tagname": "",
"default": "'/docs'",
"class": "Fountainhead",
"srcFileId": "addon_services_fountainhead.js"
},
{
"file": "addon/services/fountainhead.js",
"line": 35,
"description": "When using the History Location type, this will match the hash fragment that is\nused for linking to specific documentation headers/properties. Ember Router\ndoesn't seem to notice these changes? so we track them and pass them down to the\npage components where they trigger page scrolls when the back button is used.
\n",
"itemtype": "property",
"name": "fragmentId",
"access": "protected",
"tagname": "",
"type": "{string}",
"default": "''",
"class": "Fountainhead",
"srcFileId": "addon_services_fountainhead.js"
},
{
"file": "addon/services/fountainhead.js",
"line": 46,
"description": "Documentation meta fetched from /meta.json. Contains high level map\nof modules, classes and guides available in documentation. Is generated in\n{{c-l module='Lib'}}.
\n// meta.json Object Shape: \n{ \n classes: [ ] , \n description: '' , \n guides: [ ] , \n hashRouting: boolean\n modules: [ ] , \n name: '' , \n parser: '' , \n repository: '' , \n version: '' \n} \nhashRouting and Page Load Scrolling With Fragment Ids{{/fountainhead-header}}\nFountainhead has automatic scrolling on page load for links with a target id in\nthem. For consuming applications using history location we use fragments ids for\nthe target:\nhttps://yourdocs.com/guides/your-guide#scroll-target
\nFor consuming applications using hash location, the meta response will have\nproperty hashRouting set to true. This flags Fountainhead to use a query\nparameter for the scroll target:\nhttps://yourdocs.com/#/guides/your-guide?id=scroll-target
\nAlthough this requires generating different link text and handling scrolling\ntargets two different ways, it allows us to have clean urls with fragments for\napps that have updated to history location while still supporting apps\nwith hash location routing.
\nThis property is used throughout Fountainhead when checking which routing the\nconsuming app is using.
\n",
"itemtype": "property",
"name": "meta",
"type": "{?Object}",
"default": "null",
"class": "Fountainhead",
"srcFileId": "addon_services_fountainhead.js"
},
{
"file": "addon/services/fountainhead.js",
"line": 89,
"description": "Set to true if the call for documentation meta data fails. Almost always this\nmeans the user has not generated documentation yet, so the {{c-l class='Route.API'}}\nroute uses this to show getting started instructions when there is an error.
\n",
"itemtype": "property",
"name": "metaError",
"type": "{Boolean}",
"access": "public",
"tagname": "",
"default": "false",
"class": "Fountainhead",
"srcFileId": "addon_services_fountainhead.js"
}
],
"event": [],
"srcFileId": "addon_services_fountainhead.js"
},
"FountainheadRoutes": {
"name": "FountainheadRoutes",
"shortname": "FountainheadRoutes",
"classitems": [
{
"file": "app/instance-initializers/fountainhead-routes.js",
"line": 23,
"description": "Initialize route that is called by consuming Ember application\nRouter instance from the consuming application can directly mapped.
\n",
"itemtype": "method",
"name": "initialize",
"return": {
"description": "",
"type": "Undefined"
},
"class": "FountainheadRoutes",
"module": "App",
"srcFileId": "app_instance-initializers_fountainhead-routes.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "App",
"namespace": "",
"file": "app/instance-initializers/fountainhead-routes.js",
"line": 11,
"description": "Automagically mount Fountainhead routes through an instance-initializer.
\nNOTE: this initializer needs to be in the /app directory so that the the\nconsuming application's router can be directly imported and manipulated.
\nTODO: See if we can use some kind of lookup to do this from within an\ninitializer in the /addon directory
\n",
"is_constructor": 1,
"method": [
{
"file": "app/instance-initializers/fountainhead-routes.js",
"line": 23,
"description": "Initialize route that is called by consuming Ember application\nRouter instance from the consuming application can directly mapped.
\n",
"itemtype": "method",
"name": "initialize",
"return": {
"description": "",
"type": "Undefined"
},
"class": "FountainheadRoutes",
"module": "App",
"srcFileId": "app_instance-initializers_fountainhead-routes.js"
}
],
"property": [],
"event": [],
"srcFileId": "app_instance-initializers_fountainhead-routes.js"
},
"EmberFountainhead.Index": {
"name": "EmberFountainhead.Index",
"shortname": "EmberFountainhead.Index",
"classitems": [
{
"file": "blueprints/ember-fountainhead/index.js",
"line": 22,
"description": "Say a quick hello.
\n",
"itemtype": "method",
"name": "afterInstall",
"class": "EmberFountainhead.Index",
"module": "Blueprints",
"srcFileId": "blueprints_ember-fountainhead_index.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Blueprints",
"namespace": "",
"file": "blueprints/ember-fountainhead/index.js",
"line": 10,
"description": "Fountainhead's blueprint prints a friendly hello after install.
\n",
"is_constructor": 1,
"extends": "EmberCLI.Blueprint",
"method": [
{
"file": "blueprints/ember-fountainhead/index.js",
"line": 22,
"description": "Say a quick hello.
\n",
"itemtype": "method",
"name": "afterInstall",
"class": "EmberFountainhead.Index",
"module": "Blueprints",
"srcFileId": "blueprints_ember-fountainhead_index.js"
}
],
"property": [],
"event": [],
"srcFileId": "blueprints_ember-fountainhead_index.js"
},
"DataTypes.GenerateClasses": {
"name": "DataTypes.GenerateClasses",
"shortname": "DataTypes.GenerateClasses",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [
"generateFountainheadData"
],
"module": "Lib",
"namespace": "",
"file": "lib/data-types/generate-classes.js",
"line": 4,
"description": "Module handles decorating and compiling classes and their class items including:
\n\nCompiling each class item to its class \nCreating an id for class and class src file \nParsing class and class item descriptions markdown to HTML \n \n",
"is_constructor": 1,
"params": [
{
"name": "classes",
"description": "Object of raw YUIDoc classes",
"type": "Object"
},
{
"name": "classItems",
"description": "Array of raw YUIDoc classItems",
"type": "Object"
}
],
"return": {
"description": "Returns object: `{ classesMeta, classesDatas }` for saving",
"type": "Object"
},
"method": [],
"property": [],
"event": [],
"srcFileId": "lib_data-types_generate-classes.js"
},
"DataTypes.GenerateGuide": {
"name": "DataTypes.GenerateGuide",
"shortname": "DataTypes.GenerateGuide",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Lib",
"namespace": "",
"file": "lib/data-types/generate-guide.js",
"line": 6,
"description": "Handle syntax highlighting and creating meta information for a src file
\n",
"is_constructor": 1,
"params": [
{
"name": "data",
"description": "",
"type": "Object",
"props": [
{
"name": "fileSrc",
"description": "Guide file src",
"type": "String"
},
{
"name": "filePath",
"description": "Configured guide file path",
"type": "String"
}
]
}
],
"return": {
"description": "Returns an object with guide data in the shape of:\n `{ attributes, body, id, type }`\n With the body parsed for markdown and handlebars contents",
"type": "Object"
},
"method": [],
"property": [],
"event": [],
"srcFileId": "lib_data-types_generate-guide.js"
},
"DataTypes.GenerateModules": {
"name": "DataTypes.GenerateModules",
"shortname": "DataTypes.GenerateModules",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [
"generateFountainheadData"
],
"module": "Lib",
"namespace": "",
"file": "lib/data-types/generate-modules.js",
"line": 4,
"description": "Handle parsing/decorating raw YUIDoc modules data including:
\n\nGenerate meta objects for each module that can be used for the sidebar nav \nCreate an array of modules from YUIDoc object of modules for standard lib format \nParse module markdown description to HTML \n \n",
"params": [
{
"name": "modules",
"description": "YUIDoc raw modules object",
"type": "Object"
}
],
"return": {
"description": "Returns object: `{ modulesMeta, modulesDatas }` for saving",
"type": "Object"
},
"method": [],
"property": [],
"event": [],
"srcFileId": "lib_data-types_generate-modules.js"
},
"DataTypes.GenerateSrcFile": {
"name": "DataTypes.GenerateSrcFile",
"shortname": "DataTypes.GenerateSrcFile",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [
"generateFountainheadData"
],
"module": "Lib",
"namespace": "",
"file": "lib/data-types/generate-src-file.js",
"line": 5,
"description": "Handle syntax highlighting and creating meta information for a src file
\n",
"is_constructor": 1,
"params": [
{
"name": "filePath",
"description": "File filepath from class definition",
"type": "String"
}
],
"method": [],
"property": [],
"event": [],
"srcFileId": "lib_data-types_generate-src-file.js"
},
"readDirRecursive": {
"name": "readDirRecursive",
"shortname": "readDirRecursive",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Lib",
"namespace": "",
"file": "lib/utils/read-dir-recursive.js",
"line": 5,
"description": "Recursively walk a directory adding each file to an array
\n",
"is_constructor": 1,
"return": {
"description": "Array of all files in directory",
"type": "Array"
},
"method": [],
"property": [],
"event": [],
"srcFileId": "lib_utils_read-dir-recursive.js"
},
"createDirs": {
"name": "createDirs",
"shortname": "createDirs",
"classitems": [
{
"file": "lib/create-dirs.js",
"line": 20,
"description": "Synchronous mkdir that handles creating a potentially nested directory
\n",
"itemtype": "method",
"name": "mkdirSync",
"params": [
{
"name": "dirPath",
"description": "Directory path to create, can be nested
\n",
"type": "String"
}
],
"return": {
"description": "",
"type": "Undefined"
},
"class": "createDirs",
"module": "Lib",
"srcFileId": "lib_create-dirs.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [
"Index"
],
"module": "Lib",
"namespace": "",
"file": "lib/create-dirs.js",
"line": 7,
"description": "Handle creating output directories for Fountainhead data.
\n",
"is_constructor": 1,
"params": [
{
"name": "output",
"description": "Project output configurations",
"type": "Object"
}
],
"return": {
"description": "",
"type": "Undefined"
},
"method": [
{
"file": "lib/create-dirs.js",
"line": 20,
"description": "Synchronous mkdir that handles creating a potentially nested directory
\n",
"itemtype": "method",
"name": "mkdirSync",
"params": [
{
"name": "dirPath",
"description": "Directory path to create, can be nested
\n",
"type": "String"
}
],
"return": {
"description": "",
"type": "Undefined"
},
"class": "createDirs",
"module": "Lib",
"srcFileId": "lib_create-dirs.js"
}
],
"property": [],
"event": [],
"srcFileId": "lib_create-dirs.js"
},
"decorateConfig": {
"name": "decorateConfig",
"shortname": "decorateConfig",
"classitems": [
{
"file": "lib/decorate-config.js",
"line": 19,
"description": "Fountianhead default configurations are targeted at Ember applications and\ninclude a sane default for every option with the goal of being able to\ninstall and use the addon with zero configuration for simple/standard Ember\napps.\nTODO: Document defaults
\n",
"itemtype": "property",
"name": "defaultConfigurations",
"type": "{Object}",
"class": "decorateConfig",
"module": "Lib",
"srcFileId": "lib_decorate-config.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [
"Index"
],
"module": "Lib",
"namespace": "",
"file": "lib/decorate-config.js",
"line": 4,
"description": "Handle adding default values to config and validating required properties\nare present
\n",
"is_constructor": 1,
"params": [
{
"name": "config",
"description": "Project configuration file",
"type": "Object"
},
{
"name": "packageJSON",
"description": "Project package.json file",
"type": "Object"
},
{
"name": "buildConfig",
"description": "Configs passed to build function call",
"type": "Object"
}
],
"return": {
"description": "Fully decorated and validated project configuration file",
"type": "Object"
},
"method": [],
"property": [
{
"file": "lib/decorate-config.js",
"line": 19,
"description": "Fountianhead default configurations are targeted at Ember applications and\ninclude a sane default for every option with the goal of being able to\ninstall and use the addon with zero configuration for simple/standard Ember\napps.\nTODO: Document defaults
\n",
"itemtype": "property",
"name": "defaultConfigurations",
"type": "{Object}",
"class": "decorateConfig",
"module": "Lib",
"srcFileId": "lib_decorate-config.js"
}
],
"event": [],
"srcFileId": "lib_decorate-config.js"
},
"generateFountainheadData": {
"name": "generateFountainheadData",
"shortname": "generateFountainheadData",
"classitems": [
{
"file": "lib/generate-fountainhead-data.js",
"line": 75,
"description": "The docsMeta object is the guide for the documentation data. It contains\ndescriptions of the project as well as arrays of module and class routing\ninformation
\n",
"itemtype": "property",
"name": "docsMeta",
"type": "{Object}",
"class": "generateFountainheadData",
"module": "Lib",
"srcFileId": "lib_generate-fountainhead-data.js"
},
{
"file": "lib/generate-fountainhead-data.js",
"line": 50,
"description": "Call to handle saving data to a file. Requires a file path and data to save.\nIf data is not a string, it will be stringified
\n",
"itemtype": "method",
"name": "saveObjectToJSON",
"params": [
{
"name": "filePath",
"description": "Path to save file at
\n",
"type": "String"
},
{
"name": "data",
"description": "Data to save in file
\n",
"type": "Object|string"
}
],
"return": {
"description": "True for successful operation, false for failures",
"type": "Boolean"
},
"class": "generateFountainheadData",
"module": "Lib",
"srcFileId": "lib_generate-fountainhead-data.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [
"Index"
],
"module": "Lib",
"namespace": "",
"file": "lib/generate-fountainhead-data.js",
"line": 21,
"description": "This module handles coordinating parsing/reading/saving all of the individual\nFountainhead data files after the configs have been validated and the raw\nYUIDoc data has been generated.
\nModule should:
\n\ncreate and populate docsMeta that will be saved as meta.json \ngenerate decorated modules files \ngenerate decorated class files \ngenerate decorated src file files \n \nNOTE: When switching doc generation from an executable to a function call\nall file operations had to be changed to a synchronous operation b/c the ember\ncommand finishes before the async file operations are complete and the contents\nare not written to file. This can be switched back to an async method by\nassembling and returning a promise.all for all async file calls
\n",
"is_constructor": 1,
"uses": [
"DataTypes.GenerateModules",
"DataTypes.GenerateClasses",
"DataTypes.GenerateSrcFile"
],
"params": [
{
"name": "config",
"description": "Project configuration file",
"type": "Object"
},
{
"name": "yuidocJSON",
"description": "Raw yuidoc generated documentation JSON",
"type": "Object"
}
],
"return": {
"description": "",
"type": "Undefined"
},
"method": [
{
"file": "lib/generate-fountainhead-data.js",
"line": 50,
"description": "Call to handle saving data to a file. Requires a file path and data to save.\nIf data is not a string, it will be stringified
\n",
"itemtype": "method",
"name": "saveObjectToJSON",
"params": [
{
"name": "filePath",
"description": "Path to save file at
\n",
"type": "String"
},
{
"name": "data",
"description": "Data to save in file
\n",
"type": "Object|string"
}
],
"return": {
"description": "True for successful operation, false for failures",
"type": "Boolean"
},
"class": "generateFountainheadData",
"module": "Lib",
"srcFileId": "lib_generate-fountainhead-data.js"
}
],
"property": [
{
"file": "lib/generate-fountainhead-data.js",
"line": 75,
"description": "The docsMeta object is the guide for the documentation data. It contains\ndescriptions of the project as well as arrays of module and class routing\ninformation
\n",
"itemtype": "property",
"name": "docsMeta",
"type": "{Object}",
"class": "generateFountainheadData",
"module": "Lib",
"srcFileId": "lib_generate-fountainhead-data.js"
}
],
"event": [],
"srcFileId": "lib_generate-fountainhead-data.js"
},
"Index": {
"name": "Index",
"shortname": "Index",
"classitems": [
{
"file": "lib/index.js",
"line": 35,
"description": "Optional configs pulled from fountainhead.js
\n",
"itemtype": "property",
"name": "fountainheadConfig",
"type": "{Object}",
"class": "Index",
"module": "Lib",
"srcFileId": "lib_index.js"
},
{
"file": "lib/index.js",
"line": 40,
"description": "Package JSON for project. Used to populate project description if not\ndefined in fountainhead.js config.
\n",
"itemtype": "property",
"name": "packageJSON",
"type": "{Object}",
"class": "Index",
"module": "Lib",
"srcFileId": "lib_index.js"
},
{
"file": "lib/index.js",
"line": 78,
"description": "Raw YUIDoc JSON data generated using constructor exported by yuidocjs.\nCall new with options from config to pass configs to YUIDoc and call run\nto generate JSON
\n",
"itemtype": "property",
"name": "yuidocJSON",
"type": "{Object}",
"class": "Index",
"module": "Lib",
"srcFileId": "lib_index.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Lib",
"namespace": "",
"file": "lib/index.js",
"line": 9,
"description": "Fountainhead documentation data generation lib entry. Configuration is set\nthrough fountainhead.js file. (TODO: Add default configs to decorate-config)\nclass and link.
\nThe entry handles:
\n\nSafe require of package.json && fountainhead.js files for configs \nDecoration && validation of project configs \nGeneration of raw YUIDoc JSON through YUIDoc module directly \nDecoration of raw data in generate-fountainhead-data module. \n \nThe primary module is the generate-fountainhead-data which handles all of\nthe decoration and file creation required for Fountainhead.
\n",
"is_constructor": 1,
"uses": [
"decorateConfig",
"createDirs",
"generateFountainheadData"
],
"params": [
{
"name": "config",
"description": "Fountainhead configuration",
"type": "Object",
"props": [
{
"name": "env",
"description": "Execution environment",
"type": "String"
}
]
}
],
"method": [],
"property": [
{
"file": "lib/index.js",
"line": 35,
"description": "Optional configs pulled from fountainhead.js
\n",
"itemtype": "property",
"name": "fountainheadConfig",
"type": "{Object}",
"class": "Index",
"module": "Lib",
"srcFileId": "lib_index.js"
},
{
"file": "lib/index.js",
"line": 40,
"description": "Package JSON for project. Used to populate project description if not\ndefined in fountainhead.js config.
\n",
"itemtype": "property",
"name": "packageJSON",
"type": "{Object}",
"class": "Index",
"module": "Lib",
"srcFileId": "lib_index.js"
},
{
"file": "lib/index.js",
"line": 78,
"description": "Raw YUIDoc JSON data generated using constructor exported by yuidocjs.\nCall new with options from config to pass configs to YUIDoc and call run\nto generate JSON
\n",
"itemtype": "property",
"name": "yuidocJSON",
"type": "{Object}",
"class": "Index",
"module": "Lib",
"srcFileId": "lib_index.js"
}
],
"event": [],
"srcFileId": "lib_index.js"
},
"logger": {
"name": "logger",
"shortname": "logger",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Lib",
"namespace": "",
"file": "lib/logger.js",
"line": 7,
"description": "Logger method that takes in YUIDoc warnings array and checks those warnings\nagainst special features that we support. This allows us to use special tags\nfor Ember apps, and still support logging for incorrect tags, but suppress\nwarnings for unknown tags we have added
\n",
"is_constructor": 1,
"params": [
{
"name": "options",
"description": "Contains logger options and data to handle",
"type": "Object",
"props": [
{
"name": "warnings",
"description": "YUIDoc generated warnings array of type: `{ message, line }`",
"type": "Array"
},
{
"name": "whiteListTags",
"description": "Tags whitelisted for support in Ember Fountainhead",
"type": "Array"
}
]
}
],
"method": [],
"property": [],
"event": [],
"srcFileId": "lib_logger.js"
},
"parseMarkdown": {
"name": "parseMarkdown",
"shortname": "parseMarkdown",
"classitems": [
{
"file": "lib/parse-markdown.js",
"line": 83,
"description": "Scans the description text for instances of markdown code blocks flagged\nas 'glimmer' syntax. If any such instances are found, they are copied,\nstripped of their triple backticks and re-inserted into the\ntemplateString immediately after the original declaration. This allows\nfor functional copies of your code examples to be automatically rendered\ninto the description, without having to duplicate the code block itself.
\nIf your functional code needs to have different setup to work correctly in\nthe Fountainhead context (for example, if you need to use core-state to\nset up sandboxed state and controls), simply use 'handlebars' or no\nsyntax flag, and manually add the code block you want Fountainhead to\nrender after your example. Neato!
\n",
"itemtype": "method",
"name": "_renderCodeBlocks",
"params": [
{
"name": "description",
"description": "The description text to scan for code blocks
\n",
"type": "String"
}
],
"return": {
"description": "",
"type": "String"
},
"class": "parseMarkdown",
"module": "Lib",
"srcFileId": "lib_parse-markdown.js"
},
{
"file": "lib/parse-markdown.js",
"line": 74,
"description": "NEW render rule heading_close called for any header closing token. Replace HTML\nclosing tag with a closing {{c-l class='FountainheadHeader'}} glimmer block to\nclose opening glimmer block.
\n",
"itemtype": "method",
"name": "heading_close",
"return": {
"description": "",
"type": "String"
},
"class": "parseMarkdown",
"module": "Lib",
"srcFileId": "lib_parse-markdown.js"
},
{
"file": "lib/parse-markdown.js",
"line": 47,
"description": "NEW render rule heading_open is called for any header element's opening token.\nFor all header opening tags, return an opening glimmer block for a\n{{c-l class='FountainheadHeader'}} component.
\nHeader elements follow the token pattern:heading_open => inline => heading_close
\nUsing this pattern, we also get the content from the next token to create the\nanchor id hash fragment for the link header.
\n",
"itemtype": "method",
"name": "heading_open",
"params": [
{
"name": "tokens",
"description": null,
"type": "Array"
},
{
"name": "index",
"description": null,
"type": "Number"
}
],
"return": {
"description": "Opening glimmer block string for a\n {{c-l class='FountainheadHeader'}} with tag type and href id.",
"type": "String"
},
"class": "parseMarkdown",
"module": "Lib",
"srcFileId": "lib_parse-markdown.js"
}
],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Lib",
"namespace": "",
"file": "lib/parse-markdown.js",
"line": 13,
"description": "Handle parsing markdown using Prism
\n",
"is_constructor": 1,
"params": [
{
"name": "description",
"description": "Markdown string to parse",
"type": "String"
}
],
"return": {
"description": "HTML string parsed from passed markdown",
"type": "String"
},
"method": [
{
"file": "lib/parse-markdown.js",
"line": 83,
"description": "Scans the description text for instances of markdown code blocks flagged\nas 'glimmer' syntax. If any such instances are found, they are copied,\nstripped of their triple backticks and re-inserted into the\ntemplateString immediately after the original declaration. This allows\nfor functional copies of your code examples to be automatically rendered\ninto the description, without having to duplicate the code block itself.
\nIf your functional code needs to have different setup to work correctly in\nthe Fountainhead context (for example, if you need to use core-state to\nset up sandboxed state and controls), simply use 'handlebars' or no\nsyntax flag, and manually add the code block you want Fountainhead to\nrender after your example. Neato!
\n",
"itemtype": "method",
"name": "_renderCodeBlocks",
"params": [
{
"name": "description",
"description": "The description text to scan for code blocks
\n",
"type": "String"
}
],
"return": {
"description": "",
"type": "String"
},
"class": "parseMarkdown",
"module": "Lib",
"srcFileId": "lib_parse-markdown.js"
},
{
"file": "lib/parse-markdown.js",
"line": 74,
"description": "NEW render rule heading_close called for any header closing token. Replace HTML\nclosing tag with a closing {{c-l class='FountainheadHeader'}} glimmer block to\nclose opening glimmer block.
\n",
"itemtype": "method",
"name": "heading_close",
"return": {
"description": "",
"type": "String"
},
"class": "parseMarkdown",
"module": "Lib",
"srcFileId": "lib_parse-markdown.js"
},
{
"file": "lib/parse-markdown.js",
"line": 47,
"description": "NEW render rule heading_open is called for any header element's opening token.\nFor all header opening tags, return an opening glimmer block for a\n{{c-l class='FountainheadHeader'}} component.
\nHeader elements follow the token pattern:heading_open => inline => heading_close
\nUsing this pattern, we also get the content from the next token to create the\nanchor id hash fragment for the link header.
\n",
"itemtype": "method",
"name": "heading_open",
"params": [
{
"name": "tokens",
"description": null,
"type": "Array"
},
{
"name": "index",
"description": null,
"type": "Number"
}
],
"return": {
"description": "Opening glimmer block string for a\n {{c-l class='FountainheadHeader'}} with tag type and href id.",
"type": "String"
},
"class": "parseMarkdown",
"module": "Lib",
"srcFileId": "lib_parse-markdown.js"
}
],
"property": [],
"event": [],
"srcFileId": "lib_parse-markdown.js"
}
},
"elements": {},
"classitems": [
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 179,
"description": "Given a descriptions string, extracts data tags, parses JSON\nand adds the properties to this component, allowing them\nto be used in code examples.
\nIf we have a glimmer block which has data={'colors': ['red', 'green', 'blue']}\nthis will add a property colors to the component with the value ['red', 'green', 'blue']
\nPresents users with an error message if the JSON cannot be parsed
\n",
"itemtype": "method",
"name": "_addDataTagVariables",
"params": [
{
"name": "docString",
"description": null,
"type": "String"
}
],
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 65,
"description": "Looks through the passed-in template string and checks for action helpers;\nwhen it finds some, it checks for the actions referenced and registers no-ops\nfor them on this component's context so that the application doesn't explode\nwhen trying to reference a non-existent action.
\n",
"itemtype": "method",
"name": "_checkActionRefs",
"params": [
{
"name": "templateString",
"description": "The template string to run the check for action matches on
\n",
"type": "String"
}
],
"return": {
"description": "",
"type": "Undefined"
},
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-header.js",
"line": 59,
"description": "Copies the current url to the clipboard by updating the value of the off-screen\ninput to the url, selecting it and then calling exec copy.
\n",
"itemtype": "method",
"name": "_copyToClipboard",
"class": "FounatianheadHeader",
"srcFileId": "addon_components_fountainhead-header.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 166,
"description": "Internal method that can be used with a run.once call to only add new tabs\nonce per run loop. Simply iterates through _tabsToCreate and pushes them\ninto the tabList. This is needed to prevent multiple renders in a single\nrun loop when all of the content subcomponents register themselves with\nthe container during init.
\n",
"itemtype": "method",
"name": "_createTabsList",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 98,
"description": "Grabs the input from the parent instance's code editor, compiles it into a\nreal-live HTMLBars template, registers it on the container as a partial\nand makes it available as output for the preview component's template to\nrender.
\nNew partials are created for every change, using a date string as the\npartial name to avoid collisions.
\nTODO: Use lookup partial names that can be mapped and retrieved instead of\nmaking new ones each time
\n",
"itemtype": "method",
"name": "_generateDescription",
"params": [
{
"name": "templateString",
"description": "String to generate template from
\n",
"type": "String"
}
],
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 81,
"description": "Computed _hidden accounts for whether the tab is selected (by checking\nactiveId) && if this tab has been flagged to be hidden with property\nhidden
\n",
"itemtype": "property",
"name": "_hidden",
"return": {
"description": "String of true/false for use with `aria-hidden` binding",
"type": "String"
},
"class": "FountainheadTabsContent",
"subprops": [
{
"name": "activeId",
"description": "",
"type": "String"
},
{
"name": "hidden",
"description": "",
"type": "Boolean"
}
],
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/cross-link.js",
"line": 106,
"description": "Computed model ID passed to rendered link-to defined in {{c-l 'init'}}
\n",
"itemtype": "property",
"name": "_modelID",
"type": "{?string}",
"access": "private",
"tagname": "",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
},
{
"file": "lib/parse-markdown.js",
"line": 83,
"description": "Scans the description text for instances of markdown code blocks flagged\nas 'glimmer' syntax. If any such instances are found, they are copied,\nstripped of their triple backticks and re-inserted into the\ntemplateString immediately after the original declaration. This allows\nfor functional copies of your code examples to be automatically rendered\ninto the description, without having to duplicate the code block itself.
\nIf your functional code needs to have different setup to work correctly in\nthe Fountainhead context (for example, if you need to use core-state to\nset up sandboxed state and controls), simply use 'handlebars' or no\nsyntax flag, and manually add the code block you want Fountainhead to\nrender after your example. Neato!
\n",
"itemtype": "method",
"name": "_renderCodeBlocks",
"params": [
{
"name": "description",
"description": "The description text to scan for code blocks
\n",
"type": "String"
}
],
"return": {
"description": "",
"type": "String"
},
"class": "parseMarkdown",
"module": "Lib",
"srcFileId": "lib_parse-markdown.js"
},
{
"file": "addon/components/cross-link.js",
"line": 99,
"description": "Computed route passed to rendered link-to defined in {{c-l 'init'}}
\n",
"itemtype": "property",
"name": "_route",
"type": "{?string}",
"access": "private",
"tagname": "",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
},
{
"file": "addon/components/fountainhead-class/items-container.js",
"line": 102,
"description": "Handles finding the classitem model using the item query param value.\nIf a classitem is found, initiate a scroll.
\n",
"itemtype": "method",
"name": "_selectTabForProperty",
"access": "protected",
"tagname": "",
"params": [
{
"name": "id",
"description": "The id identifying which property to scroll to
\n",
"type": "!string"
}
],
"class": "FountainheadClass.ItemsContainer",
"srcFileId": "addon_components_fountainhead-class_items-container.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 99,
"description": "Allows for quick and easy dismissal of the alert. The alert is faded from\nview, then totally removed from the DOM and the component instance is\ndestroyed.
\n",
"itemtype": "method",
"name": "_selfDestruct",
"return": {
"description": "",
"type": "Undefined"
},
"class": "FountainheadAlert",
"srcFileId": "addon_components_fountainhead-alert.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 169,
"description": "Given a description string strips any\ndata tags from the code example.
\n",
"itemtype": "method",
"name": "_stripDataTags",
"return": {
"description": "",
"type": "String"
},
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-class/meta.js",
"line": 16,
"description": "The access property is set by using either of the tags:
\n\nThe value for access matches the tag used
\n",
"itemtype": "property",
"name": "access",
"type": "{string}",
"default": "''",
"class": "FountainheadClass.Meta",
"srcFileId": "addon_components_fountainhead-class_meta.js"
},
{
"file": "addon/components/fountainhead-state.js",
"line": 73,
"description": "Actions hash
\n",
"itemtype": "property",
"name": "actions",
"type": "{Object}",
"class": "FountainheadState",
"srcFileId": "addon_components_fountainhead-state.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 118,
"description": "Actions hash
\n",
"itemtype": "property",
"name": "actions",
"type": "{Object}",
"class": "FountainheadAlert",
"srcFileId": "addon_components_fountainhead-alert.js"
},
{
"file": "addon/routes/guides.js",
"line": 14,
"description": "When in Fountainhead we need to pass down id query param OR the hash depending\non LocationType. Kick off hash tracking on activate.
\n",
"itemtype": "method",
"name": "activate",
"class": "Guides",
"srcFileId": "addon_routes_guides.js"
},
{
"file": "addon/routes/api.js",
"line": 13,
"description": "When in Fountainhead we need to pass down id query param OR the hash depending\non LocationType. Kick off hash tracking on activate.
\n",
"itemtype": "method",
"name": "activate",
"class": "API",
"srcFileId": "addon_routes_api.js"
},
{
"file": "addon/components/fountainhead-state.js",
"line": 52,
"description": "Boolean state tracking property. Use this to handle show/hide status.\n{{if state 'state' 'no-state'}}\n{{#fountainhead-button click=stateActions.toggleState}}Click{{/fountainhead-button}}
\n",
"itemtype": "property",
"name": "active",
"type": "{Boolean}",
"class": "FountainheadState",
"srcFileId": "addon_components_fountainhead-state.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 37,
"description": "The id of the currently active tab in the scope of the\nfountainhead-tabs component. This is provided privately in the\nfountainhead-tabs yield hash.
\n",
"itemtype": "property",
"name": "activeId",
"type": "{String}",
"default": "''",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 87,
"description": "The elementId of the currently opened tab. This determines which tab is active and\nwhich tab's content to display. If this is empty, no tabs are open.
\n",
"itemtype": "property",
"name": "activeId",
"type": "{String}",
"default": "''",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-class/items-container.js",
"line": 74,
"description": "The currently active tab. This is controlled by this component to allow\nus to change the tab whenever a documentation item is clicked in the index\npanel.
\n",
"itemtype": "property",
"name": "activeTab",
"type": "{string}",
"access": "protected",
"tagname": "",
"default": "indexPanel",
"class": "FountainheadClass.ItemsContainer",
"srcFileId": "addon_components_fountainhead-class_items-container.js"
},
{
"file": "blueprints/ember-fountainhead/index.js",
"line": 22,
"description": "Say a quick hello.
\n",
"itemtype": "method",
"name": "afterInstall",
"class": "EmberFountainhead.Index",
"module": "Blueprints",
"srcFileId": "blueprints_ember-fountainhead_index.js"
},
{
"file": "addon/services/fountainhead.js",
"line": 24,
"description": "All Fountainhead API requests are prefixed with this namespace. If you\nexport your docs JSON files to a non-default location, or your application\nis served under a url namespace, you can overwrite this property to match your\nendpoint's root url namespace.
\n",
"itemtype": "property",
"name": "apiNamespace",
"type": "{string}",
"access": "public",
"tagname": "",
"default": "'/docs'",
"class": "Fountainhead",
"srcFileId": "addon_services_fountainhead.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 60,
"description": "Aria role tabpanel is bound for A++ accessibility.
\n",
"itemtype": "property",
"name": "ariaRole",
"type": "{string}",
"default": "tabpanel",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 67,
"description": "ALLLLLLLLLLL the attributes you might need.\nNOTE: role should not be bound here. You can set the role of a button\nby passing an ariaRole prop.
\n",
"itemtype": "property",
"name": "attributeBindings",
"type": "{Array}",
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 67,
"description": "Bound attributes:
\n\ndata-test: for precise testing identification_hidden: to hide this tab if it is not selected or if prop hidden is true \n",
"itemtype": "property",
"name": "attributeBindings",
"type": "{Array}",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-svg.js",
"line": 32,
"itemtype": "property",
"name": "attributeBindings",
"type": "{Array}",
"default": "['data-test']",
"class": "FountainheadSVG",
"srcFileId": "addon_components_fountainhead-svg.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 68,
"itemtype": "property",
"name": "attributeBindings",
"type": "{Array}",
"default": "['role']",
"class": "FountainheadAlert",
"srcFileId": "addon_components_fountainhead-alert.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 142,
"description": "Bound attributes:
\n\ndata-test: for precise testing identification \n",
"itemtype": "property",
"name": "attributeBindings",
"type": "{Array}",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/routes/api.js",
"line": 21,
"description": "We check for and fetch meta data if needed in the parent routes of\nFountainhead. This lets consumers overwrite the apiNamespace if they\nneed before we request the meta data that drives Fountainhead.
\nNOTE: We only fetch meta data if it isn't present yet.
\n",
"itemtype": "method",
"name": "beforeModel",
"return": {
"description": "",
"type": "Promise|true"
},
"class": "API",
"srcFileId": "addon_routes_api.js"
},
{
"file": "addon/routes/guides.js",
"line": 22,
"description": "We check for and fetch meta data if needed in the parent routes of\nFountainhead. This lets consumers overwrite the apiNamespace if they\nneed before we request the meta data that drives Fountainhead.
\nNOTE: We only fetch meta data if it isn't present yet.
\n",
"itemtype": "method",
"name": "beforeModel",
"return": {
"description": "",
"type": "Promise|true"
},
"class": "Guides",
"srcFileId": "addon_routes_guides.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 32,
"description": "Pass a brand to have btn-${brand} class applied
\n",
"itemtype": "property",
"name": "brand",
"type": "{string}",
"passed": "",
"optional": 1,
"default": "''",
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 15,
"description": "Specify brand, component handles assigning correct css class
\n",
"itemtype": "property",
"name": "brand",
"default": "''",
"type": "{string}",
"access": "public",
"tagname": "",
"class": "FountainheadAlert",
"srcFileId": "addon_components_fountainhead-alert.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 54,
"description": "Computed css class bound to component. Handled by component to allow for\nflexibility in future updates to branding class names
\n",
"itemtype": "property",
"name": "brandClass",
"type": "{string}",
"class": "FountainheadButton",
"subprops": [
{
"name": "'brand'",
"description": ""
}
],
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 54,
"description": "Computed css class bound to component. Handled by component to allow for\nflexibility in future updates to branding class names
\n",
"itemtype": "property",
"name": "brandClass",
"type": "{string}",
"access": "private",
"tagname": "",
"class": "FountainheadAlert",
"subprops": [
{
"name": "'brand'",
"description": ""
}
],
"srcFileId": "addon_components_fountainhead-alert.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 95,
"description": "Pass false to use tab style without primary color tabs.
\n",
"itemtype": "property",
"name": "buttonStyle",
"type": "{Boolean}",
"default": "true",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 23,
"description": "Whether this alert can be dismissed via the close button in the upper right\ncorner. Defaults to true. Adds an interactive close button to the alert.
\nUsage: \nOverride by passing false into this param in your handlebars template:
\n{ { #fountainhead- alert canDismiss= false } } \n { { ! Standard template content goes here } } \n{ { / fountainhead- alert} } \nClass model content.
\n",
"itemtype": "property",
"name": "class",
"type": "{?Object}",
"passed": "",
"class": "FountainheadPages.Class",
"srcFileId": "addon_components_fountainhead-pages_class.js"
},
{
"file": "addon/components/cross-link.js",
"line": 75,
"description": "Documentation Class to crosslink to.
\n",
"itemtype": "property",
"name": "class",
"type": "{?string}",
"passed": "",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
},
{
"file": "addon/components/fountainhead-class/item.js",
"line": 14,
"description": "Model backing this class item, generated by YUIDoc.\nTODO: Document props of classItem and how they get used in template
\n",
"itemtype": "property",
"name": "classItem",
"type": "{Object}",
"class": "FountaineadClass.Item",
"srcFileId": "addon_components_fountainhead-class_item.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 95,
"description": "Handle binding brand and link related css class names
\n",
"itemtype": "property",
"name": "classNameBindings",
"type": "{Array}",
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 80,
"itemtype": "property",
"name": "classNameBindings",
"type": "{Array}",
"default": "['brandClass', 'canDismiss:alert-dismissible']",
"class": "FountainheadAlert",
"srcFileId": "addon_components_fountainhead-alert.js"
},
{
"file": "addon/components/fountainhead-svg.js",
"line": 44,
"itemtype": "property",
"name": "classNameBindings",
"type": "{Array}",
"default": "['svgId']",
"class": "FountainheadSVG",
"srcFileId": "addon_components_fountainhead-svg.js"
},
{
"file": "addon/components/fountainhead-class/header.js",
"line": 32,
"itemtype": "property",
"name": "classNames",
"type": "{Array}",
"default": "['fh-page-header']",
"class": "FountaineadClass.Header",
"srcFileId": "addon_components_fountainhead-class_header.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 85,
"description": "Bind standard core classname for component: fountainhead-button
\n",
"itemtype": "property",
"name": "classNames",
"type": "{Array}",
"default": "['fh-button', 'btn']",
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/fountainhead-class/item.js",
"line": 24,
"itemtype": "property",
"name": "classNames",
"type": "{Array}",
"default": "['fh-classitem']",
"class": "FountaineadClass.Item",
"srcFileId": "addon_components_fountainhead-class_item.js"
},
{
"file": "addon/components/fountainhead-header.js",
"line": 50,
"itemtype": "property",
"name": "classNames",
"type": "{string}",
"default": "'fh-header'",
"class": "FounatianheadHeader",
"srcFileId": "addon_components_fountainhead-header.js"
},
{
"file": "addon/components/fountainhead-class/meta.js",
"line": 87,
"itemtype": "property",
"name": "classNames",
"type": "{Array.}",
"default": "['fh-class-meta']",
"class": "FountainheadClass.Meta",
"srcFileId": "addon_components_fountainhead-class_meta.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 74,
"itemtype": "property",
"name": "classNames",
"type": "{Array}",
"default": "['fh-alert']",
"class": "FountainheadAlert",
"srcFileId": "addon_components_fountainhead-alert.js"
},
{
"file": "addon/components/navigation-api/section.js",
"line": 45,
"itemtype": "property",
"name": "classNames",
"type": "{Array}",
"default": "['nav-section']",
"class": "NavigationAPI.Section",
"srcFileId": "addon_components_navigation-api_section.js"
},
{
"file": "addon/components/fountainhead-svg.js",
"line": 38,
"itemtype": "property",
"name": "classNames",
"type": "{Array}",
"default": "['fh-svg']",
"class": "FountainheadSVG",
"srcFileId": "addon_components_fountainhead-svg.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 41,
"itemtype": "property",
"name": "classNames",
"type": "{Array}",
"default": "['fh-description']",
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 75,
"description": "Class names: tabs-content
\n",
"itemtype": "property",
"name": "classNames",
"type": "{Array}",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 149,
"description": "Class names: fountainhead-tabs
\n",
"itemtype": "property",
"name": "classNames",
"type": "{Array}",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-class/items-container.js",
"line": 84,
"itemtype": "property",
"name": "classNames",
"type": "{Array}",
"default": "['fh-tabs-container']",
"class": "FountainheadClass.ItemsContainer",
"srcFileId": "addon_components_fountainhead-class_items-container.js"
},
{
"file": "addon/components/fountainhead-class/items-container.js",
"line": 22,
"description": "Array of ALL items for this class. Used to find the type when an item is\nspecified in a query param.
\n",
"itemtype": "property",
"name": "classitems",
"type": "{Array}",
"default": "[]",
"class": "FountainheadClass.ItemsContainer",
"srcFileId": "addon_components_fountainhead-class_items-container.js"
},
{
"file": "addon/components/fountainhead-state.js",
"line": 79,
"description": "Sets the {{c-l 'active'}} property to false.
\n",
"itemtype": "method",
"name": "closeModal",
"class": "FountainheadState",
"srcFileId": "addon_components_fountainhead-state.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 47,
"description": "If there is a parsing error during the template compilation the catch block\nwill set it as the compilerError. This parsing error is rendered for\neasier debugging of invalid content.
\n",
"itemtype": "property",
"name": "compilerError",
"type": "{?string}",
"default": "null",
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 22,
"description": "The content string that should be rendered. This string is passed to the\nruntime compiler and registered as a partial if compilation is successful.
\n",
"itemtype": "property",
"name": "content",
"type": "{string}",
"default": "''",
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/routes/base-route.js",
"line": 20,
"description": "Required for History consumers when cross linking to a different class (Ember\nstrips hash from the {{c-l class='FHHref'}} component) . When a cross link with\na property is clicked, the cross link will set this property to notify the route\nthat there is a fragment that should be observed on transition.
\n",
"itemtype": "property",
"name": "crossLinkFragmentOverride",
"type": "{?string}",
"access": "protected",
"tagname": "",
"default": "null",
"class": "BaseRoute",
"srcFileId": "addon_routes_base-route.js"
},
{
"file": "lib/decorate-config.js",
"line": 19,
"description": "Fountianhead default configurations are targeted at Ember applications and\ninclude a sane default for every option with the goal of being able to\ninstall and use the addon with zero configuration for simple/standard Ember\napps.\nTODO: Document defaults
\n",
"itemtype": "property",
"name": "defaultConfigurations",
"type": "{Object}",
"class": "decorateConfig",
"module": "Lib",
"srcFileId": "lib_decorate-config.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 102,
"description": "The optional elementId of the tab that should be shown by default. This is\nuseful for cases where the user has come into a page and is expecting one\nof the tabs to be shown by default.
\n",
"itemtype": "property",
"name": "defaultTab",
"type": "{String}",
"default": "''",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-class/items-container.js",
"line": 90,
"description": "The panel that that the tabs should render on creation. The tabs component\ntracks this separately and it needs to be updated separately when a class\npage is loaded with an item query parameter.
\n",
"itemtype": "property",
"name": "defaultTab",
"type": "{string}",
"default": "'indexPanel'",
"class": "FountainheadClass.ItemsContainer",
"srcFileId": "addon_components_fountainhead-class_items-container.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 30,
"description": "The string that should be converted to a partial
\n",
"itemtype": "property",
"name": "description",
"type": "{string}",
"default": "''",
"deprecated": true,
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-pages/base-page.js",
"line": 53,
"description": "Anytime the model or the fragmentId changes send a scroll event to\n{{c-l class='Fountainhead'}} service. This handles auto-scrolling to ids that\nare not in DOM when the page loads and handles scrolling to ids when the browser\nback button is clicked.
\n",
"itemtype": "event",
"name": "didReceiveAttrs",
"class": "FountainheadPages.BasePage",
"srcFileId": "addon_components_fountainhead-pages_base-page.js"
},
{
"file": "addon/components/fountainhead-class/items-container.js",
"line": 131,
"description": "When component attributes change, either the backing data or the scroll target\nhas changed. Use {{c-l 'fragmentId'}} to reset tabs to index panel if there\nis no scroll target, or select the correct tab for a scroll target.
\n",
"itemtype": "event",
"name": "didReceiveAttrs",
"class": "FountainheadClass.ItemsContainer",
"srcFileId": "addon_components_fountainhead-class_items-container.js"
},
{
"file": "addon/components/fountainhead-pages/module.js",
"line": 24,
"description": "Handle nulling out properties submodules and classes if they don't have\nany keys.
\n",
"itemtype": "event",
"name": "didReceiveAttrs",
"class": "FountainheadPages.Module",
"srcFileId": "addon_components_fountainhead-pages_module.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 156,
"description": "Whenever attrs are received fire the _generateDescription method to\ngenerate a partial that will be rendered.
\n",
"itemtype": "event",
"name": "didReceiveAttrs",
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/routes/base-route.js",
"line": 55,
"description": "On transition, handle resetting scroll position as well as updating\n{{c-l class='Fountainhead'}} service that a transition has occurred so that\nthe new location can be checked for a scroll target hash.
\n",
"itemtype": "event",
"name": "didTransition",
"class": "BaseRoute",
"srcFileId": "addon_routes_base-route.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 136,
"description": "Actions Up: When something changes in this component we need to let the\ncontainer tabs know by firing the updateTab closure action with this\ntabs changed data.
\n(Currently the only change we're notifying on is the hidden prop)
\n",
"itemtype": "event",
"name": "didUpdateAttrs",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 124,
"description": "A proxy action for the selfDestruct method
\n",
"itemtype": "method",
"name": "dismiss",
"return": {
"description": "",
"type": "Undefined"
},
"class": "FountainheadAlert",
"srcFileId": "addon_components_fountainhead-alert.js"
},
{
"file": "addon/components/navigation-api.js",
"line": 37,
"description": "Method to filter on doc elements for search.
\n",
"itemtype": "method",
"name": "doFilter",
"params": [
{
"name": "query",
"description": "The search query to filter on
\n",
"type": "String"
}
],
"return": {
"description": "",
"type": "Undefined"
},
"class": "NavigationAPI",
"srcFileId": "addon_components_navigation-api.js"
},
{
"file": "lib/generate-fountainhead-data.js",
"line": 75,
"description": "The docsMeta object is the guide for the documentation data. It contains\ndescriptions of the project as well as arrays of module and class routing\ninformation
\n",
"itemtype": "property",
"name": "docsMeta",
"type": "{Object}",
"class": "generateFountainheadData",
"module": "Lib",
"srcFileId": "lib_generate-fountainhead-data.js"
},
{
"file": "addon/components/fountainhead-header.js",
"line": 35,
"description": "Specific element id is passed to click-to-copy elements in the template.
\n",
"itemtype": "property",
"name": "elementId",
"type": "{string}",
"class": "FounatianheadHeader",
"srcFileId": "addon_components_fountainhead-header.js"
},
{
"file": "addon/components/fountainhead-class/items-container.js",
"line": 30,
"description": "This class' array of event documentation items.
\n",
"itemtype": "property",
"name": "event",
"type": "{Array}",
"default": "[]",
"passed": "",
"class": "FountainheadClass.ItemsContainer",
"srcFileId": "addon_components_fountainhead-class_items-container.js"
},
{
"file": "addon/components/navigation-guides/group.js",
"line": 14,
"description": "Protected tracking prop for guide group state.
\n",
"itemtype": "property",
"name": "expanded",
"type": "Boolean",
"access": "protected",
"tagname": "",
"default": "false",
"class": "CrossLink",
"srcFileId": "addon_components_navigation-guides_group.js"
},
{
"file": "addon/components/fountainhead-class/meta.js",
"line": 27,
"description": "The value property is set by using the @extends tag. Any class used in\nan extends tag will be linked to.
\n",
"itemtype": "property",
"name": "extends",
"type": "{string}",
"default": "''",
"class": "FountainheadClass.Meta",
"srcFileId": "addon_components_fountainhead-class_meta.js"
},
{
"file": "addon/services/fountainhead.js",
"line": 102,
"description": "Fires request for documentation meta data and returns the promise. This\nmethod is called in the beforeModel of either the docs or guides\nroute, whichever is entered first.
\n{{#fountainhead-alert brand='info' dismiss=false}}\n{{fountainhead-svg svgId='info'}} If the request fails {{cross-link item='metaError'}} will be set to true.\n{{/fountainhead-alert}}
\n",
"itemtype": "method",
"name": "fetchMeta",
"access": "public",
"tagname": "",
"return": {
"description": "",
"type": "Promise"
},
"class": "Fountainhead",
"srcFileId": "addon_services_fountainhead.js"
},
{
"file": "addon/components/fountainhead-pages/guide.js",
"line": 15,
"description": "Guide backing model matching structure:
\n{ \n id\n attributes\n body, \n} \nThe file property matches where the documentation for a class is declared\nin the source files. It is set automatically.
\n",
"itemtype": "property",
"name": "file",
"type": "{string}",
"default": "''",
"class": "FountainheadClass.Meta",
"srcFileId": "addon_components_fountainhead-class_meta.js"
},
{
"file": "addon/components/fountainhead-pages/file.js",
"line": 14,
"description": "JSON stringified file generated by documentation script.
\n",
"itemtype": "property",
"name": "file",
"type": "{string}",
"default": "''",
"class": "FountainheadPages.File",
"srcFileId": "addon_components_fountainhead-pages_file.js"
},
{
"file": "addon/components/fountainhead-svg.js",
"line": 13,
"description": "File path to svg definitions file
\n",
"itemtype": "property",
"name": "filePath",
"type": "{string}",
"passed": "",
"optional": 1,
"default": "assets/svg-defs.svg",
"class": "FountainheadSVG",
"srcFileId": "addon_components_fountainhead-svg.js"
},
{
"file": "lib/index.js",
"line": 35,
"description": "Optional configs pulled from fountainhead.js
\n",
"itemtype": "property",
"name": "fountainheadConfig",
"type": "{Object}",
"class": "Index",
"module": "Lib",
"srcFileId": "lib_index.js"
},
{
"file": "addon/components/fountainhead-class/items-container.js",
"line": 38,
"description": "Route scroll target passed in to allow automatic scrolling in\n{{c-l 'didReceiveAttrs'}} hook.
\n",
"itemtype": "property",
"name": "fragmentId",
"passed": "",
"type": "{?string}",
"default": "null",
"class": "FountainheadClass.ItemsContainer",
"srcFileId": "addon_components_fountainhead-class_items-container.js"
},
{
"file": "addon/components/fountainhead-pages/base-page.js",
"line": 21,
"description": "Route target of either the hash fragment id or the id query param. Whenever the\ntarget changes it will trigger a {{c-l 'didReceiveAttrs'}} that handles\nscrolling the page to the new target (or back to top if the target changes to\nempty).
\n",
"itemtype": "property",
"name": "fragmentId",
"passed": "",
"type": "{?string}",
"default": "null",
"class": "FountainheadPages.BasePage",
"srcFileId": "addon_components_fountainhead-pages_base-page.js"
},
{
"file": "addon/services/fountainhead.js",
"line": 35,
"description": "When using the History Location type, this will match the hash fragment that is\nused for linking to specific documentation headers/properties. Ember Router\ndoesn't seem to notice these changes? so we track them and pass them down to the\npage components where they trigger page scrolls when the back button is used.
\n",
"itemtype": "property",
"name": "fragmentId",
"access": "protected",
"tagname": "",
"type": "{string}",
"default": "''",
"class": "Fountainhead",
"srcFileId": "addon_services_fountainhead.js"
},
{
"file": "addon/components/navigation-guides/group.js",
"line": 7,
"itemtype": "property",
"name": "guideGroup",
"type": "Object",
"access": "public",
"tagname": "",
"class": "CrossLink",
"srcFileId": "addon_components_navigation-guides_group.js"
},
{
"file": "addon/components/fountainhead-header.js",
"line": 81,
"description": "Copy to clipboard method must run in next event loop so that the anchor click\ncan bubble and the browser can update the url before we grab it and copy it.
\n",
"itemtype": "method",
"name": "handleCopy",
"action": "",
"class": "FounatianheadHeader",
"srcFileId": "addon_components_fountainhead-header.js"
},
{
"file": "lib/parse-markdown.js",
"line": 74,
"description": "NEW render rule heading_close called for any header closing token. Replace HTML\nclosing tag with a closing {{c-l class='FountainheadHeader'}} glimmer block to\nclose opening glimmer block.
\n",
"itemtype": "method",
"name": "heading_close",
"return": {
"description": "",
"type": "String"
},
"class": "parseMarkdown",
"module": "Lib",
"srcFileId": "lib_parse-markdown.js"
},
{
"file": "lib/parse-markdown.js",
"line": 47,
"description": "NEW render rule heading_open is called for any header element's opening token.\nFor all header opening tags, return an opening glimmer block for a\n{{c-l class='FountainheadHeader'}} component.
\nHeader elements follow the token pattern:heading_open => inline => heading_close
\nUsing this pattern, we also get the content from the next token to create the\nanchor id hash fragment for the link header.
\n",
"itemtype": "method",
"name": "heading_open",
"params": [
{
"name": "tokens",
"description": null,
"type": "Array"
},
{
"name": "index",
"description": null,
"type": "Number"
}
],
"return": {
"description": "Opening glimmer block string for a\n {{c-l class='FountainheadHeader'}} with tag type and href id.",
"type": "String"
},
"class": "parseMarkdown",
"module": "Lib",
"srcFileId": "lib_parse-markdown.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 46,
"description": "Whether this tab should be hidden from view. Useful for situations where\na tab needs to exist in a particular place in the tab ordering but may\nnot have the data it needs to display information at the time when\nregisterTab is invoked. This allows you to make sure your tab can be\nhidden while preserving its place in the list.
\n",
"itemtype": "property",
"name": "hidden",
"type": "{Boolean}",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/controllers/base-controller.js",
"line": 23,
"itemtype": "property",
"name": "id",
"type": "{?string}",
"default": "null",
"class": "BaseController",
"srcFileId": "addon_controllers_base-controller.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 183,
"description": "When the component initializes, we set the tabList property to an array.\nThis prevents multiple instances of fountainhead-tabs on a given page\nfrom inheriting the same tabList array through prototype inheritance.
\n",
"itemtype": "event",
"name": "init",
"return": {
"description": "",
"type": "Undefined"
},
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 118,
"description": "Handle registering with the tabs container on int by firing registerTab\nclosure action with this tab's data.
\n",
"itemtype": "event",
"name": "init",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/cross-link.js",
"line": 122,
"description": "Handle setting a route and model for the template when appropriate + set text\nfor cross link for when component is used in inline form.
\n",
"itemtype": "method",
"name": "init",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 133,
"description": "On init we map the passed contextActions to real actions in this\ncomponent's actions hash to ensure they're available at compile time.
\n",
"itemtype": "method",
"name": "init",
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "app/instance-initializers/fountainhead-routes.js",
"line": 23,
"description": "Initialize route that is called by consuming Ember application\nRouter instance from the consuming application can directly mapped.
\n",
"itemtype": "method",
"name": "initialize",
"return": {
"description": "",
"type": "Undefined"
},
"class": "FountainheadRoutes",
"module": "App",
"srcFileId": "app_instance-initializers_fountainhead-routes.js"
},
{
"file": "addon/components/cross-link.js",
"line": 82,
"description": "Optionally specify an item (property/method) to cross link to on a class.
\n",
"itemtype": "property",
"name": "item",
"type": "{?string}",
"passed": "",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
},
{
"file": "addon/components/navigation-api/section.js",
"line": 18,
"description": "Array of documentation items to create links for. Each item should be of\nform:
\n{ \n name: 'Item name - used as text for anchor' , \n type: 'Either classes or modules' \n} \nThe button label text of this tab. This will be passed up via a closure\naction to the containing fountainhead-tabs component.
\n",
"itemtype": "property",
"name": "label",
"type": "{String}",
"default": "''",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-class/meta.js",
"line": 51,
"description": "The line property matches the line where documentation for a class is\ndeclared in the source files. It is set automatically.
\n",
"itemtype": "property",
"name": "line",
"type": "{?number}",
"default": "null",
"class": "FountainheadClass.Meta",
"srcFileId": "addon_components_fountainhead-class_meta.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 41,
"description": "Pass true to create a button that looks and behaves like a link. This is\nuseful for creating accessible interaction targets.
\n",
"itemtype": "property",
"name": "link",
"type": "{Boolean}",
"passed": "",
"optional": 1,
"default": "false",
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/navigation-api/logo.js",
"line": 18,
"description": "Path to a custom logo, can be set in your\nfountainhead.js
\n",
"itemtype": "property",
"name": "logo",
"type": "{?string}",
"passed": "NavigationAPI",
"class": "NavigationAPI.Logo",
"srcFileId": "addon_components_navigation-api_logo.js"
},
{
"file": "addon/components/navigation-guides.js",
"line": 16,
"description": "Fountainhead documentation meta. Component uses the guides meta to create\nlinks to each guide page.
\n",
"itemtype": "property",
"name": "meta",
"type": "{Object}",
"passed": "Fountainhead",
"required": 1,
"class": "NavigationGuides",
"srcFileId": "addon_components_navigation-guides.js"
},
{
"file": "addon/services/fountainhead.js",
"line": 46,
"description": "Documentation meta fetched from /meta.json. Contains high level map\nof modules, classes and guides available in documentation. Is generated in\n{{c-l module='Lib'}}.
\n// meta.json Object Shape: \n{ \n classes: [ ] , \n description: '' , \n guides: [ ] , \n hashRouting: boolean\n modules: [ ] , \n name: '' , \n parser: '' , \n repository: '' , \n version: '' \n} \nhashRouting and Page Load Scrolling With Fragment Ids{{/fountainhead-header}}\nFountainhead has automatic scrolling on page load for links with a target id in\nthem. For consuming applications using history location we use fragments ids for\nthe target:\nhttps://yourdocs.com/guides/your-guide#scroll-target
\nFor consuming applications using hash location, the meta response will have\nproperty hashRouting set to true. This flags Fountainhead to use a query\nparameter for the scroll target:\nhttps://yourdocs.com/#/guides/your-guide?id=scroll-target
\nAlthough this requires generating different link text and handling scrolling\ntargets two different ways, it allows us to have clean urls with fragments for\napps that have updated to history location while still supporting apps\nwith hash location routing.
\nThis property is used throughout Fountainhead when checking which routing the\nconsuming app is using.
\n",
"itemtype": "property",
"name": "meta",
"type": "{?Object}",
"default": "null",
"class": "Fountainhead",
"srcFileId": "addon_services_fountainhead.js"
},
{
"file": "addon/components/navigation-api.js",
"line": 16,
"description": "Fountainhead meta passed from service
\n",
"itemtype": "property",
"name": "meta",
"type": "{Object}",
"passed": "Fountainhead",
"required": 1,
"class": "NavigationAPI",
"srcFileId": "addon_components_navigation-api.js"
},
{
"file": "addon/services/fountainhead.js",
"line": 89,
"description": "Set to true if the call for documentation meta data fails. Almost always this\nmeans the user has not generated documentation yet, so the {{c-l class='Route.API'}}\nroute uses this to show getting started instructions when there is an error.
\n",
"itemtype": "property",
"name": "metaError",
"type": "{Boolean}",
"access": "public",
"tagname": "",
"default": "false",
"class": "Fountainhead",
"srcFileId": "addon_services_fountainhead.js"
},
{
"file": "addon/components/fountainhead-class/items-container.js",
"line": 47,
"description": "This class' array of method documentation items.
\n",
"itemtype": "property",
"name": "method",
"type": "{Array}",
"default": "[]",
"passed": "",
"class": "FountainheadClass.ItemsContainer",
"srcFileId": "addon_components_fountainhead-class_items-container.js"
},
{
"file": "lib/create-dirs.js",
"line": 20,
"description": "Synchronous mkdir that handles creating a potentially nested directory
\n",
"itemtype": "method",
"name": "mkdirSync",
"params": [
{
"name": "dirPath",
"description": "Directory path to create, can be nested
\n",
"type": "String"
}
],
"return": {
"description": "",
"type": "Undefined"
},
"class": "createDirs",
"module": "Lib",
"srcFileId": "lib_create-dirs.js"
},
{
"file": "addon/routes/api/modules.js",
"line": 11,
"description": "Fetches modules's JSON at: ${this.get('fountainhead.apiNamespace')}/modules/${params.file_id}.json
\n",
"itemtype": "method",
"name": "model",
"params": [
{
"name": "params",
"description": null,
"type": "Object",
"props": [
{
"name": "module_id",
"description": "Name of this class, use to fetch data",
"type": "String"
}
]
}
],
"return": {
"description": "jQuery ajax promise",
"type": "Promise"
},
"class": "API.Modules",
"srcFileId": "addon_routes_api_modules.js"
},
{
"file": "addon/routes/api/files.js",
"line": 11,
"description": "Fetches file's JSON at: ${this.get('fountainhead.apiNamespace')}/files/${params.file_id}.json
\n",
"itemtype": "method",
"name": "model",
"params": [
{
"name": "params",
"description": null,
"type": "Object",
"props": [
{
"name": "file_id",
"description": "Name of this class, use to fetch data",
"type": "String"
}
]
}
],
"return": {
"description": "jQuery ajax promise",
"type": "Promise"
},
"class": "API.Files",
"srcFileId": "addon_routes_api_files.js"
},
{
"file": "addon/routes/api/classes.js",
"line": 11,
"description": "Fetches class' JSON at: ${this.get('fountainhead.apiNamespace')}/classes/${params.class_id}.json
\n",
"itemtype": "method",
"name": "model",
"params": [
{
"name": "params",
"description": null,
"type": "Object",
"props": [
{
"name": "class_id",
"description": "Name of this class, use to fetch data",
"type": "String"
}
]
}
],
"return": {
"description": "jQuery ajax promise",
"type": "Promise"
},
"class": "API.Classes",
"srcFileId": "addon_routes_api_classes.js"
},
{
"file": "addon/routes/guides.js",
"line": 38,
"description": "Fetches modules's JSON at: ${this.get('fountainhead.apiNamespace')}/modules/${params.file_id}.json
\n",
"itemtype": "method",
"name": "model",
"params": [
{
"name": "params",
"description": null,
"type": "Object",
"props": [
{
"name": "guide_id",
"description": "Name of this class, use to fetch data",
"type": "String"
}
]
}
],
"return": {
"description": "jQuery ajax promise",
"type": "Promise"
},
"class": "Guides",
"srcFileId": "addon_routes_guides.js"
},
{
"file": "addon/components/cross-link.js",
"line": 89,
"description": "Documentation module to crosslink to.
\n",
"itemtype": "property",
"name": "module",
"type": "{?string}",
"passed": "",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
},
{
"file": "addon/components/fountainhead-pages/module.js",
"line": 14,
"description": "Module model content
\n",
"itemtype": "property",
"name": "module",
"type": "{string}",
"default": "''",
"class": "FountainheadPages.Module",
"srcFileId": "addon_components_fountainhead-pages_module.js"
},
{
"file": "addon/components/fountainhead-class/meta.js",
"line": 43,
"description": "The module property is set by using the @module tag. Any module used in\na module tag will be linked to.
\n",
"itemtype": "property",
"name": "module",
"type": "{string}",
"default": "''",
"class": "FountainheadClass.Meta",
"srcFileId": "addon_components_fountainhead-class_meta.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 121,
"description": "The mouseDown event is used for some utility/housekeeping methods because\nwe use the click event to pass in actions.
\nHandle setting the outline on this element to none because we know this\nevent is only triggered by actual mouse clicks. Keyboard events don't trigger\nit, which is a convenient way to know we're good to hide the outline and\nmaintain usability for keyboard users. A++ accessibility!
\nHandle checking for a tagging category and if one exists, fire a tag.
\nIf you need to override this event, be sure to call this._super();
\n",
"itemtype": "event",
"name": "mouseDown",
"return": {
"description": "",
"type": "Undefined"
},
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/fountainhead-class/header.js",
"line": 22,
"description": "Name of the class. Is generated by the @constructor tag.
\n",
"itemtype": "property",
"name": "name",
"type": "{string}",
"default": "''",
"class": "FountaineadClass.Header",
"srcFileId": "addon_components_fountainhead-class_header.js"
},
{
"file": "addon/components/fountainhead-class/items-container.js",
"line": 55,
"description": "Name of the class. Is checked in didReceiveAttrs to know if the tabs\nshould be reset to the index panel
\n",
"itemtype": "property",
"name": "name",
"type": "{string}",
"passed": "",
"class": "FountainheadClass.ItemsContainer",
"srcFileId": "addon_components_fountainhead-class_items-container.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 111,
"description": "Optional closure action that will be called whenever a tab is opened with\nthe id of that tab. Use this to create a controlled tabs instance.
\n",
"itemtype": "property",
"name": "onChange",
"type": "{function}",
"default": "null",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 42,
"description": "Contains optional action that is executed when the alert is dismissed.\nThis action will be executed before the alert is destroyed.
\n",
"itemtype": "property",
"name": "onDismiss",
"type": "{function}",
"default": "() => {}",
"access": "public",
"tagname": "",
"class": "FountainheadAlert",
"srcFileId": "addon_components_fountainhead-alert.js"
},
{
"file": "addon/components/fountainhead-state.js",
"line": 86,
"description": "Sets the {{c-l 'active'}} property to true.
\n",
"itemtype": "method",
"name": "openModal",
"class": "FountainheadState",
"srcFileId": "addon_components_fountainhead-state.js"
},
{
"file": "lib/index.js",
"line": 40,
"description": "Package JSON for project. Used to populate project description if not\ndefined in fountainhead.js config.
\n",
"itemtype": "property",
"name": "packageJSON",
"type": "{Object}",
"class": "Index",
"module": "Lib",
"srcFileId": "lib_index.js"
},
{
"file": "addon/components/fountainhead-runtime-description.js",
"line": 56,
"description": "Name of generated partial that is used in the template.
\n",
"itemtype": "property",
"name": "partialName",
"type": "{string}",
"class": "FountainheadRuntimeDescription",
"srcFileId": "addon_components_fountainhead-runtime-description.js"
},
{
"file": "addon/components/fountainhead-pages/base-page.js",
"line": 35,
"description": "Internal tracker for previous {{c-l 'fragmentId'}}. Needed to check if the\nscroll target has changed in the {{c-l 'didReceiveAttrs'}} hook.
\n",
"itemtype": "property",
"name": "previousFragmentID",
"access": "protected",
"tagname": "",
"type": "{?string}",
"default": "null",
"class": "FountainheadPages.BasePage",
"srcFileId": "addon_components_fountainhead-pages_base-page.js"
},
{
"file": "addon/components/fountainhead-class/items-container.js",
"line": 63,
"description": "This class' array of property documentation items.
\n",
"itemtype": "property",
"name": "property",
"type": "{Array}",
"default": "[]",
"passed": "",
"class": "FountainheadClass.ItemsContainer",
"srcFileId": "addon_components_fountainhead-class_items-container.js"
},
{
"file": "addon/controllers/base-controller.js",
"line": 17,
"itemtype": "property",
"name": "queryParams",
"type": "{Array}",
"default": "['item']",
"class": "BaseController",
"srcFileId": "addon_controllers_base-controller.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 229,
"description": "Closure action passed to content subcomponents that is called on init.\nEach child tab will register itself with this container. To ensure the\ntabList is only updated once per render, we proxy new tabs to the\n_tabsToCreate array and then push all of them to tabList using a\nrun.once call to _createTabsList
\n",
"itemtype": "method",
"name": "registerTab",
"params": [
{
"name": "tab",
"description": "Object model of tab to be registered
\n",
"type": "Object"
}
],
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-repo-link.js",
"line": 14,
"description": "Repository URL from fountainhead configurations. If a URL has been specified\nin the configs or the package.json this github logo will show with a link\nto the repo
\n",
"itemtype": "property",
"name": "repository",
"type": "{string}",
"default": "''",
"class": "FountainheadRepoLink",
"srcFileId": "addon_components_fountainhead-repo-link.js"
},
{
"file": "addon/routes/base-route.js",
"line": 34,
"description": "We don't want the id query param to be sticky. If it is, then if you\nhave an id scroll target for a class, navigate elsewhere and then click that\nclass again in the api-nav, the sticky query param will set the id to the\nprevious scroll target, 😣.
\nThe resetController hook is called anytime a route's model changes or the\nroute is exited, and is the recommended time to reset query param values on\na controller.
\n",
"itemtype": "method",
"name": "resetController",
"params": [
{
"name": "controller",
"description": null,
"type": "Object"
},
{
"name": "isExiting",
"description": null,
"type": "Boolean"
},
{
"name": "transition",
"description": null,
"type": "Object"
}
],
"class": "BaseRoute",
"srcFileId": "addon_routes_base-route.js"
},
{
"file": "addon/components/fountainhead-alert.js",
"line": 89,
"description": "A++ accessibility. Tells a screen this component is an alert.
\n",
"itemtype": "property",
"name": "role",
"type": "{string}",
"default": "'alert'",
"class": "FountainheadAlert",
"srcFileId": "addon_components_fountainhead-alert.js"
},
{
"file": "lib/generate-fountainhead-data.js",
"line": 50,
"description": "Call to handle saving data to a file. Requires a file path and data to save.\nIf data is not a string, it will be stringified
\n",
"itemtype": "method",
"name": "saveObjectToJSON",
"params": [
{
"name": "filePath",
"description": "Path to save file at
\n",
"type": "String"
},
{
"name": "data",
"description": "Data to save in file
\n",
"type": "Object|string"
}
],
"return": {
"description": "True for successful operation, false for failures",
"type": "Boolean"
},
"class": "generateFountainheadData",
"module": "Lib",
"srcFileId": "lib_generate-fountainhead-data.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 119,
"description": "Whether the page should scroll the tab context back to the top when one of\nthe tabs is clicked. This can be a nice convenience for usabilitee.
\n",
"itemtype": "property",
"name": "scrollOnClick",
"type": "{Boolean}",
"default": "false",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 127,
"description": "What the target of the scrollOnClick behavior should be. By default,\nthe entire page/body scrolls, however if this instance of\nfountainhead-tabs is contained within a modal or some other scrollable\nsub-container, it may be more desirable to execute a scroll against that\ninstead of the entire page. Simply pass a standard jQuery-like selector in\nas a string.
\n",
"itemtype": "property",
"name": "scrollTarget",
"type": "{string}",
"default": "'body, html'",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-class/items-container.js",
"line": 151,
"description": "Closure action passed to {{c-l class='FountainheadClass.PropertyLink'}} instances\nso that the tab for the property can be selected when a property is clicked\nbefore the selection bubbles up and the browser attempts to find the matching\nid for the property.
\n",
"itemtype": "method",
"name": "selectTabForProperty",
"params": [
{
"name": "id",
"description": "Id of the property matches the name of the property
\n",
"type": "String"
}
],
"class": "FountainheadClass.ItemsContainer",
"srcFileId": "addon_components_fountainhead-class_items-container.js"
},
{
"file": "addon/services/fountainhead.js",
"line": 124,
"description": "Reset the tracked fragment. Should be called when leaving routes b/c a hash\nchange event will not fire fire for the new clicked
\n",
"itemtype": "method",
"name": "setFragmentId",
"class": "Fountainhead",
"srcFileId": "addon_services_fountainhead.js"
},
{
"file": "addon/components/cross-link.js",
"line": 167,
"description": "Ember strips out hash fragments from link-tos, which means that when consumers\nwith History location click a cross-link pointing to a different route, Ember\nwill strip the hash.
\n'Fix' this by setting crossLinkFragmentOverride on the route. When the\nroute didTransition fires, it will see the override and update the history +\nscroll to the cross link target.
\n",
"itemtype": "method",
"name": "setFragmentOverride",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 207,
"description": "Action to show a tab. Set activeId to the passed elementId. activeId\nis passed down to children content components
\n",
"itemtype": "method",
"name": "showTab",
"params": [
{
"name": "elementId",
"description": "HTML id of the tab to show
\n",
"type": "String"
}
],
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-class/meta.js",
"line": 59,
"description": "scrFile id is set by the data scripts. It is a snake case version of the\nfile path and should be used for calling for the file
\n",
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "srcFileId",
"type": "{string}",
"default": "''",
"class": "FountainheadClass.Meta",
"srcFileId": "addon_components_fountainhead-class_meta.js"
},
{
"file": "addon/components/fountainhead-class/header.js",
"line": 15,
"description": "Src file id for this file. Used for link to for source.
\n",
"itemtype": "property",
"name": "srcFileId",
"type": "{string}",
"default": "''",
"class": "FountaineadClass.Header",
"srcFileId": "addon_components_fountainhead-class_header.js"
},
{
"file": "addon/components/fountainhead-class/meta.js",
"line": 68,
"description": "The submodule property is set by using the @submodule tag. Any submodule\nused in a submodule tag will be linked to.
\n",
"itemtype": "property",
"name": "submodule",
"type": "{string}",
"default": "''",
"class": "FountainheadClass.Meta",
"srcFileId": "addon_components_fountainhead-class_meta.js"
},
{
"file": "addon/components/fountainhead-svg.js",
"line": 22,
"description": "External SVG definitions file reference SVG id.
\n",
"itemtype": "property",
"name": "svgId",
"type": "{string}",
"passed": "",
"required": 1,
"class": "FountainheadSVG",
"srcFileId": "addon_components_fountainhead-svg.js"
},
{
"file": "addon/components/fountainhead-class/items-container.js",
"line": 162,
"description": "Closure action passed into the tab component. This action is called\nwhenever a tab is clicked with the id of the tab. Use this to update the\ncontrolling activeTab property for the tabs DDAU style.
\n",
"itemtype": "method",
"name": "tabChanged",
"action": "",
"params": [
{
"name": "tab",
"description": "Backing object for a given tab
\n",
"type": "Object",
"props": [
{
"name": "elementId",
"description": "The id of the tab, controls current tab displayed",
"type": "String"
}
]
}
],
"class": "FountainheadClass.ItemsContainer",
"srcFileId": "addon_components_fountainhead-class_items-container.js"
},
{
"file": "addon/components/fountainhead-tabs-content.js",
"line": 106,
"description": "Use this attribute to place a custom data-test attribute on the tab button\nfor this tab. This will allow easier, specific/direct targeting of clicking\nthis tab in automated testing.
\n",
"itemtype": "property",
"name": "tabDataTest",
"type": "{string}",
"class": "FountainheadTabsContent",
"srcFileId": "addon_components_fountainhead-tabs-content.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 155,
"description": "List of tabs to display. This is iterated through in the template to\nrendered the buttons that are used to change tabs.
\n",
"itemtype": "property",
"name": "tabList",
"type": "{Array.}",
"default": "null",
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/navigation-api/section.js",
"line": 51,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "'section'",
"class": "NavigationAPI.Section",
"srcFileId": "addon_components_navigation-api_section.js"
},
{
"file": "addon/components/navigation-guides.js",
"line": 28,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "NavigationGuides",
"srcFileId": "addon_components_navigation-guides.js"
},
{
"file": "addon/components/fountainhead-class/header.js",
"line": 38,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "'h2'",
"class": "FountaineadClass.Header",
"srcFileId": "addon_components_fountainhead-class_header.js"
},
{
"file": "addon/components/fountainhead-state.js",
"line": 60,
"description": "Rad State is a purely functional component with no rendered output of its\nown, so it doesn't need a root element cluttering up the DOM when it's\nbeing used.\n{{if state 'state' 'no-state'}}\n{{#fountainhead-button click=stateActions.toggleState}}Click{{/fountainhead-button}}
\n",
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"class": "FountainheadState",
"srcFileId": "addon_components_fountainhead-state.js"
},
{
"file": "addon/components/fountainhead-header.js",
"line": 41,
"description": "The tagName is passed to specify header size.
\n",
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"class": "FounatianheadHeader",
"srcFileId": "addon_components_fountainhead-header.js"
},
{
"file": "addon/components/fountainhead-svg.js",
"line": 50,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "'svg'",
"class": "FountainheadSVG",
"srcFileId": "addon_components_fountainhead-svg.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 104,
"description": "Button DOM element
\n",
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "'button'",
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/cross-link.js",
"line": 113,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "CrossLink",
"srcFileId": "addon_components_cross-link.js"
},
{
"file": "addon/components/fountainhead-class/meta.js",
"line": 93,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "'div'",
"class": "FountainheadClass.Meta",
"srcFileId": "addon_components_fountainhead-class_meta.js"
},
{
"file": "addon/components/navigation-api.js",
"line": 27,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "NavigationAPI",
"srcFileId": "addon_components_navigation-api.js"
},
{
"file": "addon/components/fountainhead-class/property-link.js",
"line": 30,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "FountainheadClass.PropertyLink",
"srcFileId": "addon_components_fountainhead-class_property-link.js"
},
{
"file": "addon/components/fountainhead-pages/api-index.js",
"line": 16,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "FountainheadPages.APIIndex",
"srcFileId": "addon_components_fountainhead-pages_api-index.js"
},
{
"file": "addon/components/navigation-api/logo.js",
"line": 29,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "NavigationAPI.Logo",
"srcFileId": "addon_components_navigation-api_logo.js"
},
{
"file": "addon/components/fountainhead-pages/base-page.js",
"line": 44,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "FountainheadPages.BasePage",
"srcFileId": "addon_components_fountainhead-pages_base-page.js"
},
{
"file": "addon/components/fountainhead-pages/api.js",
"line": 31,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "FountainheadPages.API",
"srcFileId": "addon_components_fountainhead-pages_api.js"
},
{
"file": "addon/components/fountainhead-repo-link.js",
"line": 26,
"itemtype": "property",
"name": "tagName",
"type": "{string}",
"default": "''",
"class": "FountainheadRepoLink",
"srcFileId": "addon_components_fountainhead-repo-link.js"
},
{
"file": "addon/components/navigation-api/section.js",
"line": 33,
"description": "Section header text content
\n",
"itemtype": "property",
"name": "title",
"type": "{string}",
"passed": "",
"optional": 1,
"default": "''",
"class": "NavigationAPI.Section",
"srcFileId": "addon_components_navigation-api_section.js"
},
{
"file": "addon/components/navigation-guides/group.js",
"line": 25,
"description": "Called on click of group trigger, toggles height animation of group container\nand toggles {{c-l 'expanded'}} value.
\n",
"itemtype": "method",
"name": "toggle",
"class": "CrossLink",
"srcFileId": "addon_components_navigation-guides_group.js"
},
{
"file": "addon/components/fountainhead-state.js",
"line": 93,
"description": "Sets the {{c-l 'active'}} property to passed state.
\n",
"itemtype": "method",
"name": "toggleState",
"params": [
{
"name": "state",
"description": "State to set active to
\n",
"type": "Boolean"
}
],
"class": "FountainheadState",
"srcFileId": "addon_components_fountainhead-state.js"
},
{
"file": "addon/services/fountainhead.js",
"line": 132,
"description": "Begins tracking the location.hash to pass down to page components. See\n{{c-l 'fragmentId'}} for details.
\n",
"itemtype": "method",
"name": "trackHash",
"access": "public",
"tagname": "",
"action": "",
"class": "Fountainhead",
"srcFileId": "addon_services_fountainhead.js"
},
{
"file": "addon/components/fountainhead-button.js",
"line": 111,
"description": "Include type button for usability.
\n",
"itemtype": "property",
"name": "type",
"type": "{string}",
"default": "'button'",
"class": "FountainheadButton",
"srcFileId": "addon_components_fountainhead-button.js"
},
{
"file": "addon/components/fountainhead-tabs.js",
"line": 243,
"description": "Closure action passed to content subcomponents that is called whenever\na tab has updated in a way this container needs to know of. Currently\nthis is only when a tab's hidden status changes.
\n",
"itemtype": "method",
"name": "updateTab",
"params": [
{
"name": "tab",
"description": null,
"type": "Object",
"props": [
{
"name": "elementId",
"description": "HTML id of tab to update",
"type": "String"
},
{
"name": "hidden",
"description": "Hidden status of changed tab",
"type": "Boolean"
}
]
}
],
"class": "FountainheadTabs",
"srcFileId": "addon_components_fountainhead-tabs.js"
},
{
"file": "addon/components/fountainhead-class/meta.js",
"line": 76,
"description": "The uses array is set by using one or more @uses tags. Any class used in\na uses tag will be linked to.
\n",
"itemtype": "property",
"name": "uses",
"type": "{Array}",
"default": "[]",
"class": "FountainheadClass.Meta",
"srcFileId": "addon_components_fountainhead-class_meta.js"
},
{
"file": "lib/index.js",
"line": 78,
"description": "Raw YUIDoc JSON data generated using constructor exported by yuidocjs.\nCall new with options from config to pass configs to YUIDoc and call run\nto generate JSON
\n",
"itemtype": "property",
"name": "yuidocJSON",
"type": "{Object}",
"class": "Index",
"module": "Lib",
"srcFileId": "lib_index.js"
}
],
"warnings": [
{
"message": "unknown tag: passed",
"line": " addon/components/fountainhead-class/items-container.js:30"
},
{
"message": "unknown tag: passed",
"line": " addon/components/fountainhead-class/items-container.js:38"
},
{
"message": "unknown tag: passed",
"line": " addon/components/fountainhead-class/items-container.js:47"
},
{
"message": "unknown tag: passed",
"line": " addon/components/fountainhead-class/items-container.js:55"
},
{
"message": "unknown tag: passed",
"line": " addon/components/fountainhead-class/items-container.js:63"
},
{
"message": "unknown tag: action",
"line": " addon/components/fountainhead-class/items-container.js:162"
},
{
"message": "unknown tag: passed",
"line": " addon/components/fountainhead-pages/base-page.js:21"
},
{
"message": "unknown tag: passed",
"line": " addon/components/fountainhead-pages/class.js:14"
},
{
"message": "unknown tag: passed",
"line": " addon/components/navigation-api/logo.js:18"
},
{
"message": "unknown tag: passed",
"line": " addon/components/navigation-api/section.js:18"
},
{
"message": "unknown tag: passed",
"line": " addon/components/navigation-api/section.js:33"
},
{
"message": "unknown tag: passed",
"line": " addon/components/cross-link.js:75"
},
{
"message": "unknown tag: passed",
"line": " addon/components/cross-link.js:82"
},
{
"message": "unknown tag: passed",
"line": " addon/components/cross-link.js:89"
},
{
"message": "unknown tag: passed",
"line": " addon/components/fountainhead-button.js:32"
},
{
"message": "unknown tag: passed",
"line": " addon/components/fountainhead-button.js:41"
},
{
"message": "unknown tag: action",
"line": " addon/components/fountainhead-header.js:81"
},
{
"message": "unknown tag: passed",
"line": " addon/components/fountainhead-svg.js:13"
},
{
"message": "unknown tag: passed",
"line": " addon/components/fountainhead-svg.js:22"
},
{
"message": "unknown tag: passed",
"line": " addon/components/navigation-api.js:16"
},
{
"message": "unknown tag: passed",
"line": " addon/components/navigation-guides.js:16"
},
{
"message": "unknown tag: action",
"line": " addon/services/fountainhead.js:132"
}
]
}