From 275d385c17853995427f3a59ddb387f7ee92bdf3 Mon Sep 17 00:00:00 2001 From: Sankha Lakshan Karunasekara Date: Fri, 11 Jan 2019 23:27:59 +0530 Subject: [PATCH] docs(item): update usage documentation (#16448) resolves #16440 --- core/src/components/item/readme.md | 36 +- .../components/item/test/preview/index.html | 397 +++++++++++++++--- core/src/components/item/usage/angular.md | 18 +- core/src/components/item/usage/javascript.md | 18 +- 4 files changed, 380 insertions(+), 89 deletions(-) diff --git a/core/src/components/item/readme.md b/core/src/components/item/readme.md index 181161eb3e..cac5560f80 100644 --- a/core/src/components/item/readme.md +++ b/core/src/components/item/readme.md @@ -98,7 +98,7 @@ Detail Arrows - + Button Item with Detail Arrow @@ -176,33 +176,37 @@ Item Lines - Item + Full Lines Item 1 - Item + Full Lines Item 2 - Item + Inset Lines Item 1 - Item + Inset Lines Item 2 - Item + No lines Item 1 - Item + No lines Item 2 + + + + No lines Item 3 ``` @@ -418,7 +422,7 @@ Detail Arrows - + Button Item with Detail Arrow @@ -496,33 +500,37 @@ Item Lines - Item + Full Lines Item 1 - Item + Full Lines Item 2 - Item + Inset Lines Item 1 - Item + Inset Lines Item 2 - Item + No lines Item 1 - Item + No lines Item 2 + + + + No lines Item 3 ``` diff --git a/core/src/components/item/test/preview/index.html b/core/src/components/item/test/preview/index.html index 524b1f8cfe..a6e6e0fce1 100644 --- a/core/src/components/item/test/preview/index.html +++ b/core/src/components/item/test/preview/index.html @@ -24,91 +24,366 @@ - List Header + Basic Usage + + Item - + + + - Item Divider + Button Item - - + + + + - Item + Anchor Item + + + + + + + Secondary Color Item - - - Plain Ol' div with some text - - + + + + Detail Arrows + + - - - Single line text that should have ellipses when it doesn't all fit in the item - - + + + + Standard Item with Detail Arrow + + - - - Single line item with no lines - - + + + + Button Item with Detail Arrow + + - - - Multiline text that should wrap when it is too long to fit on one line in the item. Attribute on .item - - + + + + Anchor Item + + - - -

H1 Title Text

-

Paragraph line 1

-
-
+ + + + Anchor Item with no Detail Arrow + + +
- - -

H2 Title Text

-

Paragraph line 1

-
-
+ + + + List Items + + - - - + + + + Item + + + + + + + No Lines Item + + + + + + + Multiline text that should wrap when it is too long + to fit on one line in the item. + + + + + + + +

H3 Primary Title

+
+

Paragraph line 1

+ +

Paragraph line 2 secondary

+
+
+
+ + + + + Item with Full Lines + + +
+ + + + + Item Lines + + + + + + Item Lines Inset + + + + + Item Lines Full + + + + + Item Lines None + + + + + + Full Lines Item 1 + + + + Full Lines Item 2 + + + + + + + Inset Lines Item 1 + + + + Inset Lines Item 2 + + + + + + + No lines Item 1 + + + + No lines Item 2 + + + + No lines Item 3 + + + + + + + + Media Items + + + + + + + + + Avatar Start, Button Item + + + + + + Thumbnail End, Anchor Item + + + + + + + + + + + +

H2 Title Text

+

Button on right

+
+ View +
+ + + + + +

H3 Title Text

- -

Paragraph line 1

- -

Paragraph line 2 secondary

-
-
-
+

Icon on right

+ + +
- - -

H4 Title Text

-

Paragraph line 1

-

Paragraph line 2

-

Paragraph line 3

-
-
+ - - - Item using inner ion-label - - + + + + Buttons in Items + + + + + Start + + Button Start/End + + End + + + + + Start Icon + + + Buttons with Icons + + + End Icon + + + + + + + + Icon only Buttons + + + + + + + + + + Icons in Items + + + + + Icon End + + + + + + + Large Icon End + + + + + + + Small Icon End + + + + + + + + Icon Start + + + + + + Two Icons End + + + + + + + + + + Item Inputs + + + + + Datetime + + + + + Select + + No Game Console + NES + Nintendo64 + PlayStation + Sega Genesis + Sega Saturn + SNES + + + + + Toggle + + + + + Floating Input + + + + + Input (placeholder) + + + + + Checkbox + + + + + Range + + + diff --git a/core/src/components/item/usage/angular.md b/core/src/components/item/usage/angular.md index a9207accd0..7164c00604 100644 --- a/core/src/components/item/usage/angular.md +++ b/core/src/components/item/usage/angular.md @@ -38,7 +38,7 @@ Detail Arrows
- + Button Item with Detail Arrow @@ -116,33 +116,37 @@ Item Lines - Item + Full Lines Item 1 - Item + Full Lines Item 2 - Item + Inset Lines Item 1 - Item + Inset Lines Item 2 - Item + No lines Item 1 - Item + No lines Item 2 + + + + No lines Item 3 ``` diff --git a/core/src/components/item/usage/javascript.md b/core/src/components/item/usage/javascript.md index 4bf4c47c79..75a1c38881 100644 --- a/core/src/components/item/usage/javascript.md +++ b/core/src/components/item/usage/javascript.md @@ -38,7 +38,7 @@ Detail Arrows - + Button Item with Detail Arrow @@ -116,33 +116,37 @@ Item Lines - Item + Full Lines Item 1 - Item + Full Lines Item 2 - Item + Inset Lines Item 1 - Item + Inset Lines Item 2 - Item + No lines Item 1 - Item + No lines Item 2 + + + + No lines Item 3 ```