PyCharm 2024.3 Help

Emmet

The Emmet toolkit enhances coding with HTML, CSS, and JSX. You can use Emmet code templates without leaving PyCharm. To expand a template into the correct markup, type its abbreviation and press Tab. To replace Tab with another key, refer to Configure the abbreviation expansion key.

For example, in an HTML file, type table>tr*3>td*2 and press Tab to get a stub of a 3 × 2 table:

<table> <tr> <td></td> <td></td> </tr> <tr> <td></td> <td></td> </tr> <tr> <td></td> <td></td> </tr> </table>

As a more complex example, let's type table#myid>tr.row$*3>td*2 and press Tab to get the same table but with the id attribute and a custom class for each table row:

<table id="myid"> <tr class="row1"> <td></td> <td></td> </tr> <tr class="row2"> <td></td> <td></td> </tr> <tr class="row3"> <td></td> <td></td> </tr> </table>

For more information, refer to Emmet Cheat Sheet.

PyCharm supports such features as new syntax for writing RGBA colors, implied, default, and boolean attributes, the Update Tag action, and more.

Enable and configure Emmet

With PyCharm, you can use native Emmet templates plus more than 200 additional HTML, CSS, and XSL live templates that are listed under the Zen CSS, Zen HTML, and Zen XSL nodes on the Editor | Live Templates settings page  Ctrl+Alt+S.

  1. Press Ctrl+Alt+S to open settings and then select Editor | Emmet.

  2. On the Emmet page that opens, choose the key to expand Emmet abbreviations with, by default Tab is selected.

  3. To enable or disable Emmet in a specific language (HTML, CSS, or JSX), go to Editor | Emmet | <Language> and toggle the Enable <Language> Emmet checkbox. Use the controls on the Emmet page to configure Emmet in various language contexts.

PyCharm lets you use and customize Emmet live templates, or you can add your custom templates. Suppose you have a template entry with the following template text:

<entry type="$TYPES$">$END$ <entry>

To generate a list of entries, you just need to type “entry-list<entry[number=$]*5″ and press Tab. By default, the number attribute will be generated before type. To customize the position where it is generated, you need to add the ATTRS variable to your template, for example:

<entry type="$TYPES$" $ATTRS$>$END$ <entry>

The ATTRS variable must have an empty string as the default value and should be skipped.

Use live templates with Emmet

  1. Press Ctrl+Alt+S to open settings and then select Editor | Live Templates.

  2. On the Live Templates page that opens, expand the Zen HTML, Zen CSS, or Zen XSL template group and select the checkboxes next to the templates you want to use.

  3. When you select a template in the list, the focus moves to the Template Text area where the fields show the settings of the selected template.

  4. In the Template Text field, add the required text and variables to the template body.

  5. Click the Edit Variables button. In the Edit Template Variables dialog that opens, specify the default variable values in the Default value field and select the Skip if defined checkbox where necessary.

Configure the abbreviation expansion key

By default, Emmet native abbreviations and additional live templates are expanded by pressing Tab. For additional live templates, PyCharm lets you re-define the default expansion key. Note that this custom setting does not override the default setting for native Emmet support; you will just get the ability to expand the template using either of these keys.

Configure the expansion key for native Emmet abbreviations

  1. Press Ctrl+Alt+S to open settings and then select Editor | Emmet.

  2. On the Emmet page that opens, choose the new expansion key instead of the default Tab from the Expand abbreviation with list.

Configure expansion keys for Emmet live templates

  1. Press Ctrl+Alt+S to open settings and then select Editor | Live Templates.

  2. On the Live Templates page that opens, expand the Zen HTML, Zen CSS, or Zen XSL template group and select the desired template. The focus moves to the Template Text area.

  3. From the Expand with list, choose the key to expand the template with.

Surround a block of code with an Emmet template

  1. In the editor, select a block of code to surround and press Ctrl+Alt+J or select Code | Surround with | Live Template from the main menu .

  2. From the Select Template list, select Emmet:

    Select Template context menu
  3. Type the Emmet abbreviation to use and press Enter.

    Emmet: type abbreviation

    Note the list to the right. Click the down arrow to view the history of recently applied Emmet live templates:

    History of recently applied Emmet live templates

    Also mind the color indication. If you type a valid Emmet abbreviation, the background is green. However, when a non-existent abbreviation is entered, the background turns red:

    The abbreviation you entered does not exist, the background turns red

Navigate between edit points

In HTML and XML, you can navigate between edit points, that is, between those points of code where Emmet templates are applicable.

  • To move the caret to the previous edit point, choose Navigate | Previous Emmet Edit Point, or press Alt+Shift+[.

  • To move the caret to the next edit point, choose Navigate | Next Emmet Edit Point, or press Alt+Shift+].

Last modified: 22 October 2024