From 5d9116439455579ce48ac4fa299b4734218cc346 Mon Sep 17 00:00:00 2001 From: Brandy Carney Date: Mon, 29 Jan 2018 11:28:08 -0500 Subject: [PATCH] docs(fab): update documentation for fab container --- packages/core/src/components/fab/readme.md | 118 ++++++++++++------ .../components/fab/test/standalone/index.html | 2 +- 2 files changed, 82 insertions(+), 38 deletions(-) diff --git a/packages/core/src/components/fab/readme.md b/packages/core/src/components/fab/readme.md index 9286d70641..67f4ad5fd5 100644 --- a/packages/core/src/components/fab/readme.md +++ b/packages/core/src/components/fab/readme.md @@ -1,50 +1,94 @@ # ion-fab -The `` element is a container element that places the FAB button (``) in a fixed position that does not scroll with the content. It is also used to display a list of FAB buttons. It accepts the following attributes to position the FAB button element with respect to the content: +Fabs are container elements that contain one or more fab buttons. They should be placed in a fixed position that does not scroll with the content. The following attributes can be used to position the fab with respect to the content: -``` -[top] - Places the container at the top of the content -[bottom] - Places the container at the bottom of the content -[left] - Places the container on the left -[right] - Places the container on the right -[middle] - Places the container in the middle vertically -[center] - Places the container in the center horizontally -[edge] - Used to place the container between the content and the header/footer -``` - - -```html - - - - Button - - - - - Button - - -``` - -Ionic's FAB also supports FAB lists. This is a list of related buttons that show when the main FAB button is clicked. - -The same `ion-fab` container can contain several `ion-fab-list` elements with different side values: -`top`, `bottom`, `left` and `right`. If side is ommited, the default is `bottom`. +| Value | Alignment | Details | +|--------------|------------|---------------------------------------------------------------------------| +| `top` | vertical | Places the container at the top of the content. | +| `bottom` | vertical | Places the container at the bottom of the content. | +| `middle` | vertical | Places the container in the middle vertically. | +| `edge` | vertical | Used to place the container between the content and the header/footer. | +| `left` | horizontal | Places the container on the left. | +| `right` | horizontal | Places the container on the right. | +| `center` | horizontal | Places the container in the center horizontally. | +The fab should have one main fab button. Fabs can also contain fab lists which contain related buttons that show when the main fab button is clicked. The same fab container can contain several [fab list](../../fab-list/FabList) elements with different side values. ```html - - - Share + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - Facebook - Twitter - Youtube + + + + - Vimeo + + + + diff --git a/packages/core/src/components/fab/test/standalone/index.html b/packages/core/src/components/fab/test/standalone/index.html index 88867c7b61..fe938f2da3 100644 --- a/packages/core/src/components/fab/test/standalone/index.html +++ b/packages/core/src/components/fab/test/standalone/index.html @@ -3,7 +3,7 @@ - FAB - Standalone + Floating Action Button - Standalone