Skip to content

Commit ccc746f

Browse files
Merge pull request #626 from dtaylor113/ngdocs-update
chore(ngDoc updates): Card timeframe filter and pfViewUtils
2 parents e470eb5 + 78c8599 commit ccc746f

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

src/card/examples/card-timeframe.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@
2525
* {label:'Today', value:'today'}]</pre>
2626
* <li>.defaultFilter - integer, 0 based index into the filters array
2727
* <li>.callBackFn - user defined function to call when a filter is selected
28+
* <li>.position - (optional) If not specified, or set to 'footer'; the position of the filter dropdown will appear in the
29+
* card footer. If set to 'header', the filter dropdown will appear in the card header.
2830
* </ul>
2931
* @description
3032
* Component for easily displaying a card with html content

src/views/view-utils.js

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
(function () {
22
'use strict';
33

4+
/**
5+
* @ngdoc object
6+
* @name patternfly.views.pfViewUtils
7+
* @description
8+
* A utility constant to return view objects used for Dashboard, Card, Table, List, and Topology view switcher types.
9+
* @example
10+
* <pre>
11+
* $scope.viewsConfig = {
12+
* views: [pfViewUtils.getListView(), pfViewUtils.getCardView(), pfViewUtils.getTableView()]
13+
* };
14+
* </pre>
15+
* Each getXxxxView() returns an object:
16+
* <ul style='list-style-type: none'>
17+
* <li>.id - (String) Unique id for the view, used for comparisons
18+
* <li>.title - (String) Optional title, uses as a tooltip for the view selector
19+
* <li>.iconClass - (String) Icon class to use for the view selector
20+
* </ul>
21+
* Please see {@link patternfly.toolbars.component:pfToolbar pfToolbar} for use in Toolbar View Switcher
22+
*/
423
angular.module('patternfly.views').constant('pfViewUtils', {
524
getDashboardView: function (title) {
625
return {

0 commit comments

Comments
 (0)