inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2026-09-09 18:03:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-2463] Moved doc files into subfolders (#3080)

Browse Source
This commit is contained in:
Andy Stark
2018-03-14 15:38:55 +00:00
committed by Eugenio Romano
parent 2889f6dcac
commit 86cc219bc4
48 changed files with 206 additions and 208 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content-services/sites-dropdown.component.md
+35
View File
@@ -0,0 +1,35 @@
---
Added: v2.0.0
Status: Active
Last reviewed: 2018-03-13
---
# Sites Dropdown component
Displays a dropdown menu to show and interact with the sites of the current user.
![Dropdown sites](../docassets/images/document-list-dropdown-list.png)
## Basic Usage
```html
<adf-sites-dropdown
(change)="getSiteContent($event)">
</adf-sites-dropdown>
```
### Properties
| Attribute | Type | Default | Description |
| --------- | ---- | ------- | ----------- |
| hideMyFiles | boolean | false | Hide the "My Files" option added to the list by default |
| siteList | [SitePaging](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | A custom list of sites to be displayed by the dropdown. If no value is given, the sites of the current user are displayed by default. A list of objects only with properties 'title' and 'guid' is enough to be able to display the dropdown. |
| placeholder | string | 'DROPDOWN.PLACEHOLDER_LABEL' | The placeholder text/the key from translation files for the placeholder text to be shown by default |
| value | string | null | Id of the select site |
| relations | string | null | A custom list of sites to be displayed by the dropdown. If no value is given, the sites of the current user are displayed by default. A list of objects only with properties 'title' and 'guid' is enough to be able to display the dropdown. |
### Events
| Name | Returned Type | Description |
| ---- | ------------- | ----------- |
| change | [SiteModel](../site.model.md) | Emitted when user selects a site. When default option is selected an empty model is emitted |