Include fixed Action Items in lookup menu and include them in arrow down navigation

Author: donnieberg

components/SLDSLookup/Menu/ActionItem/index.jsx

@@ -0,0 +1,41 @@
+/*
+Copyright (c) 2015, salesforce.com, inc. All rights reserved.
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+Neither the name of salesforce.com, inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+import React, { Component } from 'react';
+import {Icon} from "../../../SLDSIcons";
+
+class ActionItem extends React.Component {
+  constructor(props) {
+    super(props);
+  }
+
+  componentWillReceiveProps(nextProps){
+    if(nextProps.isActive !== this.props.isActive && nextProps.isActive === true) this.props.setFocus(this.props.id);
+  }
+
+  render(){
+    let className = 'slds-button';
+    if(this.props.isActive) className += ' slds-theme--shade'
+
+    return (
+      <button id={this.props.id} tabIndex="-1" className={className} onClick={this.props.onSelect} onMouseDown={this.props.onSelect}>
+      <Icon name={this.props.icon} category="utility" size="x-small" className="slds-icon-text-default" />
+      {this.props.children}
+      </button>
+    )
+  }
+}
+
+ActionItem.propTypes = {
+};
+
+ActionItem.defaultProps = {
+};
+
+module.exports = ActionItem;

components/SLDSLookup/Menu/Item/index.jsx

@@ -17,7 +17,7 @@ class Item extends React.Component {
   }
 
   componentWillReceiveProps(nextProps){
-    if(nextProps.isActive !== this.props.isActive && (nextProps.isActive === true)){
+    if(nextProps.isActive !== this.props.isActive && nextProps.isActive === true){
       this.scrollFocus();
       this.props.setFocus(this.props.id);
     }
@@ -33,20 +33,14 @@ class Item extends React.Component {
   }
 
   handleClick(e){
-    e.preventDefault();
-    if(e.nativeEvent){
-      e.nativeEvent.preventDefault();
-      e.nativeEvent.stopImmediatePropagation();
-    }
+    EventUtil.trapImmediate(e);
     return this.props.onSelect(this.props.id);
   }
 
   //Scroll menu item based on up/down mouse keys (assumes all items are the same height)
   scrollFocus(){
     const height = React.findDOMNode(this).offsetHeight;
-    if(height && this.props.handleItemFocus){
-      this.props.handleItemFocus(this.props.index,height);
-    }
+    if(height && this.props.handleItemFocus) this.props.handleItemFocus(this.props.index,height);
   }
 
   render(){
@@ -56,9 +50,7 @@ class Item extends React.Component {
 
     return (
       //IMPORTANT: anchor id is used to set lookup's input's aria-activedescendant
-      <li
-        className={className}
-        role="presentaion">
+      <li className={className} role="presentaion">
         <a
           href={this.props.href}
           id={id}
@@ -76,15 +68,17 @@ class Item extends React.Component {
 }
 
 Item.propTypes = {
+  key: React.PropTypes.string,
   id: React.PropTypes.string,
   href: React.PropTypes.string,
+  type: React.PropTypes.string,
   searchTerm: React.PropTypes.string,
+  index: React.PropTypes.number,
   isActive: React.PropTypes.bool,
   isDisabled: React.PropTypes.bool,
   setFocus: React.PropTypes.func,
-  scrollFocus: React.PropTypes.func,
+  handleItemFocus: React.PropTypes.func,
   onSelect: React.PropTypes.func,
-handleItemFocus: React.PropTypes.func,
 };
 
 Item.defaultProps = {

components/SLDSLookup/Menu/index.js

@@ -9,6 +9,7 @@
 
 import React, { Component } from 'react';
 import Item from './Item';
+import ActionItem from './ActionItem';
 import {Icon} from "../../SLDSIcons";
 
 class Menu extends React.Component {
@@ -41,54 +42,55 @@ class Menu extends React.Component {
       return <Item
       key={c.id}
       id={c.id}
-      index={i}
       type={this.props.type}
-      setFocus={this.props.setFocus}
+      searchTerm={this.props.searchTerm}
+      index={i}
       isActive={isActive}
+      setFocus={this.props.setFocus}
       handleItemFocus={this.handleItemFocus.bind(this)}
       onSelect={this.props.onSelect}
-      searchTerm={this.props.searchTerm}>{c}</Item>
+      >
+      {c}
+      </Item>
     });
   }
 
-  renderSearchDetails(){
-    let className = 'slds-button';
-    if(this.props.focusIndex === 0) className += ' slds-theme--shade';
-    return(
-      <button id="searchDetails" tabIndex="-1" className={className}>
-      <Icon name="search" category="utility" size="x-small" className="slds-icon-text-default" />
-      {this.props.searchTerm ? '"' + this.props.searchTerm + '"' : ""} in {this.props.type + 's'}
-      </button>
-    );
-  }
-
-  renderAddItem(){
-    let className = 'slds-button';
-    if(this.props.focusIndex === this.props.listLength + 1) className += ' slds-theme--shade';
-    return(
-      <button id="addItem" tabIndex="-1" className={className} onClick={this.props.addItem} onMouseDown={this.props.addItem}>
-      <Icon name="add" category="utility" size="x-small" className="slds-icon-text-default" />
-      New {this.props.type}
-      </button>
-    );
-  }
-
   render(){
+    let isNewItemBtnActive = false;
+    let isSearchDetailsActive = false;
+    this.props.focusIndex === this.props.listLength + 1 ? isNewItemBtnActive = true : isNewItemBtnActive = false;
+    this.props.focusIndex === 0 ? isSearchDetailsActive = true: isSearchDetailsActive = false;
+
     return (
-      <div
-      className="ignore-react-onclickoutside slds-lookup__menu"
-      role="listbox"
-      ref="scroll">
+      <div className="ignore-react-onclickoutside slds-lookup__menu" role="listbox" ref="scroll">
         <div className="slds-lookup__item">
-          {this.renderSearchDetails()}
+          <ActionItem
+            id='searchDetails'
+            icon='search'
+            type={this.props.type}
+            isActive={isSearchDetailsActive}
+            setFocus={this.props.setFocus}
+            onSelect={this.props.addItem}
+            >
+            {this.props.searchTerm ? '"' + this.props.searchTerm + '"' : ""} in {this.props.type + 's'}
+          </ActionItem>
         </div>
-        <ul className="slds-lookup__list"
-        role="presentation"
-        ref="list">
+
+        <ul className="slds-lookup__list" role="presentation" ref="list">
           {this.renderItems()}
         </ul>
+
         <div className="slds-lookup__item">
-          {this.renderAddItem()}
+          <ActionItem
+            id='addNewItem'
+            icon='add'
+            type={this.props.type}
+            isActive={isNewItemBtnActive}
+            setFocus={this.props.setFocus}
+            onSelect={this.props.addItem}
+            >
+            New {this.props.type}
+          </ActionItem>
         </div>
       </div>
     )
@@ -99,14 +101,14 @@ Menu.propTypes = {
   searchTerm: React.PropTypes.string,
   label: React.PropTypes.string,
   type: React.PropTypes.string,
-  listLength: React.PropTypes.number,
   focusIndex: React.PropTypes.number,
+  listLength: React.PropTypes.number,
   items: React.PropTypes.array,
-  onSelect: React.PropTypes.func,
-  addItem: React.PropTypes.func,
   filterWith: React.PropTypes.func,
-  setFocus: React.PropTypes.func,
   getListLength: React.PropTypes.func,
+  setFocus: React.PropTypes.func,
+  onSelect: React.PropTypes.func,
+  addItem: React.PropTypes.func,
 };
 
 Menu.defaultProps = {

components/SLDSLookup/index.jsx

@@ -48,6 +48,7 @@ class SLDSLookup extends React.Component {
   //=================================================
   // Using down/up keys, set Focus on list item and assign it to aria-activedescendant attribute in input.
   // Need to keep track of filtered list length to be able to increment/decrement the focus index so it's contained to the number of available list items.
+  // Adding/subtracting 1 from focusIndex to account for fixed action items (searchDetails and addNewItem buttons)
   increaseIndex(){
     let items = this.state.listLength;
     this.setState({ focusIndex: this.state.focusIndex <= items ? this.state.focusIndex + 1 : 0 })
@@ -74,6 +75,7 @@ class SLDSLookup extends React.Component {
       selectedIndex: index,
       searchTerm: null
     });
+    if(this.props.onItemSelect) this.props.onItemSelect();
   }
 
   handleDeleteSelected() {
@@ -83,31 +85,35 @@ class SLDSLookup extends React.Component {
     });
   }
 
+  addItem(){
+    if(this.props.onAddItem) this.props.onAddItem();
+  }
+
   //=================================================
   // Event Listeners on Input
   handleClose() {
     this.setState({
       isOpen:false,
       focusIndex:null,
       currentFocus:null,
-    })
+    });
   }
 
   handleClick() {
-    this.setState({isOpen:true})
+    this.setState({isOpen:true});
   }
 
   handleBlur() {
     this.handleClose();
   }
 
   handleFocus() {
-    this.setState({ isOpen:true });
+    this.setState({isOpen:true});
   }
 
   handleChange(event) {
     const target = event.target || event.currentTarget;
-    this.setState({ searchTerm: target.value });
+    this.setState({searchTerm: target.value});
   }
 
   handleKeyDown(event) {
@@ -123,7 +129,7 @@ class SLDSLookup extends React.Component {
       //If user hits up key, advance aria activedescendant to previous item
       else if(event.keyCode === KEYS.UP){
         EventUtil.trapImmediate(event);
-        this.state.focusIndex === null ? this.setState({focusIndex: this.state.listLength}) : this.decreaseIndex();
+        this.state.focusIndex === null ? this.setState({focusIndex: this.state.listLength + 1}) : this.decreaseIndex();
       }
       //If user hits enter/space key, select current activedescendant item
       else if((event.keyCode === KEYS.ENTER || event.keyCode === KEYS.SPACE) && this.state.focusIndex !== null){
@@ -141,29 +147,30 @@ class SLDSLookup extends React.Component {
     if(this.state.isOpen){
       return <Menu
         searchTerm={this.state.searchTerm}
-        filterWith={this.props.filterWith}
-        onSelect={this.selectItem.bind(this)}
         label={this.props.label}
+        type={this.props.type}
+        focusIndex={this.state.focusIndex}
+        listLength={this.state.listLength}
         items={this.props.items}
-        setFocus={this.setFocus.bind(this)}
+        filterWith={this.props.filterWith}
         getListLength={this.getListLength.bind(this)}
-        listLength={this.state.listLength}
-        focusIndex={this.state.focusIndex}
-        addItem={this.props.addItem}
-        type={this.props.type}
+        setFocus={this.setFocus.bind(this)}
+        onSelect={this.selectItem.bind(this)}
+        addItem={this.addItem}
       />;
     }
   }
 
   renderSelectedItem(){
+    let selectedItem = this.props.items[this.state.selectedIndex].label;
     return (
       <div className="slds-pill">
         <a href="#" className="slds-pill__label">
           <Icon name={this.props.type} />
-          {this.props.items[this.state.selectedIndex].label}
+          {selectedItem}
         </a>
         <SLDSButton
-          label='Remove'
+          label={'Remove ' + selectedItem}
           variant='icon'
           iconName='close'
           iconSize='medium'
@@ -218,17 +225,17 @@ SLDSLookup.propTypes = {
   items: React.PropTypes.array,
   label: React.PropTypes.string,
   type: React.PropTypes.string,
-  addItem: React.PropTypes.func,
   filterWith: React.PropTypes.func,
   onItemSelect: React.PropTypes.func,
+  onAddItem: React.PropTypes.func,
 };
 
 SLDSLookup.defaultProps = {
   filterWith: defaultFilter,
   onItemSelect: function(item){
     //console.log('onItemSelect should be defined');
   },
-  addItem: function(event){
+  onAddItem: function(event){
     //console.log('onItemSelect should be defined');
   },
 };