Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/olehkorchytskyi/fit
SwiftUI layout for arranging elements in lines, dynamically adjusting to the available space.
https://github.com/olehkorchytskyi/fit
flow-layout layout swift swiftui ui
Last synced: about 1 month ago
JSON representation
SwiftUI layout for arranging elements in lines, dynamically adjusting to the available space.
- Host: GitHub
- URL: https://github.com/olehkorchytskyi/fit
- Owner: OlehKorchytskyi
- License: mit
- Created: 2024-01-31T19:46:34.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-06-09T14:52:11.000Z (7 months ago)
- Last Synced: 2024-10-19T17:58:27.551Z (2 months ago)
- Topics: flow-layout, layout, swift, swiftui, ui
- Language: Swift
- Homepage:
- Size: 32.2 KB
- Stars: 50
- Watchers: 2
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**Fit** allows you to lay out your views into lines without ever bothering to group or measure them, all thanks to the implementation of the **Layout** protocol.
## Usage
Add your views just like you would do it with all other **SwiftUI** stacks:
```swift
import Fit
Fit {
Text("Tags:")
ForEach(tags) { tag in
TagView(tag: tag)
}
TextField("New tag", text: $input)
}
```
> [!NOTE]
> Full code for this example: [Tag List Example](https://github.com/OlehKorchytskyi/FitPlayground/blob/main/FitPlayground/FitPlayground/Examples/TagListExample.swift).
## Customisation
**Fit** provides multiple ways to customise your layout:
#### Line Alignment and Spacing
```swift
// .leading (default), .center or .trailing
Fit(lineAlignment: .center, lineSpacing: 12) {
// views
}
```
> [!NOTE]
> The default line spacing is **.viewSpacing**, which merges spacing of all items in the line and then uses vertical distance, [ViewSpacing.distance](https://developer.apple.com/documentation/swiftui/viewspacing/distance(to:along:)), to add spacing between to lines.
#### Item Alignment and Spacing
You can align items in the same way you would do in **HStack**:
```swift
// fixed item spacing
Fit(itemAlignment: .firstTextBaseline, itemSpacing: 8) {
// views
}
// view's preferred spacing
Fit(itemAlignment: .firstTextBaseline, itemSpacing: .viewSpacing(minimum: 8)) {
// views
}
```
#### Line-Break
Use view modifier to add line-break before or after a particular view:
```swift
Fit {
Text("Title:")
.fit(lineBreak: .after)
// next views
}
```
#### Per-line styling
You can define secific style for each line with **LineStyle**:
```swift
let conveyorBeltStyle: LineStyle = .lineSpecific { style, line in
// reverse every second line
style.reversed = (line.index + 1).isMultiple(of: 2)
// if the line is reversed, it should start from the trailing edge
style.alignment = style.reversed ? .trailing : .leading
}
Fit(lineStyle: conveyorBeltStyle) {
// views
}
```
> [!NOTE]
> Full code for this example: [Conveyor Belt Example](https://github.com/OlehKorchytskyi/FitPlayground/blob/main/FitPlayground/FitPlayground/Examples/ConveyorBeltExample.swift).
It is also possible to create a variable style:
```swift
var fancyAlignJustified: LineStyle {
.lineSpecific { style, line in
if stretch {
style.stretched = line.percentageFilled >= threshold
}
}
}
Fit(lineStyle: fancyAlignJustified) {
// views
}
```
> [!NOTE]
> Full code for this example: [Long Text Example](https://github.com/OlehKorchytskyi/FitPlayground/blob/main/FitPlayground/FitPlayground/Examples/LongTextExample.swift).
## Installing
Use **Swift Package Manager** to get **Fit**:
```swift
.package(url: "https://github.com/OlehKorchytskyi/Fit", from: "1.0.2")
```
Import **Fit** into your Swift code:
```swift
import Fit
```
## License
MIT License.
Copyright (c) 2024 Oleh Korchytskyi.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.