README.md

OneStarter

A jQuery plugin for easily making HTML appear in the style of Salesforce1. This ReadMe offers a quick start, you can also browse the examples directory for examples of using it in Visualforce, and the staticresources directory provides the necessary files to run (including TouchSwipe, etc).

Update: The Proxima fonts have been removed at the request of the authors due to licensing conflicts. I'll be trying to figure out how to properly point OneStarter to the SF hosted ones while in Visualforce. You can purchase Proxima Nova here.

OneStarter utilizes CSS from the Salesforce1 style guide here:

http://sfdc-styleguide.herokuapp.com/

However, instead of having to port a wide variety of css classes, a la:

<ul class="list-plain fw-normal bg-2 man pan">
  <li class="active--list-1 pam text-color-1 f4 border-bottom border--3">List Item 1</li>
  <li class="active--list-1 pam text-color-1 f4 border-bottom border--3">List Item 2</li>
  <li class="active--list-1 pam text-color-1 f4 border-bottom border--3">List Item 3</li>
  <li class="active--list-1 pam text-color-1 f4">List Item 4</li>
</ul>

You can just have:

<div id="one-app">
<h2>Basic List Example</h2>
<ul class="list-simple">
	<li class="list-simple">Item 1</li>
	<li class="list-simple">Item 2</li>
	<li class="list-simple">Item 3</li>
</ul>
</div>

<script>
	$('div#one-app').oneStarter('app');
</script>

And style the div using OneStarter. There is now a rudimentary attempt to restyle pageblocks, so:

<script>
    $(document).ready(function() {
    	$('div[id*="form-panel"]').oneStarter('app');
    })


    </script>

    <apex:outputPanel id="form-panel" layout="block">
		<apex:form>
			<apex:pageBlock title="{!account_detail.name}" mode="edit">
            <apex:pageBlockButtons>
                <apex:commandButton value="Save" action="{!save}" /> <apex:commandButton value="Cancel" action="{!save}" />
            </apex:pageBlockButtons>
            <apex:pageBlockSection title="My Content Section" columns="1">
                <apex:inputField value="{!account_detail.phone}"/>
            </apex:pageBlockSection>
        </apex:pageBlock>
        <apex:outputPanel rendered="{!showBack}">
			<apex:commandButton value="Back" />
		</apex:outputPanel>
		</apex:form>

	</apex:outputPanel>

Will be styled in a mobile friendly manner using the S1 CSS.

The plugin also includes the ability to mimic or control various S1 navigation points, including:

• Enabling / Disabling the Submit
• Closing an Action
• Carousel style divs

Pre Reqs

1. jQuery
2. The OneStarter and Style Guide CSS
3. For Carousel navigation, the TouchSwipe jQuery plugin

Basic Usage

To apply the baseline CSS to your page, wrap your content in a single div and then call the plugin. The default plugin method takes one parameter, which denotes whether the page is intended as a global-action,record-action or app.

<div id="one-app">
	<h1>One Starter jQuery Plugin</h1>
	<article class="padded">
		This is a sample application using the One Starter jQuery plugin.
	</article>
</div>

	$(document).ready(function() {
   		
       	$('div#one-app').oneStarter('global-action');

     });

Additional Styles

OneStarter can typically style base HTML elements like H1 and input fields, there are a few additional styles to detail elements:

Class	Element	Effect
padded	article, section, div, span	forces a 5px padding
list-simple	ul	basic list with rule lines
list-plain	ul	basic list without rule lines
field-label	span	sets up text for a field label
simple-bold	h, span, div	sets fonts for bold

Interacting with the Submit Button

The plugin returns an object which includes methods for enabling and disabling the Submit button found in Salesforce1 for global and record level actions. In the desktop browser, a submit button will be created for the record action (or removed on disable). The enable method can take a callback to handle the submission itself.

For instance:

 $(document).ready(function() {
   		
       		$('div#one-app').oneStarter('record-action').enableSubmit(function() {
            EmailScorecard.createEmail("{!Scorecard__c.Id}",function(res, mes) {
         			    oneStarter.close();
                		oneStarter.disableSubmit();
        		    }); 
            });
            
    	});

Will enable the submit button on load, and on click enact the Remote Action method in Apex. Then it will close the action / disable the submit button.

Creating Carousel Divs

Salesforce1 makes frequent use of carousels for touch friendly sections of content which can be navigated right to left. OneStarter leverages another jQuery plugin, TouchSwipe, to achieve this effect by styling and controlling the divs correctly as well as adding the bullet style page indicator.

Generating the divs is another method off the oneStarter return object. Nest divs within a parent div:

<div id="one-carousel" >

			<div id="basic-list">
				<h2>Basic List Example</h2>
				<ul class="list-simple">
					<li class="list-simple">Item 1</li>
					<li class="list-simple">Item 2</li>
					<li class="list-simple">Item 3</li>
				</ul>

			</div>

			<div id="record-list">
				<h2>Record List Example</h2>
				<article class="padded">
					<div class="icon icon-left icon--contact"></div>
					My Contacts
				</article>
				<article class="padded">
					<div class="icon icon-left icon--account"></div>
					My Accounts
				</article>
				<article class="padded">
					<div class="icon icon-left icon--opportunity"></div>
					My Opportunity
				</article>
			</div>
</div>

And then call the carousel method:

$('div#one-app').oneStarter('global-action');
oneStarter.carousel($('div#one-carousel'));