mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-26 17:24:56 +00:00
c9a3b048b4
* [ADF-1769] Added JSDocs and updated prop table script * [ADF-1769] Fixed lint error in JSDoc
56 lines
1.4 KiB
Markdown
56 lines
1.4 KiB
Markdown
# Accordion Group component
|
|
|
|
Adds a collapsible panel to an [accordion menu](accordion.component.md).
|
|
|
|
|
|
|
|
## Basic Usage
|
|
|
|
```html
|
|
<adf-accordion>
|
|
<adf-accordion-group [heading]="titleHeading" [isSelected]="true" [headingIcon]="'assignment'" [headingIconTooltip]="'Group Tooltip'">
|
|
<my-list></my-list>
|
|
</adf-accordion-group>
|
|
</adf-accordion>
|
|
```
|
|
|
|
```ts
|
|
@Component({
|
|
selector: 'my-component'
|
|
})
|
|
export class MyComponent implements OnInit {
|
|
|
|
titleHeading: string;
|
|
|
|
constructor() {
|
|
this.titleHeading = 'My Group';
|
|
}
|
|
|
|
}
|
|
```
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| heading | `string` | Title heading for the group. |
|
|
| headingIcon | `string` | The material design icon. |
|
|
| headingIconTooltip | `string` | Tooltip message to be shown for headingIcon |
|
|
| hasAccordionIcon | `boolean` | Should the (expanded) accordion icon be shown? <br/> Default value: `true` |
|
|
| isOpen | `boolean` | Is this group currently open? |
|
|
| isSelected | `boolean` | Is this group currently selected? |
|
|
|
|
### Events
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| headingClick | `EventEmitter<any>` | Emitted when the heading is clicked. |
|
|
|
|
## Details
|
|
|
|
Place one or more accordion groups within an [Accordion component](accordion.component.md) to define a menu.
|
|
|
|
## See also
|
|
|
|
- [Accordion component](accordion.component.md)
|