Skip to content

README-ja.md

Latest commit

 

History

History
76 lines (61 loc) · 2.82 KB

README-ja.md

File metadata and controls

76 lines (61 loc) · 2.82 KB

CustomNavigationTitle

Swift Package Manager

English is here.

CustomNavigationTitleは、スクロールに応じてナビゲーションタイトルをアニメーション付きで表示・非表示にするSwiftUI用のシンプルなパッケージです。(この効果はApple純正の設定アプリ、メールアプリ、AppStoreアプリで使われています。)

Demo

特徴

  • スクロールに応じてタイトルがフェードイン・アウト
  • シンプルなAPIで既存のコードのまま簡単に導入可能
  • SwiftUIのScrollView、List、Formに対応

動作環境

  • iOS 16.0+
  • MacCatalyst 16.0+
  • macOS 13.0+

インストール

Swift Package Manager (SPM) を使用してインストールできます。

  1. Xcode でプロジェクトを開きます。
  2. File > Add Package Dependency... を選択します。
  3. https://github.com/Chronos2500/CustomNavigationTitle.git を入力します。
  4. バージョン指定ルール等を設定し、 Add Package をクリックします。

使い方

基本的な使い方

  1. ScrollView、List、Formのいずれかに.scrollAwareTitle("CustomTitle")修飾子を追加します。
  2. 次にタイトルの表示・非表示をトリガーするViewにtitleVisibilityAnchor()修飾子を追加します。このViewが可視領域から外れるとタイトルが表示されます。
  • ViewがNavigationStack等でラップされていれば、これだけで機能します。
  • .navigationTitle()より.scrollAwareTitle()が優先されますが、Navigation History Stack機能のために.navigationTitle()も設定することを推奨します。
  • 詳細なサンプルはExamplesフォルダのプロジェクトにあります。
import SwiftUI
import CustomNavigationTitle

struct ContentView: View {
    var body: some View {
        NavigationStack {
            ScrollView {
                Text("First")
                    .font(.largeTitle)
                    .padding()
                Text("Second")
                    .font(.largeTitle)
                    .padding()
                    .titleVisibilityAnchor()
                Text("Third")
                    .font(.largeTitle)
                    .padding()
            }
            .scrollAwareTitle("CustomTitle")
        }
    }
}

カスタムタイトルビューを使用

.scrollAwareTitle {
    HStack {
        Image(systemName: "star.fill")
        Text("お気に入り")
    }
}

ライセンス

MIT ライセンスのもとで提供されます。

Chronos2500 © 2025