alfresco-ng2-components/docs/info-drawer.component.md
Andy Stark 4752f3b73e [ADF-2334] Added version and status metadata to doc files (#2974)
* [ADF-2334] Added version and status metadata to doc files

* [ADF-2334] Tidier looking metadata for guide pages
2018-02-22 09:34:21 +00:00

53 lines
1.5 KiB
Markdown

---
Added: v2.0.0
Status: Active
---
# InfoDrawer component
Displays a sidebar-style information panel with tabs.
![Info drawer screenshot](docassets/images/activities-infodrawer.png)
## Basic usage
```html
<adf-info-drawer title="Activities" (currentTab)="getActiveTab($event)">
<div info-drawer-buttons>
<mat-icon (click)="close()">clear</mat-icon>
</div>
<adf-info-drawer-tab label="Activity">
<mycomponent1></mycomponent1>
<mycomponent2></mycomponent2>
</adf-info-drawer-tab>
<adf-info-drawer-tab label="Details">
<mycomponent3></mycomponent3>
</adf-info-drawer-tab>
</adf-info-drawer>
```
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| title | `string` | `null` | The title of the info drawer. |
| selectedIndex | `number` | `0` | The selected index tab. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| currentTab | `EventEmitter<number>` | Emitted when the currently active tab changes. |
## Details
This is a variant of the [Info Drawer Layout component](info-drawer-layout.component.md) that displays information in tabs. You can use the `adf-info-drawer-tab` subcomponent to add tabs (as shown in the example) and the `currentTab` output property to select the currently active tab.
You can also customize the three regions (title, buttons and content) as with the Info Drawer Layout component.
## See also
- [Info drawer layout component](info-drawer-layout.component.md)