Skip to content
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.

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

missing documentation for Angular 17's standalone mode #1282

Closed
rwaskiewicz opened this issue Dec 1, 2023 · 1 comment
Closed

missing documentation for Angular 17's standalone mode #1282

rwaskiewicz opened this issue Dec 1, 2023 · 1 comment

Comments

@rwaskiewicz
Copy link
Member

In Angular v17, the Angular CLI generates applications in with components that use standalone mode by default. As a result, app.module.ts is not generated when a new application is generated.

The Stencil documentation, as written today, assumes the existence of said module in "Creating a Consumer Angular App":

From your Angular workspace (/packages/angular-workspace), run the following command to generate an Angular application:

npx -p @angular/cli ng generate app my-app

We then ask folks to modify the module in the subsequent section, "Consuming the Angular Wrapper Components":

If you distributed your components through a primary NgModule, you can simply import that module into an implementation to use your components.

// app.module.ts

import { ComponentLibraryModule } from 'component-library';

@NgModule({
imports: [ComponentLibraryModule],
})
export class AppModule {}

Moving forward, we should handle both pre and post-Angular 17. A few things we _could_ do:
- Inform folks of using `--standalone=false` when spinning up a component 
- Update the documentation to consume the libraries differently
@rwaskiewicz
Copy link
Member Author

Closing. Fixed by #1284

If anyone should have questions surrounding the documentation, please feel free to open a new issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant