Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brunomacabeusbr/FocusGuideHelper
TV Client | Create focus guides linker more easily and versatile.
https://github.com/brunomacabeusbr/FocusGuideHelper
focus-guide stalkr-internals swift tvos uikit
Last synced: 22 days ago
JSON representation
TV Client | Create focus guides linker more easily and versatile.
- Host: GitHub
- URL: https://github.com/brunomacabeusbr/FocusGuideHelper
- Owner: macabeus
- License: mit
- Created: 2017-05-14T18:39:05.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-02-16T11:33:16.000Z (almost 7 years ago)
- Last Synced: 2024-04-12T19:08:24.476Z (9 months ago)
- Topics: focus-guide, stalkr-internals, swift, tvos, uikit
- Language: Swift
- Homepage:
- Size: 21.5 KB
- Stars: 14
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](http://cocoapods.org/pods/FocusGuideHelper)
[](http://cocoapods.org/pods/FocusGuideHelper)
[](http://cocoapods.org/pods/FocusGuideHelper)
# FocusGuideHelper
✨ Create focus guides linker more easily and versatile
You can download this repository and see this example app.
🌼 Thanks to [@EdyJunior](https://github.com/EdyJunior)
# How to use
## Install
In `Podfile` add
```
pod 'FocusGuideHelper'
```
and use `pod install`.
## Setup
In your Swift file, import this pod:
```swift
import FocusGuideHelper
```
Then, create a object of `FocusGuideHelper`, for example:
```swift
class ViewController: UIViewController {
let guideHelper = FocusGuideHelper()
...
```
And, you need call `updateFocus(in:)` for every time the focus changes:
```swift
override func didUpdateFocus(in context: UIFocusUpdateContext, with coordinator: UIFocusAnimationCoordinator) {
guideHelper.updateFocus(in: context)
}
```
## Using this pod
### Minimal
```swift
override func viewDidLoad() {
super.viewDidLoad()
guideHelper.addLinkByFocus(
from: containerForm, // original view
to: containerRaccon, // destination when to touch in this focus guide
inPosition: .left // position of the focus guide in relation of "from"
)
...
```
### Update the focus guide
Sometimes, you need update your focus guide, because a destination view is changed, or to avoid have multiple copies of the same focus:
```swift
func someFunctionCalledSometimes() {
guideHelper.addLinkByFocus(
from: containerForm,
to: containerRaccon,
inPosition: .left,
identifier: "containerForm to containerRaccon" // identifier of this focus guide
)
}
```
You can write anything in `identifier`. In each `FocusGuideHelper` object, can have only one focus with same identifier.
If another focus guide to be created with same identifier, the older is replaced.
### Enable/disable focus guide
Sometimes, you need enable or disable a focus guide, to avoid conflict, or to create another experience:
```swift
guideHelper.addLinkByFocus(
from: someRaccon,
to: someView,
inPosition: .bottom,
identifier: "raccon to view",
activedWhen: { context in
return (context.nextFocusedView as? RacconView) != nil
}
)
```
If the `activedWhen` returned `true`, then the focus is enabled, otherwise, the focus is disabled.
The `identifier` is optional.
### Temporary focus
```swift
guideHelper.addLinkByFocusTemporary(
from: someRaccon,
to: someView,
inPosition: .right
)
```
This focus guide will be automatically removed when the focus changed.
It's useful for avoid conflict with anothers focus guide, or when a destination view is also temporary.
### Focus autoexclude
Sometimes, you need a temporary focus, but, that is removed at another time, then:
```swift
guideHelper.addLinkByFocus(
from: someRaccon,
to: someView,
inPosition: .bottom,
identifier: "raccon to someView",
autoexcludeWhen: { context in
return (context.nextFocusedView as? RacconView) == nil
}
)
```
This focus is excluded when the `autoexcludeWhen` return true.
The `identifier` is optional.
---
**Maintainer**:
> [macabeus](http://macalogs.com.br/) ·
> GitHub [@macabeus](https://github.com/macabeus)