-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation with the setup guide and example added
- Loading branch information
Showing
4 changed files
with
192 additions
and
11 deletions.
There are no files selected for viewing
91 changes: 91 additions & 0 deletions
91
.swiftpm/xcode/xcshareddata/xcschemes/WrappingStack.xcscheme
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <Scheme | ||
| LastUpgradeVersion = "1250" | ||
| version = "1.3"> | ||
| <BuildAction | ||
| parallelizeBuildables = "YES" | ||
| buildImplicitDependencies = "YES"> | ||
| <BuildActionEntries> | ||
| <BuildActionEntry | ||
| buildForTesting = "YES" | ||
| buildForRunning = "YES" | ||
| buildForProfiling = "YES" | ||
| buildForArchiving = "YES" | ||
| buildForAnalyzing = "YES"> | ||
| <BuildableReference | ||
| BuildableIdentifier = "primary" | ||
| BlueprintIdentifier = "WrappingStack" | ||
| BuildableName = "WrappingStack" | ||
| BlueprintName = "WrappingStack" | ||
| ReferencedContainer = "container:"> | ||
| </BuildableReference> | ||
| </BuildActionEntry> | ||
| <BuildActionEntry | ||
| buildForTesting = "YES" | ||
| buildForRunning = "YES" | ||
| buildForProfiling = "NO" | ||
| buildForArchiving = "NO" | ||
| buildForAnalyzing = "YES"> | ||
| <BuildableReference | ||
| BuildableIdentifier = "primary" | ||
| BlueprintIdentifier = "WrappingStackTests" | ||
| BuildableName = "WrappingStackTests" | ||
| BlueprintName = "WrappingStackTests" | ||
| ReferencedContainer = "container:"> | ||
| </BuildableReference> | ||
| </BuildActionEntry> | ||
| </BuildActionEntries> | ||
| </BuildAction> | ||
| <TestAction | ||
| buildConfiguration = "Debug" | ||
| selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB" | ||
| selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB" | ||
| shouldUseLaunchSchemeArgsEnv = "YES"> | ||
| <Testables> | ||
| <TestableReference | ||
| skipped = "NO"> | ||
| <BuildableReference | ||
| BuildableIdentifier = "primary" | ||
| BlueprintIdentifier = "WrappingStackTests" | ||
| BuildableName = "WrappingStackTests" | ||
| BlueprintName = "WrappingStackTests" | ||
| ReferencedContainer = "container:"> | ||
| </BuildableReference> | ||
| </TestableReference> | ||
| </Testables> | ||
| </TestAction> | ||
| <LaunchAction | ||
| buildConfiguration = "Debug" | ||
| selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB" | ||
| selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB" | ||
| launchStyle = "0" | ||
| useCustomWorkingDirectory = "NO" | ||
| ignoresPersistentStateOnLaunch = "NO" | ||
| debugDocumentVersioning = "YES" | ||
| debugServiceExtension = "internal" | ||
| allowLocationSimulation = "YES"> | ||
| </LaunchAction> | ||
| <ProfileAction | ||
| buildConfiguration = "Release" | ||
| shouldUseLaunchSchemeArgsEnv = "YES" | ||
| savedToolIdentifier = "" | ||
| useCustomWorkingDirectory = "NO" | ||
| debugDocumentVersioning = "YES"> | ||
| <MacroExpansion> | ||
| <BuildableReference | ||
| BuildableIdentifier = "primary" | ||
| BlueprintIdentifier = "WrappingStack" | ||
| BuildableName = "WrappingStack" | ||
| BlueprintName = "WrappingStack" | ||
| ReferencedContainer = "container:"> | ||
| </BuildableReference> | ||
| </MacroExpansion> | ||
| </ProfileAction> | ||
| <AnalyzeAction | ||
| buildConfiguration = "Debug"> | ||
| </AnalyzeAction> | ||
| <ArchiveAction | ||
| buildConfiguration = "Release" | ||
| revealArchiveInOrganizer = "YES"> | ||
| </ArchiveAction> | ||
| </Scheme> |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,67 @@ | ||
| # Swiftui WrappingStack | ||
| # SwiftUI WrappingStack | ||
|
|
||
|      [](https://github.com/diniska/swiftui-wrapping-stack/actions/workflows/test.yml) | ||
|      [](https://github.com/diniska/swiftui-wrapping-stack/actions/workflows/test.yml) | ||
|
|
||
| A SwiftUI Views for wrapping HStack elements into multiple lines. | ||
|
|
||
| `WrappingHStack` - provides `HStack` that supports line wrapping | ||
| ## List of supported views | ||
|
|
||
| * `WrappingHStack` - provides `HStack` that supports line wrapping | ||
|
|
||
| ## How to use | ||
| ### Step 1 | ||
| Add a dependency using Swift Package Manager to your project: [https://github.com/diniska/swiftui-wrapping-stack](https://github.com/diniska/swiftui-wrapping-stack) | ||
|
|
||
| ### Step 2 | ||
| Import the dependency | ||
|
|
||
| ```swift | ||
| import WrappingStack | ||
| ``` | ||
|
|
||
| ### Step 3 | ||
| Replace `HStack` with `WrappingHStack` in your view structure. It is compatible with `ForEach`. | ||
|
|
||
| ```swift | ||
| struct MyView: View { | ||
|
|
||
| let elements = ["Cat 🐱", "Dog 🐶", "Sun 🌞", "Moon 🌕", "Tree 🌳"] | ||
|
|
||
| var body: some View { | ||
| WrappingHStack(id: \.self) { // use the same id is in the `ForEach` below | ||
| ForEach(elements, id: \.self) { element in | ||
| Text(element) | ||
| .padding() | ||
| .background(Color.gray) | ||
| .cornerRadius(6) | ||
| } | ||
| } | ||
| .frame(width: 300) // limiting the width for demo purpose. This line is not needed in real code | ||
| } | ||
|
|
||
| } | ||
| ``` | ||
|
|
||
| The result of the code above: | ||
|
|
||
|  | ||
|
|
||
|
|
||
| ## Customization | ||
|
|
||
| Customize appearance using the next parameters. All the default SwiftUI modifiers can be applied as well. | ||
|
|
||
| ### `WrappingHStack` parameters | ||
|
|
||
| Parameter name | Description | ||
| ---------------|-------------- | ||
| `alignment` | horizontal and vertical alignment. `.center` is used by default. Vertical alignment is applied to every row | ||
| `horizontalSpacing` | horizontal spacing between elements | ||
| `verticalSpacing` | vertical spacing between the lines | ||
|
|
||
| ## Performance considerations | ||
|
|
||
| The code written in a way to cache the elements representing views sizes, it doesn't re-calculate the size for different views with the same id. | ||
|
|
||
| * huge numbers of elements are not recommended, although the same applies to `HStack` where `LazyHStack` is a better alternative for the long rows. If you have a large number of elements - double-check the memory and performance on a real device | ||
| * it is pretty good in terms of CPU consumption as every element calculates its size only once. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters