Skip to content
This repository has been archived by the owner on May 29, 2019. It is now read-only.

Commit

Permalink
chore(accordion): update docs
Browse files Browse the repository at this point in the history
Closes #4700
  • Loading branch information
Foxandxss committed Oct 23, 2015
1 parent ac62276 commit 1599cff
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 6 deletions.
15 changes: 12 additions & 3 deletions misc/demo/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -186,9 +186,18 @@ <h3>FAQ</h3>
<p>Please check <a href="https://github.com/angular-ui/bootstrap/wiki/FAQ" target="_blank">our FAQ section</a> for common problems / solutions.</p>
<h3>Reading the documentation</h3>
<p>
Each of the directives provided in <code>ui-bootstrap</code> have documentation and interactive Plunker examples. There is also a list of settings which outline the default
values of settings, and whether they are readonly. In addition to this, some settings have an eye icon next to them like this <i class="glyphicon glyphicon-eye-open"></i>. The
eye means that the setting has an Angular <a href="https://docs.angularjs.org/api/ng/type/$rootScope.Scope#$watch" title="Angular $watch" target="_blank">$watch</a> listener applied to it.
Each of the components provided in <code>ui-bootstrap</code> have documentation and interactive Plunker examples.
</p>
<p>
For the directives, we list the different attributes with their default values, and whether they are readonly. In addition to this, some settings
have an eye icon next to them like this <i class="glyphicon glyphicon-eye-open"></i>. The eye means that the setting has an Angular
<a href="https://docs.angularjs.org/api/ng/type/$rootScope.Scope#$watch" title="Angular $watch" target="_blank">$watch</a> listener applied to it.
</p>
<p>
For the services (you will recognize them with the <code>$</code> prefix), we list all the possible parameters you can pass to them and their default values if any.
</p>
<p>
Also, some components have default values that you can override globally within a <code>.config</code> function for example.
</p>
</section>
<% demoModules.forEach(function(module) { %>
Expand Down
12 changes: 9 additions & 3 deletions src/accordion/docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@ The **accordion directive** builds on top of the collapse directive to provide a

The body of each accordion group is transcluded into the body of the collapsible element.

### uib-accordion Settings
### uib-accordion settings

* `close-others`
_(Default: `false`)_ -
_(Default: `true`)_ -
Control whether expanding an item will cause the other items to close.

* `template-url`
_(Default: `template/accordion/accordion.html`)_ -
Add the ability to override the template used on the component.

### uib-accordion Group Settings
### uib-accordion-group settings

* `is-disabled`
<i class="glyphicon glyphicon-eye-open"></i>
Expand All @@ -35,6 +35,12 @@ The body of each accordion group is transcluded into the body of the collapsible
* `template-url`
_(Default: `template/accordion/accordion-group.html`)_ -
Add the ability to override the template used on the component.

### Default settings `uibAccordionConfig`

* `closeOthers`
_(Default: `true`)_ -
Control whether expanding an item will cause the other items to close.

### Accordion heading

Expand Down

0 comments on commit 1599cff

Please sign in to comment.