Language and framework-specific guidelines
JavaScript
JavaScript documentation look-up

JavaScript documentation look-up

Last modified: 11 October 2023

Required plugin:

Javascript and TypeScript - The plugin is bundled with CLion and enabled by default.

CLion shows you reference for standard JavaScript APIs, for symbols from your project and from its dependencies, as well as for symbols defined in external libraries. You can view the documentation for symbols in the Documentation popup and open documentation on external sites if links to them are available.

For a project symbol or for a symbol from the project dependencies, CLion generates the documentation from the corresponding JSDoc comment.
For a standard JavaScript object or method, CLion shows the corresponding JSDoc comment from the built-in TypeScript definition files d.ts. These files are bundled with CLion and updated on a regular basis.
If no comment is found in the d.ts files, CLion shows a summary from the corresponding MDN article.

By default, documentation is shown in the Documentation popup but you can configure it to appear in the Documentation tool window.

Quick Documentation in a popup

Hover over the necessary symbol in the editor.
Place the caret at the symbol and press Ctrl0Q or select View | Quick Documentation from the main menu.
Press Ctrl0Q again to open this documentation in the Documentation tool window.
Click in the popup to change the font size, display the quick documentation toolbar, or go to the source code.

note
To toggle the focus of the Quick Documentation popup and the Documentation Tool Window, press Ctrl0Q sequentially.

Click in the popup to change the font size, display the quick documentation toolbar, or go to the source code.

MDN documentation for symbols

In the Documentation popup Ctrl0Q, click the link at the bottom:
Press ShiftF1 or select View | External Documentation from the main menu.

CLion opens the MDN article in the default CLion browser.

Documentation for third-party JavaScript libraries

Download the required library or framework, configure it as an external JavaScript library, and specify the link to its external documentation. For more information, refer to Configuring a custom third-party JavaScript library.
Place the caret at the symbol and press ShiftF1 or choose View | External Documentation from the main menu.

Documentation for npm packages

In a package.json file or in a require or import statement, place the caret at the name of the package and press Ctrl0Q
To open the documentation on the npm official website in the browser, press ShiftF1.

Thanks for your feedback!

Was this page helpful?

JavaScript documentation look-up﻿

Quick Documentation in a popup﻿

note

MDN documentation for symbols﻿

Documentation for third-party JavaScript libraries﻿

Documentation for npm packages﻿

JavaScript documentation look-up

Quick Documentation in a popup

MDN documentation for symbols

Documentation for third-party JavaScript libraries

Documentation for npm packages