https://github.com/tgrapperon/swiftui-layout-guides

Expose layout margins and readable content width to SwiftUI's Views
https://github.com/tgrapperon/swiftui-layout-guides

Last synced: 29 days ago
JSON representation

Expose layout margins and readable content width to SwiftUI's Views

• Host: GitHub
• URL: https://github.com/tgrapperon/swiftui-layout-guides
• Owner: tgrapperon
• License: mit
• Created: 2021-09-02T20:33:13.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-01-21T01:48:25.000Z (almost 2 years ago)
• Last Synced: 2024-05-01T18:11:34.521Z (7 months ago)
• Language: Swift
• Size: 27.3 KB
• Stars: 55
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SwiftUI Layout Guides

This micro-library exposes UIKit's layout margins and readable content guides to SwiftUI.

 

## Usage

### Make a view fit the readable content width

Simply call the `fitToReadableContentWidth()` modifier:

```swift

List {

 ForEach(…) {

   Cell()

     .fitToReadableContentWidth()

 }

}

```

### Expose the layout margins in a block

Wrap your view in the `WithLayoutMargins` view. The initializer supports two variants: one closure without argument and one closure with a `EdgeInsets` argument. In this last case, the insets correspond to the layout margins for the content:

```swift

WithLayoutMargins { layoutMarginsInsets in

 Text("ABC")

   .padding(.leading, layoutMarginsInsets.leading) 

}

```

### Expose layout margins and readable content guides in a view

You need two wrap your view in `WithLayoutMargins` (you can use the argument-less closure). This will populate the content's `Environment` with the layout margins and readable content in the form of insets. 

```swift

WithLayoutMargins {

 Content()

}

struct Content: View {

  @Environment(\.layoutMarginsInsets) var layoutMarginsInsets

  @Environment(\.readableContentInsets) var readableContentInsets

  var body: some View {

    Text("ABC")

      .padding(.leading, layoutMarginsInsets.leading)

      …

  }

}

```

These insets are only valid for the bounds of the root content view. Using them deeper in the hierachy may lead to insconsitent results and you should use the  `measureLayoutMargins()` modifier if you want to refresh the insets for the target view.

## Installation

Add `.package(url: "https://github.com/tgrapperon/swiftui-layout-guides", from: "0.0.1")` to your Package dependencies, and then 

```

.product(name: "SwiftUILayoutGuides", package: "swiftui-layout-guides")

```

to your target's dependencies.