1
0

added TypeDoc

This commit is contained in:
lotte
2019-10-16 11:21:25 +02:00
parent 7ca88021c9
commit d962e40c58
84 changed files with 479 additions and 93 deletions

View File

@@ -25,19 +25,63 @@ import { CollectionElementLinkType } from '../object-collection/collection-eleme
animations: [fadeIn]
})
export class ObjectListComponent {
/**
* The view mode of the this component
*/
viewMode = ViewMode.ListElement;
/**
* The current pagination configuration
*/
@Input() config: PaginationComponentOptions;
/**
* The current sort configuration
*/
@Input() sortConfig: SortOptions;
/**
* Whether or not the list elements have a border
*/
@Input() hasBorder = false;
/**
* The whether or not the gear is hidden
*/
@Input() hideGear = false;
/**
* Whether or not the pager is visible when there is only a single page of results
*/
@Input() hidePagerWhenSinglePage = true;
/**
* The link type of the listable elements
*/
@Input() linkType: CollectionElementLinkType;
/**
* The context of the listable elements
*/
@Input() context: Context;
/**
* The current listable objects
*/
private _objects: RemoteData<PaginatedList<ListableObject>>;
/**
* Setter for the objects
* @param objects The new objects
*/
@Input() set objects(objects: RemoteData<PaginatedList<ListableObject>>) {
this._objects = objects;
}
/**
* Getter to return the current objects
*/
get objects() {
return this._objects;
}
@@ -72,6 +116,9 @@ export class ObjectListComponent {
*/
@Output() sortDirectionChange: EventEmitter<SortDirection> = new EventEmitter<SortDirection>();
/**
* An event fired when on of the pagination parameters changes
*/
@Output() paginationChange: EventEmitter<SortDirection> = new EventEmitter<any>();
/**
@@ -79,24 +126,42 @@ export class ObjectListComponent {
* Event's payload equals to the newly selected sort field.
*/
@Output() sortFieldChange: EventEmitter<string> = new EventEmitter<string>();
data: any = {};
/**
* Emits the current page when it changes
* @param event The new page
*/
onPageChange(event) {
this.pageChange.emit(event);
}
/**
* Emits the current page size when it changes
* @param event The new page size
*/
onPageSizeChange(event) {
this.pageSizeChange.emit(event);
}
/**
* Emits the current sort direction when it changes
* @param event The new sort direction
*/
onSortDirectionChange(event) {
this.sortDirectionChange.emit(event);
}
/**
* Emits the current sort field when it changes
* @param event The new sort field
*/
onSortFieldChange(event) {
this.sortFieldChange.emit(event);
}
/**
* Emits the current pagination when it changes
* @param event The new pagination
*/
onPaginationChange(event) {
this.paginationChange.emit(event);
}