mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
52df355e90
* [ADF-2373] added filtering for membership on site dropdown * [ADF-2373] added test for new site service method * [ADF-2373] added filtering for site membering to the sites dropdown * [ADF-2373] added another check into sites tests * [ADF-2373] added a fix for the site dropdown tests * [ADF-2373] fixed broken test check * [ADF-2373] added PR review changes
34 lines
1.6 KiB
Markdown
34 lines
1.6 KiB
Markdown
---
|
|
Added: v2.0.0
|
|
Status: Active
|
|
---
|
|
# 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 | This parameter will allow to perform sites query filtering the results.It could have two possible values: **members** and **containers**. When **members** is used the site list will be filtered with only the sites where the user is a member of. |
|
|
|
|
### 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 |
|