FocusTvButton

Light wrapper of UIButton that allows extra customization for tvOS

Code Quality Rank: L5

Programming language: Swift

License: MIT License

Tags: Apple TV    

Latest version: v3.1.0

README

FocusTvButton

Light wrapper of UIButton that allows extra customization for tvOS

[](art/preview.gif)

If you would like to have the same level of customization in tableview cells, you should definitely check out TvOSCustomizableTableViewCell

Description

FocusTvButton allows the customization of UIButtons in tvOS, adding extra properties to customize layout attributes which are not customizable on UIButtons out of the box.

Custom properties:

• Focused background color
• Unfocused background color
• Selected background color
• Corner radius
• Scale factor when focused
• Shadow radius when focused
• Shadow opacity when focused
• Shadow color
• Shadow offset when focused
• Duration of the focus animation
• Title color when focuses/unfocused

Two color, linear gradient properties:

• Focused background end color
• Unfocused background end color
• Selected background end color
• gradient start & end points

A simple two color, linear gradient can be configured by setting either "background end" color properties. If neither "background end" color properties are set then FocusTvButton will use a solid background color by default.

Requirements

• tvOS 10.2+
• Xcode 11.0+

Usage

FocusTvButton can be integrated both programmatically or embedded in a xib file.

Programmatically

FocusTvButton is a subclass of UIButton, so it can be created and used as a regular UIButton.

let myButton = FocusTvButton()
myButton.focusedBackgroundColor = .red
myButton.normalBackgroundColor = .white
myButton.cornerRadius = 12.0

// with optional gradient
myButton.focusedBackgroundEndColor = .green
myButton.normalBackgroundColor = .black
myButton.gradientStartPoint = .zero
myButton.gradientEndPoint = CGPoint(x: 0, y: 1)

Embedded in a xib or storyboard file

Due to the fact that FocusTvButton is a subclass of UIButton, the first step is to drag and drop a regular UIButton from the Object library to your view.

[](art/buttonObjectLibrary.png)

Then change the value of "Custom Class" to "FocusTvButton", and the Button type to "Custom" to avoid the default focus behavior.

[](art/buttonCustomClass.png) [](art/buttonTypeCustom.png)

And that's all...

The custom properties can be configured directly on the Storyboard using IBInspectables.

[](art/ibinspectables.png)

Installation

Cocoapods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To integrate FocusTvButton into your Xcode project using CocoaPods, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :tvos, '9.0'
use_frameworks!

target '<Your Target Name>' do
    pod 'FocusTvButton', '~> 3.1.0'
end

Then, run the following command:

$ pod install

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate FocusTvButton into your Xcode project using Carthage, specify it in your Cartfile:

github "dcordero/FocusTvButton" ~> 3.1.0

Run carthage update to build the framework and drag the built FocusTvButton.framework into your Xcode project.

Manually

If you prefer, you can also integrate FocusTvButton into your project manually, just copying FocusTvButton.swift to your project.