Skip to content

Commit

Permalink
Stubbed out readme and changelog for windows
Browse files Browse the repository at this point in the history
  • Loading branch information
@jandolina
jandolina committed Mar 8, 2017
1 parent ae165c1 commit de6c734
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 205 deletions.
22 changes: 5 additions & 17 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,37 +5,25 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).


<!-- ## [Unreleased] -->

## 3.0.5 - 3/2/2017
Fixed an issue with locating the framework bundle.

## 3.0.4 - 3/1/2017
Updated links in README.md to absolute paths (for CocoaPods site documentation).

## 3.0.3 - 2/27/2017
Instructions updated to reflect detailed pod installation.

## 3.0.0 - 2/15/2017
## 3.0.0 - 3/8/2017
With the introduction of the 3.0.0 release of the SLDS iOS library, there were a fair amount of API changes. Where possible functions were marked as deprecated but not everywhere. The new library aimed to add simplicity wherever possible.

[Readme.md](https://github.com/salesforce-ux/design-system-ios/blob/master/README.md)
[Readme.md](https://github.com/salesforce-ux/design-system-windows/blob/master/README.md)

### Added
- Integration of the Spring ’17 SLDS Design tokens
- Additional SalesforceSans font family support
- Font substitution mechanism for overriding default fonts
- A swift based sample and library reference app
- ObjectiveC unit tests
- Added the Salesforce.SLDS Sample app
- Library generation script unit tests

### Changed
- Comprehensive rewrite of the library generation gulp scripts
- File templates have been ported to nunjunks
- Consolidated all icons into a single icon font
- Consolidated SLDS Token values to .h files only
- Consolidated SLDS Token values to SLDSTokens.ms.xaml

## Pre 3.0.0

Previous release notes are available on GitHub: <https://github.com/salesforce-ux/design-system-ios/releases>
Previous release notes are available on GitHub: <https://github.com/salesforce-ux/design-system-windows/releases>
202 changes: 14 additions & 188 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,182 +1,27 @@
# Lightning Design System tokens, icons and fonts for iOS
# Lightning Design System tokens, icons and fonts for Windows

iOS static library for [Salesforce Lightning Design System](https://www.lightningdesignsystem.com/) [Tokens](https://www.lightningdesignsystem.com/design-tokens/).
MS XAML configuration files for [Salesforce Lightning Design System](https://www.lightningdesignsystem.com/) [Tokens](https://www.lightningdesignsystem.com/design-tokens/).

Current release: Spring ’17

## Simple Install

Install CocoaPods:

```ruby
$ sudo gem install cocoapods
```

Navigate to your iOS project directory and run:

```ruby
$ pod init
```

A `Podfile` will be created at the root of your project directory.

Add the following to your Podfile under `use_frameworks!`:

```ruby
pod 'DesignSystem'
```

run:

```
$ pod install
```

**A workspace for you project will be created (ending in .xcworkspace)**

Open this workspace file in xcode. Use this workspace for future builds.

**Update your search paths**

After opening the workspace go to YourProject->YourProjectTarget->Build Settings-> Header Search Paths, and remove everything but $(inherited) non-recursive.

## Manual Submodule/Subproject Setup

See [more info](https://github.com/salesforce-ux/design-system-ios/tree/master/manual_install_info)


## Sample Application

See [Demo App](https://github.com/salesforce-ux/design-system-ios/tree/master/Demo-Swift) for a library browser and sample code.

## Swift Usage

### Setup

To use the SLDS library in Swift, create a bridging header:

```objc

#ifndef slds_bridging_header_h
#define slds_bridging_header_h

#import <DesignSystem/SalesforceDesignSystem.h>

#endif

```

1. Create `slds-bridging-header.h`.
2. In your build settings find the “Swift Compiler – General” section.
3. Next to “Objective-C Bridging Header” add the header file (e.g. `slds-bridging-header.h`).

SLDS extensions and constants are now accessible to all files in your project/workspace. There is no need to import the Design system to each file.


### Examples


#### Colors

```swift

let textColor = UIColor.sldsTextColor(.colorTextDefault)

let borderColor = UIColor.sldsColorBorder(.colorBorderBrand)

let backgroundColor = UIColor.sldsColorBackground(.colorBackgroundBrand)

```


#### Fonts and text sizes

```swift

label.font = UIFont.sldsFont(.bold, with: .medium)

```


#### Icons

##### Action Icons

```swift

let icon = UIImage.sldsActionIcon(.addContact, withSize: SLDSSquareIconLarge)

let iconWithColor = UIImage.sldsActionIcon(.addContact, with: UIColor.black, andBGColor: UIColor.white, andSize: SLDSSquareIconLarge)

```


##### Custom Icons

```swift

let icon = UIImage.sldsActionIcon(.custom1, withSize: SLDSSquareIconLarge)

let iconWithColor = UIImage.sldsActionIcon(.custom1, with: UIColor.black, andBGColor: UIColor.white, andSize: SLDSSquareIconLarge)

```


##### Standard Icons


```swift

let icon = UIImage.sldsStandardIcon(.account, withSize: SLDSSquareIconLarge)

let iconWithColor = UIImage.sldsStandardIcon(.account, with: UIColor.black, andBGColor: UIColor.white, andSize: SLDSSquareIconLarge)

```


##### Utility Icons


```swift

let icon = UIImage.sldsUtilityIcon(.addContact, withSize: SLDSSquareIconLarge)

let iconWithColor = UIImage.sldsUtilityIcon(.addContact, with: UIColor.black, andBGColor: UIColor.white, andSize: SLDSSquareIconLarge)

```

## Objective-C Usage


### Examples


#### Colors

```objc

#import <DesignSystem/SalesforceDesignSystem.h>

...

UIColor* c = [UIColor sldsTextColor:SLDSColorTextInverse];


Example
```


#### Fonts and text sizes

```objc
#import <DesignSystem/SalesforceDesignSystem.h>
...
UIFont* f = [UIFont sldsFont:SLDSFontRegular withSize:SLDSFontSizeXLarge];
```
Example
```

Expand All @@ -185,60 +30,41 @@ UIFont* f = [UIFont sldsFont:SLDSFontRegular withSize:SLDSFontSizeXLarge];

##### Action Icons

```objc

#import <DesignSystem/SalesforceDesignSystem.h>

...

UIImage *icon = [UIImage sldsActionIcon:SLDSIconActionNewCustom98 withSize:20.0f];
```
Example
```


##### Custom Icons

```objc
#import <DesignSystem/SalesforceDesignSystem.h>
...
UIImage *icon = [UIImage sldsCustomIcon:SLDSIconCustom1 withSize:20.0f];
```
Example
```


##### Standard Icons

```objc

#import <DesignSystem/SalesforceDesignSystem.h>

...

UIImage *icon = [UIImage sldsStandardIcon:SLDSIconStandardAccount withSize:20.0f];
```
Example
```


##### Utility Icons

```objc

#import <DesignSystem/SalesforceDesignSystem.h>
...
UIImage *icon = [UIImage sldsUtilityIcon:SLDSIconUtility3dots withSize:20.0f];
```
Example
```

## Library Build (not required)

```
$ npm install
$ npm start
$ gulp
```

## Licenses
Expand Down

0 comments on commit de6c734

Please sign in to comment.