StaticViewLocator

https://github.com/wieslawsoltes/staticviewlocator
Admin
StaticViewLocator is a C# source generator that automatically implements a static view locator for...
Tokens:1,064
Snippets:12
Trust Score:7.2
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Generated View Mappings

Source: https://github.com/wieslawsoltes/staticviewlocator/blob/main/README.md

Example of the generated lookup dictionaries for views and missing views.

```csharp
public partial class ViewLocator
{
	private static Dictionary<Type, Func<Control>> s_views = new()
	{
		[typeof(StaticViewLocatorDemo.ViewModels.TestViewModel)] = () => new StaticViewLocatorDemo.Views.TestView(),
	};

	private static Dictionary<Type, string> s_missingViews = new()
	{
		[typeof(StaticViewLocatorDemo.ViewModels.MainWindowViewModel)] = "Not Found: StaticViewLocatorDemo.Views.MainWindowView",
	};
}
```

--------------------------------

### Add NuGet Package Reference

Source: https://github.com/wieslawsoltes/staticviewlocator/blob/main/README.md

Include the StaticViewLocator package in your project file.

```xml
<PackageReference Include="StaticViewLocator" Version="0.3.0">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
```

--------------------------------

### Implement ViewLocator with StaticViewLocator Attribute

Source: https://github.com/wieslawsoltes/staticviewlocator/blob/main/README.md

Annotate a partial class with [StaticViewLocator] and implement the IDataTemplate interface to handle view resolution.

```csharp
[StaticViewLocator]
public partial class ViewLocator : IDataTemplate
{
    public Control? Build(object? data)
    {
        if (data is null)
        {
            return null;
        }

        var type = data.GetType();
        var func = TryGetFactory(type) ?? TryGetFactoryFromInterfaces(type);

        if (func is not null)
        {
            return func.Invoke();
        }

        var missingView = TryGetMissingView(type) ?? TryGetMissingViewFromInterfaces(type);
        if (missingView is not null)
        {
            return new TextBlock { Text = missingView };
        }

        throw new Exception($"Unable to create view for type: {type}");
    }

    public bool Match(object? data)
    {
        return data is ViewModelBase;
    }
}
```

--------------------------------

### Configure StaticViewLocator via MSBuild

Source: https://github.com/wieslawsoltes/staticviewlocator/blob/main/README.md

Define project-level properties within a PropertyGroup to control how view models are mapped to views.

```xml
<PropertyGroup>
  <StaticViewLocatorViewModelNamespacePrefixes>MyApp.ViewModels;MyApp.Modules</StaticViewLocatorViewModelNamespacePrefixes>
  <StaticViewLocatorIncludeInternalViewModels>false</StaticViewLocatorIncludeInternalViewModels>
  <StaticViewLocatorIncludeReferencedAssemblies>false</StaticViewLocatorIncludeReferencedAssemblies>
  <StaticViewLocatorAdditionalViewBaseTypes>MyApp.Controls.ToolWindowBase</StaticViewLocatorAdditionalViewBaseTypes>
  <StaticViewLocatorNamespaceReplacementRules>ViewModels=Views</StaticViewLocatorNamespaceReplacementRules>
  <StaticViewLocatorTypeNameReplacementRules>ViewModel=View;Vm=Page</StaticViewLocatorTypeNameReplacementRules>
  <StaticViewLocatorStripGenericArityFromViewName>true</StaticViewLocatorStripGenericArityFromViewName>
  <StaticViewLocatorInterfacePrefixesToStrip>I</StaticViewLocatorInterfacePrefixesToStrip>
</PropertyGroup>
```
Tokens:
Raw