mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00

Andy Stark 431bde3ddf [ADF-3587] Fixed doc comment problems (#3822 )

* [ADF-3587] Fixed missing docs for accessor properties

* [ADF-3587] Fixed badly formed doc comments with deprecated tag

* [ADF-3587] Fixed linting issue with doc comment

2018-09-25 21:45:16 +01:00

1.8 KiB

Raw Blame History

Added, Status, Last reviewed

Added	Status	Last reviewed
v2.0.0	Active	2018-05-08

Accordion Group component

Adds a collapsible panel to an accordion menu.

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';
    }

}

Transclusions

Any content can be trancluded inside this component, since its purpose is to define a section in a surrounding Accordion component.

Class members

Properties

Name	Type	Default value	Description
hasAccordionIcon	`boolean`	true	Should the (expanded) accordion icon be shown?
heading	`string`		Title heading for the group.
headingIcon	`string`		The material design icon.
headingIconTooltip	`string`		Tooltip message to be shown for headingIcon
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.

1.8 KiB Raw Blame History