ionic-framework

mirror of https://github.com/ionic-team/ionic-framework.git synced 2026-03-13 10:22:08 +08:00

Files

Andy Joslin 986dbac893 refactor(ionList): more expressive, declarative (breaking change)

Closes #1024.

BREAKING CHANGE: ion-list syntax has changed in favor of simplicity &
flexibility.

Relevant documentation:
[ionList](http://ionicframework.com/docs/api/directive/ionList),
[ionItem](http://ionicframework.com/docs/api/directive/ionItem),
[ionOptionButton](http://ionicframework.com/docs/api/directive/ionOptionButton),
[ionReorderButton](http://ionicframework.com/docs/api/directive/ionReorderButton),
[ionDeleteButton](http://ionicframework.com/docs/api/directive/ionDeleteButton),
[$ionicListDelegate](http://ionicframework.com/docs/api/service/$ionicListDelegate).

To migrate, change your code from this:

```html
<ion-list option-buttons="[{text:'hello',type:'button-positive',onTap:tap()}]"
          on-delete="onDelete(el)"
          delete-icon="ion-minus-circled"
          can-delete="true"
          show-delete="shouldShowDelete"
          on-reorder="onReorder(el, startIndex, toIndex)"
          reorder-icon="ion-navicon"
          can-reorder="true"
          show-reorder="shouldShowReorder">
  <ion-item ng-repeat="item in items">
    {{item}}
  </ion-item>
</ion-list>
```

To this:

```html
<ion-list show-delete="shouldShowDelete"
          show-reorder="shouldShowReorder">
  <ion-item ng-repeat="item in items">
    {{item}}
    <ion-delete-button class="ion-minus-circled"
                       ng-click="onDelete(item)">
    </ion-delete-button>
    <ion-reorder-button class="ion-navicon"
                       ng-click="onReorder(item, $fromIndex, $toIndex)">
    </ion-reorder-button>
    <ion-option-button class="button-positive" ng-click="tap()">
      Hello
    </ion-option-button>
  </ion-item>
</ion-list>
```

2014-04-04 10:12:16 -06:00

filters

chore(build): documentation generation

2014-03-07 13:36:36 -07:00

inline-tag-defs

chore(docs): build to latest, mark latest in dropdown, remove /ionic

2014-03-13 20:00:36 -06:00

processors

refactor(docs): simplify hugely, leave more to ionic-site

2014-03-26 19:07:50 -06:00

tag-defs

docs(): add @delegate tag

2014-03-25 11:05:07 -06:00

templates

refactor(ionList): more expressive, declarative (breaking change)

2014-04-04 10:12:16 -06:00

docs.config.js

refactor(docs): simplify hugely, leave more to ionic-site

2014-03-26 19:07:50 -06:00

generate-versions.js

docs(): add groups by topic

2014-03-14 15:14:16 -06:00

ignore.words

chore(build): documentation generation

2014-03-07 13:36:36 -07:00

README.md

chore(docs): make left menu manually generated

2014-03-17 10:25:40 -06:00

README.md

Editing Doc Pages

First, follow these steps: https://github.com/driftyco/ionic#documentation

Templates in templates folder

templates/pages-data.template.html => _layout/docs_api.html
templates/index.template.html => The 'index' page for a doc version - http://ajoslin.github.io/docs/0.9.26/
templates/lib/yaml.template.html => the common yaml config items that every doc page includes
templates/api/componentGroup.template.html => the template for every 'componentGroup' (eg http://ajoslin.github.io/docs/0.9.26/api/ionic/directive/)
templates/api/api.template.html - the base that every doc-item extends from
templates/api/{something}.template.html - the template for {something} - eg directive.template.html for directives

Not everything in all the pages is used - a lot of it is from Angular templates. Eg things like 'doc.deprecated' aren't used currently.

New Versions

Every version uses its own include for left menu, which is manually written.

The first time a version is generated, if there is no includes/api_menu{{versionName}}.html, it will generate a generic one for you.

Then you can do what you want to edit that.