vscode-docs/docs/languages/html.md

8.8 KiB

Order Area TOCTitle ContentId PageTitle DateApproved MetaDescription
4 languages HTML 43095EAF-4B93-407C-A6F9-6DB173D79088 HTML Programming with Visual Studio Code 10/29/2024 Get the best out of Visual Studio Code for HTML development

HTML in Visual Studio Code

Visual Studio Code provides basic support for HTML programming out of the box. There is syntax highlighting, smart completions with IntelliSense, and customizable formatting. VS Code also includes great Emmet support.

IntelliSense

As you type in HTML, we offer suggestions via HTML IntelliSense. In the image below, you can see a suggested HTML element closure </div> as well as a context specific list of suggested elements.

HTML IntelliSense

Document symbols are also available for HTML, allowing you to quickly navigate to DOM nodes by id and class name.

You can also work with embedded CSS and JavaScript. However, note that script and style includes from other files are not followed, the language support only looks at the content of the HTML file.

You can trigger suggestions at any time by pressing kb(editor.action.triggerSuggest).

You can also control which built-in code completion providers are active. Override these in your user or workspace settings if you prefer not to see the corresponding suggestions.

// Configures if the built-in HTML language suggests HTML5 tags, properties and values.
"html.suggest.html5": true

Close tags

Tag elements are automatically closed when > of the opening tag is typed.

HTML Close1

The matching closing tag is inserted when / of the closing tag is entered.

HTML Close2

You can turn off autoclosing tags with the following setting:

"html.autoClosingTags": false

Auto update tags

When modifying a tag, the linked editing feature automatically updates the matching closing tag. The feature is optional and can be enabled by setting:

"editor.linkedEditing": true

Color picker

The VS Code color picker UI is now available in HTML style sections.

color picker in HTML

It supports configuration of hue, saturation and opacity for the color that is picked up from the editor. It also provides the ability to trigger between different color modes by clicking on the color string at the top of the picker. The picker appears on a hover when you are over a color definition.

Hover

Move the mouse over HTML tags or embedded styles and JavaScript to get more information on the symbol under the cursor.

HTML Hover

Validation

The HTML language support performs validation on all embedded JavaScript and CSS.

You can turn that validation off with the following settings:

// Configures if the built-in HTML language support validates embedded scripts.
"html.validate.scripts": true,

// Configures if the built-in HTML language support validates embedded styles.
"html.validate.styles": true

Folding

You can fold regions of source code using the folding icons on the gutter between line numbers and line start. Folding regions are available for all HTML elements for multiline comments in the source code.

Additionally you can use the following region markers to define a folding region: <!-- #region --> and <!-- #endregion -->

If you prefer to switch to indentation based folding for HTML use:

"[html]": {
    "editor.foldingStrategy": "indentation"
},

Formatting

To improve the formatting of your HTML source code, you can use the Format Document command kb(editor.action.formatDocument) to format the entire file or Format Selection kb(editor.action.formatSelection) to just format the selected text.

The HTML formatter is based on js-beautify. The formatting options offered by that library are surfaced in the VS Code settings:

  • setting(html.format.wrapLineLength): Maximum amount of characters per line.
  • setting(html.format.unformatted): List of tags that shouldn't be reformatted.
  • setting(html.format.contentUnformatted): List of tags, comma separated, where the content shouldn't be reformatted.
  • setting(html.format.extraLiners): List of tags that should have an extra newline before them.
  • setting(html.format.preserveNewLines): Whether existing line breaks before elements should be preserved.
  • setting(html.format.maxPreserveNewLines): Maximum number of line breaks to be preserved in one chunk.
  • setting(html.format.indentInnerHtml): Indent <head> and <body> sections.
  • setting(html.format.wrapAttributes): Wrapping strategy for attributes:
    • auto: Wrap when the line length is exceeded
    • force: Wrap all attributes, except first
    • force-aligned: Wrap all attributes, except first, and align attributes
    • force-expand-multiline: Wrap all attributes
    • aligned-multiple: Wrap when line length is exceeded, align attributes vertically
    • preserve: Preserve wrapping of attributes
    • preserve-aligned: Preserve wrapping of attributes but align
  • setting(html.format.wrapAttributesIndentSize): Alignment size when using force aligned and aligned multiple in setting(html.format.wrapAttributes) or null to use the default indent size.
  • setting(html.format.templating): Honor django, erb, handlebars and php templating language tags.
  • setting(html.format.unformattedContentDelimiter): Keep text content together between this string.

Tip: The formatter doesn't format the tags listed in the setting(html.format.unformatted) and setting(html.format.contentUnformatted) settings. Embedded JavaScript is formatted unless 'script' tags are excluded.

The Marketplace has several alternative formatters to choose from. If you want to use a different formatter, define "html.format.enable": false in your settings to turn off the built-in formatter.

Emmet snippets

VS Code supports Emmet snippet expansion. Emmet abbreviations are listed along with other suggestions and snippets in the editor auto-completion list.

Emmet HTML support built-in

Tip: See the HTML section of the Emmet cheat sheet for valid abbreviations.

If you'd like to use HTML Emmet abbreviations with other languages, you can associate one of the Emmet modes (such as css, html) with other languages with the setting(emmet.includeLanguages) setting. The setting takes a language identifier and associates it with the language ID of an Emmet supported mode.

For example, to use Emmet HTML abbreviations inside JavaScript:

{
    "emmet.includeLanguages": {
        "javascript": "html"
     }
}

We also support User Defined Snippets.

HTML custom data

You can extend VS Code's HTML support through a declarative custom data format. By setting setting(html.customData) to a list of JSON files following the custom data format, you can enhance VS Code's understanding of new HTML tags, attributes and attribute values. VS Code will then offer language support such as completion & hover information for the provided tags, attributes and attribute values.

You can read more about using custom data in the vscode-custom-data repository.

HTML extensions

Install an extension to add more functionality. Go to the Extensions view (kb(workbench.view.extensions)) and type 'html' to see a list of relevant extensions to help with creating and editing HTML.

Tip: Click on an extension tile above to read the description and reviews to decide which extension is best for you. See more in the Marketplace.

Next steps

Read on to find out about:

Common questions

Does VS Code have HTML preview?

No, VS Code doesn't have built-in support for HTML preview but there are extensions available in the VS Code Marketplace. Open the Extensions view (kb(workbench.view.extensions)) and search on 'live preview' or 'html preview' to see a list of available HTML preview extensions.