StarFederation.Datastar.FSharp
1.1.0
dotnet add package StarFederation.Datastar.FSharp --version 1.1.0
NuGet\Install-Package StarFederation.Datastar.FSharp -Version 1.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="StarFederation.Datastar.FSharp" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="StarFederation.Datastar.FSharp" Version="1.1.0" />
<PackageReference Include="StarFederation.Datastar.FSharp" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add StarFederation.Datastar.FSharp --version 1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: StarFederation.Datastar.FSharp, 1.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package StarFederation.Datastar.FSharp@1.1.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=StarFederation.Datastar.FSharp&version=1.1.0
#tool nuget:?package=StarFederation.Datastar.FSharp&version=1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Datastar + dotnet
Real-time Hypermedia first Library and Framework for dotnet
HTML Frontend
<main class="container" id="main" data-signals="{'input':'','output':'what'}">
<button data-on-click="@get('/displayDate')">Display Date</button>
<div id="target"></div>
<input type="text" placeholder="input:" data-bind-input/><br/>
<span data-text-output></span>
<button data-on-click="@post('/changeOutput')">Change Output</button>
</main>
C# Backend
using StarFederation.Datastar;
using StarFederation.Datastar.DependencyInjection;
using System.Text.Json;
using System.Text.Json.Serialization;
// add as an ASP Service
// allows injection of IDatastarService, to respond to a request with a Datastar friendly ServerSentEvent
// and to read the signals sent by the client
builder.Services.AddDatastar();
// displayDate - patching an element
app.MapGet("/displayDate", async (IDatastarService datastarService) =>
{
string today = DateTime.Now.ToString("%y-%M-%d %h:%m:%s");
await datastarService.PatchElementsAsync($"""<div id='target'><span id='date'><b>{today}</b><button data-on-click="@get('/removeDate')">Remove</button></span></div>""");
});
// removeDate - removing an element
app.MapGet("/removeDate", async (IDatastarService datastarService) => { await datastarService.RemoveElementAsync("#date"); });
public record MySignals {
[JsonPropertyName("input")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Input { get; init; } = null;
[JsonPropertyName("output")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Output { get; init; } = null;
public string Serialize() => ...
}
// changeOutput - reads the signals, update the Output, and merge back
app.MapPost("/changeOutput", async (IDatastarService datastarService) => ...
{
MySignals signals = await datastarService.ReadSignalsAsync<MySignals>();
MySignals newSignals = new() { Output = $"Your Input: {signals.Input}" };
await datastarService.PatchSignalsAsync(newSignals.Serialize());
});
Model Binding
public class MySignals {
public string myString { get; set; } = "";
public int myInt { get; set; } = 0;
public InnerSignals myInner { get; set; } = new();
public class InnerSignals {
public string myInnerString { get; set; } = "";
public int myInnerInt { get; set; } = 0;
}
}
public IActionResult Test_GetSignals([FromSignals] MySignals signals) => ...
public IActionResult Test_GetValues([FromSignals] string myString, [FromSignals] int myInt) => ...
public IActionResult Test_GetInnerPathed([FromSignals(Path = "myInner")] MySignals.InnerSignals myInnerOther) => ...
public IActionResult Test_GetInnerValues([FromSignals(Path = "myInner.myInnerString")] string myInnerStringOther, [FromSignals(Path = "myInner.myInnerInt")] int myInnerIntOther) => ...
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- FSharp.Core (>= 9.0.303)
-
net9.0
- FSharp.Core (>= 9.0.303)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on StarFederation.Datastar.FSharp:
Package | Downloads |
---|---|
StarFederation.Datastar
SDK for Datastar ServerSentEvents and Signals |
GitHub repositories
This package is not used by any popular GitHub repositories.