javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-18 19:21:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(item): clean up the item documentation

Browse Source
This commit is contained in:
Brandy Carney
2018-07-09 18:02:50 -04:00
parent 39ab607fb6
commit 78b0bd6ffb
3 changed files with 17 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
core/src/components.d.ts vendored
View File

@ -3282,7 +3282,7 @@ declare global {
* When using a router, it specifies the transition direction when navigating to another page using `href`. * When using a router, it specifies the transition direction when navigating to another page using `href`.
*/ */
'routerDirection': RouterDirection; 'routerDirection': RouterDirection;
'state': 'valid' | 'unvalid' | 'focus'; 'state': 'valid' | 'invalid' | 'focus';
} }
} }
@ -3341,7 +3341,7 @@ declare global {
* When using a router, it specifies the transition direction when navigating to another page using `href`. * When using a router, it specifies the transition direction when navigating to another page using `href`.
*/ */
'routerDirection'?: RouterDirection; 'routerDirection'?: RouterDirection;
'state'?: 'valid' | 'unvalid' | 'focus'; 'state'?: 'valid' | 'invalid' | 'focus';
} }
} }
} }

3
core/src/components/item/item.tsx
View File

@ -61,7 +61,8 @@ export class Item {
*/ */
@Prop() lines?: 'full' | 'inset' | 'none'; @Prop() lines?: 'full' | 'inset' | 'none';
@Prop() state?: 'valid' | 'unvalid' | 'focus'; // TODO document this
@Prop() state?: 'valid' | 'invalid' | 'focus';
/** /**
* When using a router, it specifies the transition direction when navigating to * When using a router, it specifies the transition direction when navigating to

26
core/src/components/item/readme.md
View File

@ -7,20 +7,20 @@ Items are elements that can contain text, icons, avatars, images, inputs, and an
By default, clickable items will display a right arrow icon on `ios` mode. To hide the right arrow icon on clickable elements, set the `detail` property to `false`. To show the right arrow icon on an item that doesn't display it naturally, add the `detail` attribute to the item. By default, clickable items will display a right arrow icon on `ios` mode. To hide the right arrow icon on clickable elements, set the `detail` property to `false`. To show the right arrow icon on an item that doesn't display it naturally, add the `detail` attribute to the item.
<!-- This feature is not enabled by default on clickable items for the `md` mode, but it can be enabled by setting the following Sass variable: --> <!--
<!-- -->
<!-- ```scss -->
<!-- $item-md-detail-push-show: true; -->
<!-- ``` -->
<!-- It can also be turned off by default on clickable items for ios by setting the following Sass variable: --> TODO add this functionality back as a css variable
<!-- -->
<!-- ```scss --> This feature is not enabled by default on clickable items for the `md` mode, but it can be enabled by setting the following CSS variable:
<!-- $item-ios-detail-push-show: false; -->
<!-- ``` --> ```css
--item-detail-push-show: true;
```
See the [theming documentation](/docs/theming/css-variables) for more information.
-->
<!-- See the [theming documentation](http://ionicframework.com/docs/theming/overriding-ionic-variables/) for more information on overriding Sass variables. -->
<!-- -->
## Item Placement ## Item Placement
@ -37,7 +37,7 @@ The below chart details the item slots and where it will place the element insid
### Text Alignment ### Text Alignment
Items left align text and add an ellipsis when the text is wider than the item. See the [Utility Attributes Documentation](../../../../theming/css-utilities/) for attributes that can be added to `<ion-item>` to transform the text. Items left align text and add an ellipsis when the text is wider than the item. See the [Utility Attributes Documentation](/docs/layout/css-utilities) for attributes that can be added to `<ion-item>` to transform the text.
<!-- Auto Generated Below --> <!-- Auto Generated Below -->