WebStorm 9.0.2 Web Help

JavaScript. Libraries

File | Settings | Languages and Frameworks | JavaScript | Libraries


Use this page to set up additional JavaScript libraries to expand the basic assistance provided through the JavaScript plugin. Note that the JavaScript libraries are global.

In this section:

Libraries

Item Description
Enabled The check boxes in this column show the enabled status of a library:
  • Checked: if a library defined and enabled on a project level is marked with a check sign.
  • Dash: if a library is defined and enabled on a more detailed level, for example, on a directory or file level, it is marked with a dash (-).
  • Cleared: if a check box is cleared, the corresponding library is disabled.
Name This column shows the names of the directories defined for a project.
Type This column shows library types.

Buttons

Item Description
Add Click this button to create a new JavaScript library in the New Library dialog box. Refer to the section Configuring JavaScript Libraries.
Edit Click this button to change the name and contents of the selected library in the Edit Library dialog box.
Remove Click this button to delete the selected library.
Download Click this button to open the Download Library dialog box, where you can have WebStorm download and install one of the popular official JavaScript-related libraries, such as:

Besides the above listed official libraries, you can download stubs for TypeScript definition files.

Choose the group of libraries in the drop-down list. The available options are Official libraries and TypeScript community stubs. Depending on your choice, WebStorm displays a list of available libraries. Select the one to be downloaded and installed, and click Download and Install. You return to the JavaScript Libraries page where the new library is added to the list. CLick OK to save the settings.

Manage scopes Click this button to configure libraries to be used for specific files and/or directories in the JavaScript. Usage Scope dialog box.

New Library / Edit Library Dialog Box

Item Description
Name Specify the library name.
Framework type From this drop-down list, choose the framework to configure as a library.
Version In this text box, specify the version of the selected framework to use.
Visibility In this area, specify where you want the library to be available for associating with files and folders. The available options are:
  • Current project: when this option is chosen, the library can be associated with files and folders within the current project only. If you later try to use the framework with another project, you will have to configure the library anew.
  • Global: choose this option to enable associating the library with any of your WebStorm projects.
Files In this section, set up the library contents.
Attach Click this button to select a JavaScript file or directory from the file system.
Detach Click this button to remove the selected file or directory from a library.
Name This read-only column shows the name of the selected library file or the names of relevant library files from the selected directory.
Type Click the column to show the drop-down list of the available versions of library files or directories: debug or release.

WebStorm enables you to create a library containing just one .js file, if this file is located on the Internet and can be accessed over HTTP. If you refer to a JavaScript library that is not yet available locally, but is available online, use the Download library intention action:

downloadJavascriptLibrary
The library will be placed to the user home directory, and will appear in the list of configured libraries in the JavaScript - Libraries page of the Settings dialog.

See Also

Concepts:

Language and Framework-Specific Guidelines:

Last modified: 11 December 2014
comments powered by Disqus