Support SVG icons added & fix bugs#511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Rasool-deldar wants to merge 6 commits into
base:main
Choose a base branch
from
Open

Support SVG icons added & fix bugs #511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0c5dd82
Support SVG icons added & fix bugs
Rasool-deldar Jan 24, 2024
fedd557
Merge remote-tracking branch 'origin/main' into Rasool-deldar/main
danielroe Apr 11, 2024
a5701c1
fix: address type issues
danielroe Apr 11, 2024
9b83cf2
fix: add `svgo` dep
danielroe Apr 11, 2024
306b03c
Merge branch 'main' into main
Rasool-deldar Apr 22, 2024
a3a67f5
Merge branch 'main' into main
Rasool-deldar Apr 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@

- Zero-config required
- Auto-import Ionic components, composables and icons
- Support SVG Icons
- Ionic Router integration
- Pre-render routes
- Mobile meta tags
Expand Down
1 change: 1 addition & 0 deletions docs/content/0.index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ Batteries-included [Ionic](https://ionicframework.com/) integration for Nuxt.
::list
- Zero-config required
- Auto-import Ionic components, composables and icons
- Support SVG Icons
- Ionic Router integration
- Pre-render routes
- Mobile meta tags
Expand Down
1 change: 1 addition & 0 deletions docs/content/1.get-started/1.introduction.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ This module attempts to get you going with Nuxt + Ionic quickly, providing sane
::list{type=success}
- **Ionic router integration:** continue defining routes based on the structure of your `~/pages` directory and using page-level utilities such as `definePageMeta()`.
- **Auto-imports**: Ionic components, composables and icons are all [auto-imported](https://nuxt.com/docs/guide/concepts/auto-imports) for ease of use.
- **Support SVG Icons**: custom icons in the assets/ionic-icons path
- **Helpful components and utilities**: This module provides components and utilities to accomplish common tasks more easily.
- **PWA support**: out-of-the-box support for progressive web apps, using `nuxt-pwa-module`.
- **Pre-render routes**
Expand Down
23 changes: 22 additions & 1 deletion docs/content/1.get-started/3.configuration.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,8 +50,29 @@ Integrations control which other modules this module should enable and setup fro

- **icons**

- **ionicons**

Default: `true`
Disable to stop icons from being auto-imported.
Disable to stop ionic-icons from being auto-imported.

- **svg**

Custom SVG icons and automatic detection with nested folders and icon size optimization in assets/ionic-icons path.
::alert{type="warning"}
⚠️ Note: Please put all the necessary SVG files in the assets/ionic-icons folder before you run your project. Because when a file is added/deleted in this path, your project will be rerendered again.
::

- **enable**

Default: `true`

Disable to stop svg from being auto-imported.

- **directoryAsNamespace**

Default: `true`

Disable to stop svg from being auto-imported.

#### `css`

Expand Down
28 changes: 26 additions & 2 deletions docs/content/2.overview/5.icons.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,35 +6,59 @@ navigation.icon: uil:illustration

Icons are auto-imported from [`ionicons/icons`](https://github.com/ionic-team/ionicons) by default, following the pattern of camel case naming with `ionicons` in front of the original icon name, that you can find on the [official ionicons website](https://ionic.io/ionicons).

::alert{type="info"}
ℹ️ Note: Please put all the necessary SVG files in the assets/ionic-icons folder before you run your project. Because when a file is added/deleted in this path, your project will be rerendered again.
::

::alert{type="warning"}
⚠️ Note: When you use #import , change the name of the icon using "as" and the desired name. Because it doesn't interfere with auto-import.
::

::code-group

```vue [Auto-imported icons]
<template>
<ion-icon :icon="ioniconsImage"></ion-icon>
<ion-icon :md="ioniconsSquareSharp" :ios="ioniconsTriangleOutline"></ion-icon>
<!-- ##### svg icon ##### -->
<!-- without directoryAsNamespace -->
<ion-icon :icon="ionicIconSvg`YourSvgFile`"></ion-icon>
<!-- example -->
<ion-icon :icon="ionicIconSvgHome"></ion-icon>
<!-- with directoryAsNamespace -->
<ion-icon :icon="ionicIconSvg`Subdirectories``YourSvgFile`"></ion-icon>
<!-- example -->
<ion-icon :icon="ionicIconSvgTabImage"></ion-icon>
</template>
```

```vue [Manual imports]
<script setup lang="ts">
import { image, squareSharp, triangleOutline } from 'ionicons/icons'
import { ionicIconSvgHome as home, ionicIconSvgTabImage as tabImage } from "#imports";
</script>

<template>
<ion-icon :icon="image"></ion-icon>
<ion-icon :md="squareSharp" :ios="triangleOutline"></ion-icon>
<!-- ##### svg icon ##### -->
<ion-icon :icon="home"></ion-icon>
<ion-icon :icon="tabImage"></ion-icon>
<ion-icon :md="home" :ios="tabImage"></ion-icon>
</template>
```

::

You can opt-out of auto-importing icons by setting the `integrations.icons` module options in your `nuxt.config.ts` to `false`.
You can opt-out of auto-importing icons by setting the `integrations.icons.ionicons` module options in your `nuxt.config.ts` to `false`.

```js
export default defineNuxtConfig({
ionic: {
integrations: {
icons: false,
icons: {
ionicons: false
},
},
},
})
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@
"ionicons": "^7.3.1",
"pathe": "^1.1.2",
"pkg-types": "^1.0.3",
"svgo": "^3.2.0",
"ufo": "^1.5.3",
"unimport": "^3.7.1"
},
Expand Down
2 changes: 1 addition & 1 deletion playground/composables/usePhotoGallery.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { Camera, CameraSource, CameraResultType } from '@capacitor/camera'
import { Filesystem, Directory } from '@capacitor/filesystem'
import { Preferences } from '@capacitor/preferences'

export function usePhotoGallery() {
export const usePhotoGallery = () => {
const photos = ref<UserPhoto[]>([])
const PHOTO_STORAGE = 'photos'

Expand Down
27 changes: 3 additions & 24 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

32 changes: 27 additions & 5 deletions src/module.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,17 +17,28 @@ import { IonicBuiltInComponents, IonicHooks } from './imports'

import { setupUtilityComponents } from './parts/components'
import { useCSSSetup } from './parts/css'
import { setupIcons } from './parts/icons'
import { setupIonIcons } from './parts/icons/ionicons'
import { setupIonicIconsSvg } from './parts/icons/ionic-icons-svg'
import { setupMeta } from './parts/meta'
import { setupPWA } from './parts/pwa'
import { setupRouter } from './parts/router'

export interface ModuleOptionIconSvg {
enable?: boolean
directoryAsNamespace?: boolean
}

export interface ModuleOptionIcon {
ionicons?: boolean
svg?: ModuleOptionIconSvg
}

export interface ModuleOptions {
integrations?: {
router?: boolean
pwa?: boolean
meta?: boolean
icons?: boolean
icons?: ModuleOptionIcon
}
css?: {
core?: boolean
Expand DownExpand Up@@ -93,7 +104,13 @@ export default defineNuxtModule<ModuleOptions>({
meta: true,
pwa: true,
router: true,
icons: true,
icons: {
ionicons: true,
svg: {
enable: false,
directoryAsNamespace: true,
},
},
},
css: {
core: true,
Expand DownExpand Up@@ -205,8 +222,13 @@ export default defineNuxtModule<ModuleOptions>({
}

// Add auto-imported icons
if (options.integrations?.icons) {
await setupIcons()
if (options.integrations?.icons?.ionicons) {
await setupIonIcons()
}

// Add auto-imported custom icons
if (options.integrations?.icons?.svg?.enable) {
setupIonicIconsSvg(options.integrations?.icons?.svg)
}

if (options.integrations?.meta) {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Support SVG icons added & fix bugs#511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

Rasool-deldar
wants to merge
6
commits into

base:main
Choose a base branch

from

 Open


Support SVG icons added & fix bugs
#511
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
0c5dd82

Support SVG icons added & fix bugs


Rasool-deldar Jan 24, 2024
fedd557

Merge remote-tracking branch 'origin/main' into Rasool-deldar/main


danielroe Apr 11, 2024
a5701c1

fix: address type issues


danielroe Apr 11, 2024
9b83cf2

fix: add `svgo` dep


danielroe Apr 11, 2024
306b03c

Merge branch 'main' into main


Rasool-deldar Apr 22, 2024
a3a67f5

Merge branch 'main' into main


Rasool-deldar Apr 27, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@

- Zero-config required
- Auto-import Ionic components, composables and icons
- Support SVG Icons
- Ionic Router integration
- Pre-render routes
- Mobile meta tags
Expand Down

1 change: 1 addition & 0 deletions
docs/content/0.index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ Batteries-included [Ionic](https://ionicframework.com/) integration for Nuxt.
::list
- Zero-config required
- Auto-import Ionic components, composables and icons
- Support SVG Icons
- Ionic Router integration
- Pre-render routes
- Mobile meta tags
Expand Down

1 change: 1 addition & 0 deletions
docs/content/1.get-started/1.introduction.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ This module attempts to get you going with Nuxt + Ionic quickly, providing sane
::list{type=success}
- **Ionic router integration:** continue defining routes based on the structure of your `~/pages` directory and using page-level utilities such as `definePageMeta()`.
- **Auto-imports**: Ionic components, composables and icons are all [auto-imported](https://nuxt.com/docs/guide/concepts/auto-imports) for ease of use.
- **Support SVG Icons**: custom icons in the assets/ionic-icons path
- **Helpful components and utilities**: This module provides components and utilities to accomplish common tasks more easily.
- **PWA support**: out-of-the-box support for progressive web apps, using `nuxt-pwa-module`.
- **Pre-render routes**
Expand Down

23 changes: 22 additions & 1 deletion
docs/content/1.get-started/3.configuration.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,8 +50,29 @@ Integrations control which other modules this module should enable and setup fro

- **icons**

 - **ionicons**

 Default: `true` 
 Disable to stop icons from being auto-imported.
 Disable to stop ionic-icons from being auto-imported.

 - **svg**

 Custom SVG icons and automatic detection with nested folders and icon size optimization in assets/ionic-icons path.
 ::alert{type="warning"}
 ⚠️ Note: Please put all the necessary SVG files in the assets/ionic-icons folder before you run your project. Because when a file is added/deleted in this path, your project will be rerendered again.
 ::

 - **enable**

 Default: `true`

 Disable to stop svg from being auto-imported.

 - **directoryAsNamespace**

 Default: `true`

 Disable to stop svg from being auto-imported.

#### `css`

Expand Down

28 changes: 26 additions & 2 deletions
docs/content/2.overview/5.icons.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,35 +6,59 @@ navigation.icon: uil:illustration

Icons are auto-imported from [`ionicons/icons`](https://github.com/ionic-team/ionicons) by default, following the pattern of camel case naming with `ionicons` in front of the original icon name, that you can find on the [official ionicons website](https://ionic.io/ionicons).

::alert{type="info"}
ℹ️ Note: Please put all the necessary SVG files in the assets/ionic-icons folder before you run your project. Because when a file is added/deleted in this path, your project will be rerendered again.
::

::alert{type="warning"}
⚠️ Note: When you use #import , change the name of the icon using "as" and the desired name. Because it doesn't interfere with auto-import.
::

::code-group

```vue [Auto-imported icons]
<template>
 <ion-icon :icon="ioniconsImage"></ion-icon>
 <ion-icon :md="ioniconsSquareSharp" :ios="ioniconsTriangleOutline"></ion-icon>
 <!-- ##### svg icon ##### -->
 <!-- without directoryAsNamespace -->
 <ion-icon :icon="ionicIconSvg`YourSvgFile`"></ion-icon>
 <!-- example -->
 <ion-icon :icon="ionicIconSvgHome"></ion-icon>
 <!-- with directoryAsNamespace -->
 <ion-icon :icon="ionicIconSvg`Subdirectories``YourSvgFile`"></ion-icon>
 <!-- example -->
 <ion-icon :icon="ionicIconSvgTabImage"></ion-icon>
</template>
```

```vue [Manual imports]
<script setup lang="ts">
import { image, squareSharp, triangleOutline } from 'ionicons/icons'
import { ionicIconSvgHome as home, ionicIconSvgTabImage as tabImage } from "#imports";
</script>

<template>
 <ion-icon :icon="image"></ion-icon>
 <ion-icon :md="squareSharp" :ios="triangleOutline"></ion-icon>
 <!-- ##### svg icon ##### -->
 <ion-icon :icon="home"></ion-icon>
 <ion-icon :icon="tabImage"></ion-icon>
 <ion-icon :md="home" :ios="tabImage"></ion-icon>
</template>
```

::

You can opt-out of auto-importing icons by setting the `integrations.icons` module options in your `nuxt.config.ts` to `false`.
You can opt-out of auto-importing icons by setting the `integrations.icons.ionicons` module options in your `nuxt.config.ts` to `false`.

```js
export default defineNuxtConfig({
 ionic: {
 integrations: {
 icons: false,
 icons: {
 ionicons: false
 },
 },
 },
})
Expand Down

1 change: 1 addition & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@
 "ionicons": "^7.3.1",
 "pathe": "^1.1.2",
 "pkg-types": "^1.0.3",
 "svgo": "^3.2.0",
 "ufo": "^1.5.3",
 "unimport": "^3.7.1"
 },
Expand Down

2 changes: 1 addition & 1 deletion
playground/composables/usePhotoGallery.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { Camera, CameraSource, CameraResultType } from '@capacitor/camera'
import { Filesystem, Directory } from '@capacitor/filesystem'
import { Preferences } from '@capacitor/preferences'

export function usePhotoGallery() {
export const usePhotoGallery = () => {
 const photos = ref<UserPhoto[]>([])
 const PHOTO_STORAGE = 'photos'

Expand Down

27 changes: 3 additions & 24 deletions
pnpm-lock.yaml

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


32 changes: 27 additions & 5 deletions
src/module.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,17 +17,28 @@ import { IonicBuiltInComponents, IonicHooks } from './imports'

import { setupUtilityComponents } from './parts/components'
import { useCSSSetup } from './parts/css'
import { setupIcons } from './parts/icons'
import { setupIonIcons } from './parts/icons/ionicons'
import { setupIonicIconsSvg } from './parts/icons/ionic-icons-svg'
import { setupMeta } from './parts/meta'
import { setupPWA } from './parts/pwa'
import { setupRouter } from './parts/router'

export interface ModuleOptionIconSvg {
 enable?: boolean
 directoryAsNamespace?: boolean
}

export interface ModuleOptionIcon {
 ionicons?: boolean
 svg?: ModuleOptionIconSvg
}

export interface ModuleOptions {
 integrations?: {
 router?: boolean
 pwa?: boolean
 meta?: boolean
 icons?: boolean
 icons?: ModuleOptionIcon
 }
 css?: {
 core?: boolean
Expand DownExpand Up@@ -93,7 +104,13 @@ export default defineNuxtModule<ModuleOptions>({
 meta: true,
 pwa: true,
 router: true,
 icons: true,
 icons: {
 ionicons: true,
 svg: {
 enable: false,
 directoryAsNamespace: true,
 },
 },
 },
 css: {
 core: true,
Expand DownExpand Up@@ -205,8 +222,13 @@ export default defineNuxtModule<ModuleOptions>({
 }

 // Add auto-imported icons
 if (options.integrations?.icons) {
 await setupIcons()
 if (options.integrations?.icons?.ionicons) {
 await setupIonIcons()
 }

 // Add auto-imported custom icons
 if (options.integrations?.icons?.svg?.enable) {
 setupIonicIconsSvg(options.integrations?.icons?.svg)
 }

 if (options.integrations?.meta) {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Support SVG icons added & fix bugs#511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

Rasool-deldar
wants to merge
6
commits into

base:main
Choose a base branch

from

 Open


Support SVG icons added & fix bugs
#511
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
0c5dd82

Support SVG icons added & fix bugs


Rasool-deldar Jan 24, 2024
fedd557

Merge remote-tracking branch 'origin/main' into Rasool-deldar/main


danielroe Apr 11, 2024
a5701c1

fix: address type issues


danielroe Apr 11, 2024
9b83cf2

fix: add `svgo` dep


danielroe Apr 11, 2024
306b03c

Merge branch 'main' into main


Rasool-deldar Apr 22, 2024
a3a67f5

Merge branch 'main' into main


Rasool-deldar Apr 27, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@

- Zero-config required
- Auto-import Ionic components, composables and icons
- Support SVG Icons
- Ionic Router integration
- Pre-render routes
- Mobile meta tags
Expand Down

1 change: 1 addition & 0 deletions
docs/content/0.index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ Batteries-included [Ionic](https://ionicframework.com/) integration for Nuxt.
::list
- Zero-config required
- Auto-import Ionic components, composables and icons
- Support SVG Icons
- Ionic Router integration
- Pre-render routes
- Mobile meta tags
Expand Down

1 change: 1 addition & 0 deletions
docs/content/1.get-started/1.introduction.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ This module attempts to get you going with Nuxt + Ionic quickly, providing sane
::list{type=success}
- **Ionic router integration:** continue defining routes based on the structure of your `~/pages` directory and using page-level utilities such as `definePageMeta()`.
- **Auto-imports**: Ionic components, composables and icons are all [auto-imported](https://nuxt.com/docs/guide/concepts/auto-imports) for ease of use.
- **Support SVG Icons**: custom icons in the assets/ionic-icons path
- **Helpful components and utilities**: This module provides components and utilities to accomplish common tasks more easily.
- **PWA support**: out-of-the-box support for progressive web apps, using `nuxt-pwa-module`.
- **Pre-render routes**
Expand Down

23 changes: 22 additions & 1 deletion
docs/content/1.get-started/3.configuration.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,8 +50,29 @@ Integrations control which other modules this module should enable and setup fro

- **icons**

 - **ionicons**

 Default: `true` 
 Disable to stop icons from being auto-imported.
 Disable to stop ionic-icons from being auto-imported.

 - **svg**

 Custom SVG icons and automatic detection with nested folders and icon size optimization in assets/ionic-icons path.
 ::alert{type="warning"}
 ⚠️ Note: Please put all the necessary SVG files in the assets/ionic-icons folder before you run your project. Because when a file is added/deleted in this path, your project will be rerendered again.
 ::

 - **enable**

 Default: `true`

 Disable to stop svg from being auto-imported.

 - **directoryAsNamespace**

 Default: `true`

 Disable to stop svg from being auto-imported.

#### `css`

Expand Down

28 changes: 26 additions & 2 deletions
docs/content/2.overview/5.icons.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,35 +6,59 @@ navigation.icon: uil:illustration

Icons are auto-imported from [`ionicons/icons`](https://github.com/ionic-team/ionicons) by default, following the pattern of camel case naming with `ionicons` in front of the original icon name, that you can find on the [official ionicons website](https://ionic.io/ionicons).

::alert{type="info"}
ℹ️ Note: Please put all the necessary SVG files in the assets/ionic-icons folder before you run your project. Because when a file is added/deleted in this path, your project will be rerendered again.
::

::alert{type="warning"}
⚠️ Note: When you use #import , change the name of the icon using "as" and the desired name. Because it doesn't interfere with auto-import.
::

::code-group

```vue [Auto-imported icons]
<template>
 <ion-icon :icon="ioniconsImage"></ion-icon>
 <ion-icon :md="ioniconsSquareSharp" :ios="ioniconsTriangleOutline"></ion-icon>
 <!-- ##### svg icon ##### -->
 <!-- without directoryAsNamespace -->
 <ion-icon :icon="ionicIconSvg`YourSvgFile`"></ion-icon>
 <!-- example -->
 <ion-icon :icon="ionicIconSvgHome"></ion-icon>
 <!-- with directoryAsNamespace -->
 <ion-icon :icon="ionicIconSvg`Subdirectories``YourSvgFile`"></ion-icon>
 <!-- example -->
 <ion-icon :icon="ionicIconSvgTabImage"></ion-icon>
</template>
```

```vue [Manual imports]
<script setup lang="ts">
import { image, squareSharp, triangleOutline } from 'ionicons/icons'
import { ionicIconSvgHome as home, ionicIconSvgTabImage as tabImage } from "#imports";
</script>

<template>
 <ion-icon :icon="image"></ion-icon>
 <ion-icon :md="squareSharp" :ios="triangleOutline"></ion-icon>
 <!-- ##### svg icon ##### -->
 <ion-icon :icon="home"></ion-icon>
 <ion-icon :icon="tabImage"></ion-icon>
 <ion-icon :md="home" :ios="tabImage"></ion-icon>
</template>
```

::

You can opt-out of auto-importing icons by setting the `integrations.icons` module options in your `nuxt.config.ts` to `false`.
You can opt-out of auto-importing icons by setting the `integrations.icons.ionicons` module options in your `nuxt.config.ts` to `false`.

```js
export default defineNuxtConfig({
 ionic: {
 integrations: {
 icons: false,
 icons: {
 ionicons: false
 },
 },
 },
})
Expand Down

1 change: 1 addition & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@
 "ionicons": "^7.3.1",
 "pathe": "^1.1.2",
 "pkg-types": "^1.0.3",
 "svgo": "^3.2.0",
 "ufo": "^1.5.3",
 "unimport": "^3.7.1"
 },
Expand Down

2 changes: 1 addition & 1 deletion
playground/composables/usePhotoGallery.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { Camera, CameraSource, CameraResultType } from '@capacitor/camera'
import { Filesystem, Directory } from '@capacitor/filesystem'
import { Preferences } from '@capacitor/preferences'

export function usePhotoGallery() {
export const usePhotoGallery = () => {
 const photos = ref<UserPhoto[]>([])
 const PHOTO_STORAGE = 'photos'

Expand Down

27 changes: 3 additions & 24 deletions
pnpm-lock.yaml

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


32 changes: 27 additions & 5 deletions
src/module.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,17 +17,28 @@ import { IonicBuiltInComponents, IonicHooks } from './imports'

import { setupUtilityComponents } from './parts/components'
import { useCSSSetup } from './parts/css'
import { setupIcons } from './parts/icons'
import { setupIonIcons } from './parts/icons/ionicons'
import { setupIonicIconsSvg } from './parts/icons/ionic-icons-svg'
import { setupMeta } from './parts/meta'
import { setupPWA } from './parts/pwa'
import { setupRouter } from './parts/router'

export interface ModuleOptionIconSvg {
 enable?: boolean
 directoryAsNamespace?: boolean
}

export interface ModuleOptionIcon {
 ionicons?: boolean
 svg?: ModuleOptionIconSvg
}

export interface ModuleOptions {
 integrations?: {
 router?: boolean
 pwa?: boolean
 meta?: boolean
 icons?: boolean
 icons?: ModuleOptionIcon
 }
 css?: {
 core?: boolean
Expand DownExpand Up@@ -93,7 +104,13 @@ export default defineNuxtModule<ModuleOptions>({
 meta: true,
 pwa: true,
 router: true,
 icons: true,
 icons: {
 ionicons: true,
 svg: {
 enable: false,
 directoryAsNamespace: true,
 },
 },
 },
 css: {
 core: true,
Expand DownExpand Up@@ -205,8 +222,13 @@ export default defineNuxtModule<ModuleOptions>({
 }

 // Add auto-imported icons
 if (options.integrations?.icons) {
 await setupIcons()
 if (options.integrations?.icons?.ionicons) {
 await setupIonIcons()
 }

 // Add auto-imported custom icons
 if (options.integrations?.icons?.svg?.enable) {
 setupIonicIconsSvg(options.integrations?.icons?.svg)
 }

 if (options.integrations?.meta) {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Support SVG icons added & fix bugs#511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

Rasool-deldar
wants to merge
6
commits into

base:main
Choose a base branch

from

 Open


Support SVG icons added & fix bugs
#511
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
0c5dd82

Support SVG icons added & fix bugs


Rasool-deldar Jan 24, 2024
fedd557

Merge remote-tracking branch 'origin/main' into Rasool-deldar/main


danielroe Apr 11, 2024
a5701c1

fix: address type issues


danielroe Apr 11, 2024
9b83cf2

fix: add `svgo` dep


danielroe Apr 11, 2024
306b03c

Merge branch 'main' into main


Rasool-deldar Apr 22, 2024
a3a67f5

Merge branch 'main' into main


Rasool-deldar Apr 27, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@

- Zero-config required
- Auto-import Ionic components, composables and icons
- Support SVG Icons
- Ionic Router integration
- Pre-render routes
- Mobile meta tags
Expand Down

1 change: 1 addition & 0 deletions
docs/content/0.index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ Batteries-included [Ionic](https://ionicframework.com/) integration for Nuxt.
::list
- Zero-config required
- Auto-import Ionic components, composables and icons
- Support SVG Icons
- Ionic Router integration
- Pre-render routes
- Mobile meta tags
Expand Down

1 change: 1 addition & 0 deletions
docs/content/1.get-started/1.introduction.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ This module attempts to get you going with Nuxt + Ionic quickly, providing sane
::list{type=success}
- **Ionic router integration:** continue defining routes based on the structure of your `~/pages` directory and using page-level utilities such as `definePageMeta()`.
- **Auto-imports**: Ionic components, composables and icons are all [auto-imported](https://nuxt.com/docs/guide/concepts/auto-imports) for ease of use.
- **Support SVG Icons**: custom icons in the assets/ionic-icons path
- **Helpful components and utilities**: This module provides components and utilities to accomplish common tasks more easily.
- **PWA support**: out-of-the-box support for progressive web apps, using `nuxt-pwa-module`.
- **Pre-render routes**
Expand Down

23 changes: 22 additions & 1 deletion
docs/content/1.get-started/3.configuration.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,8 +50,29 @@ Integrations control which other modules this module should enable and setup fro

- **icons**

 - **ionicons**

 Default: `true` 
 Disable to stop icons from being auto-imported.
 Disable to stop ionic-icons from being auto-imported.

 - **svg**

 Custom SVG icons and automatic detection with nested folders and icon size optimization in assets/ionic-icons path.
 ::alert{type="warning"}
 ⚠️ Note: Please put all the necessary SVG files in the assets/ionic-icons folder before you run your project. Because when a file is added/deleted in this path, your project will be rerendered again.
 ::

 - **enable**

 Default: `true`

 Disable to stop svg from being auto-imported.

 - **directoryAsNamespace**

 Default: `true`

 Disable to stop svg from being auto-imported.

#### `css`

Expand Down

28 changes: 26 additions & 2 deletions
docs/content/2.overview/5.icons.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,35 +6,59 @@ navigation.icon: uil:illustration

Icons are auto-imported from [`ionicons/icons`](https://github.com/ionic-team/ionicons) by default, following the pattern of camel case naming with `ionicons` in front of the original icon name, that you can find on the [official ionicons website](https://ionic.io/ionicons).

::alert{type="info"}
ℹ️ Note: Please put all the necessary SVG files in the assets/ionic-icons folder before you run your project. Because when a file is added/deleted in this path, your project will be rerendered again.
::

::alert{type="warning"}
⚠️ Note: When you use #import , change the name of the icon using "as" and the desired name. Because it doesn't interfere with auto-import.
::

::code-group

```vue [Auto-imported icons]
<template>
 <ion-icon :icon="ioniconsImage"></ion-icon>
 <ion-icon :md="ioniconsSquareSharp" :ios="ioniconsTriangleOutline"></ion-icon>
 <!-- ##### svg icon ##### -->
 <!-- without directoryAsNamespace -->
 <ion-icon :icon="ionicIconSvg`YourSvgFile`"></ion-icon>
 <!-- example -->
 <ion-icon :icon="ionicIconSvgHome"></ion-icon>
 <!-- with directoryAsNamespace -->
 <ion-icon :icon="ionicIconSvg`Subdirectories``YourSvgFile`"></ion-icon>
 <!-- example -->
 <ion-icon :icon="ionicIconSvgTabImage"></ion-icon>
</template>
```

```vue [Manual imports]
<script setup lang="ts">
import { image, squareSharp, triangleOutline } from 'ionicons/icons'
import { ionicIconSvgHome as home, ionicIconSvgTabImage as tabImage } from "#imports";
</script>

<template>
 <ion-icon :icon="image"></ion-icon>
 <ion-icon :md="squareSharp" :ios="triangleOutline"></ion-icon>
 <!-- ##### svg icon ##### -->
 <ion-icon :icon="home"></ion-icon>
 <ion-icon :icon="tabImage"></ion-icon>
 <ion-icon :md="home" :ios="tabImage"></ion-icon>
</template>
```

::

You can opt-out of auto-importing icons by setting the `integrations.icons` module options in your `nuxt.config.ts` to `false`.
You can opt-out of auto-importing icons by setting the `integrations.icons.ionicons` module options in your `nuxt.config.ts` to `false`.

```js
export default defineNuxtConfig({
 ionic: {
 integrations: {
 icons: false,
 icons: {
 ionicons: false
 },
 },
 },
})
Expand Down

1 change: 1 addition & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@
 "ionicons": "^7.3.1",
 "pathe": "^1.1.2",
 "pkg-types": "^1.0.3",
 "svgo": "^3.2.0",
 "ufo": "^1.5.3",
 "unimport": "^3.7.1"
 },
Expand Down

2 changes: 1 addition & 1 deletion
playground/composables/usePhotoGallery.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { Camera, CameraSource, CameraResultType } from '@capacitor/camera'
import { Filesystem, Directory } from '@capacitor/filesystem'
import { Preferences } from '@capacitor/preferences'

export function usePhotoGallery() {
export const usePhotoGallery = () => {
 const photos = ref<UserPhoto[]>([])
 const PHOTO_STORAGE = 'photos'

Expand Down

27 changes: 3 additions & 24 deletions
pnpm-lock.yaml

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


32 changes: 27 additions & 5 deletions
src/module.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,17 +17,28 @@ import { IonicBuiltInComponents, IonicHooks } from './imports'

import { setupUtilityComponents } from './parts/components'
import { useCSSSetup } from './parts/css'
import { setupIcons } from './parts/icons'
import { setupIonIcons } from './parts/icons/ionicons'
import { setupIonicIconsSvg } from './parts/icons/ionic-icons-svg'
import { setupMeta } from './parts/meta'
import { setupPWA } from './parts/pwa'
import { setupRouter } from './parts/router'

export interface ModuleOptionIconSvg {
 enable?: boolean
 directoryAsNamespace?: boolean
}

export interface ModuleOptionIcon {
 ionicons?: boolean
 svg?: ModuleOptionIconSvg
}

export interface ModuleOptions {
 integrations?: {
 router?: boolean
 pwa?: boolean
 meta?: boolean
 icons?: boolean
 icons?: ModuleOptionIcon
 }
 css?: {
 core?: boolean
Expand DownExpand Up@@ -93,7 +104,13 @@ export default defineNuxtModule<ModuleOptions>({
 meta: true,
 pwa: true,
 router: true,
 icons: true,
 icons: {
 ionicons: true,
 svg: {
 enable: false,
 directoryAsNamespace: true,
 },
 },
 },
 css: {
 core: true,
Expand DownExpand Up@@ -205,8 +222,13 @@ export default defineNuxtModule<ModuleOptions>({
 }

 // Add auto-imported icons
 if (options.integrations?.icons) {
 await setupIcons()
 if (options.integrations?.icons?.ionicons) {
 await setupIonIcons()
 }

 // Add auto-imported custom icons
 if (options.integrations?.icons?.svg?.enable) {
 setupIonicIconsSvg(options.integrations?.icons?.svg)
 }

 if (options.integrations?.meta) {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Support SVG icons added & fix bugs#511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

Rasool-deldar
wants to merge
6
commits into

base:main
Choose a base branch

from

 Open


Support SVG icons added & fix bugs
#511
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
0c5dd82

Support SVG icons added & fix bugs


Rasool-deldar Jan 24, 2024
fedd557

Merge remote-tracking branch 'origin/main' into Rasool-deldar/main


danielroe Apr 11, 2024
a5701c1

fix: address type issues


danielroe Apr 11, 2024
9b83cf2

fix: add `svgo` dep


danielroe Apr 11, 2024
306b03c

Merge branch 'main' into main


Rasool-deldar Apr 22, 2024
a3a67f5

Merge branch 'main' into main


Rasool-deldar Apr 27, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@

- Zero-config required
- Auto-import Ionic components, composables and icons
- Support SVG Icons
- Ionic Router integration
- Pre-render routes
- Mobile meta tags
Expand Down

1 change: 1 addition & 0 deletions
docs/content/0.index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ Batteries-included [Ionic](https://ionicframework.com/) integration for Nuxt.
::list
- Zero-config required
- Auto-import Ionic components, composables and icons
- Support SVG Icons
- Ionic Router integration
- Pre-render routes
- Mobile meta tags
Expand Down

1 change: 1 addition & 0 deletions
docs/content/1.get-started/1.introduction.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ This module attempts to get you going with Nuxt + Ionic quickly, providing sane
::list{type=success}
- **Ionic router integration:** continue defining routes based on the structure of your `~/pages` directory and using page-level utilities such as `definePageMeta()`.
- **Auto-imports**: Ionic components, composables and icons are all [auto-imported](https://nuxt.com/docs/guide/concepts/auto-imports) for ease of use.
- **Support SVG Icons**: custom icons in the assets/ionic-icons path
- **Helpful components and utilities**: This module provides components and utilities to accomplish common tasks more easily.
- **PWA support**: out-of-the-box support for progressive web apps, using `nuxt-pwa-module`.
- **Pre-render routes**
Expand Down

23 changes: 22 additions & 1 deletion
docs/content/1.get-started/3.configuration.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,8 +50,29 @@ Integrations control which other modules this module should enable and setup fro

- **icons**

 - **ionicons**

 Default: `true` 
 Disable to stop icons from being auto-imported.
 Disable to stop ionic-icons from being auto-imported.

 - **svg**

 Custom SVG icons and automatic detection with nested folders and icon size optimization in assets/ionic-icons path.
 ::alert{type="warning"}
 ⚠️ Note: Please put all the necessary SVG files in the assets/ionic-icons folder before you run your project. Because when a file is added/deleted in this path, your project will be rerendered again.
 ::

 - **enable**

 Default: `true`

 Disable to stop svg from being auto-imported.

 - **directoryAsNamespace**

 Default: `true`

 Disable to stop svg from being auto-imported.

#### `css`

Expand Down

28 changes: 26 additions & 2 deletions
docs/content/2.overview/5.icons.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,35 +6,59 @@ navigation.icon: uil:illustration

Icons are auto-imported from [`ionicons/icons`](https://github.com/ionic-team/ionicons) by default, following the pattern of camel case naming with `ionicons` in front of the original icon name, that you can find on the [official ionicons website](https://ionic.io/ionicons).

::alert{type="info"}
ℹ️ Note: Please put all the necessary SVG files in the assets/ionic-icons folder before you run your project. Because when a file is added/deleted in this path, your project will be rerendered again.
::

::alert{type="warning"}
⚠️ Note: When you use #import , change the name of the icon using "as" and the desired name. Because it doesn't interfere with auto-import.
::

::code-group

```vue [Auto-imported icons]
<template>
 <ion-icon :icon="ioniconsImage"></ion-icon>
 <ion-icon :md="ioniconsSquareSharp" :ios="ioniconsTriangleOutline"></ion-icon>
 <!-- ##### svg icon ##### -->
 <!-- without directoryAsNamespace -->
 <ion-icon :icon="ionicIconSvg`YourSvgFile`"></ion-icon>
 <!-- example -->
 <ion-icon :icon="ionicIconSvgHome"></ion-icon>
 <!-- with directoryAsNamespace -->
 <ion-icon :icon="ionicIconSvg`Subdirectories``YourSvgFile`"></ion-icon>
 <!-- example -->
 <ion-icon :icon="ionicIconSvgTabImage"></ion-icon>
</template>
```

```vue [Manual imports]
<script setup lang="ts">
import { image, squareSharp, triangleOutline } from 'ionicons/icons'
import { ionicIconSvgHome as home, ionicIconSvgTabImage as tabImage } from "#imports";
</script>

<template>
 <ion-icon :icon="image"></ion-icon>
 <ion-icon :md="squareSharp" :ios="triangleOutline"></ion-icon>
 <!-- ##### svg icon ##### -->
 <ion-icon :icon="home"></ion-icon>
 <ion-icon :icon="tabImage"></ion-icon>
 <ion-icon :md="home" :ios="tabImage"></ion-icon>
</template>
```

::

You can opt-out of auto-importing icons by setting the `integrations.icons` module options in your `nuxt.config.ts` to `false`.
You can opt-out of auto-importing icons by setting the `integrations.icons.ionicons` module options in your `nuxt.config.ts` to `false`.

```js
export default defineNuxtConfig({
 ionic: {
 integrations: {
 icons: false,
 icons: {
 ionicons: false
 },
 },
 },
})
Expand Down

1 change: 1 addition & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@
 "ionicons": "^7.3.1",
 "pathe": "^1.1.2",
 "pkg-types": "^1.0.3",
 "svgo": "^3.2.0",
 "ufo": "^1.5.3",
 "unimport": "^3.7.1"
 },
Expand Down

2 changes: 1 addition & 1 deletion
playground/composables/usePhotoGallery.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { Camera, CameraSource, CameraResultType } from '@capacitor/camera'
import { Filesystem, Directory } from '@capacitor/filesystem'
import { Preferences } from '@capacitor/preferences'

export function usePhotoGallery() {
export const usePhotoGallery = () => {
 const photos = ref<UserPhoto[]>([])
 const PHOTO_STORAGE = 'photos'

Expand Down

27 changes: 3 additions & 24 deletions
pnpm-lock.yaml

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


32 changes: 27 additions & 5 deletions
src/module.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,17 +17,28 @@ import { IonicBuiltInComponents, IonicHooks } from './imports'

import { setupUtilityComponents } from './parts/components'
import { useCSSSetup } from './parts/css'
import { setupIcons } from './parts/icons'
import { setupIonIcons } from './parts/icons/ionicons'
import { setupIonicIconsSvg } from './parts/icons/ionic-icons-svg'
import { setupMeta } from './parts/meta'
import { setupPWA } from './parts/pwa'
import { setupRouter } from './parts/router'

export interface ModuleOptionIconSvg {
 enable?: boolean
 directoryAsNamespace?: boolean
}

export interface ModuleOptionIcon {
 ionicons?: boolean
 svg?: ModuleOptionIconSvg
}

export interface ModuleOptions {
 integrations?: {
 router?: boolean
 pwa?: boolean
 meta?: boolean
 icons?: boolean
 icons?: ModuleOptionIcon
 }
 css?: {
 core?: boolean
Expand DownExpand Up@@ -93,7 +104,13 @@ export default defineNuxtModule<ModuleOptions>({
 meta: true,
 pwa: true,
 router: true,
 icons: true,
 icons: {
 ionicons: true,
 svg: {
 enable: false,
 directoryAsNamespace: true,
 },
 },
 },
 css: {
 core: true,
Expand DownExpand Up@@ -205,8 +222,13 @@ export default defineNuxtModule<ModuleOptions>({
 }

 // Add auto-imported icons
 if (options.integrations?.icons) {
 await setupIcons()
 if (options.integrations?.icons?.ionicons) {
 await setupIonIcons()
 }

 // Add auto-imported custom icons
 if (options.integrations?.icons?.svg?.enable) {
 setupIonicIconsSvg(options.integrations?.icons?.svg)
 }

 if (options.integrations?.meta) {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Support SVG icons added & fix bugs#511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

Rasool-deldar
wants to merge
6
commits into

base:main
Choose a base branch

from

 Open


Support SVG icons added & fix bugs
#511
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
0c5dd82

Support SVG icons added & fix bugs


Rasool-deldar Jan 24, 2024
fedd557

Merge remote-tracking branch 'origin/main' into Rasool-deldar/main


danielroe Apr 11, 2024
a5701c1

fix: address type issues


danielroe Apr 11, 2024
9b83cf2

fix: add `svgo` dep


danielroe Apr 11, 2024
306b03c

Merge branch 'main' into main


Rasool-deldar Apr 22, 2024
a3a67f5

Merge branch 'main' into main


Rasool-deldar Apr 27, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@

- Zero-config required
- Auto-import Ionic components, composables and icons
- Support SVG Icons
- Ionic Router integration
- Pre-render routes
- Mobile meta tags
Expand Down

1 change: 1 addition & 0 deletions
docs/content/0.index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ Batteries-included [Ionic](https://ionicframework.com/) integration for Nuxt.
::list
- Zero-config required
- Auto-import Ionic components, composables and icons
- Support SVG Icons
- Ionic Router integration
- Pre-render routes
- Mobile meta tags
Expand Down

1 change: 1 addition & 0 deletions
docs/content/1.get-started/1.introduction.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ This module attempts to get you going with Nuxt + Ionic quickly, providing sane
::list{type=success}
- **Ionic router integration:** continue defining routes based on the structure of your `~/pages` directory and using page-level utilities such as `definePageMeta()`.
- **Auto-imports**: Ionic components, composables and icons are all [auto-imported](https://nuxt.com/docs/guide/concepts/auto-imports) for ease of use.
- **Support SVG Icons**: custom icons in the assets/ionic-icons path
- **Helpful components and utilities**: This module provides components and utilities to accomplish common tasks more easily.
- **PWA support**: out-of-the-box support for progressive web apps, using `nuxt-pwa-module`.
- **Pre-render routes**
Expand Down

23 changes: 22 additions & 1 deletion
docs/content/1.get-started/3.configuration.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,8 +50,29 @@ Integrations control which other modules this module should enable and setup fro

- **icons**

 - **ionicons**

 Default: `true` 
 Disable to stop icons from being auto-imported.
 Disable to stop ionic-icons from being auto-imported.

 - **svg**

 Custom SVG icons and automatic detection with nested folders and icon size optimization in assets/ionic-icons path.
 ::alert{type="warning"}
 ⚠️ Note: Please put all the necessary SVG files in the assets/ionic-icons folder before you run your project. Because when a file is added/deleted in this path, your project will be rerendered again.
 ::

 - **enable**

 Default: `true`

 Disable to stop svg from being auto-imported.

 - **directoryAsNamespace**

 Default: `true`

 Disable to stop svg from being auto-imported.

#### `css`

Expand Down

28 changes: 26 additions & 2 deletions
docs/content/2.overview/5.icons.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,35 +6,59 @@ navigation.icon: uil:illustration

Icons are auto-imported from [`ionicons/icons`](https://github.com/ionic-team/ionicons) by default, following the pattern of camel case naming with `ionicons` in front of the original icon name, that you can find on the [official ionicons website](https://ionic.io/ionicons).

::alert{type="info"}
ℹ️ Note: Please put all the necessary SVG files in the assets/ionic-icons folder before you run your project. Because when a file is added/deleted in this path, your project will be rerendered again.
::

::alert{type="warning"}
⚠️ Note: When you use #import , change the name of the icon using "as" and the desired name. Because it doesn't interfere with auto-import.
::

::code-group

```vue [Auto-imported icons]
<template>
 <ion-icon :icon="ioniconsImage"></ion-icon>
 <ion-icon :md="ioniconsSquareSharp" :ios="ioniconsTriangleOutline"></ion-icon>
 <!-- ##### svg icon ##### -->
 <!-- without directoryAsNamespace -->
 <ion-icon :icon="ionicIconSvg`YourSvgFile`"></ion-icon>
 <!-- example -->
 <ion-icon :icon="ionicIconSvgHome"></ion-icon>
 <!-- with directoryAsNamespace -->
 <ion-icon :icon="ionicIconSvg`Subdirectories``YourSvgFile`"></ion-icon>
 <!-- example -->
 <ion-icon :icon="ionicIconSvgTabImage"></ion-icon>
</template>
```

```vue [Manual imports]
<script setup lang="ts">
import { image, squareSharp, triangleOutline } from 'ionicons/icons'
import { ionicIconSvgHome as home, ionicIconSvgTabImage as tabImage } from "#imports";
</script>

<template>
 <ion-icon :icon="image"></ion-icon>
 <ion-icon :md="squareSharp" :ios="triangleOutline"></ion-icon>
 <!-- ##### svg icon ##### -->
 <ion-icon :icon="home"></ion-icon>
 <ion-icon :icon="tabImage"></ion-icon>
 <ion-icon :md="home" :ios="tabImage"></ion-icon>
</template>
```

::

You can opt-out of auto-importing icons by setting the `integrations.icons` module options in your `nuxt.config.ts` to `false`.
You can opt-out of auto-importing icons by setting the `integrations.icons.ionicons` module options in your `nuxt.config.ts` to `false`.

```js
export default defineNuxtConfig({
 ionic: {
 integrations: {
 icons: false,
 icons: {
 ionicons: false
 },
 },
 },
})
Expand Down

1 change: 1 addition & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@
 "ionicons": "^7.3.1",
 "pathe": "^1.1.2",
 "pkg-types": "^1.0.3",
 "svgo": "^3.2.0",
 "ufo": "^1.5.3",
 "unimport": "^3.7.1"
 },
Expand Down

2 changes: 1 addition & 1 deletion
playground/composables/usePhotoGallery.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { Camera, CameraSource, CameraResultType } from '@capacitor/camera'
import { Filesystem, Directory } from '@capacitor/filesystem'
import { Preferences } from '@capacitor/preferences'

export function usePhotoGallery() {
export const usePhotoGallery = () => {
 const photos = ref<UserPhoto[]>([])
 const PHOTO_STORAGE = 'photos'

Expand Down

27 changes: 3 additions & 24 deletions
pnpm-lock.yaml

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


32 changes: 27 additions & 5 deletions
src/module.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,17 +17,28 @@ import { IonicBuiltInComponents, IonicHooks } from './imports'

import { setupUtilityComponents } from './parts/components'
import { useCSSSetup } from './parts/css'
import { setupIcons } from './parts/icons'
import { setupIonIcons } from './parts/icons/ionicons'
import { setupIonicIconsSvg } from './parts/icons/ionic-icons-svg'
import { setupMeta } from './parts/meta'
import { setupPWA } from './parts/pwa'
import { setupRouter } from './parts/router'

export interface ModuleOptionIconSvg {
 enable?: boolean
 directoryAsNamespace?: boolean
}

export interface ModuleOptionIcon {
 ionicons?: boolean
 svg?: ModuleOptionIconSvg
}

export interface ModuleOptions {
 integrations?: {
 router?: boolean
 pwa?: boolean
 meta?: boolean
 icons?: boolean
 icons?: ModuleOptionIcon
 }
 css?: {
 core?: boolean
Expand DownExpand Up@@ -93,7 +104,13 @@ export default defineNuxtModule<ModuleOptions>({
 meta: true,
 pwa: true,
 router: true,
 icons: true,
 icons: {
 ionicons: true,
 svg: {
 enable: false,
 directoryAsNamespace: true,
 },
 },
 },
 css: {
 core: true,
Expand DownExpand Up@@ -205,8 +222,13 @@ export default defineNuxtModule<ModuleOptions>({
 }

 // Add auto-imported icons
 if (options.integrations?.icons) {
 await setupIcons()
 if (options.integrations?.icons?.ionicons) {
 await setupIonIcons()
 }

 // Add auto-imported custom icons
 if (options.integrations?.icons?.svg?.enable) {
 setupIonicIconsSvg(options.integrations?.icons?.svg)
 }

 if (options.integrations?.meta) {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Support SVG icons added & fix bugs#511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

Rasool-deldar
wants to merge
6
commits into

base:main
Choose a base branch

from

 Open


Support SVG icons added & fix bugs
#511
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
0c5dd82

Support SVG icons added & fix bugs


Rasool-deldar Jan 24, 2024
fedd557

Merge remote-tracking branch 'origin/main' into Rasool-deldar/main


danielroe Apr 11, 2024
a5701c1

fix: address type issues


danielroe Apr 11, 2024
9b83cf2

fix: add `svgo` dep


danielroe Apr 11, 2024
306b03c

Merge branch 'main' into main


Rasool-deldar Apr 22, 2024
a3a67f5

Merge branch 'main' into main


Rasool-deldar Apr 27, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@

- Zero-config required
- Auto-import Ionic components, composables and icons
- Support SVG Icons
- Ionic Router integration
- Pre-render routes
- Mobile meta tags
Expand Down

1 change: 1 addition & 0 deletions
docs/content/0.index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ Batteries-included [Ionic](https://ionicframework.com/) integration for Nuxt.
::list
- Zero-config required
- Auto-import Ionic components, composables and icons
- Support SVG Icons
- Ionic Router integration
- Pre-render routes
- Mobile meta tags
Expand Down

1 change: 1 addition & 0 deletions
docs/content/1.get-started/1.introduction.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ This module attempts to get you going with Nuxt + Ionic quickly, providing sane
::list{type=success}
- **Ionic router integration:** continue defining routes based on the structure of your `~/pages` directory and using page-level utilities such as `definePageMeta()`.
- **Auto-imports**: Ionic components, composables and icons are all [auto-imported](https://nuxt.com/docs/guide/concepts/auto-imports) for ease of use.
- **Support SVG Icons**: custom icons in the assets/ionic-icons path
- **Helpful components and utilities**: This module provides components and utilities to accomplish common tasks more easily.
- **PWA support**: out-of-the-box support for progressive web apps, using `nuxt-pwa-module`.
- **Pre-render routes**
Expand Down

23 changes: 22 additions & 1 deletion
docs/content/1.get-started/3.configuration.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,8 +50,29 @@ Integrations control which other modules this module should enable and setup fro

- **icons**

 - **ionicons**

 Default: `true` 
 Disable to stop icons from being auto-imported.
 Disable to stop ionic-icons from being auto-imported.

 - **svg**

 Custom SVG icons and automatic detection with nested folders and icon size optimization in assets/ionic-icons path.
 ::alert{type="warning"}
 ⚠️ Note: Please put all the necessary SVG files in the assets/ionic-icons folder before you run your project. Because when a file is added/deleted in this path, your project will be rerendered again.
 ::

 - **enable**

 Default: `true`

 Disable to stop svg from being auto-imported.

 - **directoryAsNamespace**

 Default: `true`

 Disable to stop svg from being auto-imported.

#### `css`

Expand Down

28 changes: 26 additions & 2 deletions
docs/content/2.overview/5.icons.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,35 +6,59 @@ navigation.icon: uil:illustration

Icons are auto-imported from [`ionicons/icons`](https://github.com/ionic-team/ionicons) by default, following the pattern of camel case naming with `ionicons` in front of the original icon name, that you can find on the [official ionicons website](https://ionic.io/ionicons).

::alert{type="info"}
ℹ️ Note: Please put all the necessary SVG files in the assets/ionic-icons folder before you run your project. Because when a file is added/deleted in this path, your project will be rerendered again.
::

::alert{type="warning"}
⚠️ Note: When you use #import , change the name of the icon using "as" and the desired name. Because it doesn't interfere with auto-import.
::

::code-group

```vue [Auto-imported icons]
<template>
 <ion-icon :icon="ioniconsImage"></ion-icon>
 <ion-icon :md="ioniconsSquareSharp" :ios="ioniconsTriangleOutline"></ion-icon>
 <!-- ##### svg icon ##### -->
 <!-- without directoryAsNamespace -->
 <ion-icon :icon="ionicIconSvg`YourSvgFile`"></ion-icon>
 <!-- example -->
 <ion-icon :icon="ionicIconSvgHome"></ion-icon>
 <!-- with directoryAsNamespace -->
 <ion-icon :icon="ionicIconSvg`Subdirectories``YourSvgFile`"></ion-icon>
 <!-- example -->
 <ion-icon :icon="ionicIconSvgTabImage"></ion-icon>
</template>
```

```vue [Manual imports]
<script setup lang="ts">
import { image, squareSharp, triangleOutline } from 'ionicons/icons'
import { ionicIconSvgHome as home, ionicIconSvgTabImage as tabImage } from "#imports";
</script>

<template>
 <ion-icon :icon="image"></ion-icon>
 <ion-icon :md="squareSharp" :ios="triangleOutline"></ion-icon>
 <!-- ##### svg icon ##### -->
 <ion-icon :icon="home"></ion-icon>
 <ion-icon :icon="tabImage"></ion-icon>
 <ion-icon :md="home" :ios="tabImage"></ion-icon>
</template>
```

::

You can opt-out of auto-importing icons by setting the `integrations.icons` module options in your `nuxt.config.ts` to `false`.
You can opt-out of auto-importing icons by setting the `integrations.icons.ionicons` module options in your `nuxt.config.ts` to `false`.

```js
export default defineNuxtConfig({
 ionic: {
 integrations: {
 icons: false,
 icons: {
 ionicons: false
 },
 },
 },
})
Expand Down

1 change: 1 addition & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@
 "ionicons": "^7.3.1",
 "pathe": "^1.1.2",
 "pkg-types": "^1.0.3",
 "svgo": "^3.2.0",
 "ufo": "^1.5.3",
 "unimport": "^3.7.1"
 },
Expand Down

2 changes: 1 addition & 1 deletion
playground/composables/usePhotoGallery.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { Camera, CameraSource, CameraResultType } from '@capacitor/camera'
import { Filesystem, Directory } from '@capacitor/filesystem'
import { Preferences } from '@capacitor/preferences'

export function usePhotoGallery() {
export const usePhotoGallery = () => {
 const photos = ref<UserPhoto[]>([])
 const PHOTO_STORAGE = 'photos'

Expand Down

27 changes: 3 additions & 24 deletions
pnpm-lock.yaml

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


32 changes: 27 additions & 5 deletions
src/module.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,17 +17,28 @@ import { IonicBuiltInComponents, IonicHooks } from './imports'

import { setupUtilityComponents } from './parts/components'
import { useCSSSetup } from './parts/css'
import { setupIcons } from './parts/icons'
import { setupIonIcons } from './parts/icons/ionicons'
import { setupIonicIconsSvg } from './parts/icons/ionic-icons-svg'
import { setupMeta } from './parts/meta'
import { setupPWA } from './parts/pwa'
import { setupRouter } from './parts/router'

export interface ModuleOptionIconSvg {
 enable?: boolean
 directoryAsNamespace?: boolean
}

export interface ModuleOptionIcon {
 ionicons?: boolean
 svg?: ModuleOptionIconSvg
}

export interface ModuleOptions {
 integrations?: {
 router?: boolean
 pwa?: boolean
 meta?: boolean
 icons?: boolean
 icons?: ModuleOptionIcon
 }
 css?: {
 core?: boolean
Expand DownExpand Up@@ -93,7 +104,13 @@ export default defineNuxtModule<ModuleOptions>({
 meta: true,
 pwa: true,
 router: true,
 icons: true,
 icons: {
 ionicons: true,
 svg: {
 enable: false,
 directoryAsNamespace: true,
 },
 },
 },
 css: {
 core: true,
Expand DownExpand Up@@ -205,8 +222,13 @@ export default defineNuxtModule<ModuleOptions>({
 }

 // Add auto-imported icons
 if (options.integrations?.icons) {
 await setupIcons()
 if (options.integrations?.icons?.ionicons) {
 await setupIonIcons()
 }

 // Add auto-imported custom icons
 if (options.integrations?.icons?.svg?.enable) {
 setupIonicIconsSvg(options.integrations?.icons?.svg)
 }

 if (options.integrations?.meta) {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Support SVG icons added & fix bugs#511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

Rasool-deldar
wants to merge
6
commits into

base:main
Choose a base branch

from

 Open


Support SVG icons added & fix bugs
#511
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
0c5dd82

Support SVG icons added & fix bugs


Rasool-deldar Jan 24, 2024
fedd557

Merge remote-tracking branch 'origin/main' into Rasool-deldar/main


danielroe Apr 11, 2024
a5701c1

fix: address type issues


danielroe Apr 11, 2024
9b83cf2

fix: add `svgo` dep


danielroe Apr 11, 2024
306b03c

Merge branch 'main' into main


Rasool-deldar Apr 22, 2024
a3a67f5

Merge branch 'main' into main


Rasool-deldar Apr 27, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@

- Zero-config required
- Auto-import Ionic components, composables and icons
- Support SVG Icons
- Ionic Router integration
- Pre-render routes
- Mobile meta tags
Expand Down

1 change: 1 addition & 0 deletions
docs/content/0.index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ Batteries-included [Ionic](https://ionicframework.com/) integration for Nuxt.
::list
- Zero-config required
- Auto-import Ionic components, composables and icons
- Support SVG Icons
- Ionic Router integration
- Pre-render routes
- Mobile meta tags
Expand Down

1 change: 1 addition & 0 deletions
docs/content/1.get-started/1.introduction.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ This module attempts to get you going with Nuxt + Ionic quickly, providing sane
::list{type=success}
- **Ionic router integration:** continue defining routes based on the structure of your `~/pages` directory and using page-level utilities such as `definePageMeta()`.
- **Auto-imports**: Ionic components, composables and icons are all [auto-imported](https://nuxt.com/docs/guide/concepts/auto-imports) for ease of use.
- **Support SVG Icons**: custom icons in the assets/ionic-icons path
- **Helpful components and utilities**: This module provides components and utilities to accomplish common tasks more easily.
- **PWA support**: out-of-the-box support for progressive web apps, using `nuxt-pwa-module`.
- **Pre-render routes**
Expand Down

23 changes: 22 additions & 1 deletion
docs/content/1.get-started/3.configuration.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,8 +50,29 @@ Integrations control which other modules this module should enable and setup fro

- **icons**

 - **ionicons**

 Default: `true` 
 Disable to stop icons from being auto-imported.
 Disable to stop ionic-icons from being auto-imported.

 - **svg**

 Custom SVG icons and automatic detection with nested folders and icon size optimization in assets/ionic-icons path.
 ::alert{type="warning"}
 ⚠️ Note: Please put all the necessary SVG files in the assets/ionic-icons folder before you run your project. Because when a file is added/deleted in this path, your project will be rerendered again.
 ::

 - **enable**

 Default: `true`

 Disable to stop svg from being auto-imported.

 - **directoryAsNamespace**

 Default: `true`

 Disable to stop svg from being auto-imported.

#### `css`

Expand Down

28 changes: 26 additions & 2 deletions
docs/content/2.overview/5.icons.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,35 +6,59 @@ navigation.icon: uil:illustration

Icons are auto-imported from [`ionicons/icons`](https://github.com/ionic-team/ionicons) by default, following the pattern of camel case naming with `ionicons` in front of the original icon name, that you can find on the [official ionicons website](https://ionic.io/ionicons).

::alert{type="info"}
ℹ️ Note: Please put all the necessary SVG files in the assets/ionic-icons folder before you run your project. Because when a file is added/deleted in this path, your project will be rerendered again.
::

::alert{type="warning"}
⚠️ Note: When you use #import , change the name of the icon using "as" and the desired name. Because it doesn't interfere with auto-import.
::

::code-group

```vue [Auto-imported icons]
<template>
 <ion-icon :icon="ioniconsImage"></ion-icon>
 <ion-icon :md="ioniconsSquareSharp" :ios="ioniconsTriangleOutline"></ion-icon>
 <!-- ##### svg icon ##### -->
 <!-- without directoryAsNamespace -->
 <ion-icon :icon="ionicIconSvg`YourSvgFile`"></ion-icon>
 <!-- example -->
 <ion-icon :icon="ionicIconSvgHome"></ion-icon>
 <!-- with directoryAsNamespace -->
 <ion-icon :icon="ionicIconSvg`Subdirectories``YourSvgFile`"></ion-icon>
 <!-- example -->
 <ion-icon :icon="ionicIconSvgTabImage"></ion-icon>
</template>
```

```vue [Manual imports]
<script setup lang="ts">
import { image, squareSharp, triangleOutline } from 'ionicons/icons'
import { ionicIconSvgHome as home, ionicIconSvgTabImage as tabImage } from "#imports";
</script>

<template>
 <ion-icon :icon="image"></ion-icon>
 <ion-icon :md="squareSharp" :ios="triangleOutline"></ion-icon>
 <!-- ##### svg icon ##### -->
 <ion-icon :icon="home"></ion-icon>
 <ion-icon :icon="tabImage"></ion-icon>
 <ion-icon :md="home" :ios="tabImage"></ion-icon>
</template>
```

::

You can opt-out of auto-importing icons by setting the `integrations.icons` module options in your `nuxt.config.ts` to `false`.
You can opt-out of auto-importing icons by setting the `integrations.icons.ionicons` module options in your `nuxt.config.ts` to `false`.

```js
export default defineNuxtConfig({
 ionic: {
 integrations: {
 icons: false,
 icons: {
 ionicons: false
 },
 },
 },
})
Expand Down

1 change: 1 addition & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@
 "ionicons": "^7.3.1",
 "pathe": "^1.1.2",
 "pkg-types": "^1.0.3",
 "svgo": "^3.2.0",
 "ufo": "^1.5.3",
 "unimport": "^3.7.1"
 },
Expand Down

2 changes: 1 addition & 1 deletion
playground/composables/usePhotoGallery.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { Camera, CameraSource, CameraResultType } from '@capacitor/camera'
import { Filesystem, Directory } from '@capacitor/filesystem'
import { Preferences } from '@capacitor/preferences'

export function usePhotoGallery() {
export const usePhotoGallery = () => {
 const photos = ref<UserPhoto[]>([])
 const PHOTO_STORAGE = 'photos'

Expand Down

27 changes: 3 additions & 24 deletions
pnpm-lock.yaml

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


32 changes: 27 additions & 5 deletions
src/module.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,17 +17,28 @@ import { IonicBuiltInComponents, IonicHooks } from './imports'

import { setupUtilityComponents } from './parts/components'
import { useCSSSetup } from './parts/css'
import { setupIcons } from './parts/icons'
import { setupIonIcons } from './parts/icons/ionicons'
import { setupIonicIconsSvg } from './parts/icons/ionic-icons-svg'
import { setupMeta } from './parts/meta'
import { setupPWA } from './parts/pwa'
import { setupRouter } from './parts/router'

export interface ModuleOptionIconSvg {
 enable?: boolean
 directoryAsNamespace?: boolean
}

export interface ModuleOptionIcon {
 ionicons?: boolean
 svg?: ModuleOptionIconSvg
}

export interface ModuleOptions {
 integrations?: {
 router?: boolean
 pwa?: boolean
 meta?: boolean
 icons?: boolean
 icons?: ModuleOptionIcon
 }
 css?: {
 core?: boolean
Expand DownExpand Up@@ -93,7 +104,13 @@ export default defineNuxtModule<ModuleOptions>({
 meta: true,
 pwa: true,
 router: true,
 icons: true,
 icons: {
 ionicons: true,
 svg: {
 enable: false,
 directoryAsNamespace: true,
 },
 },
 },
 css: {
 core: true,
Expand DownExpand Up@@ -205,8 +222,13 @@ export default defineNuxtModule<ModuleOptions>({
 }

 // Add auto-imported icons
 if (options.integrations?.icons) {
 await setupIcons()
 if (options.integrations?.icons?.ionicons) {
 await setupIonIcons()
 }

 // Add auto-imported custom icons
 if (options.integrations?.icons?.svg?.enable) {
 setupIonicIconsSvg(options.integrations?.icons?.svg)
 }

 if (options.integrations?.meta) {
Expand Down
Loading