[ADF-3745] Updates for doc review (#4291)

* [ADF-3745] Updates for doc review

* [ADF-3745] Fixed bad links to Content node selector page

* [ADF-3745] Updated index files
This commit is contained in:
Andy Stark
2019-02-08 21:21:06 +00:00
committed by Eugenio Romano
parent 581a0c5177
commit 1079361c2c
24 changed files with 277 additions and 180 deletions

View File

@@ -64,9 +64,9 @@ export class ContentNodeSelectorPanelComponent implements OnInit {
@Input()
dropdownHideMyFiles: boolean = false;
/** Custom site for site dropdown same as siteList. See the
* [Sites Dropdown component](sites-dropdown.component.md)
* for more information.
/** Custom site for site dropdown. This is the same as the `siteList`.
* property of the Sites Dropdown component (see its doc page
* for more information).
*/
@Input()
dropdownSiteList: SitePaging = null;
@@ -74,14 +74,15 @@ export class ContentNodeSelectorPanelComponent implements OnInit {
_rowFilter: RowFilter = defaultValidation;
/** Custom *where* filter function. See the
* [Document List component](document-list.component.md)
* Document List component
* for more information.
*/
@Input()
where: string;
/** Custom row filter function. See the
* [Document List component](document-list.component.md#custom-row-filter)
/**
* Custom row filter function. See the
* [Row Filter Model](row-filter.model.md) page
* for more information.
*/
@Input()
@@ -108,8 +109,9 @@ export class ContentNodeSelectorPanelComponent implements OnInit {
return this._excludeSiteContent;
}
/** Custom image resolver function. See the
* [Document List component](document-list.component.md#custom-row-filter)
/**
* Custom image resolver function. See the
* [Image Resolver Model](image-resolver.model.md) page
* for more information.
*/
@Input()

View File

@@ -197,10 +197,15 @@ export class DocumentListComponent implements OnInit, OnChanges, OnDestroy, Afte
@Input()
loading: boolean = false;
/** Custom row filter */
/** @hidden */
@Input()
_rowFilter: RowFilter | null = null;
/**
* Custom function to choose whether to show or hide rows.
* See the [Row Filter Model](row-filter.model.md) page for
* more information.
*/
@Input()
set rowFilter(rowFilter: RowFilter) {
this._rowFilter = rowFilter;
@@ -216,7 +221,11 @@ export class DocumentListComponent implements OnInit, OnChanges, OnDestroy, Afte
return this._rowFilter;
}
/** Custom image resolver */
/**
* Custom function to choose image file paths to show. See the
* [Image Resolver Model](image-resolver.model.md) page for
* more information.
*/
@Input()
imageResolver: any | null = null;
@@ -246,7 +255,7 @@ export class DocumentListComponent implements OnInit, OnChanges, OnDestroy, Afte
@Input()
node: NodePaging = null;
/** Default value is stored into user preference settings use it only if you are not using the pagination */
/** Default value is stored in the user preference settings. Use this only if you are not using pagination. */
@Input()
maxItems: number = this.DEFAULT_PAGINATION.maxItems;

View File

@@ -255,6 +255,11 @@ export class SearchQueryBuilderService {
return [];
}
/**
* Gets the query group.
* @param query Target query
* @returns Query group
*/
getQueryGroup(query) {
return query.group || this.config.facetQueries.label || 'Facet Queries';
}