mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-19 17:14:57 +00:00
36 lines
1.6 KiB
Markdown
36 lines
1.6 KiB
Markdown
---
|
|
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.
|
|
|
|
|
|
|
|
## 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](../core/site.model.md) | Emitted when user selects a site. When default option is selected an empty model is emitted |
|