Proliminal.BlazorTools 1.1.0

dotnet add package Proliminal.BlazorTools --version 1.1.0
                    
NuGet\Install-Package Proliminal.BlazorTools -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="Proliminal.BlazorTools" Version="1.1.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Proliminal.BlazorTools" Version="1.1.0" />
                    
Directory.Packages.props
<PackageReference Include="Proliminal.BlazorTools" />
                    
Project file
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 Proliminal.BlazorTools --version 1.1.0
                    
#r "nuget: Proliminal.BlazorTools, 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 Proliminal.BlazorTools@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=Proliminal.BlazorTools&version=1.1.0
                    
Install as a Cake Addin
#tool nuget:?package=Proliminal.BlazorTools&version=1.1.0
                    
Install as a Cake Tool

Introduction

I tried to use various Javascript based code syntax highlighting libraries in a Blazor Client app without success.

BlazorTools provides a very lightweight component <strong>CodeBlock</strong> that formats and highlights code. (For now, only Json is supported.)

I also needed a VU meter to show the length of queues, so I created <strong>VuMeter</strong>.

Getting Started

  1. Add the Proliminal.BlazorTools NuGet package.

  2. In index.html add a link to the stylesheet (omit if you create your own styles):

    <link href="_content/Proliminal.BlazorTools/blazortools-codeblock.css" rel="stylesheet" />
    <link href="_content/Proliminal.BlazorTools/blazortools-meter.css" rel="stylesheet" />
    
  3. In index.html add a link to the javascript file that contains interop functions:

    <script src="_content/Proliminal.BlazorTools/blazortools.js"></script>
    

Json Highlighting

  1. Add a using statement to your page or to _Imports.razor:

    @using Proliminal.BlazorTools
    
  2. Add a CodeBlock component to your page:

    <CodeBlock Code="@forecasts"></CodeBlock>
    

    Where forecasts is a string containing a serialized json object.

Run and enjoy:

image

VuMeter

  1. Add a using statement to your page or to _Imports.razor:

    @using Proliminal.BlazorTools
    
  2. Add a VuMeter component to your page:

    <VuMeter Label="First" Value="25" MaxValue="100"></VuMeter>
    

VuMeters showing label sizes and values:

image


Dependencies

None.

Changes

1.1.0

Add syntax coloring for KUSTO queries in CodeBlock.

1.0.7-preview2

Add Clipboard support to CodeBlock.

1.0.7-preview1

Improved CodeBlock rendering.

1.0.6-preview1

Added SubValue parameter. This allowes for a secondary value to be added in text in brackets. Only the value in Value is rendered in blocks, so you are free to choose how to use SubValue. For example, a queue may have scheduled items that are not in the queue yet. Queue depth can be rendered as xxxx 40 [11] with 40 items on the queue and 11 items scheduled to be enqueued.

1.0.5 alpha

Contribute

I've not planned anything long-term for this. I'm just serving an immediate need. It's possible that I will add support for other languages (XML first), unless I find another lightweight solution that works inside Blazor Client side pages.

That said, contributions are welcome.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.1.0 400 2/4/2024
1.0.7-preview2 101 2/4/2024
1.0.7-preview1 107 2/1/2024
1.0.6-preview1 255 8/17/2022
1.0.5-alpha 757 2/22/2020
1.0.4-alpha 413 2/19/2020
1.0.3-alpha 444 2/17/2020
1.0.2-alpha 362 2/17/2020
1.0.1-alpha 364 2/16/2020
1.0.0-alpha 380 2/16/2020