mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
91 lines
2.4 KiB
Markdown
91 lines
2.4 KiB
Markdown
# Accordion Component
|
|
|
|
Creates a collapsible accordion menu.
|
|
|
|
|
|
|
|
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
|
|
|
|
<!-- toc -->
|
|
|
|
- [Basic Usage](#basic-usage)
|
|
* [Properties](#properties)
|
|
- [Details](#details)
|
|
* [Example](#example)
|
|
- [See also](#see-also)
|
|
|
|
<!-- tocstop -->
|
|
|
|
<!-- markdown-toc end -->
|
|
|
|
## Basic Usage
|
|
|
|
```html
|
|
<adf-accordion>
|
|
<adf-accordion-group [heading]="titleHeading" [isSelected]="true" [headingIcon]="'assignment'">
|
|
<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 | The header title. |
|
|
| isSelected | boolean | Define if the accordion group is selected or not. |
|
|
| headingIcon | string | The material design icon. |
|
|
| hasAccordionIcon | boolean | Define if the accordion (expand) icon needs to be shown or not, the default value is true |
|
|
|
|
## Details
|
|
|
|
An accordion menu contains several panels of content, only one of which is visible at any time. The
|
|
hidden panels are collapsed down to just the title and pushed together (like the bellows of an accordion)
|
|
while the visible panel fills the remaining space in the menu.
|
|
|
|
Use one or more [Accordion Group](accordion-group.component.md) subcomponents to define the panels and set their
|
|
properties (title, selection status, etc).
|
|
|
|
### Example
|
|
|
|
You can use an accordion menu to wrap a [process filter](process-filters.component.md), as shown in
|
|
the following example:
|
|
|
|
```html
|
|
<adf-accordion>
|
|
<adf-accordion-group
|
|
[heading]="'Processes'"
|
|
[isSelected]="true"
|
|
[headingIcon]="'assessment'">
|
|
<adf-process-instance-filters
|
|
[appId]="appId"
|
|
(filterClick)="onProcessFilterClick($event)"
|
|
(success)="onSuccessProcessFilterList($event)">
|
|
</adf-process-instance-filters>
|
|
</adf-accordion-group>
|
|
</adf-accordion>
|
|
```
|
|
|
|
|
|
|
|
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
|
<!-- seealso start -->
|
|
## See also
|
|
|
|
- [Accordion group component](accordion-group.component.md)
|
|
<!-- seealso end --> |