Skip to content

Commit 4332200

Browse files
committed
improve documentation of plugin hook
1 parent 5eed96b commit 4332200

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

index.js

+7-4
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,14 @@ export default {
55
/**
66
* Vue's plugin install hook.
77
*
8-
* Collects all available plugins and maintains a list of hooks.
8+
* Collects all available plugins and maintains a list of hooks, pointing to them.
99
* @param {Object} Vue The main Vue instance
10-
* @param {Object} options An object of available options:
11-
* "plugins": a Vue component (or list of components) that fits this
12-
* extension.
10+
* @param {Object} options An named index of objects:
11+
* "plugins": a named index of modules that export a plugin:
12+
* name: the name of the plugin
13+
* hooks: named index of hooks, each pointing to a list of Vue components
14+
* implementing that hook. They will be rendered at each extensionpoint
15+
* that has the same hook name.
1316
*/
1417
install: (Vue, options) => {
1518

0 commit comments

Comments
 (0)