Uno.Dsp.Tasks 1.2.8

Uno DSP Tooling - MSBuild Tasks

This is the package that contains the MSBuild tasks to automate the generation of the color overrides file in projects using Uno.

This is used to generate Color Overrides file for project using Uno.Themes like documented on the official documentation.

How to get your DSP file

DSP Files are used to define the color palette of a theme and can be generated using the Material V3 Theme Builder web site. Simply export using the "Material Tokens (DSP)" format and download the generated zip file.

Configuration

1. You need to add reference to the Uno.Dsp.Tasks package in the project where you want the color overrides file to be generated.

   [-- MyProject.Shared\MyProject.Shared.csproj --]
   <ItemGroup>
       [-- You'll need to replace the version for the proper one --]
       <PackageReference Include="Uno.Dsp.Tasks" Version="[version]" />
   </ItemGroup>
   

2. Place your DSP zip file close to where you want the color overrides file to be generated. This is usually in the Styles folder on the shared project.

   ex: MyProject.Shared\Styles\MyTheme.zip

3. You need to add the following PropertyGroupto your project file:

   [-- MyProject.Shared\MyProject.Shared.csproj --]
   <PropertyGroup>
      <UnoDspImportColors Include="*.zip" Generator="xaml" />
   </PropertyGroup>
   

4. Compile and you should get a new file named MyTheme.xaml in the same folder as your DSP file.

5. Reference this file in your App.xaml file, following the Uno Themes documentation:

   [-- App.xaml --]
   <Application.Resources>
      <MaterialColors xmlns="using:Uno.Material"
                      OverrideSource="ms-appx:///Styles/MyTheme.xaml" />
   </Application.Resources>
   

Another tool - CLI

Another tool exists, called Uno.Dsp.Cli to generate the output file from the command line. It is less integrated than this MSBuild task, but it can be used to generate the color overrides file from a DSP file that is not in your project or if you need more flexibility on the moment when it is generated.