From bb2ce19677e2852de2d1142f9dbb16d07283ce76 Mon Sep 17 00:00:00 2001 From: Brandy Carney Date: Thu, 1 Sep 2022 15:31:29 -0400 Subject: [PATCH 1/3] docs(thumbnail): add component playgrounds and new svg --- docs/api/thumbnail.md | 148 ++---------------- static/demos/api/skeleton-text/thumbnail.svg | 15 +- static/demos/api/thumbnail/thumbnail.svg | 15 +- static/usage/thumbnail/basic/angular.md | 5 + static/usage/thumbnail/basic/demo.html | 27 ++++ static/usage/thumbnail/basic/index.md | 8 + static/usage/thumbnail/basic/javascript.md | 5 + static/usage/thumbnail/basic/react.md | 15 ++ static/usage/thumbnail/basic/vue.md | 16 ++ static/usage/thumbnail/item/angular.md | 8 + static/usage/thumbnail/item/demo.html | 30 ++++ static/usage/thumbnail/item/index.md | 8 + static/usage/thumbnail/item/javascript.md | 8 + static/usage/thumbnail/item/react.md | 18 +++ static/usage/thumbnail/item/vue.md | 19 +++ static/usage/thumbnail/theming/angular.md | 5 + .../theming/angular/example_component_css.md | 7 + .../theming/angular/example_component_html.md | 6 + static/usage/thumbnail/theming/demo.html | 33 ++++ static/usage/thumbnail/theming/index.md | 32 ++++ static/usage/thumbnail/theming/javascript.md | 12 ++ .../usage/thumbnail/theming/react/main_css.md | 6 + .../usage/thumbnail/theming/react/main_tsx.md | 18 +++ static/usage/thumbnail/theming/vue.md | 23 +++ 24 files changed, 347 insertions(+), 140 deletions(-) create mode 100644 static/usage/thumbnail/basic/angular.md create mode 100644 static/usage/thumbnail/basic/demo.html create mode 100644 static/usage/thumbnail/basic/index.md create mode 100644 static/usage/thumbnail/basic/javascript.md create mode 100644 static/usage/thumbnail/basic/react.md create mode 100644 static/usage/thumbnail/basic/vue.md create mode 100644 static/usage/thumbnail/item/angular.md create mode 100644 static/usage/thumbnail/item/demo.html create mode 100644 static/usage/thumbnail/item/index.md create mode 100644 static/usage/thumbnail/item/javascript.md create mode 100644 static/usage/thumbnail/item/react.md create mode 100644 static/usage/thumbnail/item/vue.md create mode 100644 static/usage/thumbnail/theming/angular.md create mode 100644 static/usage/thumbnail/theming/angular/example_component_css.md create mode 100644 static/usage/thumbnail/theming/angular/example_component_html.md create mode 100644 static/usage/thumbnail/theming/demo.html create mode 100644 static/usage/thumbnail/theming/index.md create mode 100644 static/usage/thumbnail/theming/javascript.md create mode 100644 static/usage/thumbnail/theming/react/main_css.md create mode 100644 static/usage/thumbnail/theming/react/main_tsx.md create mode 100644 static/usage/thumbnail/theming/vue.md diff --git a/docs/api/thumbnail.md b/docs/api/thumbnail.md index 77ef73f041c..21b640a3b54 100644 --- a/docs/api/thumbnail.md +++ b/docs/api/thumbnail.md @@ -1,11 +1,6 @@ --- title: "ion-thumbnail" -hide_table_of_contents: true -demoUrl: "/docs/demos/api/thumbnail/index.html" -demoSourceUrl: "https://github.com/ionic-team/ionic-docs/tree/main/static/demos/api/thumbnail/index.html" --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; import Props from '@site/static/auto-generated/thumbnail/props.md'; import Events from '@site/static/auto-generated/thumbnail/events.md'; @@ -20,153 +15,30 @@ import Slots from '@site/static/auto-generated/thumbnail/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; -import APITOCInline from '@components/page/api/APITOCInline'; -

Contents

- - - - - Thumbnails are square components that usually wrap an image or icon. They can be used to make it easier to display a group of larger images or provide a preview of the full-size image. Thumbnails can be used by themselves or inside of any element. If placed inside of an `ion-item`, the thumbnail will resize to fit the parent component. To position a thumbnail on the left or right side of an item, set the slot to `start` or `end`, respectively. +## Basic +import Basic from '@site/static/usage/thumbnail/basic/index.md'; + -## Usage - - - - - -```html - - - - - - - - - Item Thumbnail - -``` - - - - - - -```html - - - - - - - - - Item Thumbnail - -``` - - - - - - -```tsx -import React from 'react'; -import { IonThumbnail, IonItem, IonLabel, IonContent } from '@ionic/react'; - -export const ThumbnailExample: React.FC = () => ( - - - - - - - - - - Item Thumbnail - - -); -``` - - - - - - - -```tsx -import { Component, h } from '@stencil/core'; - -@Component({ - tag: 'thumbnail-example', - styleUrl: 'thumbnail-example.css' -}) -export class ThumbnailExample { - render() { - return [ - - - , - - - - - - Item Thumbnail - - ]; - } -} -``` - - - - - - - -```html - +import Item from '@site/static/usage/thumbnail/item/index.md'; - -``` +## Theming - +import Theming from '@site/static/usage/thumbnail/theming/index.md'; - + ## Properties @@ -184,4 +56,4 @@ export default defineComponent({ ## Slots - \ No newline at end of file + diff --git a/static/demos/api/skeleton-text/thumbnail.svg b/static/demos/api/skeleton-text/thumbnail.svg index dafcf4c1751..bc5622b74fa 100644 --- a/static/demos/api/skeleton-text/thumbnail.svg +++ b/static/demos/api/skeleton-text/thumbnail.svg @@ -1 +1,14 @@ - \ No newline at end of file + + + + + + + + + + + + + + diff --git a/static/demos/api/thumbnail/thumbnail.svg b/static/demos/api/thumbnail/thumbnail.svg index dafcf4c1751..bc5622b74fa 100644 --- a/static/demos/api/thumbnail/thumbnail.svg +++ b/static/demos/api/thumbnail/thumbnail.svg @@ -1 +1,14 @@ - \ No newline at end of file + + + + + + + + + + + + + + diff --git a/static/usage/thumbnail/basic/angular.md b/static/usage/thumbnail/basic/angular.md new file mode 100644 index 00000000000..0cecc35c686 --- /dev/null +++ b/static/usage/thumbnail/basic/angular.md @@ -0,0 +1,5 @@ +```html + + + +``` diff --git a/static/usage/thumbnail/basic/demo.html b/static/usage/thumbnail/basic/demo.html new file mode 100644 index 00000000000..445aac119e2 --- /dev/null +++ b/static/usage/thumbnail/basic/demo.html @@ -0,0 +1,27 @@ + + + + + + + Thumbnail + + + + + + + + + + +
+ + + +
+
+
+ + + diff --git a/static/usage/thumbnail/basic/index.md b/static/usage/thumbnail/basic/index.md new file mode 100644 index 00000000000..221786ddeee --- /dev/null +++ b/static/usage/thumbnail/basic/index.md @@ -0,0 +1,8 @@ +import Playground from '@site/src/components/global/Playground'; + +import javascript from './javascript.md'; +import react from './react.md'; +import vue from './vue.md'; +import angular from './angular.md'; + + diff --git a/static/usage/thumbnail/basic/javascript.md b/static/usage/thumbnail/basic/javascript.md new file mode 100644 index 00000000000..0cecc35c686 --- /dev/null +++ b/static/usage/thumbnail/basic/javascript.md @@ -0,0 +1,5 @@ +```html + + + +``` diff --git a/static/usage/thumbnail/basic/react.md b/static/usage/thumbnail/basic/react.md new file mode 100644 index 00000000000..da45bfe5148 --- /dev/null +++ b/static/usage/thumbnail/basic/react.md @@ -0,0 +1,15 @@ +```tsx +import React from 'react'; +import { IonThumbnail } from '@ionic/react'; + +function Example() { + return ( + <> + + + + + ); +} +export default Example; +``` diff --git a/static/usage/thumbnail/basic/vue.md b/static/usage/thumbnail/basic/vue.md new file mode 100644 index 00000000000..b922dad660f --- /dev/null +++ b/static/usage/thumbnail/basic/vue.md @@ -0,0 +1,16 @@ +```html + + + +``` diff --git a/static/usage/thumbnail/item/angular.md b/static/usage/thumbnail/item/angular.md new file mode 100644 index 00000000000..b7286f0a1bb --- /dev/null +++ b/static/usage/thumbnail/item/angular.md @@ -0,0 +1,8 @@ +```html + + + + + Item Thumbnail + +``` diff --git a/static/usage/thumbnail/item/demo.html b/static/usage/thumbnail/item/demo.html new file mode 100644 index 00000000000..a9e87f6bb70 --- /dev/null +++ b/static/usage/thumbnail/item/demo.html @@ -0,0 +1,30 @@ + + + + + + + Thumbnail + + + + + + + + + + +
+ + + + + Item Thumbnail + +
+
+
+ + + diff --git a/static/usage/thumbnail/item/index.md b/static/usage/thumbnail/item/index.md new file mode 100644 index 00000000000..13b7272fa89 --- /dev/null +++ b/static/usage/thumbnail/item/index.md @@ -0,0 +1,8 @@ +import Playground from '@site/src/components/global/Playground'; + +import javascript from './javascript.md'; +import react from './react.md'; +import vue from './vue.md'; +import angular from './angular.md'; + + diff --git a/static/usage/thumbnail/item/javascript.md b/static/usage/thumbnail/item/javascript.md new file mode 100644 index 00000000000..b7286f0a1bb --- /dev/null +++ b/static/usage/thumbnail/item/javascript.md @@ -0,0 +1,8 @@ +```html + + + + + Item Thumbnail + +``` diff --git a/static/usage/thumbnail/item/react.md b/static/usage/thumbnail/item/react.md new file mode 100644 index 00000000000..57ab6abc470 --- /dev/null +++ b/static/usage/thumbnail/item/react.md @@ -0,0 +1,18 @@ +```tsx +import React from 'react'; +import { IonItem, IonLabel, IonThumbnail } from '@ionic/react'; + +function Example() { + return ( + <> + + + + + Item Thumbnail + + + ); +} +export default Example; +``` diff --git a/static/usage/thumbnail/item/vue.md b/static/usage/thumbnail/item/vue.md new file mode 100644 index 00000000000..f80aa1b268e --- /dev/null +++ b/static/usage/thumbnail/item/vue.md @@ -0,0 +1,19 @@ +```html + + + +``` diff --git a/static/usage/thumbnail/theming/angular.md b/static/usage/thumbnail/theming/angular.md new file mode 100644 index 00000000000..0cecc35c686 --- /dev/null +++ b/static/usage/thumbnail/theming/angular.md @@ -0,0 +1,5 @@ +```html + + + +``` diff --git a/static/usage/thumbnail/theming/angular/example_component_css.md b/static/usage/thumbnail/theming/angular/example_component_css.md new file mode 100644 index 00000000000..605855deb77 --- /dev/null +++ b/static/usage/thumbnail/theming/angular/example_component_css.md @@ -0,0 +1,7 @@ + +```css +ion-thumbnail { + --size: 140px; + --border-radius: 14px; +} +``` diff --git a/static/usage/thumbnail/theming/angular/example_component_html.md b/static/usage/thumbnail/theming/angular/example_component_html.md new file mode 100644 index 00000000000..e90e238c112 --- /dev/null +++ b/static/usage/thumbnail/theming/angular/example_component_html.md @@ -0,0 +1,6 @@ + +```html + + + +``` diff --git a/static/usage/thumbnail/theming/demo.html b/static/usage/thumbnail/theming/demo.html new file mode 100644 index 00000000000..8a071cdfb68 --- /dev/null +++ b/static/usage/thumbnail/theming/demo.html @@ -0,0 +1,33 @@ + + + + + + + Thumbnail + + + + + + + + + + + +
+ + + +
+
+
+ + + diff --git a/static/usage/thumbnail/theming/index.md b/static/usage/thumbnail/theming/index.md new file mode 100644 index 00000000000..8be9b0ddccc --- /dev/null +++ b/static/usage/thumbnail/theming/index.md @@ -0,0 +1,32 @@ +import Playground from '@site/src/components/global/Playground'; + +import javascript from './javascript.md'; + +import reactTSX from './react/main_tsx.md'; +import reactCSS from './react/main_css.md'; + +import vue from './vue.md'; + +import angularHTML from './angular/example_component_html.md'; +import angularCSS from './angular/example_component_css.md'; + + diff --git a/static/usage/thumbnail/theming/javascript.md b/static/usage/thumbnail/theming/javascript.md new file mode 100644 index 00000000000..61e742c20bc --- /dev/null +++ b/static/usage/thumbnail/theming/javascript.md @@ -0,0 +1,12 @@ +```html + + + + + +``` diff --git a/static/usage/thumbnail/theming/react/main_css.md b/static/usage/thumbnail/theming/react/main_css.md new file mode 100644 index 00000000000..74742dfe9f0 --- /dev/null +++ b/static/usage/thumbnail/theming/react/main_css.md @@ -0,0 +1,6 @@ +```css +ion-thumbnail { + --size: 140px; + --border-radius: 14px; +} +``` diff --git a/static/usage/thumbnail/theming/react/main_tsx.md b/static/usage/thumbnail/theming/react/main_tsx.md new file mode 100644 index 00000000000..ee65bdccfbd --- /dev/null +++ b/static/usage/thumbnail/theming/react/main_tsx.md @@ -0,0 +1,18 @@ + +```tsx +import React from 'react'; +import { IonThumbnail } from '@ionic/react'; + +import './main.css'; + +function Example() { + return ( + <> + + + + + ); +} +export default Example; +``` diff --git a/static/usage/thumbnail/theming/vue.md b/static/usage/thumbnail/theming/vue.md new file mode 100644 index 00000000000..7a1f74bf4a0 --- /dev/null +++ b/static/usage/thumbnail/theming/vue.md @@ -0,0 +1,23 @@ +```html + + + + + +``` From 2aae00c34317bb8fc8ebd35e912317f20dab1a3a Mon Sep 17 00:00:00 2001 From: Brandy Carney Date: Thu, 1 Sep 2022 15:56:48 -0400 Subject: [PATCH 2/3] fix(thumbnail): update svg image --- static/demos/api/skeleton-text/thumbnail.svg | 13 ++++++------- static/demos/api/thumbnail/thumbnail.svg | 13 ++++++------- 2 files changed, 12 insertions(+), 14 deletions(-) diff --git a/static/demos/api/skeleton-text/thumbnail.svg b/static/demos/api/skeleton-text/thumbnail.svg index bc5622b74fa..b12a43f92a9 100644 --- a/static/demos/api/skeleton-text/thumbnail.svg +++ b/static/demos/api/skeleton-text/thumbnail.svg @@ -1,13 +1,12 @@ - - - - - - + + + + + - + diff --git a/static/demos/api/thumbnail/thumbnail.svg b/static/demos/api/thumbnail/thumbnail.svg index bc5622b74fa..b12a43f92a9 100644 --- a/static/demos/api/thumbnail/thumbnail.svg +++ b/static/demos/api/thumbnail/thumbnail.svg @@ -1,13 +1,12 @@ - - - - - - + + + + + - + From 1871f28b0cc9710ee055df0006f299258cc8c3a4 Mon Sep 17 00:00:00 2001 From: Brandy Carney Date: Thu, 1 Sep 2022 16:21:28 -0400 Subject: [PATCH 3/3] fix(demos): update img to include alt text --- static/usage/thumbnail/basic/angular.md | 2 +- static/usage/thumbnail/basic/demo.html | 2 +- static/usage/thumbnail/basic/javascript.md | 2 +- static/usage/thumbnail/basic/react.md | 2 +- static/usage/thumbnail/basic/vue.md | 2 +- static/usage/thumbnail/item/angular.md | 2 +- static/usage/thumbnail/item/demo.html | 2 +- static/usage/thumbnail/item/javascript.md | 2 +- static/usage/thumbnail/item/react.md | 2 +- static/usage/thumbnail/item/vue.md | 2 +- static/usage/thumbnail/theming/angular.md | 2 +- .../usage/thumbnail/theming/angular/example_component_html.md | 2 +- static/usage/thumbnail/theming/demo.html | 2 +- static/usage/thumbnail/theming/javascript.md | 2 +- static/usage/thumbnail/theming/react/main_tsx.md | 2 +- static/usage/thumbnail/theming/vue.md | 2 +- 16 files changed, 16 insertions(+), 16 deletions(-) diff --git a/static/usage/thumbnail/basic/angular.md b/static/usage/thumbnail/basic/angular.md index 0cecc35c686..6e388336952 100644 --- a/static/usage/thumbnail/basic/angular.md +++ b/static/usage/thumbnail/basic/angular.md @@ -1,5 +1,5 @@ ```html - + Silhouette of mountains ``` diff --git a/static/usage/thumbnail/basic/demo.html b/static/usage/thumbnail/basic/demo.html index 445aac119e2..d5bdb920fe4 100644 --- a/static/usage/thumbnail/basic/demo.html +++ b/static/usage/thumbnail/basic/demo.html @@ -17,7 +17,7 @@
- + Silhouette of mountains
diff --git a/static/usage/thumbnail/basic/javascript.md b/static/usage/thumbnail/basic/javascript.md index 0cecc35c686..6e388336952 100644 --- a/static/usage/thumbnail/basic/javascript.md +++ b/static/usage/thumbnail/basic/javascript.md @@ -1,5 +1,5 @@ ```html - + Silhouette of mountains ``` diff --git a/static/usage/thumbnail/basic/react.md b/static/usage/thumbnail/basic/react.md index da45bfe5148..cfd6d629ee8 100644 --- a/static/usage/thumbnail/basic/react.md +++ b/static/usage/thumbnail/basic/react.md @@ -6,7 +6,7 @@ function Example() { return ( <> - + Silhouette of mountains ); diff --git a/static/usage/thumbnail/basic/vue.md b/static/usage/thumbnail/basic/vue.md index b922dad660f..8ef56dfa2c8 100644 --- a/static/usage/thumbnail/basic/vue.md +++ b/static/usage/thumbnail/basic/vue.md @@ -1,7 +1,7 @@ ```html diff --git a/static/usage/thumbnail/item/angular.md b/static/usage/thumbnail/item/angular.md index b7286f0a1bb..5b724820494 100644 --- a/static/usage/thumbnail/item/angular.md +++ b/static/usage/thumbnail/item/angular.md @@ -1,7 +1,7 @@ ```html - + Silhouette of mountains Item Thumbnail diff --git a/static/usage/thumbnail/item/demo.html b/static/usage/thumbnail/item/demo.html index a9e87f6bb70..db7778adda6 100644 --- a/static/usage/thumbnail/item/demo.html +++ b/static/usage/thumbnail/item/demo.html @@ -18,7 +18,7 @@
- + Silhouette of mountains Item Thumbnail diff --git a/static/usage/thumbnail/item/javascript.md b/static/usage/thumbnail/item/javascript.md index b7286f0a1bb..5b724820494 100644 --- a/static/usage/thumbnail/item/javascript.md +++ b/static/usage/thumbnail/item/javascript.md @@ -1,7 +1,7 @@ ```html - + Silhouette of mountains Item Thumbnail diff --git a/static/usage/thumbnail/item/react.md b/static/usage/thumbnail/item/react.md index 57ab6abc470..6d1d3dafea3 100644 --- a/static/usage/thumbnail/item/react.md +++ b/static/usage/thumbnail/item/react.md @@ -7,7 +7,7 @@ function Example() { <> - + Silhouette of mountains Item Thumbnail diff --git a/static/usage/thumbnail/item/vue.md b/static/usage/thumbnail/item/vue.md index f80aa1b268e..a791dd166f1 100644 --- a/static/usage/thumbnail/item/vue.md +++ b/static/usage/thumbnail/item/vue.md @@ -2,7 +2,7 @@