Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Rajush Shakya committed Aug 31, 2015
1 parent 5783f5c commit afca2f5
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,16 +114,18 @@ Configure the options from the controller to set <code>dropdown-config</code>.
divider,
icon,
displayBadge,
height
height,
filter
</pre>

<p><code>options</code>: Data to be displayed in dropdown list. This should be an array of objects.</p>
<p><code>trackBy</code>: Any property name from the option object that should be used for tracking the selected item.</p>
<p><code>displayBy</code>: An array that takes two values which will be used as data to be displayed in dropdown list, in a respective order. If it is not set, then it will automagically set the first two prooperty names as the values to be displayed.</p>
<p><code>divider</code>: A custom divider sign setter <code>-, : , =, # ,......</code> between the dropdown list columns. Default is <code>-</code>.</p>
<p><code>icon</code>: A custom icon setter for the selected items. Works with Font-Awesome too. Default is Bootstrap's glyphicons checkmark.</p>
<p><code>displayBadge</code>: Badge on the dropdown button that displays the total number of selected items from the dropdown list. Default visibility is true, but could be set to false.</p>
<p><code>height</code>: Height of the dropdown-box, in pixel, containing the list options. Default height is set to 300px.</p>
<h6>options:</h6> <p>Data to be displayed in dropdown list. This should be an array of objects.</p>
<h6>trackBy:</h6> <p>Any property name from the option object that should be used for tracking the selected item.</p>
<h6>displayBy:</h6><p>An array that takes two values which will be used as data to be displayed in dropdown list, in a respective order. If it is not set, then it will automagically set the first two prooperty names as the values to be displayed.</p>
<h6>divider:</h6> <p>A custom divider sign setter <code>-, : , =, # ,......</code> between the dropdown list columns. Default is <code>-</code>.</p>
<h6>icon:</h6> <p>A custom icon setter for the selected items. Works with Font-Awesome too. Default is Bootstrap's glyphicons checkmark.</p>
<h6>displayBadge:</h6> <p>Badge on the dropdown button that displays the total number of selected items from the dropdown list. Default visibility is <code>true</code>, but could be set to <code>false</code>.</p>
<h6>height:</h6> <p>Height of the scrollable item list in a dropdown-box, in pixel. Default height is set to <code>200px</code>.</p>
<h6>filter:</h6> <p>Filter/search items from the dropdown list. Default visibility is <code>false</code>, but could be set to <code>true</code>.</p>

Controller:
```javascript
Expand All @@ -148,7 +150,8 @@ $scope.config = {
divider: ':',
icon: 'glyphicon glyphicon-heart',
displayBadge: true,
height: '200px'
height: '200px',
filter: true
};
```

Expand Down

0 comments on commit afca2f5

Please sign in to comment.