/LiveData

A simple android LiveData alternative for WPF and C#

Primary LanguageC#MIT LicenseMIT

LiveData

A simple android LiveData alternative for WPF and C#
Easily add reactive properties with a single line of code


License Nuget Nuget downloads Github

Features

  • Automatically notifies value changes
  • Add reactive properties in one line
  • Map LiveData values (Map)
  • Convert one LiveData to another (SwitchMap)
  • Combine two LiveData
  • Debounce emitted values
  • Delay emitted values
  • Convert Task to LiveData

Available for

NET6
NET5
NETCore3
NETFramework48
NETFramework47
NETFramework46

How to use

Use LiveData on your viewmodels and add reactive properties

public class MyViewModel : ViewModel {

	public LiveData<string> SearchQuery { get; set; }
	public LiveData<bool> IsVisible { get; set; }

	public MyViewModel() {

		SearchQuery = new LiveData<string>("");
		SearchQuery.Value = "myname";

		//React to SearchQuery changes and map the value to a boolean.
		//Everything is automatically notified to the UI
		IsVisible = SearchQuery.Map<bool>(it => it != "");
	}

}

Transformations

//Map values to async functions
IsVisible = SearchQuery.MapAsync<bool>(it => Task.FromResult(true));


//Delay emitted values
DelayedLiveData = MyLiveData.Delay(1000);


//Debounce emitted values
Debounced = MyLiveData.Debounce(1000);


//Combine two LiveData
Combined = First.CombineWith(Second, (a, b) => a + b);


//Convert one LiveData to another LiveData
Mapped = IsVisible.SwitchMap(it => it ? SearchResultLiveData : EmptyResultLiveData);


//Concatenate transformation functions
FinalLiveData = Name.Delay(1000)
                    .Debounce(800)
                    .Map(name => "Hello" + name);

Utils

Extensions further simplify using and transforming LiveData objects.

//Convert task to LiveData
var task = Task.FromResult(true);
LiveData<bool> IsVisible = task.ToLiveData<bool>();

//Append, prepend, remove into LiveData of lists
//Changes are notified
LiveData<List<string>> Items;
Items.Remove("first");
Items.Append("first");
Items.Prepend("first");

LiveData and XAML Binding

Bind LiveData to xaml properties

<!-- Bind the "Value" property --->
<TextBlock Text="{Binding LiveData.Value}" />

📜 License

Copyright (c) 2022 Marco

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.