diff --git a/core/src/components/fab/readme.md b/core/src/components/fab/readme.md index 54bbe7bf71..4f45a546c1 100644 --- a/core/src/components/fab/readme.md +++ b/core/src/components/fab/readme.md @@ -1,110 +1,15 @@ # ion-fab -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: - -| 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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -``` - +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. 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. - ## Properties #### activated boolean - #### edge boolean @@ -113,7 +18,6 @@ If true, the fab will display on the edge of the header if `vertical` is `"top"`, and on the edge of the footer if it is `"bottom"`. Should be used with a `fixed` slot. - #### horizontal string @@ -121,7 +25,6 @@ string Where to align the fab horizontally in the viewport. Possible values are: `"center"`, `"start"`, `"end"`. - #### vertical string @@ -129,14 +32,12 @@ string Where to align the fab vertically in the viewport. Possible values are: `"top"`, `"center"`, `"bottom"`. - ## Attributes #### activated boolean - #### edge boolean @@ -145,7 +46,6 @@ If true, the fab will display on the edge of the header if `vertical` is `"top"`, and on the edge of the footer if it is `"bottom"`. Should be used with a `fixed` slot. - #### horizontal string @@ -153,7 +53,6 @@ string Where to align the fab horizontally in the viewport. Possible values are: `"center"`, `"start"`, `"end"`. - #### vertical string @@ -161,15 +60,12 @@ string Where to align the fab vertically in the viewport. Possible values are: `"top"`, `"center"`, `"bottom"`. - ## Methods #### close() Close an active FAB list container +--- - ----------------------------------------------- - -*Built with [StencilJS](https://stenciljs.com/)* +_Built with [StencilJS](https://stenciljs.com/)_ diff --git a/core/src/components/fab/usage/javascript.md b/core/src/components/fab/usage/javascript.md new file mode 100644 index 0000000000..3645f979ea --- /dev/null +++ b/core/src/components/fab/usage/javascript.md @@ -0,0 +1,81 @@ +```html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +```