mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-14 16:52:26 +08:00

Files

Brandy Smith 08e3e7ab51 fix(angular): update schematics to support Angular's latest build system (#30525 )

Issue number: resolves ionic-team/ionic-docs#2091

---------

## What is the current behavior?
Documentation to test `ng add` schematic for @ionic/angular is outdated
& it fails when running with:
```
Invalid projectType for my-app: undefined
```

## What is the new behavior?
Fix the schematic to support the latest Angular build system & update
the documentation for testing local Ionic Framework with `ng add`.

## Does this introduce a breaking change?

- [ ] Yes
- [x] No

## Other information

_I am using `Angular CLI: 20.0.4`_

Run these commands first to see the error: 
```sh
ng new my-app --style=css --ssr=false --zoneless=false
cd my-app
ng add @ionic/angular --skip-confirmation
```

Switch to this branch (`fix-angular-schematics`) and then follow the
[new
steps](b9b345303c/packages/angular/README.md (testing-local-ionic-framework-with-ng-add))
and confirm the error is gone.

--------

`Co-authored-by: soundproofboot <colinedwinbares@gmail.com>`

---------

Co-authored-by: Brandy Smith <6577830+brandyscarney@users.noreply.github.com>

2025-07-02 15:23:43 +00:00

3.3 KiB

Raw Permalink Blame History

@ionic/angular

Ionic Angular specific building blocks on top of @ionic/core components.

License

Testing Local Ionic Framework with `ng add`

This guide shows you how to test the local Ionic Framework build with a new Angular application using ng add. This is useful for development and testing changes before publishing.

Prerequisites

Node.js and npm installed
Angular CLI installed globally (npm install -g @angular/cli)

Build Local Ionic Framework

Clone the repository (if not already done):

git clone https://github.com/ionic-team/ionic-framework.git
cd ionic-framework

Pull the latest from main
```
git pull origin main
```
Install dependencies and build the core package:
```
cd core
npm install
npm run build
```
Install dependencies, sync the core build and build the Angular package:
```
cd ../packages/angular
npm install
npm run sync
npm run build
```
Create a tarball:
```
cd dist
npm pack
```

Copy the tarball to Downloads:

cp ionic-angular-*.tgz ~/Downloads/ionic-angular.tgz

Test with New Angular App

Create a new Angular app:

# Change to whichever directory you want the app in
cd ~/Documents/
ng new my-app --style=css --ssr=false --zoneless=false
cd my-app

Install the local @ionic/angular package:

npm install ~/Downloads/ionic-angular.tgz

Run ng add:

ng add @ionic/angular --skip-confirmation

Serve the app:
```
ng serve
```

The local Ionic Framework build is now active in the Angular app. Changes to the Ionic source code require rebuilding the packages and reinstalling the tarball to see updates.

Project Structure

common

This is where logic that is shared between lazy loaded and standalone components live. For example, the lazy loaded IonPopover and standalone IonPopover components extend from a base IonPopover implementation that exists in this directory.

Note: This directory exposes internal APIs and is only accessed in the standalone and src submodules. Ionic developers should never import directly from @ionic/angular/common. Instead, they should import from @ionic/angular or @ionic/angular/standalone.

standalone

This is where the standalone component implementations live. It was added as a separate entry point to avoid any lazy loaded logic from accidentally being pulled in to the final build. Having a separate directory allows the lazy loaded implementation to remain accessible from @ionic/angular for backwards compatibility.

Ionic developers can access this by importing from @ionic/angular/standalone.

src

This is where the lazy loaded component implementations live.

Ionic developers can access this by importing from @ionic/angular.

3.3 KiB Raw Permalink Blame History