BlazorPathHelper.Core 0.1.0-alpha.12

BlazorPathHelper

<div> <a href="https://www.nuget.org/packages/BlazorPathHelper/"> <img alt="NuGet Version" src="https://img.shields.io/nuget/v/BlazorPathHelper?style=for-the-badge"> </a> <img alt="GitHub License" src="https://img.shields.io/github/license/arika0093/BlazorPathHelper?style=for-the-badge">

</div>

機能

• パス定義からURLビルダーを生成
• パス定義からメニューアイテム一覧を生成
• シンプルな実装方法でメニューを生成可能
• メニュー生成部分を自由にカスタマイズ可能・各種フレームワークに対応

使い方例

以下のクラスを作成します。

using BlazorPathHelper;

[BlazorPath]
public partial class WebPaths
{
    [BlazorPathItem("ホーム")]
    public const string Index = "/";
    [BlazorPathItem("サンプル1")]
    public const string Sample = "/sample";
    [BlazorPathItem("サンプル1-a")]
    public const string SampleChild = "/sample/child";
    [BlazorPathItem("サンプル2")]
    public const string Counter = "/counter";
    public const string CounterWithState = "/counter/{count:int}";
}

すると、以下のようなクラス定義が自動で生成されます。

// 元々のクラスに追記されます
public partial class WebPaths
{
    // URLビルドを行う際に便利なヘルパー関数
    public partial class Helper
    {
        public static string Index() => "/";
        public static string Sample() => "/sample";
        public static string SampleChild() => "/sample/child";
        public static string Counter() => "/counter";
        public static string CounterWithState(int count) => string.Format("/counter/{0}", count);
    }
    
    // メニュー項目を動的に作成するのに便利な配列
    public static readonly BlazorMenuItem[] MenuItems = [
        new BlazorPathMenuItem(){
            Name = "ホーム",  // メニュー名。標準では変数名
            Path = "/",      // ページのパス
            Children = []    // 子メニュー
            // その他メニューを生成するのに便利なプロパティを自動生成
        },
        new BlazorPathMenuItem(){
            Name = "サンプル1",
            Path = "/sample", 
            // URLを解析して、よしなに子メニューを生成する
            Children = [
                new BlazorPathMenuItem(){
                    Name = "サンプル1-a",
                    Path = "/sample/child", 
                    Children = []
                }
            ]
        },
        new BlazorPathMenuItem(){
            Name = "サンプル2",
            Path = "/counter",
            // パラメータを持つページはメニューに表示されない
            Children = []
        }
    ];
}

詳細な利用方法は ドキュメント(WIP) を参照してください。

TODO

• CI/CD設定
• nuget公開
• 最小限のドキュメント作成
• 各種例を追加
  • 最小限の例
  • 多言語化を行った例
  • Blazorテンプレートを使った例
  • FluentUI
  • AntBlazor
  • MudBlazor
  • MASA Blazor
• ReadMeを整備
  • ドキュメント整備
  • 英語のドキュメント追加
• ドキュメントサイト追加
• コード綺麗にする