openstack/horizon
Code Issues Proposed changes

Merge "Magic Search inline doc cleanup"

Browse Source
This commit is contained in:
Jenkins 2016-06-21 16:32:42 +00:00 committed by Gerrit Code Review
commit 8408be31dc
4 changed files with 63 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
horizon/static/framework/widgets/magic-search/hz-magic-search-bar.directive.js
View File

@ -35,7 +35,35 @@
*
* @example
* ```
* <hz-magic-search-context>
*
* var filterFacets = [
* {
* label: gettext('Name'),
* name: 'name',
* singleton: true
* },
* {
* label: gettext('VCPUs'),
* name: 'vcpus',
* singleton: true
* },
* {
* label: gettext('RAM'),
* name: 'ram',
* singleton: true
* },
* {
* label: gettext('Public'),
* name: 'isPublic',
* singleton: true,
* options: [
* { label: gettext('No'), key: false },
* { label: gettext('Yes'), key: true }
* ]
* }];
*
* <hz-magic-search-context
* filter-facets="filterFacets">
* <hz-magic-search-bar></hz-magic-search-bar>
* </hz-magic-search-context>
* ```

9
horizon/static/framework/widgets/magic-search/hz-magic-search-context.directive.js
View File

@ -41,7 +41,9 @@
*
* @param {object} filterFacets Facets allowed for searching
* @param {object=} filterStrings Help content shown in search bar
* @param {object=} clientFullTextSearch if full text search is to be done on the client
* @param {boolean=} clientFullTextSearch if true, performs full text search
* exclusively on the client
*
* Facets:
* ```
* var nameFacet = {
@ -72,9 +74,8 @@
* @example
* ```
* <hz-magic-search-context
* template="/static/framework/widgets/magic-search/magic-search.html"
* strings="filterStrings"
* facets="{{ filterFacets }}">
* filter-strings="filterStrings"
* filter-facets="filterFacets">
* <magic-search></magic-search>
* <table st-magic-search st-table="controller.data">
* </table>

6
horizon/static/framework/widgets/magic-search/magic-search.module.js
View File

@ -25,12 +25,6 @@
* used with the Eucalyptus third-party MagicSearch module at
* https://github.com/eucalyptus/magic-search.
*
* | Directives |
* |-------------------------------------------------------------------|
* | {@link MagicSearch.directive:hzMagicSearchBar `hzMagicSearchBar`} |
* | {@link MagicSearch.directive:magicOverrides `magicOverrides`} |
* | {@link MagicSearch.directive:stMagicSearch `stMagicSearch`} |
*
*/
angular
.module('horizon.framework.widgets.magic-search', ['ui.bootstrap'])

30
horizon/static/framework/widgets/magic-search/st-magic-search.directive.js
View File

@ -41,7 +41,35 @@
*
* @example
* ```
* <hz-magic-search-context>
*
* var filterFacets = [
* {
* label: gettext('Name'),
* name: 'name',
* singleton: true
* },
* {
* label: gettext('VCPUs'),
* name: 'vcpus',
* singleton: true
* },
* {
* label: gettext('RAM'),
* name: 'ram',
* singleton: true
* },
* {
* label: gettext('Public'),
* name: 'isPublic',
* singleton: true,
* options: [
* { label: gettext('No'), key: false },
* { label: gettext('Yes'), key: true }
* ]
* }];
*
* <hz-magic-search-context
* filter-facets="filterFacets">
* <hz-magic-search-bar></hz-magic-search-bar>
* <table st-table st-magic-search>
* </table>