alfresco-ng2-components/docs/accordion-group.component.md
Andy Stark c9a3b048b4 [ADF-1769] Added JSDocs and updated prop table script (#2838)
* [ADF-1769] Added JSDocs and updated prop table script

* [ADF-1769] Fixed lint error in JSDoc
2018-01-17 17:11:22 +00:00

1.4 KiB

Accordion Group component

Adds a collapsible panel to an accordion menu.

Accordion menu screenshot

Basic Usage

<adf-accordion>
    <adf-accordion-group [heading]="titleHeading" [isSelected]="true" [headingIcon]="'assignment'" [headingIconTooltip]="'Group Tooltip'">
        <my-list></my-list>
    </adf-accordion-group>
</adf-accordion>
@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?
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 to define a menu.

See also