alfresco-ng2-components/docs/content-services/sites-dropdown.component.md
Andy Stark 2c0e7aa035 [ADF-2847] Added Class members headings and rebuilt prop/method tables for docs (#3240)
* [ADF-2847] Added class members heading to content services docs

* [ADF-2847] Updated all prop/method tables in content services
2018-04-26 14:54:25 +01:00

1.6 KiB

Added, Status, Last reviewed
Added Status Last reviewed
v2.0.0 Active 2018-03-13

Sites Dropdown component

Displays a dropdown menu to show and interact with the sites of the current user.

Dropdown sites

Basic Usage

 <adf-sites-dropdown
  (change)="getSiteContent($event)">
 </adf-sites-dropdown>

Class members

Properties

Attribute Type Default Description
hideMyFiles boolean false Hide the "My Files" option added to the list by default
siteList SitePaging 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 Emitted when user selects a site. When default option is selected an empty model is emitted