README.md

SwiftNEW

English · 繁中 · 简中 · 粵語 · 日本語 · 한국어

A modern, SwiftUI-native "What's New" presentation framework for all Apple platforms — animated gradient backgrounds, glass effects, remote data loading, and full RTL/localization support out of the box.

🎨 Gallery

Light	Dark

🚀 Quick Start

1. Add the package in Xcode → File → Add Package Dependencies…

Important

Package URL

https://github.com/1998code/SwiftNEWKit

2. Add a data.json to your app bundle:

Tip

Sample release notes JSON

[
  {
    "version": "1.0",
    "new": [
      { "icon": "star.fill", "title": "Welcome", "subtitle": "Get Started", "body": "Thanks for downloading our app!" }
    ]
  }
]

3. Drop it in your view:

Note

Minimal SwiftUI integration

import SwiftNEW

struct ContentView: View {
    @State private var showNew = false
    var body: some View {
        SwiftNEW(show: $showNew)
    }
}

That's it — SwiftNEW auto-triggers when the app version changes.

✨ Features

Feature	Since	Description
🔢 Optional Build Number	6.3.0	Hide build number via showBuild: false
🎨 Floating Particles Effect	6.3.0	New .particles special effect (TimelineView + Canvas)
🎯 Flexible Presentations	6.2.0	.sheet, .fullScreenCover, .embed
🌈 Adaptive Text Color	6.2.0	Button text auto-contrasts with background
🛠️ Simplified Initializer	6.2.0	Direct values — no .constant() wrapping needed
🪟 Glass Morphism	5.5.0	Modern blur with customizable transparency
🌈 Mesh & Linear Gradients	5.3.0	Animated gradient backgrounds
🥽 visionOS Support	4.1.0	Native spatial computing
🔄 Auto-trigger	4.0.0	Shows automatically when version/build changes
🎄 Special Effects	3.9.0	.christmas snowfall, .particles rainbow
📱 Drop Notifications	3.5.0	iOS-style banner notifications
🔥 Firebase Realtime DB	3.0.0	Live content updates
🌐 Remote JSON	3.0.0	Load from any REST endpoint
📚 Version History	2.0.0	Browse all previous releases

Feature Showcase

Mesh Gradient (5.3+)	visionOS (4.1+)

App Icon (3.9.6+)	History (2.0+)

📚 Learn More

Guide	Covers
Configuration	All parameters, examples, data sources (local / remote / Firebase), data model
Platform Support & Installation	Supported OS versions, requirements, feature matrix, SPM setup
Contributing	Project structure, dev setup, PR guidelines, troubleshooting

📄 License

SwiftNEW is released under the MIT License — one of the most permissive open-source licenses.

	Details
✅ You can	Use it in commercial apps (including paid App Store apps), modify it, redistribute it, and ship it inside closed-source software
📝 You must	Keep the original copyright and license notice in your project
⚠️ No warranty	The software is provided "as is" — the author is not liable for any issues arising from its use

See LICENSE for the full text.

💖 Supported By

Sponsor	Resource
	Cloud infrastructure
	AI-powered docs Q&A