From 78b0bd6ffbfba1d96de0c173cfa0decf8618c57a Mon Sep 17 00:00:00 2001 From: Brandy Carney Date: Mon, 9 Jul 2018 18:02:50 -0400 Subject: [PATCH] docs(item): clean up the item documentation --- core/src/components.d.ts | 4 ++-- core/src/components/item/item.tsx | 3 ++- core/src/components/item/readme.md | 26 +++++++++++++------------- 3 files changed, 17 insertions(+), 16 deletions(-) diff --git a/core/src/components.d.ts b/core/src/components.d.ts index fc1e54ef6f..f98f497886 100644 --- a/core/src/components.d.ts +++ b/core/src/components.d.ts @@ -3282,7 +3282,7 @@ declare global { * When using a router, it specifies the transition direction when navigating to another page using `href`. */ '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`. */ 'routerDirection'?: RouterDirection; - 'state'?: 'valid' | 'unvalid' | 'focus'; + 'state'?: 'valid' | 'invalid' | 'focus'; } } } diff --git a/core/src/components/item/item.tsx b/core/src/components/item/item.tsx index c68ac6281c..7b803d0594 100644 --- a/core/src/components/item/item.tsx +++ b/core/src/components/item/item.tsx @@ -61,7 +61,8 @@ export class Item { */ @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 diff --git a/core/src/components/item/readme.md b/core/src/components/item/readme.md index a3bef8a8bd..00aaa6a798 100644 --- a/core/src/components/item/readme.md +++ b/core/src/components/item/readme.md @@ -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. - - - - - + - - - - +TODO add this functionality back as a css variable + +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: + +```css +--item-detail-push-show: true; +``` + +See the [theming documentation](/docs/theming/css-variables) for more information. + +--> - - ## Item Placement @@ -37,7 +37,7 @@ The below chart details the item slots and where it will place the element insid ### 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 `` 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 `` to transform the text.