Merge pull request #435 from jeff-phillips-18/branch-4.0-dev

dtaylor113 · web-flow · commit d7323931070a · 2017-04-04T11:43:34.000-04:00
Fix pfSelect documentation to show appropriate parameters
diff --git a/bower.json b/bower.json
@@ -52,5 +52,8 @@
   "devDependencies": {
     "angular-mocks": "1.5.*",
     "angular-ui-router": "^1.0.0-beta.3"
+  },
+  "resolutions": {
+    "jquery": "~2.1.4"
   }
 }
diff --git a/src/select/examples/select.js b/src/select/examples/select.js
@@ -3,8 +3,11 @@
  * @name patternfly.select.component:pfSelect
  * @restrict E
  *
- * @param {string} ngModel Model binding using the {@link https://docs.angularjs.org/api/ng/type/ngModel.NgModelController/ NgModelController} is mandatory.
- * @param {string=} ngOptions The `{@link https://docs.angularjs.org/api/ng/directive/select/ ngOptions}` attribute can be used to dynamically generate a list of `<option>` elements
+ * @param {object} selected Curently selected value
+ * @param {object} options Array of valid selections
+ * @param {string} displayField Field from the object in the array to display for selection (optional)
+ * @param {string} emptyValue value to display when nothing is selected
+ * @param {function(item)} onSelect Function to call upon user selection of an item.
  *
  * @description
  * The pfSelect component provides a wrapper for the angular ui bootstrap dropdown container allowing for use of ng-model and ng-options

Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,11 @@`
`3`	`3`	`* @name patternfly.select.component:pfSelect`
`4`	`4`	`* @restrict E`
`5`	`5`	`*`
`6`		`- * @param {string} ngModel Model binding using the {@link https://docs.angularjs.org/api/ng/type/ngModel.NgModelController/ NgModelController} is mandatory.`
`7`		- * @param {string=} ngOptions The `{@link https://docs.angularjs.org/api/ng/directive/select/ ngOptions}` attribute can be used to dynamically generate a list of `<option>` elements
	`6`	`+ * @param {object} selected Curently selected value`
	`7`	`+ * @param {object} options Array of valid selections`
	`8`	`+ * @param {string} displayField Field from the object in the array to display for selection (optional)`
	`9`	`+ * @param {string} emptyValue value to display when nothing is selected`
	`10`	`+ * @param {function(item)} onSelect Function to call upon user selection of an item.`
`8`	`11`	`*`
`9`	`12`	`* @description`
`10`	`13`	`* The pfSelect component provides a wrapper for the angular ui bootstrap dropdown container allowing for use of ng-model and ng-options`