├── .gitignore
├── LICENSE
├── README.md
├── images
    └── demo_picklist_select_component.png
└── src
    ├── aura
        └── PicklistSelect
        │   ├── PicklistSelect.cmp
        │   ├── PicklistSelect.cmp-meta.xml
        │   ├── PicklistSelect.design
        │   ├── PicklistSelectController.js
        │   └── PicklistSelectHelper.js
    ├── classes
        ├── PicklistSelectController.cls
        ├── PicklistSelectController.cls-meta.xml
        ├── PicklistSelectControllerTest.cls
        └── PicklistSelectControllerTest.cls-meta.xml
    ├── flexipages
        └── Demo_PicklistSelect_Component.flexipage
    ├── package.xml
    └── tabs
        └── Demo_PicklistSelect_Component.tab


/.gitignore:
--------------------------------------------------------------------------------
1 | config/
2 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | BSD 3-Clause License
 2 | 
 3 | Copyright (c) 2017, Doug Ayers
 4 | All rights reserved.
 5 | 
 6 | Redistribution and use in source and binary forms, with or without
 7 | modification, are permitted provided that the following conditions are met:
 8 | 
 9 | * Redistributions of source code must retain the above copyright notice, this
10 |   list of conditions and the following disclaimer.
11 | 
12 | * Redistributions in binary form must reproduce the above copyright notice,
13 |   this list of conditions and the following disclaimer in the documentation
14 |   and/or other materials provided with the distribution.
15 | 
16 | * Neither the name of the copyright holder nor the names of its
17 |   contributors may be used to endorse or promote products derived from
18 |   this software without specific prior written permission.
19 | 
20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28 | OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Lightning Picklist Field Select Component
 2 | 
 3 | Lightning Component that renders `lightning:select` with options from an sobject picklist field. Ideally, this component shouldn't be needed but as of Winter '16 release the `force:inputField` component has a [bug that when used with picklist fields it renders disabled](https://success.salesforce.com/issues_view?id=a1p3A0000001BaTQAU). Disabled form fields are not conducive to users entering data.
 4 | 
 5 | <a href="https://githubsfdeploy.herokuapp.com">
 6 |   <img alt="Deploy to Salesforce"
 7 |        src="https://raw.githubusercontent.com/afawcett/githubsfdeploy/master/deploy.png">
 8 | </a>
 9 | 
10 | ![screenshot](images/demo_picklist_select_component.png)
11 | 
12 | # Usage
13 | 
14 | The simplest way is to use the component and specify `objectName` and `fieldName` required attributes:
15 | 
16 | ```
17 | <c:PicklistSelect objectName="Account" fieldName="Type"/>
18 | ```
19 | 
20 | Since the standard [lightning:select](https://developer.salesforce.com/docs/atlas.en-us.lightning.meta/lightning/aura_compref_lightning_select.htm) component is used by this component, most of the standard attributes are available to you as well:
21 | 
22 | | Attribute | Description | Required? |
23 | |-----------|-------------|-----------|
24 | | objectName | API name of object | yes |
25 | | fieldName | API name of picklist field | yes |
26 | | label     | Text that describes the desired select input. Default is the field's label. | no |
27 | | value     | The value of the select, also used as the default value to select the right option during init. If no value is provided, the first option will be selected. | no |
28 | | class     | A CSS class that will be applied to the outer element. This style is in addition to base classes associated with the component. | no
29 | | onblur    | The action triggered when the element releases focus. | no |
30 | | onfocus   | The action triggered when the element receives focus. | no |
31 | | onchange  | The action triggered when a value attribute changes. | no |
32 | 


--------------------------------------------------------------------------------
/images/demo_picklist_select_component.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/douglascayers/sfdc-lightning-picklist-field-component/703a09a7d00080408ecff2b64634bf6471299007/images/demo_picklist_select_component.png


--------------------------------------------------------------------------------
/src/aura/PicklistSelect/PicklistSelect.cmp:
--------------------------------------------------------------------------------
 1 | <aura:component controller="PicklistSelectController" implements="force:appHostable,flexipage:availableForAllPageTypes"
 2 |                 description="Renders a lightning:select component with options populated from a picklist field.">
 3 | 	
 4 |     <!-- required -->
 5 |     <aura:attribute name="objectName" type="String" required="true" default="Account"/>
 6 |     <aura:attribute name="fieldName" type="String" required="true" default="Type"/>
 7 | 
 8 |     <!-- optional -->
 9 |     <aura:attribute name="label" type="String" default="Label" description="Text that describes the desired select input. Default is the field's label."/>
10 |     <aura:attribute name="value" type="String" description="The value of the select, also used as the default value to select the right option during init. If no value is provided, the first option will be selected."/>    
11 |     <aura:attribute name="class" type="String" description="A CSS class that will be applied to the outer element. This style is in addition to base classes associated with the component."/>
12 |     
13 |     <!-- event handlers, as exposed by lightning:select component -->
14 |     <aura:attribute name="onblur" type="Aura.Action" description="The action triggered when the element releases focus."/>
15 |     <aura:attribute name="onfocus" type="Aura.Action" description="The action triggered when the element receives focus."/>
16 |     <aura:attribute name="onchange" type="Aura.Action" description="The action triggered when a value attribute changes."/>
17 |     
18 |     <aura:attribute name="options" type="List" access="private" description="The picklist options to choose from. Populated during component initialization."/>
19 |     
20 |     <aura:handler name="init" value="{!this}" action="{!c.doInit}"/>
21 |            
22 |     <lightning:select name="picklistSelect"
23 |                       label="{!v.label}"
24 |                       value="{!v.value}"
25 |                       class="{!v.class}"
26 |                       onblur="{!v.onblur}"
27 |                       onfocus="{!v.onfocus}"
28 |                       onchange="{!v.onchange}">
29 |         
30 |         <aura:iteration var="opt" items="{!v.options}">
31 |             <option value="{!opt.value}">{!opt.label}</option>
32 |         </aura:iteration>
33 |         
34 |     </lightning:select>
35 |     
36 | </aura:component>
37 | 


--------------------------------------------------------------------------------
/src/aura/PicklistSelect/PicklistSelect.cmp-meta.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="UTF-8"?>
2 | <AuraDefinitionBundle xmlns="http://soap.sforce.com/2006/04/metadata">
3 |     <apiVersion>38.0</apiVersion>
4 |     <description>A Lightning Component Bundle</description>
5 | </AuraDefinitionBundle>
6 | 


--------------------------------------------------------------------------------
/src/aura/PicklistSelect/PicklistSelect.design:
--------------------------------------------------------------------------------
1 | <design:component>
2 |     <design:attribute name="objectName" label="Object Name" description="API name of object." required="true" default="Account"/>
3 |     <design:attribute name="fieldName" label="Field Name" description="API name of picklist field." required="true" default="Type"/>
4 | </design:component>


--------------------------------------------------------------------------------
/src/aura/PicklistSelect/PicklistSelectController.js:
--------------------------------------------------------------------------------
 1 | ({
 2 | 	doInit : function(component, event, helper) {
 3 | 
 4 |         helper.callAction( component, 'c.getFieldLabel', {
 5 |             	'objectName' : component.get('v.objectName'),
 6 |             	'fieldName'  : component.get('v.fieldName')
 7 |         	}, function( data ) {
 8 |             component.set('v.label', data);
 9 |         });
10 | 
11 |         helper.callAction( component, 'c.getPicklistOptions', {
12 |             	'objectName' : component.get('v.objectName'),
13 |             	'fieldName'  : component.get('v.fieldName')
14 |         	}, function( data ) {
15 |             component.set('v.options', data);
16 |         });
17 | 
18 | 	}
19 |     
20 | })


--------------------------------------------------------------------------------
/src/aura/PicklistSelect/PicklistSelectHelper.js:
--------------------------------------------------------------------------------
 1 | ({
 2 |     /**
 3 |      * actionName = the apex controller method to call (e.g. 'c.myMethod' )
 4 |      * params = JSON object specifying action parameters (e.g. { 'x' : 42 } )
 5 |      * successCallback = function to call when action completes (e.g. function( response ) { ... } )
 6 |      * failureCallback = function to call when action fails (e.g. function( response ) { ... } )
 7 |      */
 8 |     callAction : function( component, actionName, params, successCallback, failureCallback ) {
 9 |         
10 |         var action = component.get( actionName );
11 |         
12 |         if ( params ) {
13 |             action.setParams( params );
14 |         }
15 |         
16 |         action.setCallback( this, function( response ) {
17 |             if ( component.isValid() && response.getState() === 'SUCCESS' ) {
18 |                 
19 |                 if ( successCallback ) {
20 |                     successCallback( response.getReturnValue() );
21 |                 }
22 |                 
23 |             } else {
24 |                 
25 |                 console.error( 'Error calling action "' + actionName + '" with state: ' + response.getState() );
26 |                 
27 |                 if ( failureCallback ) {
28 |                     failureCallback( response.getError(), response.getState() );
29 |                 } else {
30 |                     this.logActionErrors( component, response.getError() );
31 |                 }
32 |                 
33 |             }
34 |         });
35 |         
36 |         $A.enqueueAction( action );
37 |         
38 |     },
39 |     
40 |     logActionErrors : function( component, errors ) {
41 |         if ( errors ) {
42 |             for ( var index in errors ) {
43 |                 console.error( 'Error: ' + errors[index].message );
44 |             }
45 |         } else {
46 |             console.error( 'Unknown error' );
47 |         }
48 |     }
49 | 
50 | })
51 | 


--------------------------------------------------------------------------------
/src/classes/PicklistSelectController.cls:
--------------------------------------------------------------------------------
 1 | public with sharing class PicklistSelectController {
 2 | 
 3 |     /**
 4 |      * Given an API object and field name, returns the configured field label to display to users.
 5 |      */    
 6 |     @AuraEnabled
 7 |     public static String getFieldLabel( String objectName, String fieldName ) {
 8 |         
 9 |         System.debug( 'Getting field label: objectName=' + objectName + ', fieldName=' + fieldName );
10 |         
11 |         String label = Schema.getGlobalDescribe().get( objectName ).getDescribe().fields.getMap().get( fieldName ).getDescribe().getLabel();
12 |         
13 |         System.debug( 'label= ' + label );
14 |         
15 |         return label;
16 |     }
17 |     
18 |     /**
19 |      * Given an API object and field name, returns list of the picklist values for use in select input.
20 |      */
21 |     @AuraEnabled
22 |     public static List<PicklistOption> getPicklistOptions( String objectName, String fieldName ) {
23 |         
24 |         System.debug( 'Getting picklist options: objectName=' + objectName + ', fieldName=' + fieldName );
25 |         
26 |         List<PicklistOption> options = new List<PicklistOption>();
27 |         
28 |         for ( PicklistEntry entry : Schema.getGlobalDescribe().get( objectName ).getDescribe().fields.getMap().get( fieldName ).getDescribe().getPicklistValues() ) {
29 |             options.add( new PicklistOption( entry.getLabel(), entry.getValue() ) );
30 |         }
31 |         
32 |         System.debug( 'options=' + options );
33 |         
34 |         return options;
35 |     }
36 |     
37 |     /**
38 |      * The system class PicklistEntry is not aura enabled so cannot be returned from @AuraEnabled method.
39 |      * Workaround is to define our own class with aura enabled properties.
40 |      */
41 |     public class PicklistOption {
42 |         
43 |         @AuraEnabled
44 |         public String label { get; set; }
45 |         
46 |         @AuraEnabled
47 |         public String value { get; set; }
48 |         
49 |         public PicklistOption( String label, String value ) {
50 |             this.label = label;
51 |             this.value = value;
52 |         }
53 |         
54 |     }
55 |     
56 | }
57 | 


--------------------------------------------------------------------------------
/src/classes/PicklistSelectController.cls-meta.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="UTF-8"?>
2 | <ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
3 |     <apiVersion>38.0</apiVersion>
4 |     <status>Active</status>
5 | </ApexClass>
6 | 


--------------------------------------------------------------------------------
/src/classes/PicklistSelectControllerTest.cls:
--------------------------------------------------------------------------------
 1 | @isTest
 2 | private class PicklistSelectControllerTest {
 3 | 
 4 |     @isTest
 5 |     static void test_get_field_label() {
 6 |         
 7 |         Test.startTest();
 8 |         
 9 |         String fieldLabel = PicklistSelectController.getFieldLabel( 'Account', 'Type' );
10 |         
11 |         Test.stopTest();
12 |         
13 |         System.assertEquals( Account.Type.getDescribe().getLabel(), fieldLabel );
14 |         
15 |     }
16 |     
17 |     @isTest
18 |     static void test_get_picklist_values() {
19 |         
20 |         Test.startTest();
21 |         
22 |         List<PicklistSelectController.PicklistOption> options = PicklistSelectController.getPicklistOptions( 'Account', 'Type' );
23 |         
24 |         Test.stopTest();
25 |         
26 |         List<PicklistEntry> values = Account.Type.getDescribe().getPicklistValues();
27 |         
28 |         for ( Integer i = 0; i < options.size(); i++ ) {
29 |             System.assertEquals( values[i].getLabel(), options[i].label );
30 |             System.assertEquals( values[i].getValue(), options[i].value );
31 |         }
32 |         
33 |     }
34 |     
35 | }


--------------------------------------------------------------------------------
/src/classes/PicklistSelectControllerTest.cls-meta.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="UTF-8"?>
2 | <ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
3 |     <apiVersion>38.0</apiVersion>
4 |     <status>Active</status>
5 | </ApexClass>
6 | 


--------------------------------------------------------------------------------
/src/flexipages/Demo_PicklistSelect_Component.flexipage:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <FlexiPage xmlns="http://soap.sforce.com/2006/04/metadata">
 3 |     <flexiPageRegions>
 4 |         <componentInstances>
 5 |             <componentInstanceProperties>
 6 |                 <name>fieldName</name>
 7 |                 <value>Type</value>
 8 |             </componentInstanceProperties>
 9 |             <componentInstanceProperties>
10 |                 <name>objectName</name>
11 |                 <value>Account</value>
12 |             </componentInstanceProperties>
13 |             <componentName>PicklistSelect</componentName>
14 |         </componentInstances>
15 |         <componentInstances>
16 |             <componentInstanceProperties>
17 |                 <name>fieldName</name>
18 |                 <value>Status</value>
19 |             </componentInstanceProperties>
20 |             <componentInstanceProperties>
21 |                 <name>objectName</name>
22 |                 <value>Lead</value>
23 |             </componentInstanceProperties>
24 |             <componentName>PicklistSelect</componentName>
25 |         </componentInstances>
26 |         <componentInstances>
27 |             <componentInstanceProperties>
28 |                 <name>fieldName</name>
29 |                 <value>StageName</value>
30 |             </componentInstanceProperties>
31 |             <componentInstanceProperties>
32 |                 <name>objectName</name>
33 |                 <value>Opportunity</value>
34 |             </componentInstanceProperties>
35 |             <componentName>PicklistSelect</componentName>
36 |         </componentInstances>
37 |         <name>main</name>
38 |         <type>Region</type>
39 |     </flexiPageRegions>
40 |     <masterLabel>Demo PicklistSelect Component</masterLabel>
41 |     <pageTemplate>flexipage:defaultAppHomeTemplate</pageTemplate>
42 |     <type>AppPage</type>
43 | </FlexiPage>
44 | 


--------------------------------------------------------------------------------
/src/package.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <Package xmlns="http://soap.sforce.com/2006/04/metadata">
 3 |     <types>
 4 |         <members>PicklistSelectController</members>
 5 |         <members>PicklistSelectControllerTest</members>
 6 |         <name>ApexClass</name>
 7 |     </types>
 8 |     <types>
 9 |         <members>PicklistSelect</members>
10 |         <name>AuraDefinitionBundle</name>
11 |     </types>
12 |     <types>
13 |         <members>Demo_PicklistSelect_Component</members>
14 |         <name>CustomTab</name>
15 |     </types>
16 |     <types>
17 |         <members>Demo_PicklistSelect_Component</members>
18 |         <name>FlexiPage</name>
19 |     </types>
20 |     <version>38.0</version>
21 | </Package>
22 | 


--------------------------------------------------------------------------------
/src/tabs/Demo_PicklistSelect_Component.tab:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="UTF-8"?>
2 | <CustomTab xmlns="http://soap.sforce.com/2006/04/metadata">
3 |     <description>Created by Lightning App Builder</description>
4 |     <flexiPage>Demo_PicklistSelect_Component</flexiPage>
5 |     <label>Demo PicklistSelect Component</label>
6 |     <mobileReady>true</mobileReady>
7 |     <motif>Custom60: Umbrella</motif>
8 | </CustomTab>
9 | 


--------------------------------------------------------------------------------