From 76dcd0f948578ee251a32edd4446ec4591080ca5 Mon Sep 17 00:00:00 2001 From: Brandy Carney Date: Thu, 18 Jul 2024 18:20:56 -0400 Subject: [PATCH] docs(text): update icon playgrounds to use addIcons usage --- .../example_component_html.md} | 0 .../basic/angular/example_component_ts.md | 22 +++++++++ static/usage/v7/text/basic/index.md | 35 ++++++++++++-- .../index_html.md} | 0 .../v7/text/basic/javascript/index_ts.md | 35 ++++++++++++++ .../example_component_html.md} | 0 .../basic/angular/example_component_ts.md | 22 +++++++++ static/usage/v8/text/basic/index.md | 35 ++++++++++++-- .../index_html.md} | 0 .../v8/text/basic/javascript/index_ts.md | 46 +++++++++++++++++++ 10 files changed, 189 insertions(+), 6 deletions(-) rename static/usage/v7/text/basic/{angular.md => angular/example_component_html.md} (100%) create mode 100644 static/usage/v7/text/basic/angular/example_component_ts.md rename static/usage/v7/text/basic/{javascript.md => javascript/index_html.md} (100%) create mode 100644 static/usage/v7/text/basic/javascript/index_ts.md rename static/usage/v8/text/basic/{angular.md => angular/example_component_html.md} (100%) create mode 100644 static/usage/v8/text/basic/angular/example_component_ts.md rename static/usage/v8/text/basic/{javascript.md => javascript/index_html.md} (100%) create mode 100644 static/usage/v8/text/basic/javascript/index_ts.md diff --git a/static/usage/v7/text/basic/angular.md b/static/usage/v7/text/basic/angular/example_component_html.md similarity index 100% rename from static/usage/v7/text/basic/angular.md rename to static/usage/v7/text/basic/angular/example_component_html.md diff --git a/static/usage/v7/text/basic/angular/example_component_ts.md b/static/usage/v7/text/basic/angular/example_component_ts.md new file mode 100644 index 00000000000..122ee98dfbe --- /dev/null +++ b/static/usage/v7/text/basic/angular/example_component_ts.md @@ -0,0 +1,22 @@ +```ts +import { Component } from '@angular/core'; + +import { addIcons } from 'ionicons'; +import { warning } from 'ionicons/icons'; + +@Component({ + selector: 'app-example', + templateUrl: 'example.component.html', + styleUrls: ['example.component.css'], +}) +export class ExampleComponent { + constructor() { + /** + * Any icons you want to use in your application + * can be registered in app.component.ts and then + * referenced by name anywhere in your application. + */ + addIcons({ warning }); + } +} +``` diff --git a/static/usage/v7/text/basic/index.md b/static/usage/v7/text/basic/index.md index 3fe68c18bfa..e1d0bc17a21 100644 --- a/static/usage/v7/text/basic/index.md +++ b/static/usage/v7/text/basic/index.md @@ -1,8 +1,37 @@ import Playground from '@site/src/components/global/Playground'; -import javascript from './javascript.md'; +import javascript_index_html from './javascript/index_html.md'; +import javascript_index_ts from './javascript/index_ts.md'; + import react from './react.md'; import vue from './vue.md'; -import angular from './angular.md'; - +import angular_example_component_html from './angular/example_component_html.md'; +import angular_example_component_ts from './angular/example_component_ts.md'; + + diff --git a/static/usage/v7/text/basic/javascript.md b/static/usage/v7/text/basic/javascript/index_html.md similarity index 100% rename from static/usage/v7/text/basic/javascript.md rename to static/usage/v7/text/basic/javascript/index_html.md diff --git a/static/usage/v7/text/basic/javascript/index_ts.md b/static/usage/v7/text/basic/javascript/index_ts.md new file mode 100644 index 00000000000..122e5dac0d2 --- /dev/null +++ b/static/usage/v7/text/basic/javascript/index_ts.md @@ -0,0 +1,35 @@ +```ts +import { defineCustomElements } from '@ionic/core/loader'; + +import { addIcons } from 'ionicons'; +import { warning } from 'ionicons/icons'; + +/* Core CSS required for Ionic components to work properly */ +import '@ionic/core/css/core.css'; + +/* Basic CSS for apps built with Ionic */ +import '@ionic/core/css/normalize.css'; +import '@ionic/core/css/structure.css'; +import '@ionic/core/css/typography.css'; + +/* Optional CSS utils that can be commented out */ +import '@ionic/core/css/padding.css'; +import '@ionic/core/css/float-elements.css'; +import '@ionic/core/css/text-alignment.css'; +import '@ionic/core/css/text-transformation.css'; +import '@ionic/core/css/flex-utils.css'; +import '@ionic/core/css/display.css'; + +/* Theme variables */ +import './theme/variables.css'; + +/** + * On Ionicons 7.2+ this icon + * gets mapped to a "warning" key. + * Alternatively, developers can do: + * addIcons({ 'warning': warning }); + */ +addIcons({ warning }); + +defineCustomElements(); +``` diff --git a/static/usage/v8/text/basic/angular.md b/static/usage/v8/text/basic/angular/example_component_html.md similarity index 100% rename from static/usage/v8/text/basic/angular.md rename to static/usage/v8/text/basic/angular/example_component_html.md diff --git a/static/usage/v8/text/basic/angular/example_component_ts.md b/static/usage/v8/text/basic/angular/example_component_ts.md new file mode 100644 index 00000000000..122ee98dfbe --- /dev/null +++ b/static/usage/v8/text/basic/angular/example_component_ts.md @@ -0,0 +1,22 @@ +```ts +import { Component } from '@angular/core'; + +import { addIcons } from 'ionicons'; +import { warning } from 'ionicons/icons'; + +@Component({ + selector: 'app-example', + templateUrl: 'example.component.html', + styleUrls: ['example.component.css'], +}) +export class ExampleComponent { + constructor() { + /** + * Any icons you want to use in your application + * can be registered in app.component.ts and then + * referenced by name anywhere in your application. + */ + addIcons({ warning }); + } +} +``` diff --git a/static/usage/v8/text/basic/index.md b/static/usage/v8/text/basic/index.md index d3b4a26d301..67be75cab35 100644 --- a/static/usage/v8/text/basic/index.md +++ b/static/usage/v8/text/basic/index.md @@ -1,8 +1,37 @@ import Playground from '@site/src/components/global/Playground'; -import javascript from './javascript.md'; +import javascript_index_html from './javascript/index_html.md'; +import javascript_index_ts from './javascript/index_ts.md'; + import react from './react.md'; import vue from './vue.md'; -import angular from './angular.md'; - +import angular_example_component_html from './angular/example_component_html.md'; +import angular_example_component_ts from './angular/example_component_ts.md'; + + diff --git a/static/usage/v8/text/basic/javascript.md b/static/usage/v8/text/basic/javascript/index_html.md similarity index 100% rename from static/usage/v8/text/basic/javascript.md rename to static/usage/v8/text/basic/javascript/index_html.md diff --git a/static/usage/v8/text/basic/javascript/index_ts.md b/static/usage/v8/text/basic/javascript/index_ts.md new file mode 100644 index 00000000000..ddd8ea06544 --- /dev/null +++ b/static/usage/v8/text/basic/javascript/index_ts.md @@ -0,0 +1,46 @@ +```ts +import { defineCustomElements } from '@ionic/core/loader'; + +import { addIcons } from 'ionicons'; +import { warning } from 'ionicons/icons'; + +/* Core CSS required for Ionic components to work properly */ +import '@ionic/core/css/core.css'; + +/* Basic CSS for apps built with Ionic */ +import '@ionic/core/css/normalize.css'; +import '@ionic/core/css/structure.css'; +import '@ionic/core/css/typography.css'; + +/* Optional CSS utils that can be commented out */ +import '@ionic/core/css/padding.css'; +import '@ionic/core/css/float-elements.css'; +import '@ionic/core/css/text-alignment.css'; +import '@ionic/core/css/text-transformation.css'; +import '@ionic/core/css/flex-utils.css'; +import '@ionic/core/css/display.css'; + +/** + * Ionic Dark Theme + * ----------------------------------------------------- + * For more information, please see: + * https://ionicframework.com/docs/theming/dark-mode + */ + +// import '@ionic/core/css/palettes/dark.always.css'; +// import '@ionic/core/css/palettes/dark.class.css'; +import '@ionic/core/css/palettes/dark.system.css'; + +/* Theme variables */ +import './theme/variables.css'; + +/** + * On Ionicons 7.2+ this icon + * gets mapped to a "warning" key. + * Alternatively, developers can do: + * addIcons({ 'warning': warning }); + */ +addIcons({ warning }); + +defineCustomElements(); +```