https://github.com/bannzai/Gecco

Simply highlight items for your tutorial walkthrough, written in Swift
https://github.com/bannzai/Gecco

Last synced: 15 days ago
JSON representation

Simply highlight items for your tutorial walkthrough, written in Swift

• Host: GitHub
• URL: https://github.com/bannzai/Gecco
• Owner: bannzai
• License: mit
• Created: 2016-01-15T10:57:06.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2021-09-01T03:02:11.000Z (about 3 years ago)
• Last Synced: 2024-10-15T23:22:09.826Z (29 days ago)
• Language: Swift
• Homepage:
• Size: 776 KB
• Stars: 1,886
• Watchers: 27
• Forks: 168
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Gecco

[![Pod Version](http://img.shields.io/cocoapods/v/Gecco.svg?style=flat)](http://cocoadocs.org/docsets/Gecco/)

[![Pod Platform](http://img.shields.io/cocoapods/p/Gecco.svg?style=flat)](http://cocoadocs.org/docsets/Gecco/)

[![Pod License](http://img.shields.io/cocoapods/l/Gecco.svg?style=flat)](http://opensource.org/licenses/MIT)

Simply highlight items for your tutorial walkthrough, written in Swift

Gecco means Moonlight in Japanese.

![Demo](https://cloud.githubusercontent.com/assets/6880730/12470510/2d1cb602-c038-11e5-8095-a2a0d77f99db.gif)

## Usage

### Basic

Basically instantiate a SpotlightViewController and present via `UIViewController.present(_:animated:completion) and call `SpotlightViewController.spotlight.appear(_:)` with SpotlightType.

``` swift

import Gecco

class ViewController: UIViewController {

  func showSpotlight() {

    let spotlightViewController = SpotlightViewController()

    present(spotlightViewController, animated: true, completion: nil)

    spotlightViewController.spotlightView.appear(Spotlight.Oval(center: view.center, diameter: 100))

  }

}

```

#### Supported SpotlightType

Gecco provide some SpotlightType as default implemantation.

  Oval 

`Oval` displays a perfect circle.

```swift

spotlightViewController.spotlightView.appear(Spotlight.Oval(center: view.center, diameter: 100))

```



  Rect 

`Rect` is a rectangle drawn by specifying the width and height.

```swift

spotlightViewController.spotlightView.appear(Spotlight.Rect(center: view.center, size: CGSize(width: 200, height: 100)))

```



  RoundedRect 

`RoundedRect` is a rectangle with corner radius.

```swift

spotlightViewController.spotlightView.appear(Spotlight.RoundedRect(center: view.center, size: CGSize(width: 200, height: 100), cornerRadius: 8))

```



### Advanced

**Gecco** publish some delegate methods for hook each events about SpotlightViewController and SpotlightView.

If you want to write adavanced feature, you can write to define SpotlightViewControllerDelegate or SpotlightViewDelegate.

See [SpotlightViewControllerDelegate](https://github.com/yukiasai/Gecco/blob/9791f0c050572f43d54a7f13dc081a165d99e9f3/Classes/SpotlightViewController.swift#L11) and [SpotlightViewDelegate](https://github.com/yukiasai/Gecco/blob/9791f0c050572f43d54a7f13dc081a165d99e9f3/Classes/SpotlightView.swift#L11).

For example

```swift

// Hook events for SpotlightViewControllerDelegate

spotlightViewController.delegate = self

// Hook events for SpotlightViewDelegate

spotlightViewController.spotlightView.delegate = self

```

### Example

Please refer to [GeccoExample](https://github.com/yukiasai/Gecco/tree/master/GeccoExample).

## Installation

#### CocoaPods

```

pod 'Gecco'

```

#### Carthage

```

github "yukiasai/Gecco"

```

## License

Gecco is released under the MIT license. See LICENSE for details.