uber_select_rails 0.4.6 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e9476e5e12129ec65c9dd22981e3a0bb5f175b151906197517ae33aa4de4266
-  data.tar.gz: 0b792f41ef6e47776b0e011b6c4708eca9fa5e98f07d821bf866727708f4fbbe
+  metadata.gz: 0dad48d52dd5e14c133c8d6c01861f5ae3e9069110df7b8b5faa7840703342f7
+  data.tar.gz: 72be4762c753d35290e7f9d63d6b9575f0967d44d9a9b382d417accb6324fd6b
 SHA512:
-  metadata.gz: ab52406500e12ecfa53a5a44f7c4eb41f67e6b6ccbb28b6f24c54f6390077ce2b76ea0b3be04815ab104008e93aa0acff80121454fdeaeb1b4527bed55891ecf
-  data.tar.gz: 2e76709d02c09e85b8ab0f1f5e3f05d41bdd3ac70cb099e8fabeb5f118e45edc4a0fcdae3c71ee12fbe4e00a563590872be6d068d0c66330746298cc0d754c2f
+  metadata.gz: a39831aaeb705925e5bf27053e4445232096eb8ba8f4e572ce2809a21b1cd4a9f42af62189614089fa7dba4fa9b5f046988fcfea92ce47ee872e76f24692b797
+  data.tar.gz: 98cdf58391fea57de5ac5ea903a72e2d6fb15b67956ec64d0ffcdf73aa3231349f38b1555a31f2422653b2ed6acb37b63882918cbf16856368cb54af42c1924f

data/lib/uber_select_rails/version.rb

@@ -1,3 +1,3 @@
 module UberSelectRails
-  VERSION = "0.4.6"
+  VERSION = "0.6.0"
 end

data/vendor/assets/javascript/uber_select/README.md

@@ -3,13 +3,16 @@
 UberSelect is a fancy UI on top of a regular `<select>` element.
 
 ## Requirements
+
 Tested on jQuery 1.11.x to 3.3.x
 
 ## Parts
+
 UberSelect is composed of two main parts, an UberSearch that does all the of searching and UI, and an UberSelect which
 is used to connect an UberSearch to a `<select>` element.
 
 ### UberSelect
+
 This is the object that allows an UberSearch and a `<select>` element to work together. The select element can be used
 to control the state of the UberSearch, and vice-versa. This means you can programmatically change the state of the
 select, and UberSearch will update. Users can interact with the UberSearch, and the select will update. This also means
@@ -22,38 +25,61 @@ $('.my_selects').uberSelect(options);
 ```
 
 #### Attributes <a name="UberSearch attributes"></a>
+
 Attribtes on the outermost element can be specified by setting the `data-uber-attributes` attribute on the `<select>` element. Values should be passed
 as a JSON string of key/value pairs where the key is the attribute name and the value is the attribute value.
 
 #### Options
+
 Options can be specified by setting the `data-uber-options` attribute on the `<select>` element. Values should be passed
 as a JSON string. All options on the are passed to the underlying UberSearch, see [UberSearch options](#UberSearchOptions).
 
 - ##### prepopulateSearchOnOpen
+
   Determines whether the search input starts with the selected value in it when the pane is opened.
 
   Default: `false`
 
 - ##### clearSearchClearsSelect
+
   Determines whether the select value should be cleared when the search is cleared.
 
   Default: `false`
 
 - ##### placeholder
+
   Placeholder to show in the selected text area.
 
   Default: `<select>` element attributes `<select placeholder="my placeholder" data-placeholder="my placeholder">`
 
-- ##### dataUrl
+- ##### dataUrl <a name="dataUrl"></a>
+
   A url to pre-fetch select options from. JSON response should be of the form
   `[{text:'option with explicit value', value: 'some value'}, {text:'option with implicit value'}]`. For a custom JSON response, use in conjunction with optionFromDatum.
 
   Default: `null`
 
+- ##### dataFormatter
+
+  A function that can modify the data from the dataUrl before it is used.
+
+  The function signature is as follows:
+
+  ```js
+    function(data) {
+      // Modify the data
+
+      return modifiedData
+    }
+  ```
+  See <a href="#dataUrl">dataUrl</a> for details about the expected format of `data`.
+
 - ##### optionFromDatum
+
   A function that is used to customize the options value and text built from a JSON response. `datum` is a single result returned from the JSON response.
 
   The function signature is as follows:
+
   ```js
     function(datum) {
       return // a <option> element to represent the select
@@ -63,25 +89,36 @@ as a JSON string. All options on the are passed to the underlying UberSearch, se
    Default: `datum.value` populates the `<option>` value, `datum.text` populates the `<option>` text.
 
 - ##### value
+
   Initialize the UberSearch with this selected value
 
   Default: `<select>` element `value` property
 
+- ##### ariaLabel
+
+  Add an aria-label attribute with this value to the uber_select element.
+
 #### Events Triggered
+
 - ##### uber-select:ready
+
   This fires when the UberSelect has initialized and is ready for user interaction
 
 #### Events Observed
+
 The `<select>` element observes the following events:
 
 - ##### uber-select:refreshOptions
+
   The UberSearch options list will be updated to match the `<select>` element's `<option>` list.
 
 - ##### uber-select:refresh
+
   The UberSearch will update its selected value to match the `<select>` element's. This handler also runs when the
   `<select>` element triggers a `change` event.
 
 ### UberSearch
+
 The UberSearch performs all of the heavy lifting. It creates the UI views, maintains state, and performs the searching.
 It can be instantiated without the use of an UberSelect, which can be useful for situations where the selected value is
 being used in purely in JS, and not being linked to a `<select>` element in a form.
@@ -93,114 +130,152 @@ new UberSearch(data, options);
 ```
 
 #### Data
+
 Data is an array of objects. Each object may have the following properties:
 
 - ##### text
+
   String shown to the user in the list of results. This value is required if *value* is not provided.
 
 - ##### selectedText
+
   String shown to the user in the output container when this option is selected. *optional*
 
 - ##### title
+
   Title text shown to the user when hovering over the result. *optional*
 
 - ##### value
+
   This is matched against the *value* option passed UberSearch and will appear selected if it matches. It is also used to match against search input text when the user searches. This value is required if *text* is not provided.
 
 - ##### matchValue
+
   This overrides the value used to match against search input text when the user searches. *optional*
 
 - ##### visibility
+
   This is used to determine whether the option appears only when searching or only when not searching. Values accepted: `query`, `no-query`. *optional*
 
 - ##### disabled
+
   This is used to determine whether the option appears disabled. *optional*
 
 - ##### group
+
   This is used to visually group options. All options with the same group will appear together. *optional*
 
 #### Methods
 
 - ##### setData(data)
+
   Sets the data. `data` should be an Array conforming to the specifications described in <a href="#data">Data</a>
 
+- ##### getValue()
+
+  Returns the currently selected value.
+
+- ##### getSelection()
+
+  Returns the currently selected element from the search results.
+
 
 #### Options <a name="UberSearch options"></a>
+
 Options can be specified by setting the `data-uber-options` attribute on the `<select>` element. Values should be passed
 as a JSON string.
 
 - ##### value
+
   Sets the initially selected value of the UberSearch. This value should match the `value` property of the desired
   option data.
 
   Default: `null`
 
 - ##### search
+
   Determines whether the search input be shown.
 
   Default: `true`
 
 - ##### clearSearchButton
+
   Sets the text content of clear search button.
 
   Default: `✕`
 
 - ##### selectCaret
+
   Sets the text content of clear select caret.
 
   Default: `⌄`
 
 - ##### hideBlankOption
+
   Sets whether blank options should be hidden automatically.
 
   Default: `false`
 
 - ##### treatBlankOptionAsPlaceholder
+
   Determines whether the `text` property of an option with a blank `value` property should be used as the placeholder
   text if no placeholder is specified.
 
   Default: `false`
 
 - ##### highlightByDefault
+
   Determines whether the first search result be auto-highlighted.
 
   Default: `true`
 
 - ##### minQueryLength
+
   Sets minimum number of characters the user must type before a search will be performed.
 
   Default: `0`
 
 - ##### minQueryMessage
+
   Sets the message shown to the user when the query doesn't exceed the minimum length. `true` for a default message,
   `false` for none, or provide a string to set a custom message.
 
   Default: `true`
 
 - ##### placeholder
+
   Sets the placeholder shown in the selected text area.
 
   Default: `null`
 
 - ##### searchPlaceholder
+
   Sets the placeholder shown in the search input.
 
   Default: `'Type to search'`
 
 - ##### noResultsText
+
   Sets the message shown when there are no results.
 
   Default: `'No Matches Found'`
 
 - ##### noDataText
+
   Sets the text to show when the results list is empty and no search is in progress
 
   Default: `'No options'`
 
+- ##### searchInputAttributes
+
+  An Object containing attributes to add to the search input element.
+
 - ##### buildResult
+
   A function that is used to build result elements.
 
   The function signature is as follows:
+
   ```js
     function(listOptionData) {
       return // HTML/element to insert into the the results list
@@ -208,10 +283,12 @@ as a JSON string.
   ```
 
 - ##### resultPostprocessor
+
   A function that is run after a result is built and can be used to decorate it. This can be useful when extending the
   functionality of an existing UberSearch implementation.
 
   The function signature is as follows:
+
   ```js
     function(resultsListElement, listOptionData) { }
   ```
@@ -219,50 +296,63 @@ as a JSON string.
   Default: No-op
 
 - ##### onRender
+
   A function to run when the results container is rendered. If the result returns false, the default `select` event
   handler is not run and the event is cancelled.
 
   The function signature is as follows:
+
   ```js
   function(resultsContainer, searchResultsHTML) { }
   ```
 
 - ##### onSelect
+
   A function to run when a result is selected. If the result returns false, the default `select` event handler is not
   run and the event is cancelled.
 
   The function signature is as follows:
+
   ```js
   function(listOptionData, resultsListElement, clickEvent) { }
   ```
 
 - ##### onNoHighlightSubmit
+
   A function to run when a user presses enter without selecting a result.
   Should be used in combination with `highlightByDefault: false`.
 
   The function signature is as follows:
+
   ```js
   function(value) { }
   ```
 
 - ##### outputContainer (Deprecated)
+
   An object that receives the output once a result is selected. Must respond to `setValue(value)` and `view()`. This object serves to
   attach the result list to the DOM at the desired location.
 
 #### Events Triggered
+
 - ##### shown
+
   This fires when the UberSearch pane is opened.
 
 - ##### renderedResults
+
   This fires each time the list of results is updated.
 
 - ##### clear
+
   This fires when the user clicks the clear search button.
 
 - ##### select
+
   This fires when the user selects a result.
 
   The handler function signature is as follows:
+
   ```js
   function(event, [listOptionData, resultsContainer, originalEvent]) { }
   ```

data/vendor/assets/javascript/uber_select/javascript/jquery.uber-select.js

@@ -17,6 +17,7 @@
         disabled: $(select).is(':disabled'),                                              // Whether the select is currently disabled
         placeholder: $(select).attr('placeholder') || $(select).attr('data-placeholder'), // Placeholder to show in the selected text area
         dataUrl: null,                                                                    // A url to pre-fetch select options from, see optionsFromData for data format
+        dataFormatter: function(data) { return data },                                    // A function to manipulate data received from the dataUrl before it is used. The function should return an array of data with desired modifications.
         optionFromDatum: optionFromDatum,                                                 // A function to create select options
         value: $(select).val()                                                            // Initialize the UberSearch with this selected value
       }, opts, $(select).data('uber-options'))
@@ -61,6 +62,7 @@
       hideSelect()
       if (options.dataUrl) {
         $.getJSON(options.dataUrl).done(function(data){
+          data = options.dataFormatter(data)
           $(select).append(optionsFromData(data))
           updateSelectValue(options.value)
           uberSearch.setData(dataFromSelect(select))
@@ -134,7 +136,11 @@
 
       // Copies the value of the select into the search input
       function updateSearchValueFromSelect(){
-        uberSearch.searchField.input.val($(select).find('option:selected').text())
+        var index = select.selectedIndex
+
+        if (index == undefined) { return }
+
+        uberSearch.searchField.input.val($(select).find('option').eq(index).text())
         uberSearch.searchField.refresh()
       }
 

data/vendor/assets/javascript/uber_select/javascript/list.js

@@ -7,7 +7,7 @@ function List(options) {
   // BEHAVIOUR
 
   // Handle up and down arrow key presses
-  $(options.keypressInput).on('keydown', function(event){
+  $(options.keypressInput || view).on('keydown', function(event){
     switch (event.which) {
       case 38: // Up Arrow
         stepHighlight(-1, true)
@@ -50,7 +50,7 @@ function List(options) {
 
   // Can be overridden to format how results are built
   this.buildResult = function(datum){
-    return $('<li></li>').html(datum).addClass('result')
+    return $('<li role="option" class="result" tabindex="0"></li>').html(datum)
   }
 
   this.unhighlightResults = unhighlightResults
@@ -73,6 +73,7 @@ function List(options) {
     if (!result.length) { return }
 
     result.addClass('highlighted')
+    result.attr("aria-selected", true)
 
     if (options.scroll){
       scrollResultIntoView(result)
@@ -80,7 +81,7 @@ function List(options) {
   }
 
   function unhighlightResults(){
-    highlightedResult().removeClass('highlighted')
+    highlightedResult().removeClass('highlighted').attr("aria-selected", false)
   }
 
   function highlightedResult(){

data/vendor/assets/javascript/uber_select/javascript/output_container.js

@@ -1,6 +1,6 @@
 var OutputContainer = function(options){
   options = $.extend({}, options)
-  var view         = $('<span class="selected_text_container" tabindex=0 role="button"></span>')
+  var view         = $('<span class="selected_text_container" tabindex="0"></span>')
   var selectedText = $('<span class="selected_text"></span>').appendTo(view)
   var selectCaret  = $('<span class="select_caret"></span>').appendTo(view).html(options.selectCaret)
 

data/vendor/assets/javascript/uber_select/javascript/pane.js

@@ -3,40 +3,31 @@ function Pane(options){
     trigger: null
   }, options)
 
-  var context = this
-  var model = this.model = {}
-  var isOpen = false
-  var view = this.view = $('<div class="pane"></div>').toggle(isOpen)
+  var context   = this
+  var model     = {}
+  var isOpen    = false
+  var view      = $('<div class="pane"></div>').toggle(isOpen)
   var innerPane = $('<div class="pane_inner"></div>').appendTo(view)
 
 
   // PUBLIC INTERFACE
 
-  $.extend(this, {view: view, addContent: addContent, removeContent: removeContent, show: show, hide: hide})
+  $.extend(this, {
+    model:         model,
+    view:          view,
+    addContent:    addContent,
+    removeContent: removeContent,
+    show:          show,
+    hide:          hide,
+    toggle:        toggle,
+    isOpen:        paneIsOpen,
+    isClosed:      paneIsClosed
+  })
 
 
   // BEHAVIOUR
 
-  if (options.trigger){
-    // Show the pane when the select element is clicked
-    $(options.trigger).on('click', function(event){
-      if ($(options.trigger).hasClass('disabled')) { return }
-
-      context.show()
-    })
-
-    // Show the pane if the user was tabbed onto the trigger and pressed enter or space
-    $(options.trigger).on('keyup', function(event){
-      if ($(options.trigger).hasClass('disabled')) { return }
-
-      if (event.which == 13 || event.which == 32){
-        context.show()
-        return false
-      }
-    })
-  }
-
-    // Hide the pane when clicked out
+  // Hide the pane when clicked out
   $(document).on('mousedown', function(event){
     if (isEventOutsidePane(event) && isEventOutsideTrigger(event)){
       context.hide()
@@ -52,13 +43,21 @@ function Pane(options){
   $(document).on('keyup', function(event){
     if (event.which == 27 && isOpen){
       context.hide()
-      options.trigger.focus()
+      return false
     }
   })
 
 
   // HELPER FUNCTIONS
 
+  function paneIsOpen(){
+    return isOpen
+  }
+
+  function paneIsClosed(){
+    return !isOpen
+  }
+
   function addContent(name, content){
     model[name] = content
     innerPane.append(content)
@@ -81,6 +80,13 @@ function Pane(options){
     view.hide()
     $(context).trigger('hidden')
   }
+  function toggle(){
+    if (isOpen) {
+      context.hide()
+    } else {
+      context.show()
+    }
+  }
 
   // returns true if the event originated outside the pane
   function isEventOutsidePane(event){

data/vendor/assets/javascript/uber_select/javascript/search_field.js

@@ -1,11 +1,15 @@
 function SearchField(options){
   options = $.extend({
     placeholder: 'Type to Search',
+    searchInputAttributes: { 'aria-label': "Type to Search" },
     clearButton:'✕' // Text content of clear search button
   }, options)
 
+  var inputAttrs = {}
+  $.extend(inputAttrs, { placeholder: options.placeholder }, options.searchInputAttributes)
+    
   var context     = this
-  var input       = this.input       = $('<input type="search" class="search_input">').attr('placeholder', options.placeholder)
+  var input       = this.input       = $('<input type="search" class="search_input">').attr(inputAttrs)
   var value       = input.val()
   var clearButton = this.clearButton = $('<span class="clear_search_button"></span>').html(options.clearButton)
   var view        = this.view        = $('<span class="search_field_container"></span>').append(input).append(clearButton)

data/vendor/assets/javascript/uber_select/javascript/uber_search.js

@@ -7,6 +7,7 @@ var UberSearch = function(data, options){
   }
 
   options = $.extend({
+    ariaLabel: null,
     value: null,                                      // Initialize with this selectedValue
     disabled: false,                                  // Initialize with this disabled value
     search: true,                                     // Show the search input
@@ -30,14 +31,22 @@ var UberSearch = function(data, options){
   }, options)
 
   var context          = this
-  var view             = $('<span class="uber_select"></span>')
+  var view             = $('<span class="uber_select" role="listbox"></span>')
   var selectedValue    = options.value // Internally selected value
   var outputContainer  = options.outputContainer || new OutputContainer({selectCaret: options.selectCaret})
-  var searchField      = new SearchField({placeholder: options.searchPlaceholder, clearButton: options.clearSearchButton})
   var resultsContainer = $('<div class="results_container"></div>')
   var messages         = $('<div class="messages"></div>')
-  var pane             = new Pane({trigger: outputContainer.view})
-  var search           = new Search(searchField.input, resultsContainer, {
+  var pane             = new Pane()
+
+  if (options.ariaLabel) { view.attr("aria-label", options.ariaLabel) }
+
+  var searchField = new SearchField({
+      placeholder: options.searchPlaceholder,
+      clearButton: options.clearSearchButton,
+      searchInputAttributes: options.searchInputAttributes
+  })
+
+  var search = new Search(searchField.input, resultsContainer, {
     model: {
       dataForMatching: dataForMatching,
       minQueryLength: options.minQueryLength,
@@ -48,23 +57,56 @@ var UberSearch = function(data, options){
     view: {
       renderResults: renderResults,
       buildResult: options.buildResult || buildResult,
-      keypressInput: searchField.input
+      keypressInput: options.search ? searchField.input : null
     }
   })
 
 
   // BEHAVIOUR
 
+  // Show the pane when the select element is clicked
+  $(outputContainer.view).on('click', function(event){
+    if (outputContainer.view.hasClass('disabled')) { return }
+
+    pane.show()
+  })
+
+  // Show the pane if the user was tabbed onto the trigger and pressed enter, space, or down arrow
+  $(outputContainer.view).on('keyup', function(event){
+    if (outputContainer.view.hasClass('disabled')) { return }
+
+    if (event.which === 32 || event.which === 40 && pane.isClosed()){
+      pane.show()
+      return false
+    }
+    else if (event.which === 13){ // toggle pane when enter is pressed
+      pane.toggle()
+      return false
+    }
+  })
+
   // When the pane is opened
   $(pane).on('shown', function(){
     search.clear()
     markSelected()
-    $(searchField.input).focus()
     view.addClass('open')
 
+    if (options.search) {
+      $(searchField.input).focus()
+    } else {
+      pane.view.find("ul.results li:first").focus()
+    }
+
     triggerEvent(eventsTriggered.shown)
   })
 
+
+  // When the pane is hidden
+  $(pane).on('hidden', function(){
+    view.removeClass('open')
+    view.focus()
+  })
+
   // When the query is changed
   $(search).on('queryChanged', function(){
     updateMessages()
@@ -96,6 +138,8 @@ var UberSearch = function(data, options){
       return
     }
 
+    event.stopPropagation();
+
     setValue(valueFromResult(this))
     pane.hide()
     triggerEvent(eventsTriggered.select, [datum, this, event])
@@ -106,20 +150,13 @@ var UberSearch = function(data, options){
     options.onNoHighlightSubmit($(this).val())
   })
 
-   // When the pane is hidden
-  $(pane).on('hidden', function(){
-    view.removeClass('open')
-  })
-
 
   // INITIALIZATION
 
   setDisabled(options.disabled)
   setData(data)
 
-  if (options.search){
-    pane.addContent('search', searchField.view)
-  }
+  if (options.search) { pane.addContent('search', searchField.view) }
   pane.addContent('messages', messages)
   pane.addContent('results', resultsContainer)
 
@@ -152,6 +189,11 @@ var UberSearch = function(data, options){
     markSelected()
   }
 
+  // Returns the selected value
+  function getValue(){
+    return selectedValue
+  }
+
   // Enables or disables UberSearch
   function setDisabled(boolean){
     outputContainer.setDisabled(boolean)
@@ -239,7 +281,7 @@ var UberSearch = function(data, options){
   }
 
   function buildResult(datum){
-    var result = $('<li class="result"></li>')
+    var result = $('<li class="result" tabindex="0"></li>')
       .html((options.treatBlankOptionAsPlaceholder ? datum.text || options.placeholder : datum.text) || "&nbsp;")
       .data(datum) // Store the datum so we can get know what the value of the selected item is
 
@@ -325,5 +367,5 @@ var UberSearch = function(data, options){
 
   // PUBLIC INTERFACE
 
-  $.extend(this, {view:view,  searchField:searchField, setValue:setValue, setData:setData, setDisabled:setDisabled, options:options})
+  $.extend(this, {view:view,  searchField:searchField, setValue:setValue, getValue: getValue, setData:setData, setDisabled:setDisabled, getSelection:getSelection, options:options})
 }

data/vendor/assets/javascript/uber_select/test.html

@@ -18,7 +18,7 @@
 
 <span class="example">
   <label for="select">
-  search and placeholder
+  Search and placeholder
   </label>
   <select placeholder="Choose a gender">
     <option></option>
@@ -31,6 +31,17 @@
   </p>
 </span>
 
+<span class="example">
+  <label for="select">
+  Search input attributes
+  </label>
+  <select data-uber-options='{"searchInputAttributes": {"aria-label": "This is a test"}}'>
+    <option></option>
+    <option>male</option>
+    <option>female</option>
+  </select>
+  <p>This example includes an aria label attribute for the search input element.</p>
+</span>
 
 <span class="example">
   <label for="select">

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uber_select_rails
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.6.0
 platform: ruby
 authors:
 - Nicholas Jakobsen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-08 00:00:00.000000000 Z
+date: 2022-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -99,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: A Rails gem containing a javascript plugin that adds a layer of UI goodness