diff options
Diffstat (limited to 'doc/development/fe_guide/droplab/droplab.md')
| -rw-r--r-- | doc/development/fe_guide/droplab/droplab.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/development/fe_guide/droplab/droplab.md b/doc/development/fe_guide/droplab/droplab.md index fe0f07b3019..8f1ecc115fe 100644 --- a/doc/development/fe_guide/droplab/droplab.md +++ b/doc/development/fe_guide/droplab/droplab.md @@ -1,7 +1,7 @@ --- stage: none group: unassigned -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # DropLab @@ -22,7 +22,7 @@ The value is irrelevant. The DropLab class has no side effects, so you must always call `.init` when the DOM is ready. `DropLab.prototype.init` takes the same arguments as `DropLab.prototype.addHook`. -If you don't provide any arguments, it will globally query and instantiate all +If you don't provide any arguments, it globally queries and instantiates all DropLab-compatible dropdowns. ```html @@ -103,7 +103,7 @@ droplab.addHook(trigger, list); ### Dynamic data -Adding `data-dynamic` to your dropdown element will enable dynamic list +Adding `data-dynamic` to your dropdown element enables dynamic list rendering. You can template a list item using the keys of the data object provided. Use the @@ -111,7 +111,7 @@ handlebars syntax `{{ value }}` to HTML escape the value. Use the `<%= value %>` syntax to interpolate the value. Use the `<%= value %>` syntax to evaluate the value. -Passing an array of objects to `DropLab.prototype.addData` will render that data +Passing an array of objects to `DropLab.prototype.addData` renders that data for all `data-dynamic` dropdown lists tracked by that DropLab instance. ```html @@ -227,14 +227,14 @@ provides some potentially useful data. Plugins are objects that are registered to be executed when a hook is added (when a DropLab trigger and dropdown are instantiated). -If no modules API is detected, the library will fall back as it does with -`window.DropLab` and will add `window.DropLab.plugins.PluginName`. +If no modules API is detected, the library falls back as it does with +`window.DropLab` and adds `window.DropLab.plugins.PluginName`. ### Usage To use plugins, you can pass them in an array as the third argument of `DropLab.prototype.init` or `DropLab.prototype.addHook`. Some plugins require -configuration values; the config object can be passed as the fourth argument. +configuration values; the configuration object can be passed as the fourth argument. ```html <a href="#" id="trigger" data-dropdown-trigger="#list">Toggle</a> |