diff --git a/ng2-components/ng2-alfresco-core/README.md b/ng2-components/ng2-alfresco-core/README.md index 064d4bb78a..01faf1dfc3 100644 --- a/ng2-components/ng2-alfresco-core/README.md +++ b/ng2-components/ng2-alfresco-core/README.md @@ -297,7 +297,7 @@ _See **Demo Shell** or **DocumentList** implementation for more details and use ```ts @Component({ - selector: 'my-component + selector: 'my-component' }) export class MyComponent implements OnInit { @@ -322,6 +322,41 @@ export class MyComponent implements OnInit { } ``` +## Accordion Component +The component provide a way to easy create an accordion menu. You can customize the header and the icon. + +```html + + + + + +``` + +```ts +@Component({ + selector: 'my-component' +}) +export class MyComponent implements OnInit { + + titleHeading: string; + + constructor() { + this.titleHeading = 'My Group'; + } + +} +``` + +### Options + +| Name | Type | Required | Description | +| --- | --- | --- | --- | +| `heading` | {string} | optional | The header title. | +| `isSelected` | {boolean} | optional | Define if the accordion group is selected or not. | +| `headingIcon` | {string} | optional | The material design icon. | + + ## Authentication Service The authentication service is used inside the [login component](../ng2-alfresco-login) and is possible to find there an example of how to use it. @@ -511,4 +546,4 @@ npm run coverage ## License -[Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE) \ No newline at end of file +[Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE)