alfresco-ng2-components/docs/sites-dropdown.component.md
Popovics András 092e07c545 [ADF-1600] Change translation (#2574)
* Change translation

* Add browser test runner to scripts

* Adding option to hide the My Files option

* Add documentation and fix property's name
2017-11-01 09:38:51 +00:00

38 lines
1009 B
Markdown

# 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)
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Basic Usage](#basic-usage)
* [Properties](#properties)
* [Events](#events)
<!-- tocstop -->
<!-- markdown-toc end -->
## 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 |
### Events
| Name | Returned Type | Description |
| --- | --- | --- |
| change | [SiteModel](https://github.com/Alfresco/alfresco-ng2-components/blob/master/ng2-components/ng2-alfresco-core/src/models/site.model.ts) | emitted when user selects a site. When default option is selected an empty model is emitted |