Code Monkey home page Code Monkey logo

swiftuiguideline's Introduction

SwiftUIGuideline

Гайдлайн по разработке приложений на SwiftUI

Оглавление

Именование

  • Любая View должна иметь суффикс View или компонента. Например: HomeView, FilterButton, TitleLabel, ValueSlider
  • Замыкания у View должны иметь префикс on. Например: onTap, onSelection, onChange, onDrag
  • View-модель должна иметь префикс названия View и суффикс Model. Например: HomeViewModel, FilterViewModel

Ограничения

  • Инициализация View и выполнение body должны быть максимально легкими. Не нагружайте их вычислениями
  • Не используйте вертикальные паддинги в вертикальном стэке и горизонтальные паддинги в горизонтальном стэке. Вместо этого для отступов используйте Spacer() с фиксированной высотой или шириной
  • Не расширяйте View больше 100 строк. Если это случается, то выносите компоненты в отдельные View
  • Выносите отдельные View в вычисляемые переменные или make-методы, если они должны принимать параметры
  • Не расширяйте тело, вычисляемые переменные или make-методы View больше 50 строк
  • Выносите содержимое ForEach в отдельную View, вычисляемые переменные или make-методы
  • Повторяющийся UI в разных View выносите в отдельную View, чтобы не допускать дублирования кода
  • Повторяющийся UI в рамках одной View выносите в вычисляемые переменные или make-методы
  • Модификаторы всегда пишите с новой строки. Рекомендуется:
MyView()
    .frame(height: 20)

Не рекомендуется:

MyView().frame(height: 20)

Использование Property wrappers

  • @State - используется только внутри View, чтобы изменить значение. Всегда делайте приватным
  • @Binding - объявляет, что значение передается снаружи, но может изменяться и внутри View
  • @StateObject - наблюдает за изменениями объекта и отвечает за сохранность данных. Используется только внутри View. Жизненный цикл равен жизненному циклу View. Всегда делайте приватным
  • @ObservedObject - наблюдает за изменениями объекта, но не отвечает за сохранность данных. Используется как внутри View, так и снаружи. Жизненный цикл управляется снаружи
  • @EnvironmentObject - общий объект, расшаренный для чтения/записи для конкретной иерархии View
  • @Environment - общий объект, расшаренный для использования во всем приложении
  • @Published - позволяет создавать наблюдаемые объекты, которые автоматически сообщают, когда происходят изменения. SwiftUI автоматически отслеживает такие изменения и повторно вызывает у View обновление body, в котором используются наблюдаемые объекты. Используется как внутри ObservableObject, так и снаружи

Организация кода

Соблюдайте следующую последовательность свойств внутри View:

struct MyView: some View {
    enum { }
    struct { }
 
    private enum { }
    private struct { }

    let
    
    @Environment var 
    @ObservedObject var 
    @StateObject var 
    @Binding var 
    @State var 
    var
    
    var body: some View { }
    
    private let 

    @Environment private var 
    @ObservedObject private var 
    @StateObject private var 
    @Binding private var 
    @State private var 
    private var 
    
    init() { }
    
    private func () { }
}

Добавляйте пустую строку между разделами. Например:

let state: ViewState<[String]>
let title: String
    
@Binding var filterInfo: [String: Bool]

@State private var isFilterHidden = true

Ссылки

Туториал от Apple
Первое знакомство с компонентами и переход из UIKit
Все базовые вещи SwiftUI
100 дней SwiftUI
Описания Property Wrapper-ов в SwiftUI

swiftuiguideline's People

Contributors

bystritskiy avatar ilya-2606 avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Forkers

bystritskiy

swiftuiguideline's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.