https://github.com/surfstudio/surfplaybook
iOS framework for Playbook
https://github.com/surfstudio/surfplaybook
Last synced: 6 months ago
JSON representation
iOS framework for Playbook
- Host: GitHub
- URL: https://github.com/surfstudio/surfplaybook
- Owner: surfstudio
- License: mit
- Created: 2021-04-13T12:16:04.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-11T09:48:15.000Z (8 months ago)
- Last Synced: 2025-04-13T07:13:10.850Z (6 months ago)
- Language: Swift
- Size: 27.3 MB
- Stars: 19
- Watchers: 7
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# SurfPlaybook
[](https://github.com/surfstudio/SurfPlaybook/actions)
[](https://cocoapods.org/pods/SurfPlaybook)
[](https://github.com/apple/swift-package-manager)
iOS framework for Playbook
[](https://github.com/surfstudio/SurfPlaybook)
## About
Библиотека для быстрого и легкого построения playbook-а проекта, который бы включал в себя его основные UI-компоненты,
а также, при необходимости, давал бы возможность быстрого доступа к его основным экранам.
## Screenshots
## Installation
#### CocoaPods:
Добавьте в свой Podfile следующую строку, затем запустите `pod install`
```ruby
pod 'SurfPlaybook'
```
#### Swift Package Manager
- В XCode пройдите в `File > Swift Packages > Add Package Dependency`
- Введите URL репозитория `https://github.com/surfstudio/SurfPlaybook.git`
## Features
При создании библиотеки преследовались следующие цели: создать площадку для тестирования и наглядного отображения всех переиспользуемых компонентов проекта
- что могло бы помочь как при проектировании новых фич
- так и при взаимодействии с дизайн-отделом
- облегчило бы вход новых разработчиков в проект
- и ускорило бы разработку
Для этого были реализованы следующие фичи:
- **Chapters-Page** - система глав и страниц, как в настоящей книге, где каждой главе соответствует набор UI-компонентов, объединенных по смыслу общим принаком,
а каждой странице - непосредственно сам UI-компонент
- общее отображение всех UI-компонентов, поиск по названию, а также детальный просмотр компонента
- возможность задать набор различных состояний для одного UI-компонента и возможность переключения между ними при его детальном просмотре
- **UIKit Pages** - механика для построения полноценного UIKit-а проекта, где вам будет дана возможность заполнить табличные экраны необходимыми именно вам данными,
для, например, отображения цветовой палитры приложения, или же для отображения всех доступных стилей кнопок
- **Flow Coordinators** - возможность задать точку входа на любой экран приложения, или же получить возможность подключить тестовый экран-playground
для тестирования новых UI-компонентов в процессе их разработки
- возможность кастомизации цветовой палитры и текстов playbook-а
## Example
Все вышеперечисленное можно увидеть в Example-проекте. Для его корректного запуска и конфигурации скачайте репозиторий и выполните команду `make init` перед тем как его запустить.
## Usage
Доступ к playbook осуществляется через singleton
```swift
Playbook.shared
```
Дальнейшая работа с ним заключается в двух шагах
```swift
func application(_ application: UIApplication,
didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
window = UIWindow(frame: UIScreen.main.bounds)
window?.rootViewController = UIViewController()
window?.makeKeyAndVisible()
// 1
Playbook.shared
.add(chapter: ControlsChapter().build())
.add(uiKitPage: ColorsUIKitPage())
.add(flowCoordinator: AuthFlowCoordinator())
// 2
Playbook.shared.start(from: self.window)
return true
}
```
1. Заполнить playbook необходимыми вам данными
2. Запустить playbook, передав в качестве параметра `KeyAndVisible`-window, в рамках которого отображается приложение
При необходимости - перед шагом `[2]` можно изменить цветовую палитру playbook-а и вшитые в него тексты на подходящие именно вам (для этого предусмотрены `ColorsConfig` и `StringsConfig`).
## Changelog
Список всех изменений можно посмотреть в этом [файле](./CHANGELOG.md).
## License
[MIT License](./LICENSE)