PyCharm 2025.1 Help

Angular

Angular is a popular framework for building cross-platform applications. PyCharm provides support for Angular and helps you on every step of the development process – from creating a new Angular app and working on the components to debugging and testing it.

Before you start

  1. Make sure you have Node.js on your computer.

  2. Make sure the JavaScript and TypeScript and Angular and AngularJS required plugins are enabled on the Settings | Plugins page, tab Installed. For more information, refer to Managing plugins.

Create a new Angular application

The recommended way to start building a new Angular application is Angular CLI, which PyCharm downloads and runs for you using npx. As a result, your application is bootstrapped with a ready-to-use TypeScript and Webpack configuration.

Of course, you can download Angular CLI yourself or create an empty PyCharm project and install Angular in it.

Create a new Angular app

  1. Click Create New Project on the Welcome screen or select File | New | Project from the main menu. The New Project dialog opens.

  2. In the left-hand pane, choose Angular CLI.

  3. Specify the path to the folder where the project-related files will be stored.

  4. In the Node Interpreter field, specify the Node.js interpreter to use. Select a configured interpreter from the list or choose Add to configure a new one.

  5. From the Angular CLI list, select npx --package @angular/cli ng.

    Alternatively, for npm version 5.1 and earlier, install the @angular/cli package yourself by running npm install -g @angular/cli in the Terminal Alt+F12. When creating an application, select the folder where the @angular/cli package is stored.

  6. Optionally:

    • In the Additional parameters field, specify the extra ng new options to pass to Angular CLI. Code completion is available in this field: as you start typing the name of an option or press Ctrl+Space, PyCharm shows you the available options and their description.

    • If you are using Angular version 16 or later, you can also select the Create new project with standalone components checkbox. Learn more from the Angular official website.

  7. When you click Create, PyCharm generates an Angular-specific project with all the required configuration files and downloads all the necessary dependencies.

Create an empty PyCharm project

  1. Click Create New Project on the Welcome screen or select File | New | Project from the main menu. The New Project dialog opens.

  2. In the left-hand pane, choose Empty Project.

  3. Specify the path to the folder where the project-related files will be stored.

  4. When you click Create, PyCharm creates and opens an empty project.

Install Angular in an empty project

  1. Open the empty project where you will use Angular.

  2. In the embedded Terminal (Alt+F12) , type:

    npm install @angular/core

    That will install the core Angular package with the critical runtime parts of the framework.

You may also need to install other packages that are parts of Angular, refer to the list of packages.

Start with an existing Angular application

To continue developing an existing Angular application, open it in PyCharm and download the required dependencies.

Open the application sources that are already on your machine

  • Click Open on the Welcome screen or select File | Open from the main menu. In the dialog that opens, select the folder where your sources are stored.

Check out the application sources from your version control

  1. Click Clone Repository on the Welcome screen.

    Alternatively, select File | New | Project from Version Control or Git | Clone or VCS | Get from Version Control from the main menu.

    Instead of Git in the main menu, you may see any other Version Control System that is associated with your project. For example, Mercurial or Perforce.

  2. In the dialog that opens, select your version control system from the list and specify the repository to check out the application sources from. For more information, refer to Check out a project (clone).

Download the dependencies

  • Click Run 'npm install' or Run 'yarn install' in the popup:

    Open an application and download the dependencies

    You can use npm, Yarn 1, or Yarn 2, refer to npm and Yarn for details.

  • Alternatively, select Run 'npm install' or Run 'yarn install' from the context menu of package.json in the editor or in the Project tool window Alt+1.

Project security

When you open a project that was created outside PyCharm and was imported into it, PyCharm displays a dialog where you can decide how to handle this project with unfamiliar source code.

Untrusted project warning

Select one of the following options:

  • Preview in Safe Mode: in this case, PyCharm opens the project in a preview mode. It means that you can browse the project's sources but you cannot run tasks and script or run/debug your project.

    PyCharm displays a notification on top of the editor area, and you can click the Trust project link and load your project at any time.

  • Trust Project: in this case, PyCharm opens and loads a project. That means the project is initialized, project's plugins are resolved, dependencies are added, and all PyCharm features are available.

  • Don't Open: in this case, PyCharm doesn't open the project.

Learn more from Project security.

Write and edit your code

This chapter provides Angular-specific hints. For general guidelines, refer to Work with source code and TypeScript.

Configure the Angular Language Service

PyCharm provides full Angular-specific coding assistance including code completion, error detection and highlighting, hints, and navigation inside Angular templates. You can configure to get coding assistance for Angular projects from the Angular Language Service, from the TypeScript Language Service or only from the internal PyCharm parser and code inspections.

By default, the Angular Language Service is enabled and is listed in the Language services wizard on the Status bar.

  1. To open the Angular settings, click the Language Services running on current file icon on the Status bar and click the Open Settings icon.

    Angular Language Service widget

    Alternatively, press Ctrl+Alt+S to open settings and select Settings | Languages & Frameworks | TypeScript | Angular.

  2. Specify the service to get coding assistance for .ts files from.

    • By default, the Auto option is selected so PyCharm automatically enables Angular Language Service in any appropriate context. As a result, type evaluation is performed based on the data from the TypeScript Language Service while internal PyCharm inspections are also applied.

    • Select the Disabled option to get coding assistance based only on the data from the internal PyCharm parser and inspections.

Restart the Angular Language Service

  • Click the Language Services running on current file icon on the Status bar and then click the Restart Service icon next to Angular TypeScript <version>.

    Angular Language Service widget - Restart Service

Configure type evaluation

  • Click the Service-Powered Type Engine icon on the Status bar and select the checkboxes next to the services from which you want to get type evaluation. Restart PyCharm, when ready.

    Service-Powered Type Engine widget

  • Alternatively, press Ctrl+Alt+S to open settings and select Settings | Languages & Frameworks | TypeScript | Angular, select Auto, and then select Enable service-powered type engine checkbox.

    By default, the checkbox is cleared, so type evaluation, resolution, code inspections and refactorings are based on the type information from the PyCharm internal TypeScript engine.

    This default behavior may result in performance issues and in bugs in type resolution because the type evaluation algorithm that the PyCharm internal TypeScript engine uses differs from the algorithm of the Angular Language Service. Selecting the checkbox may help avoid these problems.

Components

With PyCharm, you can create Angular components in several ways:

Create a component using a predefined template

PyCharm provides predefined live templates for creating Angular components, such as a-component, a-component-inline, and a-component-root.

Create an Angular component using a predefined code snippet

For more information about live templates, refer to Live templates.

To view a full list of predefined templates, open the Settings dialog (Ctrl+Alt+S) , go to Editor | Live Templates, and expand the Angular node.

  1. In the editor, press Ctrl+J, select the appropriate template (for example, a-component) from the list, and then press Enter.

  2. PyCharm generates a component stub, places the caret at a field with canvas, and waits for you to specify the component name there. As you type the component name, the name of the selector and the template URL are filled in automatically in accordance with the Angular Style Guide.

  3. If necessary, make the new component standalone using the inspection pop-up.

    Make component standalone

Learn how to customize a template with variables from Using and Creating Code Snippets in WebStorm Blog.

Create a component folder

In PyCharm, you can create a bunch of files for an Angular component in one action and even place them all in a separate folder. To do that, you need to use a file template with several child templates. When you create a file from the parent template, the related files from the child templates are generated automatically. For more information, refer to Templates with multiple files.

Suppose you want to create an example folder with a bunch of component files, for example, example.component.ts for logic, example.component.html for the template, and example.component.css for styles. You can create a file template with two parent templates so all the three files will be generated at once and placed in a separate folder.

  1. In the Settings dialog (Ctrl+Alt+S) , select Editor | File and Code Templates.

  2. First create a template for a TypeScript component file:

    1. In the Files tab, click the Add button (the Create Template button) on the toolbar.

      Add new template

      A new, Unnamed, template is added to the list.

    2. In the right-hand pane, specify the template name, let it be Angular Component, and component.ts as the file extension.

    3. In the File name field, type $NAME/$NAME.

    4. Optionally, add a code template, for example:

      /* * Created by ${USER} on ${DATE} */ import { Component } from '@angular/core';
    Create parent template

    Click Apply.

  3. Create a child template for the related HTML file:

    1. Select the parent template Angular Component and click the Create Child Template File button the Create Child Template File on the toolbar.

      Add child template icon

      A child template is added below the Angular Component template.

    2. In the right-hand pane, type $NAME/$NAME in the File name field and specify the component.html extension.

    Create child template: component.html

    Click Apply.

  4. Create a child template for the related Style Sheet.

    1. Select the parent template Angular Component and click the Create Child Template File on the toolbar. A child template is added below the Angular Component template.

    2. In the right-hand pane, type $NAME/$NAME in the File name field and specify the component.css extension.

  5. Click OK to save the templates.

  6. Create the component files.

    From the context menu of the folder where you want to store the component files, select New | Angular Component. In the dialog that opens, specify the name that will be used for the folder and for the component files in it (example in this example).

    Create an Angular component from a multiple files template in a separate folder

Extract a component from a template

The Extract Angular component refactoring works by running ng generate component, taking schematic preferences inside your angular.json file into account.

  1. In an HTML template file, select the code fragment that you want to extract into an Angular component.

  2. From the context menu of the selection, choose Refactor | Extract Component.

    Alternatively, press Ctrl+Alt+Shift+T and select Extract Component from the Refactor This popup.

    Extract a component: Refactor This

  3. In the dialog that opens, specify the name of the new component.

Standalone components

If your project uses Angular 19, Components, Pipes and Directives are by default standalone. For components that are declared via NgModules, set standalone: false.

PyCharm detects incorrect imports of non-standalone pipes, directives or components and usages of the imports property within non-standalone components:

Incorrect usage imports directives in non-standalone components

Signals

With PyCharm, you can easily create Angular signals straight from signal, computed, and effect templates.

Angular signals

Create signals

  1. Write the function you need. PyCharm runs an inspection and highlights the new function as unresolved.

  2. Hover over the highlighted function and click the Create signal '<function name>' link in the popup.

    Create Angular signal: inspection popup

    Alternatively, place the cursor at the highlighted function, press Alt+Enter, and select Create signal '<function name>'.

    Create Angular signal: intention action

  3. PyCharm brings you to the component TypeScript file where a stub of the new signal is generated. Fill in the placeholders as necessary.

PyCharm recognizes, highlights, provides documentation and completion, and supports navigation for contentChild, contentChilden, viewChild, and viewChildren signal queries.

Configure highlighting for Angular signals

  1. Press Ctrl+Alt+S to open settings and select Editor | Color Scheme | Angular Template.

  2. Select Signal in the list and click the color indication next to Foreground.

    Angular signal: configure highlighting

  3. Select the color you prefer and click Apply.

Structural directives

PyCharm recognizes structural directives and provides highlighting within templates.

For binding keys and template context properties, completion is suggested in a popup:

Structural directives - completion

Rename refactoring is provided for template binding keys mapped to directive inputs.

Parameter info popup shows automatically on completing attributes or on pressing Ctrl+P.

Structural directives - parameter info popup

Host listeners and bindings

PyCharm provides full support for host listeners and bindings.

  • Completion, highlighting, quick documentation for @HostListener and @HostBinding decorators.

    Support for @HostListener and HostBinding decorators

  • Event completion for @HostListener

    event completion for HostListeners

  • Type Check Blocks (TCB) are generated for host binding.

  • Support for CSS classes across host bindings and HTML templates

    Usages of CSS classes in host bindings

Reactive forms

PyCharm provides support for Angular Reactive Forms.

  • Building nested form group model structure from field initializer with the new FormGroup({.. .}) and with FormBuilder.group({...}) calls as well as field initialization in a constructor with the FormBuilder.group({...}) call.

    PyCharm recognizes control, group and array within the form group object initializer, new instance calls (FormGroup, FormControl and FormArray), and as well as FormBuilder methods.

    Completion and quick doc in Reactive Forms

  • For FormGroup.get() call, PyCharm provides code completion, name validation, quick fixes for unknown segments and syntax highlighting within the string literals.

    Completion and quick doc in FormGroup.get()

  • For formControlName, formGroupName, and formArrayName in HTML templates, code completion, name validation, quick fixes to create missing control, syntax highlighting, and structural dependency is provided.

    Structural dependency in Reactive Forms

Incremental hydration

PyCharm supports Angular 19 @defer hydrate syntax.

  • Code completion

    Code completion for @defer syntax

  • Quick documentation lookup

    Quick documentation for @defer syntax

  • Error reporting for Angular version earlier than 19.

    Error messages for @defer syntax in Angular earlier than 19

Wrap HTML templates in Control Flow blocks

  • In an Angular HTML template, select a code fragment, press Ctrl+Alt+T, and then select the enclosing code from the list.

    Wrap HTML block

Add new features with ng add

You can add most published Angular libraries using the Angular Dependency action. This action runs the ng add command which installs the dependency and updates the app in the current working directory to use that dependency. Note that not all libraries support installation with ng add.

  1. Select File | New from the main menu or press Alt+Insert in the Project tool window Alt+1, and then select Angular Dependency.

  2. From the list, select the library to add. The list shows the libraries that can be definitely installed with ng add. To install a package that is not on the list, scroll to its end and double-click the Install package not listed above link, then specify the package name in the dialog that opens.

  3. Follow the steps of the wizard.

    The example below illustrates adding Angular Material to a project.

    Adding Angular Material to a project with ng add

If you manage dependencies manually through your package.json, PyCharm still recognizes packages that support ng add. When you add such package to package.json, PyCharm suggests installing it with ng add.

PyCharm suggests adding a dependency with ng add

Generate code with Angular Schematics

PyCharm can generate code using both schematics defined in libraries like @angular/material and those defined in Angular CLI itself.

  1. Select File | New from the main menu or press Alt+Insert in the Project tool window, and then select Angular Schematic.

  2. From the list, select the relevant schematic. Start typing the name of the schematics, the list shrinks as you type.

    Choosing Angular Schematic

  3. In the dialog that opens, specify the name of the schematic to be generated and additional options, if necessary. PyCharm shows the description of the schematic and provides code completion and description for available options.

    Generating Angular CLI schematic: code completion and description is provided

View parameter hints

In Angular HTML templates, Parameter hints show the names of parameters in methods and functions to make your code easier to read. In templates, information on block parameters is shown on completion.

Configure parameter hints

  1. Open the Settings dialog (Ctrl+Alt+S) and go to Editor | Inlay Hints.

  2. Expand Angular HTML template under Parameter names.

  3. Specify the context in which you want parameter hints shown by selecting the corresponding checkboxes.

    The preview shows how the changes you make in the settings affect the code appearance.

  4. For some methods and functions, PyCharm does not show parameter hints in any context. Click Exclude list... to view these methods and functions, possibly enable parameter hints for them, or add new items to the list.

  5. To hide parameter hints for any value type in any context, clear the Angular HTML template checkbox under Parameter names.

Configure parameter hints in Angular templates

Inspect your code

PyCharm brings a number of Angular-specific inspections that help you find errors as you edit your code and suggest quick-fixes for them.

Duplicate properties

In the example below, both a template and a templateUrl properties are used. PyCharm detects the error, warns you about it, and suggests a quick-fix.

Angular inspection: duplicate properties

Incorrect use of structural directives

PyCharm warns you about incorrect use of the *ngIf and *ngFor structural directives.

Angular inspection: incorrect use of structural directive

Use of standalone components

Angular-specific inspections help you identify improper usage of standalone components. In the example below, PyCharm detects an import statement for a component that is not standalone and suggests a quick-fix for the problem.

A non-standalone is imported directly

Unused imports

In standalone components, PyCharm detects import statements for unused components, pipes, and directives and suggests removing them.

Angular inspection - unused import

Unused import statements can be also removed automatically on reformatting a file (Ctrl+Alt+Shift+L).

Quick-fixes and context-aware actions

You may find it handy to use quick-fixes for creating @Input and @Output properties from Angular component templates, both with or without a transform property. Note that the required import statements are also generated automatically.

Quick-fix to generate @Input and @Output properties

PyCharm also provides context-aware Create Field and Create Method actions that help you generate properly declared fields.

View and configure Angular-specific inspections

  1. In the Settings dialog (Ctrl+Alt+S) , go to Editor | Inspections.

  2. Expand the Angular node.

  3. Configure inspection profiles and severity, disable and suppress predefined inspections, and create custom ones as described in Code inspections.

Navigate through an Angular application

When working on Angular projects you have to jump between different component files, such as TypeScript, template, and style files. To navigate around your code, you can use the following options:

Also, you can download the Angular CLI QuickSwitch plugin and install it on your computer.

Navigate with the Related Symbol popup

  1. To call the Related Symbol popup with a list of related files, perform one of the following actions:

    • Press Ctrl+Alt+Home.

    • Select Navigate | Related Symbol from the main menu.

    • Right-click any area in the editor and select Go To | Related Symbol.

    In a TypeScript component file, the popup also lists all the symbols that were imported into this file.

    Navigating through an Angular app using the Related Symbol popup

  2. To open a file, select it and press Enter. Alternatively, use the numbers associated with each file type:

    1. The TypeScript file with the component class

    2. Template

    3. Tests

    4. Styles

Navigate with usages

  • Place the caret at the declaration of a symbol and press Ctrl+B.

    If the symbol is used only once, PyCharm brings you to this usage and highlights it.

    If several usages are found, PyCharm shows them in a popup. Select the usage to navigate to and press Enter or just click it in the list.

  • Place the caret at the declaration of a symbol and press Ctrl+Alt+F7.

    Use the icons on the toolbar to show or hide references to components in import statements (the Show import statements button), in string literals (the Show Dynamic Usages button), and in HTML files (the Show Component Usages icon.

  • Click the Show usages hint to jump to the usage or to select the relevant one from the list.

Use Angular Material Design components

PyCharm recognizes Angular Material components and attributes and provides coding assistance for them:

  • Completion for components

    A list of suggested completion variants for an Angular component

  • Completion for attributes

    A list of suggested completion variants for an Angular attribute

  • Navigation between a component or an attribute and its declaration (press Ctrl+B or select Go To | Declaration from the context menu).

Install Angular Material

  • Open the embedded Terminal (Alt+F12) and type ng add @angular/material.

  • Add "@angular/material": "^16.2.11" under dependencies in your package.json and run npm install.

  • In the main menu, go to File | New | Angular Dependency, then select @angular/material from the list and follow the steps of the wizard that starts.

    AInstall Angualar Material

Learn more from Getting Started on the Angular Material official website.

Configure syntax highlighting

In an Angular project, PyCharm recognizes and highlights various symbols, such as CSS classes and properties, HTML attributes and tags, as well as Angular input and output bindings. The occurrences of these symbols are highlighted in various contexts, such as HTML attributes or JavaScript string literals.

Highlighting symbols in various contexts

You can configure Angular-aware syntax highlighting according to your preferences and habits.

  1. In the Settings dialog (Ctrl+Alt+S) , go to Editor | Color Scheme | Angular Template.

  2. Select the color scheme, accept the highlighting settings inherited from the defaults or customize them as described in Colors and fonts.

Use several frameworks within a project

Sometimes you may need to use other frameworks within one Angular project.

To get context-aware coding assistance in each file, create a configuration file .ws-context and specify which framework should be used in each particular file or folder. The settings from this file will override the default configuration.

  1. In the project root, select New | File from the context menu and specify .ws-context as the file name.

  2. In .ws-context, use two types of properties:

    • <context-name> with the context value string

    • A GLOB pattern with a context details object

  3. Use the following context values:

    • framework: vue, angular, react, svelte, astro

    • angular-template-syntax: V_2, V_17

    • nextjs-project: nextjs

    • astro-project: astro

    • vue-store: vuex, pinia

    • vue-class-component-library: vue-class-component, vue -property-decorator, vue-facing-decorator

    • jsdoc-dialect: jsdoc-typescript, jsdoc-closure

  4. Use path nesting for simplicity.

    • The last segment of a GLOB path is the file name pattern, it only supports the * wildcard.

    • If the last segment is a ** it matches all nested directories and files.

    • Top level context properties should have the /** pattern.

  5. When several patterns match the same file name, the following rules are used for disambiguation:

    • Choose the pattern with maximum number of path segments, excluding ** segments.

    • Choose the pattern that is a pure file name pattern, which means that it does not end in ** or /.

    • Choose the pattern that was defined first.

Example

Suppose you have a project with a number of frameworks used in various folders.

A project with different frameworks

To get context-aware assistance for each file in the project, add the following code to .ws-context:

{ "framework": "vue", "angular-template-syntax": "V_2", "src/**/app/**": { "framework": null, "app.component.html" : { "framework": "angular", "angular-template-syntax": "V_17" } }, "src/**/p*-editor/*.html" : { "framework" : "angular" } }
Last modified: 10 April 2025
JavaScriptRun and debug Angular applications