rrubush / sldsx Goto Github PK

#SLDS Sample Components SLDS Sample Components is an open-source project to provide a set of common Lightning Components that conform and wrap Salesforce Lightning Design System's (SLDS) CSS framework. This is to help you not worry about SLDS specific CSS, markup for basic components. And also to provide JS support so you don't have to implement them.

Needs Winter '16

We've created a tutorial to explain how to use it. Please go through the tutorial here.

This project is distributed as an unmanaged package. The package has all the components, and latest version of SLDS framework (CSS, fonts, icons etc). To use it, simply install the package, load SLDS static resource and use individual components in your app.

1. Install the unmanaged package (w/ SLDS v0.8).
2. Load SLDS static resource

<ltng:require styles="/resource/slds/assets/styles/salesforce-lightning-design-system-ltng.css"/>

If your org has it's own namespace, for example: ns then, append ns__ to the sldsx in the resource path to look like below:

 <ltng:require styles="/resource/ns__slds/assets/styles/salesforce-lightning-design-system-ltng.css"/>

3. Write SLDS component under <div class="slds">

Notes: If your org already has some of the components

SLDS app contains a list of all the SLDSX components and source code for each one of them. The examples are identical to what you'll find in the Salesforce Lightning Design System's (SLDS) website.

Usage: Once you install the unmanaged package, open {yourOrg}//{namespace}/SLDS.app.

Note: All the components are in metadata/aura/ folder.

If you are distributing a component that's built using SLDSX, you need to package your component and SLDSX static resource. This is to ensure that your component uses proper version of SLDS.

You can fork this repo and contribute newer SLDSX components or bug fixes. When you submit a new component, make sure it is in metadata/aura folder metadata/aura/{yourcomponent} In addition also provide an example usage of your component by editing {yourOrg}//sldsx/SLDS.app and adding your component at the bottom of the app.

Please see the details in the LICENSE file above.

This project is built as a 'labs' project and while a small team within Salesforce will try to maintain it, but it is so not officially supported.