From eaec9ca791ae97d33770cfe638f8b3d948b67009 Mon Sep 17 00:00:00 2001 From: Liam DeBeasi Date: Mon, 25 Mar 2019 13:39:15 -0400 Subject: [PATCH] docs(item): update item detail property usage (#17861) updates the documentation for item to better explain how to use the detail prop --- core/src/components/item/readme.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/core/src/components/item/readme.md b/core/src/components/item/readme.md index 04cba9e6a5..adc46148d6 100644 --- a/core/src/components/item/readme.md +++ b/core/src/components/item/readme.md @@ -2,10 +2,13 @@ Items are elements that can contain text, icons, avatars, images, inputs, and any other native or custom elements. Generally they are placed in a list with other items. Items can be swiped, deleted, reordered, edited, and more. +## Clickable Items + +An item is considered "clickable" if it has an `href` or `button` property set. Clickable items have a few visual differences that indicate they can be interacted with. For example, a clickable item receives the ripple effect upon activation in `md` mode, has a highlight when activated in `ios` mode, and has a [detail arrow](/#detail-arrows) by default in `ios` mode. ## Detail Arrows -By default, clickable items will display a right arrow icon on `ios` mode. A clickable item is an item that has an `href` or `button` property set. 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](/#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, set the `detail` property to `true`.