Skip to content
Merged
Show file tree
Hide file tree
Changes from 19 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
ca19178
wip: start ember types
rtablada Sep 2, 2025
3e25e78
feat: init ember-example
rtablada Sep 2, 2025
bd9de95
update examples
rtablada Sep 3, 2025
8141f5a
dont change js fn type
rtablada Sep 3, 2025
d4c2fc2
feat: working example of ember compiler
rtablada Sep 3, 2025
a08066b
fix: lint errors in ember example
rtablada Sep 3, 2025
7425c72
ember-vite example
rtablada Sep 3, 2025
34f0948
feat: ember-cli snuck in git submodule again...
rtablada Sep 3, 2025
2f55ec7
ember-vite is a real folder
rtablada Sep 3, 2025
e3f477f
doc: update docs for ember plugin
rtablada Sep 3, 2025
8141fb2
Make ember examples minimal: remove ember-data, linting, testing, pre…
NullVoxPopuli Oct 9, 2025
2f70e5f
Move 'ember' to 'webpack-ember'
NullVoxPopuli Oct 9, 2025
5198494
Lockfile
NullVoxPopuli Oct 9, 2025
299b997
Remove READMEs
NullVoxPopuli Oct 9, 2025
b902334
TIL: the whole public folders aren't needed
NullVoxPopuli Oct 9, 2025
541f356
Reorder
NullVoxPopuli Oct 9, 2025
109242b
Cleanup the ember part of the readme
NullVoxPopuli Oct 9, 2025
c5731f5
Cleanup the ember part of the readme
NullVoxPopuli Oct 9, 2025
7cb6e3d
De-prioritize the ember-webpack instructions
NullVoxPopuli Oct 9, 2025
1e995c0
Delete extraneous files
NullVoxPopuli Oct 9, 2025
eed3c35
vite-ember has no ember-cli, so we can remove .ember-cli file for teh…
NullVoxPopuli Oct 9, 2025
9e17c0f
Vite-ember example has no tests, so we don't need to care about .env.…
NullVoxPopuli Oct 9, 2025
c5f5de8
lint:fix
NullVoxPopuli Oct 9, 2025
934fa2a
Add override to eslint due to an oopsie from array-callback-return
NullVoxPopuli Oct 9, 2025
2a2da4d
Use antfu eslint-config apis instead of eslint-overrides entry
NullVoxPopuli Oct 9, 2025
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
73 changes: 73 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -734,6 +734,79 @@ See [the Qwik example](examples/vite-qwik) for a working example project.

<br></details>

<details>
<summary>Ember</summary><br>

Ember support requires using either Webpack or Vite

```ts
Icons({ compiler: 'ember' })
```

For Vite applications, add the Icon plugin to the plugins array in `vite.config.js`:

```ts
import { ember, extensions } from '@embroider/vite'
import { babel } from '@rollup/plugin-babel'
import Icons from 'unplugin-icons/vite'
import { defineConfig } from 'vite'

export default defineConfig({
plugins: [
ember(),
Icons({
compiler: 'ember',
}),
babel({
babelHelpers: 'runtime',
extensions,
}),
],
})
```

Type Declarations:

```jsonc
// tsconfig.json
{
"compilerOptions": {
"types": [
// ... existing declarations omitted ...
"unplugin-icons/types/ember"
]
}
}
```

<details><summary>Ember + Webpack</summary>

Assuming your app was generated with `--embroider`, or manually migrated to embroider following the instructions on [the old embroider readme](https://github.com/embroider-build/embroider/tree/stable?tab=readme-ov-file#how-to-try-it)

Add the Icon plugin to the webpack plugins array in `ember-cli-build.js`:

<!-- eslint-skip -->

```ts
return require('@embroider/compat').compatBuild(app, Webpack, {
packagerOptions: {
webpackConfig: {
plugins: [
Icons({
compiler: 'ember',
}),
],
},
},
// ...other options
```

</details>

See the [Ember (with Webpack)](examples/webpack-ember) or [Ember vite example](examples/vite-ember) for a working example project.

<br></details>

## Use RAW compiler from query params

From `v0.13.2` you can also use `raw` compiler to access the `svg` icon and use it on your html templates, just add `raw` to the icon query param.
Expand Down
19 changes: 19 additions & 0 deletions examples/vite-ember/.editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# EditorConfig helps developers define and maintain consistent
# coding styles between different editors and IDEs
# editorconfig.org

root = true

[*]
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
indent_style = space
indent_size = 2

[*.hbs]
insert_final_newline = false

[*.{diff,md}]
trim_trailing_whitespace = false
19 changes: 19 additions & 0 deletions examples/vite-ember/.ember-cli
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
/**
Setting `isTypeScriptProject` to true will force the blueprint generators to generate TypeScript
rather than JavaScript by default, when a TypeScript version of a given blueprint is available.
*/
"isTypeScriptProject": true,

/**
Setting `componentAuthoringFormat` to "strict" will force the blueprint generators to generate GJS
or GTS files for the component and the component rendering test. "loose" is the default.
*/
"componentAuthoringFormat": "strict",

/**
Setting `routeAuthoringFormat` to "strict" will force the blueprint generators to generate GJS
or GTS templates for routes. "loose" is the default
*/
"routeAuthoringFormat": "strict"
}
8 changes: 8 additions & 0 deletions examples/vite-ember/.env.development
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# This file is committed to git and should not contain any secrets.
#
# Vite recommends using .env.local or .env.[mode].local if you need to manage secrets
# SEE: https://vite.dev/guide/env-and-mode.html#env-files for more information.


# Default NODE_ENV with vite build --mode=test is production
NODE_ENV=development
26 changes: 26 additions & 0 deletions examples/vite-ember/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# compiled output
/dist/
/declarations/
/tmp/

# dependencies
/node_modules/

# misc
/.env*
/.pnp*
/.eslintcache
/coverage/
/npm-debug.log*
/testem.log
/yarn-error.log

# ember-try
/.node_modules.ember-try/
/npm-shrinkwrap.json.ember-try
/package.json.ember-try
/package-lock.json.ember-try
/yarn.lock.ember-try

# broccoli-debug
/DEBUG/
20 changes: 20 additions & 0 deletions examples/vite-ember/app/app.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import Application from 'ember-strict-application-resolver';
import EmberRouter from '@embroider/router';
import compatModules from '@embroider/virtual/compat-modules';

class Router extends EmberRouter {
location = 'history';
rootURL = '/';
}

Router.map(() => {
// Add route declarations here
});

export default class App extends Application {
modules = {
'./router': Router,
...import.meta.glob('./templates/**/*.{gjs,gts}', { eager: true }),
}
}

12 changes: 12 additions & 0 deletions examples/vite-ember/app/templates/application.gts
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import Tomster from '~icons/logos/ember-tomster';

import FileJavaScript from '~icons/devicon/javascript';
import styles from './application.module.css';

<template>
<h2 id="title">Welcome to Ember</h2>
<Tomster />
<FileJavaScript class={{styles.large}} />

{{outlet}}
</template>
4 changes: 4 additions & 0 deletions examples/vite-ember/app/templates/application.module.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.large {
width: 50px;
height: 50px;
}
51 changes: 51 additions & 0 deletions examples/vite-ember/babel.config.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
const { buildMacros } = require('@embroider/macros/babel')

const macros = buildMacros()

module.exports = {
plugins: [
[
'@babel/plugin-transform-typescript',
{
allExtensions: true,
onlyRemoveTypeImports: true,
allowDeclareFields: true,
},
],
[
'babel-plugin-ember-template-compilation',
{
compilerPath: 'ember-source/dist/ember-template-compiler.js',
enableLegacyModules: [
'ember-cli-htmlbars',
'ember-cli-htmlbars-inline-precompile',
'htmlbars-inline-precompile',
],
transforms: [...macros.templateMacros],

},
],
[
'module:decorator-transforms',
{
runtime: {
import: require.resolve('decorator-transforms/runtime-esm'),
},
},
],
[
'@babel/plugin-transform-runtime',
{
absoluteRuntime: __dirname,
useESModules: true,
regenerator: false,
},
],
...macros.babelMacros,

],

generatorOpts: {
compact: false,
},
}
16 changes: 16 additions & 0 deletions examples/vite-ember/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>EmberViteExample</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body>
<script type="module">
import Application from './app/app';

Application.create({});
</script>
</body>
</html>
42 changes: 42 additions & 0 deletions examples/vite-ember/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
{
"name": "ember-vite-example",
"type": "module",
"private": true,
"license": "MIT",
"exports": {
"./tests/*": "./tests/*",
"./*": "./app/*"
},
"engines": {
"node": ">= 22"
},
"scripts": {
"start": "vite"
},
"devDependencies": {
"@babel/core": "^7.27.1",
"@babel/plugin-transform-runtime": "^7.27.1",
"@babel/plugin-transform-typescript": "^7.27.1",
"@babel/runtime": "^7.27.1",
"@ember/app-tsconfig": "^1.0.3",
"@embroider/core": "^4.1.0",
"@embroider/macros": "^1.18.0",
"@embroider/router": "^3.0.1",
"@embroider/vite": "^1.1.5",
"@glimmer/component": "^2.0.0",
"@glint/ember-tsc": "^1.0.3",
"@glint/template": "^1.6.1",
"@glint/tsserver-plugin": "^2.0.3",
"@iconify-json/devicon": "^1.2.29",
"@iconify-json/logos": "^1.2.5",
"@rollup/plugin-babel": "^6.0.4",
"@types/rsvp": "^4.0.9",
"babel-plugin-ember-template-compilation": "^2.4.1",
"decorator-transforms": "^2.3.0",
"ember-source": "~6.7.0",
"ember-strict-application-resolver": "0.1.0",
"typescript": "^5.8.3",
"unplugin-icons": "workspace:*",
"vite": "^7.1.9"
}
}
17 changes: 17 additions & 0 deletions examples/vite-ember/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"extends": "@ember/app-tsconfig",
"compilerOptions": {
"paths": {
"ember-vite-example/tests/*": ["./tests/*"],
"ember-vite-example/*": ["./app/*"],
"*": ["./types/*"]
},
"types": [
"ember-source/types",
"@embroider/core/virtual",
"vite/client",
"unplugin-icons/types/ember"
],
"allowJs": true
}
}
18 changes: 18 additions & 0 deletions examples/vite-ember/vite.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { ember, extensions } from '@embroider/vite'
import { babel } from '@rollup/plugin-babel'
import Icons from 'unplugin-icons/vite'
import { defineConfig } from 'vite'

export default defineConfig({
plugins: [
ember(),
Icons({
compiler: 'ember',
}),
// extra plugins here
babel({
babelHelpers: 'runtime',
extensions,
}),
],
})
19 changes: 19 additions & 0 deletions examples/webpack-ember/.ember-cli
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
/**
Setting `isTypeScriptProject` to true will force the blueprint generators to generate TypeScript
rather than JavaScript by default, when a TypeScript version of a given blueprint is available.
*/
"isTypeScriptProject": false,

/**
Setting `componentAuthoringFormat` to "strict" will force the blueprint generators to generate GJS
or GTS files for the component and the component rendering test. "loose" is the default.
*/
"componentAuthoringFormat": "loose",

/**
Setting `routeAuthoringFormat` to "strict" will force the blueprint generators to generate GJS
or GTS templates for routes. "loose" is the default
*/
"routeAuthoringFormat": "loose"
}
18 changes: 18 additions & 0 deletions examples/webpack-ember/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# compiled output
/dist/
/declarations/

# dependencies
/node_modules/

# misc
/.env*
/.pnp*
/.eslintcache
/coverage/
/npm-debug.log*
/testem.log
/yarn-error.log

# broccoli-debug
/DEBUG/
9 changes: 9 additions & 0 deletions examples/webpack-ember/app/app.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import Application from '@ember/application'
import config from 'ember-example/config/environment'
import Resolver from 'ember-resolver'

export default class App extends Application {
modulePrefix = config.modulePrefix
podModulePrefix = config.podModulePrefix
Resolver = Resolver
}
Loading
Loading