[ADF-2451] Reviewed docs for components (#3061)

* [ADF-2451] Reviewed tasklist docs

* [ADF-2451] Reviewed docs for content node components

* [ADF-2451] Fixed tslint error

* [ADF-2463] Moved core components to subfolder (#3062)

* [ADF-2443] renaming getDifferentPageSize to getDefaultPageSize (#3060)

* [ADF-2443] renaming getDifferentPageSize to getDefaultPageSize

* [ADF-2443] fixed method call for demo shell

* Add data-automation-id to an error message displayed on the Tag Page. (#3064)

* Update upload-drag-area.component.md (#3067)

* [ADF-2443] fixed documentation (#3066)

* [ADF-2451] Reviewed tasklist docs

* [ADF-2451] Reviewed docs for content node components

* [ADF-2451] Fixed tslint error
This commit is contained in:
Andy Stark
2018-03-13 12:11:13 +00:00
committed by Eugenio Romano
parent c3e2588e35
commit d563dbbd77
7 changed files with 181 additions and 119 deletions

View File

@@ -60,6 +60,11 @@ export class BreadcrumbComponent implements OnInit, OnChanges {
@Input()
target: DocumentListComponent;
/** Transformation to be performed on the chosen/folder node before building
* the breadcrumb UI. Can be useful when custom formatting is needed for the
* breadcrumb. You can change the path elements from the node that are used to
* build the breadcrumb using this function.
*/
@Input()
transform: (node) => any;

View File

@@ -50,30 +50,57 @@ const defaultValidation = () => true;
})
export class ContentNodeSelectorPanelComponent implements OnInit {
/** Node ID of the folder currently listed. */
@Input()
currentFolderId: string = null;
/** Hide the "My Files" option added to the site list by default.
* See the [Sites Dropdown component](sites-dropdown.component.md)
* for more information.
*/
@Input()
dropdownHideMyFiles: boolean = false;
/** Custom site for site dropdown same as siteList. See the
* [Sites Dropdown component](sites-dropdown.component.md)
* for more information.
*/
@Input()
dropdownSiteList: SitePaging = null;
/** Custom row filter function. See the
* [Document List component](document-list.component.md#custom-row-filter)
* for more information.
*/
@Input()
rowFilter: RowFilter = null;
/** Custom image resolver function. See the
* [Document List component](document-list.component.md#custom-row-filter)
* for more information.
*/
@Input()
imageResolver: ImageResolver = null;
/** Number of items shown per page in the list. */
@Input()
pageSize: number;
/** Function used to decide if the selected node has permission to be selected.
* Default value is a function that always returns true.
*/
@Input()
isSelectionValid: ValidationFunction = defaultValidation;
/** Transformation to be performed on the chosen/folder node before building the
* breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb.
* You can change the path elements from the node that are used to build the
* breadcrumb using this function.
*/
@Input()
breadcrumbTransform: (node) => any;
/** Emitted when the user has chosen an item. */
@Output()
select: EventEmitter<MinimalNodeEntryEntity[]> = new EventEmitter<MinimalNodeEntryEntity[]>();

View File

@@ -61,23 +61,23 @@ export class TaskListComponent implements OnChanges, AfterContentInit, Paginated
@ContentChild(DataColumnListComponent) columnList: DataColumnListComponent;
/* The id of the app. */
/** The id of the app. */
@Input()
appId: number;
/* The Instance Id of the process. */
/** The Instance Id of the process. */
@Input()
processInstanceId: string;
/* The Definition Key of the process. */
/** The Definition Key of the process. */
@Input()
processDefinitionKey: string;
/* Current state of the process. Possible values are: `completed`, `active`. */
/** Current state of the process. Possible values are: `completed`, `active`. */
@Input()
state: string;
/* The assignment of the process. Possible values are: "assignee" (the current user
/** The assignment of the process. Possible values are: "assignee" (the current user
* is the assignee), candidate (the current user is a task candidate", "group_x" (the task
* is assigned to a group where the current user is a member,
* no value(the current user is involved).
@@ -85,53 +85,56 @@ export class TaskListComponent implements OnChanges, AfterContentInit, Paginated
@Input()
assignment: string;
/* Define the sort order of the processes. Possible values are : `created-desc`,
/** Define the sort order of the processes. Possible values are : `created-desc`,
* `created-asc`, `due-desc`, `due-asc`
*/
@Input()
sort: string;
/** Name of the tasklist. */
@Input()
name: string;
/* Define which task id should be selected after reloading. If the task id doesn't
/** Define which task id should be selected after reloading. If the task id doesn't
* exist or nothing is passed then the first task will be selected.
*/
@Input()
landingTaskId: string;
/* Data source object that represents the number and the type of the columns that
/** Data source object that represents the number and the type of the columns that
* you want to show.
*/
@Input()
data: DataTableAdapter;
/* Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode,
/** Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode,
* you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for
* multiple rows.
*/
@Input()
selectionMode: string = 'single'; // none|single|multiple
/** Custom preset column schema in JSON format. */
@Input()
presetColumn: string;
/* Toggles multiple row selection, renders checkboxes at the beginning of each row */
/** Toggles multiple row selection, renders checkboxes at the beginning of each row */
@Input()
multiselect: boolean = false;
/* Emitted when a task in the list is clicked */
/** Emitted when a task in the list is clicked */
@Output()
rowClick: EventEmitter<string> = new EventEmitter<string>();
/* Emitted when rows are selected/unselected */
/** Emitted when rows are selected/unselected */
@Output()
rowsSelected: EventEmitter<any[]> = new EventEmitter<any[]>();
/* Emitted when the task list is loaded */
/** Emitted when the task list is loaded */
@Output()
success: EventEmitter<any> = new EventEmitter<any>();
/** Emitted when an error occurs. */
@Output()
error: EventEmitter<any> = new EventEmitter<any>();
@@ -140,11 +143,11 @@ export class TaskListComponent implements OnChanges, AfterContentInit, Paginated
layoutPresets = {};
pagination: BehaviorSubject<Pagination>;
/* The page number of the tasks to fetch. */
/** The page number of the tasks to fetch. */
@Input()
page: number = 0;
/* The number of tasks to fetch. */
/** The number of tasks to fetch. Default value: 25. */
@Input()
size: number = PaginationComponent.DEFAULT_PAGINATION.maxItems;