Skip to content

ReactiveUIBuilder class

Attributes: [DebuggerDisplay("ReactiveUIBuilder")]

Defined in

Namespace: ReactiveUI.Reactive.Builder Assembly: ReactiveUI.Reactive.dll Full name: ReactiveUI.Reactive.Builder.ReactiveUIBuilder Modifiers: public sealed

Summary

View source

        A builder class for configuring ReactiveUI services with AOT compatibility.
        Extends the Splat AppBuilder to provide ReactiveUI-specific configuration.
        

Applies to

net10.0, net10.0-maccatalyst26.0, net10.0-desktop1.0, net10.0-browserwasm1.0, net10.0-tvos26.0, net10.0-windows10.0.19041, net10.0-macos26.0, net10.0-ios26.0, net10.0-android36.0, net9.0, net9.0-tvos18.0, net9.0-macos15.0, net9.0-maccatalyst18.0, net9.0-windows10.0.19041, net9.0-ios18.0, net9.0-desktop1.0, net8.0, net8.0-windows10.0.19041, net8.0-ios18.0, net8.0-maccatalyst18.0, net8.0-macos15.0, net8.0-tvos18.0, net8.0-ios17.5, net8.0-maccatalyst17.5, net8.0-macos14.5, netstandard2.1, net481, net462, net471

Class hierarchy
classDiagram
class ReactiveUIBuilder
class AppBuilder
AppBuilder <|-- ReactiveUIBuilder
class IReactiveUIBuilder {
    <>
}
IReactiveUIBuilder <|.. ReactiveUIBuilder
class IAppBuilder {
    <>
}
IAppBuilder <|.. ReactiveUIBuilder
class IReactiveUIInstance {
    <>
}
IReactiveUIInstance <|.. ReactiveUIBuilder
class IAppInstance {
    <>
}
IAppInstance <|.. ReactiveUIBuilder

Inherits from: AppBuilder

Implements: IReactiveUIBuilder, IAppBuilder, IReactiveUIInstance, IAppInstance

Constructors

NameSummary
.ctorInitializes a new instance of the [ReactiveUIBuilder](# class.

Properties

NameSummary
MainThreadSchedulerGets a scheduler used to schedule work items that should be run "on the UI thread". In normal mode, this will be DispatcherScheduler, and in Unit Test mode this will be...
TaskpoolSchedulerGets the a the scheduler used to schedule work items to run in a background thread. In both modes, this will run on the TPL Task Pool.
ConverterServiceGets the converter service used for binding type conversions.

Methods

NameSummary
BuildBuilds the application and returns the ReactiveUI instance wrapper.
BuildAppBuilds the application and returns the ReactiveUI instance wrapper.
WithInstanceResolves a single instance and passes it to the action.
WithMainThreadSchedulerConfigures the main thread scheduler for ReactiveUI.
WithTaskPoolSchedulerConfigures the task pool scheduler for ReactiveUI.
WithRegistrationOnBuildAdds a custom ReactiveUI registration action.
WithRegistrationAdds a custom ReactiveUI registration action.
WithPlatformServicesRegisters the platform-specific ReactiveUI services.
WithCoreServicesRegisters the core ReactiveUI services in an AOT-compatible manner.
WithViewsFromAssemblyAutomatically registers all views that implement IViewFor from the specified assembly.
WithPlatformModuleRegisters a platform-specific registration module by type.
UsingSplatModuleUsing the splat module.
UsingSplatBuilderUses the splat builder.
ForCustomPlatformConfigures a custom platform implementation for ReactiveUI.
ForPlatformsConfigures ReactiveUI for multiple platforms simultaneously.
WithMessageBusConfigures the ReactiveUI message bus.
ConfigureViewLocatorConfigures the ReactiveUI view locator.
ConfigureSuspensionDriverConfigures the ReactiveUI suspension driver.
WithConverterRegisters a typed binding converter using the concrete type.
WithFallbackConverterRegisters a fallback binding converter.
WithSetMethodConverterRegisters a set-method binding converter.
WithConvertersFromImports all converters from a Splat dependency resolver into the builder.
WithExceptionHandlerConfigures a custom exception handler for unhandled errors in ReactiveUI observables.
WithSuspensionHostConfigures the non-generic suspension host for application lifecycle management.
WithCacheSizesConfigures custom cache size limits for ReactiveUI's internal memoizing caches.
RegisterViewModelRegisters a custom view model with the dependency resolver.
RegisterConstantViewModelRegisters a constant instance of the specified view model type in the dependency resolver.
RegisterSingletonViewModelRegisters a custom view model with the dependency resolver.
RegisterViewRegisters a custom view for a specific view model.
RegisterSingletonViewRegisters a custom view for a specific view model.
Inherited members