iOSライブラリを自作する
3 min readApr 29, 2020
本記事では、iOS向けのライブラリを自作するにあたり、はじめに知っておきたいポイントをまとめています。
NewYorkAlert
Alert / Action sheetを表示するiOS向けライブラリを公開しました。主に以下の特徴があります。
- Alert / Action sheetの両方に対応
- シンプルなデザイン
- Text fields / 画像を簡単に追加できる
- ダークモード対応
自作ライブラリの作成・公開を通して、はじめに知っておきたかったポイントをまとめます。
プロジェクト構成
ライブラリ作成のプロジェクト構成には
- ライブラリのソースコードとデモアプリのproject
- ライブラリのprojectとデモアプリのproject
など様々ありますが、最終的には
- 1 projectにライブラリのFramework+デモアプリのTarget
を採用しました。
理由は以下の通りです。
- デバッグが容易
- Carthageに対応するためにはFrameworkでなければならない
- プロジェクト化することでjazzyによるドキュメントページ生成が可能
UIの実装
以下の理由から、UIの実装にXibファイルや画像は利用せず、全てコードで記述しました。
- ライブラリ利用者にとってUIの変更点がわかりづらくなる
- Cocoapodsにリソースを含める方法が煩雑である
APIドキュメント
APIドキュメントの作成にはrealm/jazzyを利用し、生成されたページをレポジトリのGitHub Pagesに設定しました。実際のページがこちらです。
jazzyはソースコード内にあるMarkdown形式のコメントから、Apple公式ドキュメントと同じような見た目のページを自動で生成してくれるツールです。Markdownのコメントは、jazzyによってドキュメントを作成できるだけでなく、以下のようにXcodeでQuick Helpが表示されるようになります。書き方はこちらを参照してください。
その他
ライブラリの命名や.podspecファイルの記述、READMEの内容など、わからなかったり迷ったりした場合は、awsome-iosで他のライブラリを参考にしました。
