Introducing the SwiftUI Effects Library Twitter-2400x1350px

EffectsLibrary(特效库)

特效库允许开发者轻松创建复杂而逼真的粒子系统,例如雪、火、雨、彩纸屑、烟花和烟雾,几乎无需或只需极少的努力。

All effects previews

它内置了预制特效,可直接用于您的作品。您还可以使用几乎任何图像、形状、文本视图和灵活的自定义选项来构建自己的特效。

它是完全开源的,具有精心设计的文档和一个交互式演练教程,可以帮助您入门。

您可以查看该项目的示例应用,贡献到其配套的 GitHub 仓库,或让我们知道您的反馈。

🚀 快速上手

安装

该软件包通过 Swift Package Manager 分发。我们提供了一个非常详细的教程,其中包含清晰的安装说明。您也可以按照以下步骤操作:

  1. 在 Xcode 中,转到File -> Add Packages(文件 -> 添加包)
  2. 在新打开窗口的右上角(显示Search or Enter Package URL(搜索或输入包 URL)的位置),粘贴仓库的链接:https://github.com/GetStream/effects-library
  3. 对于Dependency Rule(依赖规则),选择Up to Next Major Version(直到下一个主要版本),并在随后的字段中输入1.0.0
  4. 点击Add Package(添加包)
  5. 在即将出现的窗口中确认Add Package(添加包)

设置您的第一个特效

设置完成后,添加您的第一个特效非常简单。 它们都是 SwiftUI View,因此您可以直接将它们放入您的布局中并开始使用。 以下是所有的 View

一个使用其中一种特效的 View 的示例

import SwiftUI
import EffectsLibrary

struct ContentView: View {
    var body: some View {
        FireworksView()
    }
}

使用配置自定义特效

可以使用它们的配置文件进一步自定义特效。这是一个示例:

struct ContentView: View {
    var body: some View {
        FireworksView(
            config: FireworksConfig(
                content: [
                    .shape(.triangle, .blue, 10.0),
                    .shape(.square, .green, 10.0),
                    .shape(.circle, .red, 10.0),
                    .emoji("🚀", 10.0),
                    .emoji("💥", 3.0),
                    .image(UIImage(named: "stream-logo")!, nil, 0.8)
                ],
                intensity: .high,
                lifetime: .long,
                initialVelocity: .fast,
                fadeOut: .slow
            )
        )
    }
}

我们为您提供的教程中还有更多示例。

🧵 实用资源

我们创建了一个漂亮的文档站点,以帮助您开始使用该库。那里有一些基础文章(并且会随着时间的推移添加更多)。

我们还创建了一些教程,以使您尽可能无缝地开始使用该库。 有一个入门级教程,您将学习如何将库添加到您的应用程序,并通过添加第一个特效来迈出第一步。

还有一个高级教程,展示了如何根据您的需要配置特效。 这将包括使用不同的配置进行微调。 此外,它将展示如何完全改变特效并添加自定义品牌,所有这些都只需很少的代码。

有趣的是,我们在整个软件包中完全使用了 Apple 优秀的 DocC 文档风格。 这意味着所有功能都有详细的文档记录,并且与 Xcode 完美集成。

您甚至可以了解教程和整个文档的创建方式。 只需查看 Documentation 文件夹

此外,我们还创建了一个示例应用程序,以便您可以了解如何在实际应用程序中利用该库。 这也是完全开源的,并且展示了我们库中的所有特效。

注意:我们总是很高兴看到来自社区的贡献,所以请随意尝试,提出问题和 PR,并享受其中的乐趣。

🤩 关于我们

该软件包由 Stefan BlosAmos GyamfiStream 创建。 如果您想贡献或只是想联系我们,您可以在 Github 上(通过 issue、PR 或类似方式)或 Twitter 上这样做。

非常感谢您考虑我们的产品。 如果您喜欢它,请考虑给该仓库一个 ⭐️,这将帮助我们继续从事该项目,并实现我们为未来计划的所有美好事物。