Skip to content

Generalize and extend API #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ArtemyB wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Generalize and extend API #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a973d7f
refactor: move hooks from type to module
ArtemyB Aug 9, 2024
9be2b44
build: update project configuration
ArtemyB Aug 9, 2024
7b039dd
feat!: generalize store API
ArtemyB Aug 25, 2024
bb6e10f
feat: introduce `StoreApi` module
ArtemyB Aug 26, 2024
77f86d4
fix(Example): fix new API call error, add some comments on the new AP…
ArtemyB Aug 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .config/dotnet-tools.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"isRoot": true,
"tools": {
"fable": {
"version": "4.9.0",
"version": "4.7.0",
"commands": [
"fable"
]
Expand Down
5 changes: 3 additions & 2 deletions src/ElmishStore.Example/ElmishStore.Example.fsproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
<?xml version="1.0" encoding="utf-8"?>
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
Expand Down Expand Up @@ -31,8 +31,9 @@
</ItemGroup>
<ItemGroup>
<PackageReference Include="Fable.Elmish.Debugger" Version="4.0.0" />
<PackageReference Include="Feliz" Version="2.8.0" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\ElmishStore\ElmishStore.fsproj" />
</ItemGroup>
</Project>
</Project>
32 changes: 24 additions & 8 deletions src/ElmishStore.Example/ModelStore.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,35 @@ open Elmish.Debug

#endif

let store =
Program.mkProgram init update (fun _ _ -> ())
#if DEBUG
|> Program.withConsoleTrace
|> Program.withDebugger
#endif
|> ElmishStore.createStore "main"
// One additional step (comparing with the previous module-based API).
// However, creating the Host on the global level is essentially the same as using the module-based API.
let storesHost = ElmishStoresHost<string>()

let store =
let program =
Program.mkProgram init update (fun _ _ -> ())
#if DEBUG
|> Program.withConsoleTrace
|> Program.withDebugger
#endif
storesHost.create "main" program

(*// Previous API:
[<Hook>]
let useSelector (selector: Model -> 'a) = React.useElmishStore (store, selector)

[<Hook>]
let useSelectorMemoized (memoizedSelector: Model -> 'a) =
React.useElmishStoreMemoized (store, memoizedSelector)
React.useElmishStoreMemoized (store, memoizedSelector)
*)

// Instead of defining separate custom hooks for a specific Store,
// just create all the Store-related hooks packed in an object.
let storeApi = StoreApi.getElmishStoreApi store

// These helpers should be inline so that Fable doesn't generate unnecessary extra-functions around the hooks.
// However, these helpers aren't really needed, as the hooks could be called directly from the `storeApi` value.
let inline useSelector selector = storeApi.useSelector selector
let inline useSelectorMemoized selector = storeApi.useSelectorMemoized selector

let dispatch = store.Dispatch
Loading