[Swift] いとも簡単にトーストを表示する (HNToaster)

photo credit: dhobern Streptoprocne zonaris via photopin (license)

iOS で Toast を表示するためのライブラリをリリースしたので、紹介する。

このライブラリHNToasterを使うと、
次の たった１行のコード を書くだけでトーストが表示できる。

Toaster.toast(onView: self.view, message: "Can you see me?")

さらに、パラメーターを与えれば次のような指定もできる。

• トーストの表示領域の指定(場所、大きさ)
• トーストに表示する文字のフォント指定(種類、サイズ)

目次

• HNToaster のインストール方法
  1. CoacoaPods をインストールする
  2. Xcode のプロジェクトで CocoaPods を使えるようにする
  3. HNToaster を CocoaPods でインストールする
  4. (もしくは CocoaPods を使わない方法)
• HNToaster を使ってみる
  • 最も簡単な使い方
  • 表示領域とフォントを指定する使い方
  • Example Project

HNToaster のインストール方法

1. CocoaPods をインストールする

まず、 RubyGem の最新化、 CocoaPods インストールとセット・アップ をする。

$ sudo gem update --system
$ sudo gem install cocoapods
$ pod setup

2. Xcode のプロジェクトで CocoaPosd を使えるようにする

プロジェクトのあるディレクトリにPodfileというファイルを作成する。

$ cd ~/YourProject/
$ vim Podfile

Podfile

platform :ios, "8.0"
pod 'HNToaster', '~> 1.0'

※↑のPodfileでは iOS 8.0以上、HNToaster 1.X を指定している

3. HNToaster を CocoaPods でインストールする

$ pod install

これで HNToaster がインストールできた。

YourProject.xcworkspaceを Xcode で開くことで、自分のプロジェクトと CocoaPods のライブラリ をリンクさせてビルドができる。
(YourProject.codeproj ではなく .xcworkspace の方を開く)

4. (もしくは CocoaPods を使わない方法)

ここまでで HNToaster をインストールしたという方はこの項目を飛ばしてOK。
「CocoaPodsを使わない」という方のみを対象としている。

↓のファイルをプロジェクトにコピーすることで、HNToaster.swiftを入手しても良い。
https://github.com/hahnah/HNToaster/blob/1.0.0/HNToaster/Classes/HNToaster.swift

HNToaster を使ってみる

まず、適当な swift ファイルに HNToaster を import しよう。
※ 4. (もしくは CocoaPods を使わない方法) の場合は import 不要

import HNToaster

最も簡単な使い方

Toaster.toast(onView: UIView message: String)のメソッドを呼び出せばトーストが表示される。
引数onViewには トーストを浮かび上がらせたいビュー を、messageには表示したい文字列を渡す。

↓のコードでは、記事冒頭のアニメーションで見せたトーストが表示される。

let message1: String = "Can you see me?"
Toaster.toast(onView: self.view, message: message1)

表示領域とフォントを指定する使い方

Toaster.toast(onView: UIView, message: String, frame: CGRect?, font: UIFont?)のメソッドを使えば、トーストの表示領域やフォントの指定も可能だ。

引数frameにはトーストの表示領域となる CGRect インスタンスを、fontには UIFont インスタンスを渡すことで、トーストの表示位置や縦x横の大きさ、フォントの種類やサイズを 指定することができる。
※引数を nil にした場合はデフォルト値が適用される

let message2: String = """
You can arrange
the toast's frame
and the message's font.
"""

let toastFrame: CGRect = CGRect(x: 10, y: self.view.bounds.height - 150, width: self.view.bounds.width - 20, height: 120)

let messageFont: UIFont = UIFont.italicSystemFont(ofSize: 32)

Toaster.toast(onView: self.view, message: message2, frame: toastFrame, font: messageFont)

Example Project

Example ディレクトリにサンプルを置いてあるのでそれを試せる。

もしくはまだ HNToaster をインストールしていない場合でも、
以下のコマンドを打つと自動的にリポジトリを clone して Example Project を Xcode で開くので、あとは Xcode の Run ボタンを押すと簡単にサンプルを実行できる。 (CocoaPodsすごい!)

$ pod try HNToaster