-
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add documentation * Create generate_docs.sh * Proof reading documentation + better for Jazzy * Lint fix
- Loading branch information
1 parent
b0849d1
commit d463f7b
Showing
13 changed files
with
192 additions
and
132 deletions.
There are no files selected for viewing
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
This file was deleted.
Oops, something went wrong.
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
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,69 @@ | ||
| Fluxor is based on Combine and is therefore ideal to use with SwiftUI. It comes with a separate package (**FluxorSwiftUI**) with extensions for `Store` and types that can be used directly in [SwiftUI Views](https://developer.apple.com/documentation/swiftui/view). | ||
|
|
||
| ## Observing a value | ||
|
|
||
| The `ObservableValue` can be used to observe a value in the `State`. It can be created by calling the `observe` function found in the `Store` extension. When wrapping the `ObservableValue` in an [`@ObservedObject`](https://developer.apple.com/documentation/swiftui/observedobject) property wrapper, its `current` property can be used like any other value wrapped in a [`@State`](https://developer.apple.com/documentation/swiftui/state) property wrapper. | ||
|
|
||
| ```swift | ||
| import FluxorSwiftUI | ||
| import SwiftUI | ||
|
|
||
| struct DrawView: View { | ||
| @ObservedObject var canClear = Current.store.observe(Selectors.canClear) | ||
|
|
||
| var body: some View { | ||
| Button(action: { ... }, label: { Text("Clear") }) | ||
| .disabled(!canClear.current) | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Binding a value which can be changed | ||
|
|
||
| The `ValueBinding` can be used to create a [`Binding`](https://developer.apple.com/documentation/swiftui/binding) to a value in the `State` and use an `ActionTemplate` to update the value through the `Store`. The `binding` property on `ValueBinding` will create a [`Binding`](https://developer.apple.com/documentation/swiftui/binding) which can be used like any other bindings. The value can also manually be updated using the `update` function. This will dispatch an `Action` on the `Store` based on the specified `ActionTemplate`. | ||
|
|
||
| ```swift | ||
| import FluxorSwiftUI | ||
| import SwiftUI | ||
|
|
||
| struct GreetingView: View { | ||
| var greeting = Current.store.binding(get: Selectors.getGreeting, send: Actions.setGreeting) | ||
|
|
||
| var body: some View { | ||
| TextField("Greeting", text: greeting.binding) | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Binding a value which can be enabled and disabled | ||
|
|
||
| When the `ValueBinding` has a `Bool` value, it can be created with a `ActionTemplate` for enabling the value (making it `true`) and another one for disabling the value (making it `false`). When the value is `Bool` and the payload for the `ActionTemplate` is either `Void` or `Bool`, the `ValueBinding` gains more functions beside the `update` function to `toggle`, `enable` and `disable` the value. | ||
|
|
||
| ```swift | ||
| import FluxorSwiftUI | ||
| import SwiftUI | ||
|
|
||
| struct DrawView: View { | ||
| var showClearActionSheet = Current.store.binding(get: Selectors.isClearOptionsVisible, | ||
| enable: Actions.askToClear, | ||
| disable: Actions.cancelClear) | ||
|
|
||
| var body: some View { | ||
| Button(action: { self.showClearActionSheet.enable() }, label: { Text("Clear") }) | ||
| .actionSheet(isPresented: showClearActionSheet.binding) { clearActionSheet } | ||
| } | ||
|
|
||
| private var clearActionSheet: ActionSheet { | ||
| .init(title: Text("Clear"), | ||
| message: Text("Are you sure you want to clear?"), | ||
| buttons: [ | ||
| .destructive(Text("Yes, clear")) { | ||
| Current.store.dispatch(action: Actions.clear()) | ||
| }, | ||
| .cancel(Text("Cancel")) { | ||
| self.showClearActionSheet.disable() | ||
| } | ||
| ]) | ||
| } | ||
| } | ||
| ``` |
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,6 @@ | ||
| rm -rf docs | ||
| sourcekitten doc --spm --module-name Fluxor > mod1.json | ||
| sourcekitten doc --spm --module-name FluxorTestSupport > mod2.json | ||
| sourcekitten doc --spm --module-name FluxorSwiftUI > mod3.json | ||
| jazzy --sourcekitten-sourcefile mod1.json,mod2.json,mod3.json | ||
| open docs/index.html |
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
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
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
Oops, something went wrong.