Allows a user to select items from a Content Services repository.
The Content Node Selector component works a lot like the standard File Open/Save dialog used by desktop applications except that it chooses items from a Content Services repository rather than the filesystem. For example, the Document List component uses a selector to choose the targets of Copy/Move actions (see the Content Action component for more information).
Unlike most components, the Content Node Selector Component is typically shown in a dialog box
rather than the main page and you are responsible for opening the dialog yourself. You can use the
Angular Material Dialog for this,
as shown in the usage example. ADF provides the ContentNodeSelectorComponentData
interface
to work with the Dialog's
data option:
export interface ContentNodeSelectorComponentData {
title: string;
actionName?: string;
currentFolderId: string;
dropdownHideMyFiles?: boolean;
restrictRootToCurrentFolderId?: boolean;
dropdownSiteList?: SitePaging;
rowFilter?: any;
where?: string;
imageResolver?: any;
selectionMode?: 'multiple' | 'single';
isSelectionValid?: (entry: Node) => boolean;
breadcrumbTransform?: (node) => any;
excludeSiteContent?: string[];
select: Subject<Node[]>;
showSearch?: boolean;
showFilesInResult?: boolean;
showDropdownSiteList?: boolean;
showLocalUploadButton?: boolean;
multipleUpload?: boolean;
}
The properties are described in the table below:
Name | Type | Default value | Description |
---|---|---|---|
title | string | "" | Dialog title |
actionName | string | "" | Text to appear on the dialog's main action button ("Move", "Copy", etc) |
currentFolderId | string | null | Node ID of the folder currently listed. |
dropdownHideMyFiles | boolean | false | Hide the "My Files" option added to the site list by default. See the Sites Dropdown component for more information. |
dropdownSiteList | SitePaging | null | Custom site for site dropdown same as siteList. See the Sites Dropdown component for more information. |
rowFilter | RowFilter | null | Custom row filter function. See the Row Filter Model page for more information. |
where | string | null | Custom where filter function. See the Document List component for more information. |
imageResolver | ImageResolver | null | Custom image resolver function. See the Image Resolver Model page for more information. |
pageSize | number | Number of items shown per page in the list. | |
isSelectionValid | ValidationFunction | defaultValidation | Function used to decide if the selected node has permission to be selected. Default value is a function that always returns true. |
breadcrumbTransform | (node: any) => any | 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. | |
select | Subject<Node> | Event emitted with the current node selection when the dialog closes | |
showSearch | boolean | true | Render search input |
showDropdownSiteList | boolean | true | Render sites list dropdown menu |
If you don't want to manage the dialog yourself then it is easier to use the Content Node Selector Panel component, or the methods of the Content Node Dialog service, which create the dialog for you.
import { MatDialog } from '@angular/material/dialog';
import { ContentNodeSelectorComponentData, ContentNodeSelectorComponent} from '@adf/content-services'
import { Subject } from 'rxjs/Subject';
...
constructor(dialog: MatDialog ... ) {}
openSelectorDialog() {
data: ContentNodeSelectorComponentData = {
title: "Choose an item",
actionName: "Choose",
currentFolderId: someFolderId,
select: new Subject<Node[]>()
};
this.dialog.open(
ContentNodeSelectorComponent,
{
data, panelClass: 'adf-content-node-selector-dialog',
width: '630px'
}
);
data.select.subscribe((selections: Node[]) => {
// Use or store selection...
},
(error)=>{
//your error handling
},
()=>{
//action called when an action or cancel is clicked on the dialog
this.dialog.closeAll();
});
}
All the results will be streamed to the select subject present in the ContentNodeSelectorComponentData
object passed to the dialog.
When the dialog action is selected by clicking, the data.select
stream will be completed.
The Content Node Selector uses a Document List to display the items that the user can choose. As with the standard Document List, you can supply a custom row filter function (to hide items that can't be chosen) and a custom image resolver function (to select an image to show in a particular list cell). For example, you could use a row filter to hide document nodes in a folder selector. See the Row Filter Model and Image Resolver Model pages for more information.
The breadcrumbTransform
property of ContentNodeSelectorComponentData
lets you modify
the Node
object that is used to generate the
list of breadcrumbs. You can use this, for example, to remove path elements that are not
relevant to the use case. See the Breadcrumb component page for an
example of how to use this function.
© 2023 Alfresco Software, Inc. All Rights Reserved.
By using this site, you are agreeing to allow us to collect and use cookies as outlined in Alfresco’s Cookie Statement and Terms of Use (and you have a legitimate interest in Alfresco and our products, authorizing us to contact you in such methods). If you are not ok with these terms, please do not use this website.