@@ -16,14 +16,17 @@ Plunker DEMO available [here](https://embed.plnkr.co/uAPJq0/)
1616
1717## Table of contents
1818
19- * [ Installation] ( #installation )
20- * [ Setup] ( #setup )
21- * [ Usage] ( #usage )
22- * [ Design your list] ( #design-your-list )
23- * [ Demo App] ( #demo-app )
24- * [ Contributing] ( #contributing )
25- * [ Changelog] ( #changelog )
26- * [ License] ( #license )
19+ * [ Installation] ( #installation )
20+ * [ Setup] ( #setup )
21+ * [ Usage] ( #usage )
22+ * [ Design your list] ( #design-your-list )
23+ * [ Demo App] ( #demo-app )
24+ * [ Contributing] ( #contributing )
25+ * [ Options] ( #options )
26+ * [ Properties] ( #properties )
27+ * [ Attributes] ( #attributes )
28+ * [ Changelog] ( #changelog )
29+ * [ License] ( #license )
2730
2831## Installation
2932
@@ -104,6 +107,7 @@ import { Component } from '@angular/core';
104107 <span title>My List</span>
105108 <a item href="http://www.goo.gl">Google</a>
106109 <a item href="http://www.goo.gl">Google</a>
110+ <expandable-list-divider></expandable-list-divider>
107111 <a item href="http://www.goo.gl">Google</a>
108112 </expandable-list-item>
109113 </expandable-list>
@@ -158,7 +162,7 @@ Now you're ready to fill your list with some items.
158162```
159163
160164It is important to append the html attribute ` item ` to each of the item you want
161- to render in the list and it's up to you which HTML tag to use. We've just filled
165+ to be rendered in the list and it's up to you which HTML tag to use. We've just filled
162166our list with anchor link but feel free to use any other tag.
163167
164168### Dividers
@@ -170,15 +174,12 @@ our list with anchor link but feel free to use any other tag.
170174 <span secondary >Secondary</span >
171175 <a item href =" http://www.goo.gl" >Google</a >
172176 <a item href =" http://www.goo.gl" >Google</a >
173- <expandable-list-divider item ></expandable-list-divider >
177+ <expandable-list-divider ></expandable-list-divider >
174178 <a item href =" http://www.goo.gl" >Google</a >
175179 </expandable-list-item >
176180</expandable-list >
177181```
178182
179- We still need to postfix the ` expandable-list-divider ` with the ` item ` attribute to
180- see that divider rendered on the page.
181-
182183### Create more
183184
184185Now you can create as many ` <expandable-list-item> ` nodes as you want inside
@@ -191,7 +192,7 @@ your `<expandable-list>`.
191192 <span secondary >Secondary</span >
192193 <a item href =" http://www.goo.gl" >Google</a >
193194 <a item href =" http://www.goo.gl" >Google</a >
194- <expandable-list-divider item ></expandable-list-divider >
195+ <expandable-list-divider ></expandable-list-divider >
195196 <a item href =" http://www.goo.gl" >Google</a >
196197 </expandable-list-item >
197198
@@ -217,6 +218,46 @@ $ npm run demo
217218Open your browser to [ http://localhost:9007/ ] ( http://localhost:9007/ )
218219to see the application running.
219220
221+ ## Options
222+
223+ ## Properties
224+
225+ ### isExpanded
226+
227+ | Type | Default value |
228+ | --- | --- |
229+ | boolean | false |
230+
231+ Used for interacting with the ` expandable-list-item ` element.
232+
233+ Example:
234+
235+ ``` ts
236+ @Component ({
237+ selector: ' app' ,
238+ template: `
239+ <expandable-list class="expandable-list">
240+ <expandable-list-item [isExpanded]="listExpanded">
241+ <span title>My list</span>
242+ <a item href="http://www.goo.gl">Google</a>
243+ <a item href="http://www.goo.gl">Google</a>
244+ <a item href="http://www.goo.gl">Google</a>
245+ </expandable-list-item>
246+ </expandable-list>
247+ `
248+ })
249+ export class AppComponent {
250+ listExpanded = true ;
251+ }
252+ ```
253+
254+ ## Attributes
255+
256+ | Name | Type | Description |
257+ | --- | --- | --- |
258+ | disabled | boolean | When applied to the ` expandable-list-item ` , disabled the
259+ | is-expanded | boolean | Reflect the expandable state of the item list element
260+
220261## Contributing
221262
222263This package is using the AngularJS commit messages as default way to contribute
0 commit comments