https://github.com/futuredapp/Sonar

Radar style view written in swift
https://github.com/futuredapp/Sonar

Last synced: 2 months ago
JSON representation

Radar style view written in swift

• Host: GitHub
• URL: https://github.com/futuredapp/Sonar
• Owner: futuredapp
• License: mit
• Created: 2016-01-13T13:07:00.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2022-07-22T02:22:45.000Z (over 2 years ago)
• Last Synced: 2024-05-22T17:04:11.465Z (8 months ago)
• Language: Swift
• Size: 2.34 MB
• Stars: 128
• Watchers: 13
• Forks: 19
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-swift-cn - Sonar - Cool radar-style view (Libs / UI)

README

        


# Sonar

[![Version](https://img.shields.io/cocoapods/v/Sonar.svg?style=flat)](http://cocoapods.org/pods/Sonar)

[![License](https://img.shields.io/cocoapods/l/Sonar.svg?style=flat)](http://cocoapods.org/pods/Sonar)

[![Platform](https://img.shields.io/cocoapods/p/Sonar.svg?style=flat)](http://cocoapods.org/pods/Sonar)





Simple radar style view, written in Swift, pure CoreAnimation (no images). Highly adjustable.

## Usage

Just place the UIView somewhere in your controller and make it SonarView class.

SonarView copies the data source and delegate patter from UITableView.

```swift

/// Data source

public weak var dataSource: SonarViewDataSource?

/// SonarViewDelegate and SonarViewLayout

public weak var delegate: SonarViewDelegate?

```

There are three required methods.

```swift

public protocol SonarViewDataSource: class {

    func numberOfWaves(sonarView: SonarView) -> Int

    func sonarView(sonarView: SonarView, numberOfItemForWaveIndex waveIndex: Int) -> Int

    func sonarView(sonarView: SonarView, itemViewForWave waveIndex: Int, atIndex: Int) -> SonarItemView

}

```

`SonarItemView` is just a UIView subclass. In order to use your custom view in radar, make your view SonarItemView subclass. The size of view is determined via layout. The layout is defined by SonarViewLayout protocol. Sonar comes with one predefined layout - SonarViewCenteredLayout. The items in a wave are placed from edges to the center, for example if we have 4 items in wave, first is placed at the left side, second at the right side, third at the left again but a right from the first one and so on. I know, the image would be better:



If you need different behaviour, you can of course create your own layout by adopting the SonarViewLayout and pass it to the SonarView. See [SonarViewLayout](Pod/Classes/SonarViewLayout.swift) for more information.

The last protocol is Delegate which handles selections and titles on each wave

```swift

public protocol SonarViewDelegate: class {

    func sonarView(sonarView: SonarView, didSelectObjectInWave waveIndex: Int, atIndex: Int)

    func sonarView(sonarView: SonarView, textForWaveAtIndex waveIndex: Int) -> String?

}

```

If `distanceForWaveAtIndex` returns nil, the label will be hidden. For more information see the Example project.

### Appearance

There are 3 colours that can be adjusted.

```swift

class public var lineColor: UIColor

class public var lineShadowColor: UIColor

class public var distanceTextColor: UIColor

```

## Contribution

If you need to expose another properties or you have ideas how to improve it, file issue or send pull request, I'll be happy to discuss it.

## Requirements

iOS 8+,

Version 2.x - Swift 2.2+

Version 3.x - Swift 3.0+

Version 4.x - Swift 4.2+

Version 5.x - Swift 5.0+

## Installation

Sonar is available through [CocoaPods](http://cocoapods.org). To install

it, simply add the following line to your Podfile:

```ruby

pod "Sonar"

```

## Author

Aleš Kocur, [email protected]

## License

Sonar is available under the MIT license. See the [LICENSE](LICENSE) file for more info.