EasyConfetti 使用教程

1. 项目的目录结构及介绍

EasyConfetti 项目的目录结构如下：

EasyConfetti/
├── .github/              # GitHub 相关配置文件
├── .gitignore            # 指定 Git 忽略的文件
├── CONTRIBUTING.md       # 贡献指南
├── LICENSE.md            # 开源协议
├── README.md             # 项目描述文件
├── demo.gif              # 演示动画
├── Sources/              # 源代码目录
│   └── EasyConfetti/     # EasyConfetti 主要源代码
└── swiftpm/              # Swift 包管理器配置
    └── package.xcworkspace # Xcode 工作区文件

• .github/: 存放 GitHub 相关的配置文件，如 funding.yml 等。
• .gitignore: 指定 Git 忽略的文件列表，用于保持仓库的清洁。
• CONTRIBUTING.md: 提供贡献指南，指导他人如何参与项目的贡献。
• LICENSE.md: 项目所采用的开源协议文件，本项目采用 MIT 协议。
• README.md: 项目的说明文档，介绍项目的基本信息和用法。
• demo.gif: 项目效果演示的动图。
• Sources/: 源代码目录，包含所有项目代码。
• swiftpm/: Swift 包管理器配置目录，包含项目依赖和构建配置。

2. 项目的启动文件介绍

项目的启动主要通过 Xcode 工作区文件 package.xcworkspace 来进行。打开该文件会启动 Xcode，并加载项目。

在 Sources/EasyConfetti/ 目录下，主要的启动文件是 ConfettiView.swift，它定义了 ConfettiView 类，用于显示和配置礼花效果。

import UIKit

open class ConfettiView: UIView {
    //...
}

3. 项目的配置文件介绍

项目的配置主要通过修改 ConfettiView 类中的 config 属性来完成。以下是一些基本的配置选项：

• particle: 用于设置礼花粒子，可以是形状、文本或图片。
• colors: 用于设置礼花粒子的颜色。
• customize: 用于自定义粒子细胞的展示。

以下是一个简单的配置示例：

let confettiView = ConfettiView()
view.addSubview(confettiView)

confettiView.config.particle = .confetti(allowedShapes: .all)
confettiView.config.colors = [UIColor.red, UIColor.green]
confettiView.start()

在这个示例中，我们创建了一个 ConfettiView 实例，将其添加到视图中，然后配置礼花粒子的形状为所有可用形状，颜色为红色和绿色，最后开始显示礼花效果。

请注意，具体的配置选项和用法可以参考项目的 README.md 文件。