Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dcordero/TvOSTextViewer

Light and scrollable view controller for tvOS to present blocks of text
https://github.com/dcordero/TvOSTextViewer

swift tvos

Last synced: about 1 month ago
JSON representation

Light and scrollable view controller for tvOS to present blocks of text

Host: GitHub
URL: https://github.com/dcordero/TvOSTextViewer
Owner: dcordero
License: mit
Created: 2017-02-15T21:45:30.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2022-03-09T23:08:19.000Z (over 2 years ago)
Last Synced: 2024-08-03T04:23:07.898Z (about 1 month ago)
Topics: swift, tvos
Language: Swift
Homepage:
Size: 2.24 MB
Stars: 49
Watchers: 6
Forks: 6
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

awesome-ios - TvOSTextViewer - Light and scrollable view controller for tvOS to present blocks of text (Apple TV)
awesome-ios-star - TvOSTextViewer - Light and scrollable view controller for tvOS to present blocks of text (Apple TV)

README

# TvOSTextViewer
[![Twitter: @dcordero](https://img.shields.io/badge/[email protected]?style=flat)](https://twitter.com/dcordero)
![License MIT](https://img.shields.io/badge/license-MIT-green.svg)
![Swift 5.0](https://img.shields.io/badge/Swift-5.0-orange.svg)
[![Build Status](https://travis-ci.org/dcordero/TvOSTextViewer.svg?branch=master)](https://travis-ci.org/dcordero/TvOSTextViewer)

Light and scrollable view controller for tvOS to present blocks of text

![](preview.gif)

## Description

TvOSTextViewer is a view controller to present blocks of text on the same way native Apps do it on tvOS.

Customizable properties:

- text: The block of text to be presented
- textEdgeInsets: Margins for the text
- backgroundBlurEffectStyle: .dark by default
- textAttributes: Custom fonts/sizes, text colors, alignment, etc... via [NSAttributedText](https://developer.apple.com/documentation/uikit/uilabel/1620542-attributedtext)

## Requirements

- tvOS 9.0+
- Xcode 11

## Installation

### Cocoapods

[CocoaPods](https://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:

```
$ gem install cocoapods
```

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

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

target '' do
pod 'TvOSTextViewer', '~> 1.3.0'
end
```

Then, run the following command:

```
$ pod install
```

### Carthage

[Carthage](https://github.com/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 TvOSTextViewer into your Xcode project using Carthage, specify it in your Cartfile:

```
github "dcordero/TvOSTextViewer" ~> 1.3.0
```

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

## Usage

All you need is to create an instance of TvOSTextViewerViewController and present it on the screen:

```swift
let viewController = TvOSTextViewerViewController()
viewController.text = "Hello World"
present(viewController, animated: true, completion: nil)
```

If you would like to show this fullscreen view comming from an awesome button cropping the text on the same way Apple does, you can use it in combination with [TvOSMoreButton](https://github.com/cgoldsby/TvOSMoreButton) by [cgoldsby](https://twitter.com/GoldsbyChris)