diff --git a/docs/api.md b/docs/api.md index 15240d5f1..6dc6d3d63 100644 --- a/docs/api.md +++ b/docs/api.md @@ -70,7 +70,7 @@ var selectize = $select[0].selectize; getAdjacentOption(value, direction) - Retrieves the jQuery element for the previous or next option, relative to the currently highlighted option. The `direction` argument should be 1 for "next" or -1 for "previous". + Retrieves the jQuery element for the previous or next option, relative to the currently highlighted option. The direction argument should be 1 for "next" or -1 for "previous". refreshOptions(triggerDropdown) @@ -88,7 +88,7 @@ var selectize = $select[0].selectize; clear(silent) - Resets / clears all selected items from the control. If `silent` is truthy, no change event will be fired on the original input. + Resets / clears all selected items from the control. If silent is truthy, no change event will be fired on the original input. getItem(value) @@ -96,15 +96,15 @@ var selectize = $select[0].selectize; addItem(value, silent) - "Selects" an item. Adds it to the list at the current caret position. If `silent` is truthy, no change event will be fired on the original input. + "Selects" an item. Adds it to the list at the current caret position. If silent is truthy, no change event will be fired on the original input. removeItem(value, silent) - Removes the selected item matching the provided value. If `silent` is truthy, no change event will be fired on the original input. + Removes the selected item matching the provided value. If silent is truthy, no change event will be fired on the original input. createItem(value, callback) - Invokes the `create` method provided in the Selectize settings that should provide the data for the new item, given the user input. Once this completes, it will be added to the item list. + Invokes the create method provided in the Selectize settings that should provide the data for the new item, given the user input. Once this completes, it will be added to the item list. refreshItems() @@ -122,7 +122,7 @@ var selectize = $select[0].selectize; addOptionGroup(id, data) - Registers a new optgroup for options to be bucketed into. The `id` argument refers to a value of the property in option identified by the `optgroupField` setting. + Registers a new optgroup for options to be bucketed into. The id argument refers to a value of the property in option identified by the optgroupField setting. removeOptionGroup(id) @@ -221,7 +221,7 @@ var selectize = $select[0].selectize; getValue() - Returns the value of the control. If multiple items can be selected with a "select" input tag (e.g. <select multiple>), this returns an array. Otherwise, returns a string (separated by `delimiter` if "multiple"). + Returns the value of the control. If multiple items can be selected with a "select" input tag (e.g. <select multiple>), this returns an array. Otherwise, returns a string (separated by delimiter if "multiple"). setValue(value, silent) @@ -229,7 +229,7 @@ var selectize = $select[0].selectize; setCaret(index) - Moves the caret to the specified position (`index` being the index in the list of selected items). + Moves the caret to the specified position (index being the index in the list of selected items). isFull() @@ -237,7 +237,7 @@ var selectize = $select[0].selectize; clearCache(template) - Clears the render cache. Takes an optional template argument (e.g. `option` , `item`) to clear only that cache. + Clears the render cache. Takes an optional template argument (e.g. option , item) to clear only that cache. updatePlaceholder() @@ -268,7 +268,7 @@ var selectize = $select[0].selectize; tokens - An array containing parsed search tokens. A token is an object containing two properties: `string` and `regex` . + An array containing parsed search tokens. A token is an object containing two properties: string and regex . array @@ -278,7 +278,7 @@ var selectize = $select[0].selectize; items - A list of matched results. Each result is an object containing two properties: `score` and `id` . + A list of matched results. Each result is an object containing two properties: score and id . array diff --git a/docs/events.md b/docs/events.md index 5dec543fb..bf65d69be 100644 --- a/docs/events.md +++ b/docs/events.md @@ -104,7 +104,7 @@ selectize.off('event_name', handler); "load" data - Invoked when new options have been loaded and added to the control (via the `load` option or `load` API method). + Invoked when new options have been loaded and added to the control (via the load option or load API method). "destroy" diff --git a/docs/usage.md b/docs/usage.md index 26ca75dfa..b5349d816 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -46,21 +46,21 @@ $(function() { delimiter - The string to separate items by. When typing an item in a multi-selection control allowing creation, then the delimiter, the item is added. If you paste delimiter-separated items in such control, the items are added at once. The deimiter is also used in the `getValue` API call on a text <input> tag to separate the multiple values. + The string to separate items by. When typing an item in a multi-selection control allowing creation, then the delimiter, the item is added. If you paste delimiter-separated items in such control, the items are added at once. The deimiter is also used in the getValue API call on a text <input> tag to separate the multiple values. string ',' create - Allows the user to create new items that aren't in the initial list of options. This setting can be any of the following: `true` , `false` (disabled), or a function that accepts two arguments: `input` and `callback`. The callback should be invoked with the final data for the option. - boolean/function + Allows the user to create new items that aren't in the initial list of options. This setting can be any of the following: true , false (disabled), or a function that accepts two arguments: input and callback. The callback should be invoked with the final data for the option. + boolean|function false createOnBlur - If true, when user exits the field (clicks outside of input), a new option is created and selected (if `create` setting is enabled). + If true, when user exits the field (clicks outside of input), a new option is created and selected (if create setting is enabled). boolean false @@ -68,7 +68,7 @@ $(function() { createFilter Specifies a RegExp or a string containing a regular expression that the current search filter must match to be allowed to be created. May also be a predicate function that takes the filter text and returns whether it is allowed. - RegExp/string/function + RegExp|string|function null @@ -145,13 +145,13 @@ $(function() { preload - If true, the `load` function will be called upon control initialization (with an empty search). Alternatively it can be set to `'focus'` to call the `load` function when control receives focus. + If true, the load function will be called upon control initialization (with an empty search). Alternatively it can be set to 'focus' to call the load function when control receives focus. boolean/string false dropdownParent - The element the dropdown menu is appended to. This should be `'body'` or `null`. If null, the dropdown will be appended as a child of the Selectize control. + The element the dropdown menu is appended to. This should be 'body' or null. If null, the dropdown will be appended as a child of the Selectize control. string null @@ -194,7 +194,7 @@ $(function() { optgroups - Option groups that options will be bucketed into. If your element is a <select> with <optgroup>s this property gets populated automatically. Make sure each object in the array has a property named whatever `optgroupValueField` is set to. + Option groups that options will be bucketed into. If your element is a <select> with <optgroup>s this property gets populated automatically. Make sure each object in the array has a property named whatever optgroupValueField is set to. array [] @@ -206,7 +206,7 @@ $(function() { valueField - The name of the property to use as the `value` when an item is selected. + The name of the property to use as the value when an item is selected. string 'value' @@ -238,7 +238,7 @@ $(function() { sortField A single field or an array of fields to sort by. Each item in the array should be an object containing at - least a `field` property. Optionally, `direction` can be set to `'asc'` or `'desc'` . The + least a field property. Optionally, direction can be set to 'asc' or 'desc' . The order of the array defines the sort precedence.

Unless present, a special `$score` field will be automatically added to the beginning @@ -257,7 +257,7 @@ $(function() { searchConjunction - When searching for multiple terms (separated by space), this is the operator used. Can be `'and'` or `'or'` . + When searching for multiple terms (separated by space), this is the operator used. Can be 'and' or 'or' . string 'and' @@ -290,7 +290,7 @@ $(function() { score(search) - Overrides the scoring function used to sort available options. The provided function should return a function that returns a number greater than or equal to zero to represent the `score` of an item (the function's first argument). If 0, the option is declared not a match. The `search` argument is a Search object. For an example, see the "GitHub" example. + Overrides the scoring function used to sort available options. The provided function should return a function that returns a number greater than or equal to zero to represent the score of an item (the function's first argument). If 0, the option is declared not a match. The search argument is a Search object. For an example, see the "GitHub" example. function null @@ -374,7 +374,7 @@ $(function() { onLoad(data) - Invoked when new options have been loaded and added to the control (via the `load` option or `load` API method). + Invoked when new options have been loaded and added to the control (via the load option or load API method). function null @@ -384,8 +384,8 @@ $(function() { render - Custom rendering functions. Each function should accept two arguments: `data` and `escape` and return HTML (string) with a single root element. - The `escape` argument is a function that takes a string and escapes all special HTML characters. + Custom rendering functions. Each function should accept two arguments: data and escape and return HTML (string) with a single root element. + The escape argument is a function that takes a string and escapes all special HTML characters. This is very important to use to prevent XSS vulnerabilities. @@ -398,7 +398,7 @@ $(function() { - + @@ -406,7 +406,7 @@ $(function() { - +
option_createThe "create new" option at the bottom of the dropdown. The data contains one property: `input` (which is what the user has typed).The "create new" option at the bottom of the dropdown. The data contains one property: input (which is what the user has typed).
optgroup_header
optgroupThe wrapper for an optgroup. The `html` property in the data will be the raw html of the optgroup's header and options.The wrapper for an optgroup. The html property in the data will be the raw html of the optgroup's header and options.