From 5ec95c2e862f5a6f97c3f18820497165f7145940 Mon Sep 17 00:00:00 2001 From: Brandy Carney Date: Tue, 6 Sep 2022 13:45:45 -0400 Subject: [PATCH 1/7] docs(avatar): update headings for consistency --- docs/api/avatar.md | 8 +++++--- .../angular/example_component_css.md | 0 .../angular/example_component_html.md | 0 .../theming/{ => css-properties}/demo.html | 4 ++-- .../theming/{ => css-properties}/index.md | 2 +- .../{ => css-properties}/javascript.md | 0 .../{ => css-properties}/react/main_css.md | 0 .../{ => css-properties}/react/main_tsx.md | 0 .../theming/{ => css-properties}/vue.md | 0 static/usage/avatar/theming/react.md | 20 ------------------- 10 files changed, 8 insertions(+), 26 deletions(-) rename static/usage/avatar/theming/{ => css-properties}/angular/example_component_css.md (100%) rename static/usage/avatar/theming/{ => css-properties}/angular/example_component_html.md (100%) rename static/usage/avatar/theming/{ => css-properties}/demo.html (88%) rename static/usage/avatar/theming/{ => css-properties}/index.md (92%) rename static/usage/avatar/theming/{ => css-properties}/javascript.md (100%) rename static/usage/avatar/theming/{ => css-properties}/react/main_css.md (100%) rename static/usage/avatar/theming/{ => css-properties}/react/main_tsx.md (100%) rename static/usage/avatar/theming/{ => css-properties}/vue.md (100%) delete mode 100644 static/usage/avatar/theming/react.md diff --git a/docs/api/avatar.md b/docs/api/avatar.md index e7a005fa719..dd1d64e3b32 100644 --- a/docs/api/avatar.md +++ b/docs/api/avatar.md @@ -22,7 +22,7 @@ Avatars are circular components that usually wrap an image or icon. They can be Avatars can be used by themselves or inside of any element. If placed inside of an `ion-chip` or `ion-item`, the avatar will resize to fit the parent component. To position an avatar on the left or right side of an item, set the slot to `start` or `end`, respectively. -## Basic +## Basic Usage import Basic from '@site/static/usage/avatar/basic/index.md'; @@ -42,9 +42,11 @@ import Item from '@site/static/usage/avatar/item/index.md'; ## Theming -import Theming from '@site/static/usage/avatar/theming/index.md'; +### CSS Custom Properties - +import CSSProps from '@site/static/usage/avatar/theming/css-properties/index.md'; + + ## Properties diff --git a/static/usage/avatar/theming/angular/example_component_css.md b/static/usage/avatar/theming/css-properties/angular/example_component_css.md similarity index 100% rename from static/usage/avatar/theming/angular/example_component_css.md rename to static/usage/avatar/theming/css-properties/angular/example_component_css.md diff --git a/static/usage/avatar/theming/angular/example_component_html.md b/static/usage/avatar/theming/css-properties/angular/example_component_html.md similarity index 100% rename from static/usage/avatar/theming/angular/example_component_html.md rename to static/usage/avatar/theming/css-properties/angular/example_component_html.md diff --git a/static/usage/avatar/theming/demo.html b/static/usage/avatar/theming/css-properties/demo.html similarity index 88% rename from static/usage/avatar/theming/demo.html rename to static/usage/avatar/theming/css-properties/demo.html index 0d3c4b67ac2..a7f56a37548 100644 --- a/static/usage/avatar/theming/demo.html +++ b/static/usage/avatar/theming/css-properties/demo.html @@ -5,8 +5,8 @@ Avatar - - + + diff --git a/static/usage/avatar/theming/index.md b/static/usage/avatar/theming/css-properties/index.md similarity index 92% rename from static/usage/avatar/theming/index.md rename to static/usage/avatar/theming/css-properties/index.md index e586aae743b..b6b1ee34106 100644 --- a/static/usage/avatar/theming/index.md +++ b/static/usage/avatar/theming/css-properties/index.md @@ -27,6 +27,6 @@ import angularCSS from './angular/example_component_css.md'; } }, }} - src="usage/avatar/theming/demo.html" + src="usage/avatar/theming/css-properties/demo.html" size="250px" /> diff --git a/static/usage/avatar/theming/javascript.md b/static/usage/avatar/theming/css-properties/javascript.md similarity index 100% rename from static/usage/avatar/theming/javascript.md rename to static/usage/avatar/theming/css-properties/javascript.md diff --git a/static/usage/avatar/theming/react/main_css.md b/static/usage/avatar/theming/css-properties/react/main_css.md similarity index 100% rename from static/usage/avatar/theming/react/main_css.md rename to static/usage/avatar/theming/css-properties/react/main_css.md diff --git a/static/usage/avatar/theming/react/main_tsx.md b/static/usage/avatar/theming/css-properties/react/main_tsx.md similarity index 100% rename from static/usage/avatar/theming/react/main_tsx.md rename to static/usage/avatar/theming/css-properties/react/main_tsx.md diff --git a/static/usage/avatar/theming/vue.md b/static/usage/avatar/theming/css-properties/vue.md similarity index 100% rename from static/usage/avatar/theming/vue.md rename to static/usage/avatar/theming/css-properties/vue.md diff --git a/static/usage/avatar/theming/react.md b/static/usage/avatar/theming/react.md deleted file mode 100644 index 7d0e98290b8..00000000000 --- a/static/usage/avatar/theming/react.md +++ /dev/null @@ -1,20 +0,0 @@ -```tsx -import React from 'react'; -import { IonAvatar, IonItem, IonLabel } from '@ionic/react'; - -import './main.css'; - -function Example() { - return ( - <> - - - Silhouette of a person's head - - Item Avatar - - - ); -} -export default Example; -``` From a49b22a6ce11c65a239484f82c1dc98029ac327a Mon Sep 17 00:00:00 2001 From: Brandy Carney Date: Tue, 6 Sep 2022 13:48:13 -0400 Subject: [PATCH 2/7] docs(badge): update headings and folder names for consistency --- docs/api/badge.md | 20 ++++++++++--------- .../color => theming/colors}/angular.md | 0 .../color => theming/colors}/demo.html | 0 .../color => theming/colors}/index.md | 4 ++-- .../color => theming/colors}/javascript.md | 0 .../color => theming/colors}/react.md | 0 .../color => theming/colors}/vue.md | 0 .../css-properties/angular/angular-css.md | 0 .../css-properties/angular/angular-html.md | 0 .../css-properties/demo.html | 0 .../css-properties/index.md | 2 +- .../css-properties/javascript.md | 0 .../css-properties/react/react-css.md | 0 .../css-properties/react/react-ts.md | 0 .../css-properties/vue.md | 0 15 files changed, 14 insertions(+), 12 deletions(-) rename static/usage/badge/{customization/color => theming/colors}/angular.md (100%) rename static/usage/badge/{customization/color => theming/colors}/demo.html (100%) rename static/usage/badge/{customization/color => theming/colors}/index.md (84%) rename static/usage/badge/{customization/color => theming/colors}/javascript.md (100%) rename static/usage/badge/{customization/color => theming/colors}/react.md (100%) rename static/usage/badge/{customization/color => theming/colors}/vue.md (100%) rename static/usage/badge/{customization => theming}/css-properties/angular/angular-css.md (100%) rename static/usage/badge/{customization => theming}/css-properties/angular/angular-html.md (100%) rename static/usage/badge/{customization => theming}/css-properties/demo.html (100%) rename static/usage/badge/{customization => theming}/css-properties/index.md (91%) rename static/usage/badge/{customization => theming}/css-properties/javascript.md (100%) rename static/usage/badge/{customization => theming}/css-properties/react/react-css.md (100%) rename static/usage/badge/{customization => theming}/css-properties/react/react-ts.md (100%) rename static/usage/badge/{customization => theming}/css-properties/vue.md (100%) diff --git a/docs/api/badge.md b/docs/api/badge.md index 32004eab66f..32da34d7aae 100644 --- a/docs/api/badge.md +++ b/docs/api/badge.md @@ -22,23 +22,25 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; Badges are inline block elements that usually appear near another element. Typically they contain a number or other characters. They can be used as a notification that there are additional items associated with an element and indicate how many items there are. -import BasicExample from '@site/static/usage/badge/basic/index.md'; +## Basic Usage - +import Basic from '@site/static/usage/badge/basic/index.md'; -## Customization Examples + -### Color +## Theming -import ColorExample from '@site/static/usage/badge/customization/color/index.md'; +### Colors - +import Colors from '@site/static/usage/badge/theming/colors/index.md'; + + ### CSS Properties -import CSSPropsExample from '@site/static/usage/badge/customization/css-properties/index.md'; +import CSSProps from '@site/static/usage/badge/theming/css-properties/index.md'; - + ## Properties @@ -56,4 +58,4 @@ import CSSPropsExample from '@site/static/usage/badge/customization/css-properti ## Slots - \ No newline at end of file + diff --git a/static/usage/badge/customization/color/angular.md b/static/usage/badge/theming/colors/angular.md similarity index 100% rename from static/usage/badge/customization/color/angular.md rename to static/usage/badge/theming/colors/angular.md diff --git a/static/usage/badge/customization/color/demo.html b/static/usage/badge/theming/colors/demo.html similarity index 100% rename from static/usage/badge/customization/color/demo.html rename to static/usage/badge/theming/colors/demo.html diff --git a/static/usage/badge/customization/color/index.md b/static/usage/badge/theming/colors/index.md similarity index 84% rename from static/usage/badge/customization/color/index.md rename to static/usage/badge/theming/colors/index.md index 047e0871bcf..6db34769b24 100644 --- a/static/usage/badge/customization/color/index.md +++ b/static/usage/badge/theming/colors/index.md @@ -8,5 +8,5 @@ import angular from './angular.md'; \ No newline at end of file + src="usage/badge/theming/colors/demo.html" +/> diff --git a/static/usage/badge/customization/color/javascript.md b/static/usage/badge/theming/colors/javascript.md similarity index 100% rename from static/usage/badge/customization/color/javascript.md rename to static/usage/badge/theming/colors/javascript.md diff --git a/static/usage/badge/customization/color/react.md b/static/usage/badge/theming/colors/react.md similarity index 100% rename from static/usage/badge/customization/color/react.md rename to static/usage/badge/theming/colors/react.md diff --git a/static/usage/badge/customization/color/vue.md b/static/usage/badge/theming/colors/vue.md similarity index 100% rename from static/usage/badge/customization/color/vue.md rename to static/usage/badge/theming/colors/vue.md diff --git a/static/usage/badge/customization/css-properties/angular/angular-css.md b/static/usage/badge/theming/css-properties/angular/angular-css.md similarity index 100% rename from static/usage/badge/customization/css-properties/angular/angular-css.md rename to static/usage/badge/theming/css-properties/angular/angular-css.md diff --git a/static/usage/badge/customization/css-properties/angular/angular-html.md b/static/usage/badge/theming/css-properties/angular/angular-html.md similarity index 100% rename from static/usage/badge/customization/css-properties/angular/angular-html.md rename to static/usage/badge/theming/css-properties/angular/angular-html.md diff --git a/static/usage/badge/customization/css-properties/demo.html b/static/usage/badge/theming/css-properties/demo.html similarity index 100% rename from static/usage/badge/customization/css-properties/demo.html rename to static/usage/badge/theming/css-properties/demo.html diff --git a/static/usage/badge/customization/css-properties/index.md b/static/usage/badge/theming/css-properties/index.md similarity index 91% rename from static/usage/badge/customization/css-properties/index.md rename to static/usage/badge/theming/css-properties/index.md index de39bd6203f..85abdef8270 100644 --- a/static/usage/badge/customization/css-properties/index.md +++ b/static/usage/badge/theming/css-properties/index.md @@ -27,5 +27,5 @@ import angularCSS from './angular/angular-css.md'; }, }, }} - src="usage/badge/customization/css-properties/demo.html" + src="usage/badge/theming/css-properties/demo.html" /> diff --git a/static/usage/badge/customization/css-properties/javascript.md b/static/usage/badge/theming/css-properties/javascript.md similarity index 100% rename from static/usage/badge/customization/css-properties/javascript.md rename to static/usage/badge/theming/css-properties/javascript.md diff --git a/static/usage/badge/customization/css-properties/react/react-css.md b/static/usage/badge/theming/css-properties/react/react-css.md similarity index 100% rename from static/usage/badge/customization/css-properties/react/react-css.md rename to static/usage/badge/theming/css-properties/react/react-css.md diff --git a/static/usage/badge/customization/css-properties/react/react-ts.md b/static/usage/badge/theming/css-properties/react/react-ts.md similarity index 100% rename from static/usage/badge/customization/css-properties/react/react-ts.md rename to static/usage/badge/theming/css-properties/react/react-ts.md diff --git a/static/usage/badge/customization/css-properties/vue.md b/static/usage/badge/theming/css-properties/vue.md similarity index 100% rename from static/usage/badge/customization/css-properties/vue.md rename to static/usage/badge/theming/css-properties/vue.md From 8d8c612d1f90ec777ed6083a405efaef86b05536 Mon Sep 17 00:00:00 2001 From: Brandy Carney Date: Tue, 6 Sep 2022 13:50:25 -0400 Subject: [PATCH 3/7] docs(checkbox): update headings and folder names for consistency --- docs/api/checkbox.md | 8 +++++--- .../{ => css-properties}/angular/example_component_css.md | 0 .../angular/example_component_html.md | 0 .../usage/checkbox/theming/{ => css-properties}/demo.html | 4 ++-- .../usage/checkbox/theming/{ => css-properties}/index.md | 2 +- .../checkbox/theming/{ => css-properties}/javascript.md | 0 .../theming/{ => css-properties}/react/main_css.md | 0 .../theming/{ => css-properties}/react/main_tsx.md | 0 static/usage/checkbox/theming/{ => css-properties}/vue.md | 0 9 files changed, 8 insertions(+), 6 deletions(-) rename static/usage/checkbox/theming/{ => css-properties}/angular/example_component_css.md (100%) rename static/usage/checkbox/theming/{ => css-properties}/angular/example_component_html.md (100%) rename static/usage/checkbox/theming/{ => css-properties}/demo.html (89%) rename static/usage/checkbox/theming/{ => css-properties}/index.md (93%) rename static/usage/checkbox/theming/{ => css-properties}/javascript.md (100%) rename static/usage/checkbox/theming/{ => css-properties}/react/main_css.md (100%) rename static/usage/checkbox/theming/{ => css-properties}/react/main_tsx.md (100%) rename static/usage/checkbox/theming/{ => css-properties}/vue.md (100%) diff --git a/docs/api/checkbox.md b/docs/api/checkbox.md index 490a0606d49..6b15c69765b 100644 --- a/docs/api/checkbox.md +++ b/docs/api/checkbox.md @@ -22,7 +22,7 @@ import APITOCInline from '@components/page/api/APITOCInline'; Checkboxes allow the selection of multiple options from a set of options. They appear as checked (ticked) when activated. Clicking on a checkbox will toggle the `checked` property. They can also be checked programmatically by setting the `checked` property. -## Basic +## Basic Usage import Basic from '@site/static/usage/checkbox/basic/index.md'; @@ -36,9 +36,11 @@ import Indeterminate from '@site/static/usage/checkbox/indeterminate/index.md'; ## Theming -import Theming from '@site/static/usage/checkbox/theming/index.md'; +### CSS Custom Properties - +import CSSProps from '@site/static/usage/checkbox/theming/css-properties/index.md'; + + ## Interfaces diff --git a/static/usage/checkbox/theming/angular/example_component_css.md b/static/usage/checkbox/theming/css-properties/angular/example_component_css.md similarity index 100% rename from static/usage/checkbox/theming/angular/example_component_css.md rename to static/usage/checkbox/theming/css-properties/angular/example_component_css.md diff --git a/static/usage/checkbox/theming/angular/example_component_html.md b/static/usage/checkbox/theming/css-properties/angular/example_component_html.md similarity index 100% rename from static/usage/checkbox/theming/angular/example_component_html.md rename to static/usage/checkbox/theming/css-properties/angular/example_component_html.md diff --git a/static/usage/checkbox/theming/demo.html b/static/usage/checkbox/theming/css-properties/demo.html similarity index 89% rename from static/usage/checkbox/theming/demo.html rename to static/usage/checkbox/theming/css-properties/demo.html index 224dedb9800..4666cbf6298 100644 --- a/static/usage/checkbox/theming/demo.html +++ b/static/usage/checkbox/theming/css-properties/demo.html @@ -4,8 +4,8 @@ Checkbox - - + +