Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 20 additions & 0 deletions packages/angular/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,23 @@ $ npx schematics @ionic/angular:ng-add


You'll now be able to add ionic components to a vanilla Angular app setup.

## 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`.
5 changes: 5 additions & 0 deletions packages/angular/common/ng-package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"lib": {
"entryFile": "src/index.ts"
},
}
3 changes: 3 additions & 0 deletions packages/angular/common/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
// This is required to get ng-packagr to build.
// Remove this when you actually have something to export
export const placeholder = true;
5 changes: 5 additions & 0 deletions packages/angular/standalone/ng-package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"lib": {
"entryFile": "src/index.ts"
},
}
3 changes: 3 additions & 0 deletions packages/angular/standalone/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
// This is required to get ng-packagr to build.
// Remove this when you actually have something to export
export const placeholder = true;