Angular

Create a component using a predefined template

PhpStorm provides predefined live templates for creating Angular components, such as a-component, a-component-inline, and a-component-root. For details about live templates, see 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. PhpStorm 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.

Gif

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

Create a component folder

In PhpStorm, 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. See Templates with multiple files for details.

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 an 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 () on the toolbar. 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';

   

   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 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.html extension.

   

   Click Apply.

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

   1. Select the parent template Angular Component and click 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 name28 that will be used for the folder and for the component files in it (example in this example).

   

   Gif

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.

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

1. To call a 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.

   

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

1. Select File | New from the main menu or press Alt+Insert in the Project tool window, 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.

   tip

   The list of packages that can be installed with ng add is available on GitHub.

   The example below illustrates adding Angular Material to a project.

   

   Gif

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.

   

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

   

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, PhpStorm 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.

View the list of Angular-specific inspections and configure them

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.

Install Angular Material

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

  • ng add @angular/material for Angular CLI version 6 and later

  • npm install --save @angular/material for earlier versions of Angular CLI

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

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.

1. Select the Angular CLI Server run configuration from the list on the toolbar and click next to the list.

   Alternatively, run npm start in the Terminal Alt+F12, or double-click the start task in the npm tool window (View | Tool Windows | npm), or click in the gutter next to the start script in package.json.

2. Wait till the application is compiled and the Webpack development server is ready.

   The Run tool window or the Terminal shows the URL at which your application is running, by default it is http://localhost:4200/. Click this link to view the application.

   

Debug applications created with Angular CLI

1. Set the breakpoints in your code.

2. Start the application in the development mode as described above and wait till the application is compiled and the development server is ready.

3. Select the autogenerated Angular Application configuration from the list and click the Debug button next to the list.

   

   Gif

Debug applications running on localhost

1. Set the breakpoints in your code.

2. Start the application in the development mode as described above and wait till the application is compiled and the development server is ready.

3. The Run tool window or the Terminal shows the URL at which your application is running, by default it is http://localhost:4200/. Hold Ctrl+Shift and click this URL link. PhpStorm starts a debugging session with an automatically generated Angular Application configuration of the type JavaScript Debug.

   

   Gif

Debug applications running on custom URLs

1. Set the breakpoints in your code.

2. Start the application in the development mode as described above and wait till the application is compiled and the Webpack development server is ready.

3. The Run tool window or the Terminal shows the URL at which your application is running. Copy this URL address, you will later specify it in a debug configuration. To view your application, just click the link.

4. Create a JavaScript Debug configuration. To do that, go to Run | Edit Configurations on the main menu, click , and select JavaScript Debug from the list. In the Run/Debug Configuration: JavaScript Debug dialog, paste the saved URL in the URL field and save the configuration.

5. To launch your newly created configuration, select it from the list of configurations and click next to the list.