JavaScript documentation look-up

Last modified: 26 May 2021

Required plugin: Javascript and TypeScript

The plugin is bundled with RubyMine and enabled by default.

RubyMine 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, get information on method parameters, and open documentation on external sites if links to them are available.

  • For a project symbol or for a symbol from the project dependencies, RubyMine generates the documentation from the corresponding JSDoc comment.

  • For a standard JavaScript object or method, RubyMine shows the corresponding JSDoc comment from the built-in TypeScript definition files d.ts. These files are bundled with RubyMine and updated on a regular basis.

  • If no comment is found in the d.ts files, RubyMine shows a summary from the corresponding MDN article.

View documentation for a symbol

  • Position the caret at the symbol and press Ctrl+Q or select View | Quick Documentation Lookup from the main menu.

  • When you hover the mouse pointer over a symbol, RubyMine immediately displays the reference for it in the Documentation popup.

    You can turn off this behavior or configure the popup to appear faster or slower, see Configuring the behavior of Documentation popup below.

Configure the behavior of Documentation popup

  • To turn off showing documentation automatically, open the Settings/Preferences dialog Ctrl+Alt+S, go to Editor | Code Editing, and clear the Show quick documentation on mouse move checkbox.

  • To have the Documentation popup shown faster or slower, open the Settings/Preferences dialog Ctrl+Alt+S, go to Editor | General | Code Completion, then select the Show the documentation popup checkbox and specify the delay time.

View the MDN documentation for symbols

  • In the Documentation popup Ctrl+Q, click the link at the bottom:

    ws_mdn_docs.png

  • Press Shift+F1 or select View | External Documentation from the main menu.

RubyMine opens the MDN article in the default RubyMine browser.

View documentation for third-party JavaScript libraries

  1. Download the required library or framework, configure it as an external JavaScript library, and specify the link to its external documentation, see Configuring a custom third-party JavaScript library for details.

  2. Position the caret at the symbol in question and press Shift+F1 or choose View | External Documentation from the main menu.

View documentation for npm packages

  • In a package.json file or in a require or import statement, position the caret at the name of the package and press Ctrl+Q

    ws_quick_doc_for_npm_package.png

  • To open the documentation on the npm official website in the browser, press Shift+F1.

View reference in a tool window

  • Pin the Documentation popup. It turns into the Documentation tool window, with the corresponding sidebar icon and more controls.

  • To switch between the Documentation popup and the Documentation tool window, press Ctrl+Q sequentially.

Change the font size of quick documentation

  • Click the Slider icon in the upper-right corner of the quick documentation window, and move the slider.

  • In the Settings/Preferences dialog Ctrl+Alt+S, go to Editor | General and select the Change font size (Zoom) with Ctrl+Mouse Wheel checkbox. See Useful editor configurations for details.

See also

Procedures