FluxFlow.Components.Designer 0.1.0-alpha.1

This is a prerelease version of FluxFlow.Components.Designer.
There is a newer version of this package available.
See the version list below for details.
dotnet add package FluxFlow.Components.Designer --version 0.1.0-alpha.1
                    
NuGet\Install-Package FluxFlow.Components.Designer -Version 0.1.0-alpha.1
                    
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="FluxFlow.Components.Designer" Version="0.1.0-alpha.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="FluxFlow.Components.Designer" Version="0.1.0-alpha.1" />
                    
Directory.Packages.props
<PackageReference Include="FluxFlow.Components.Designer" />
                    
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 FluxFlow.Components.Designer --version 0.1.0-alpha.1
                    
#r "nuget: FluxFlow.Components.Designer, 0.1.0-alpha.1"
                    
#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 FluxFlow.Components.Designer@0.1.0-alpha.1
                    
#: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=FluxFlow.Components.Designer&version=0.1.0-alpha.1&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=FluxFlow.Components.Designer&version=0.1.0-alpha.1&prerelease
                    
Install as a Cake Tool

FluxFlow.Components.Designer

Reusable component metadata contracts for FluxFlow.

Purpose

This package lets component packages describe how a host can present and edit a component without depending on a specific rendering framework.

Contracts

  • ComponentDesignMetadata: component display name, category, summary, icon key, preferred node name, suggested editor width, options, ports, and attributes.
  • OptionDesignMetadata: option name, kind, default value, required flag, helper text, min/max values, choices, and attributes.
  • PortDesignMetadata: port name, direction, display name, group, order, summary, value type, primary flag, and attributes.
  • ComponentDesignMetadataCatalog: validates and composes metadata from one or more providers.

Option Kinds

The option kind contract supports:

  • text
  • number
  • boolean
  • enum
  • multiline text
  • JSON
  • expression
  • duration
  • secret

Example

using FluxFlow.Components.Designer;
using FluxFlow.Components.Designer.Contracts;
using FluxFlow.Engine.Definitions;

var metadata = new ComponentDesignMetadata
{
    Type = new NodeType("sample.transform"),
    DisplayName = "Sample Transform",
    Category = "Samples",
    Summary = "Transforms a sample value.",
    IconKey = "transform",
    PreferredNodeName = "transform",
    SuggestedEditorWidth = 420,
    Options =
    [
        new OptionDesignMetadata
        {
            Name = "expression",
            Kind = OptionValueKind.Expression,
            DisplayName = "Expression",
            IsRequired = true
        }
    ],
    Ports =
    [
        new PortDesignMetadata
        {
            Name = new PortName("Input"),
            Direction = PortDirection.Input,
            Order = 0,
            IsPrimary = true
        },
        new PortDesignMetadata
        {
            Name = new PortName("Output"),
            Direction = PortDirection.Output,
            Order = 0,
            IsPrimary = true
        }
    ]
};

var catalog = new ComponentDesignMetadataCatalog().Add(metadata);

Boundaries

This package only defines metadata contracts and catalog helpers. Hosts decide how metadata is rendered, stored, localized, or combined with their own design system.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (20)

Showing the top 5 NuGet packages that depend on FluxFlow.Components.Designer:

Package Downloads
FluxFlow.Components.Mqtt.Composition

Canonical FluxFlow Composition resources and nodes for provider-neutral MQTT client control, publication, subscriptions, and client events.

FluxFlow.Components.Projections.Composition

Canonical event-projection result registration and Designer metadata over host-owned clocks.

FluxFlow.Components.Serialization.Composition

FluxFlow.Composition registration and Designer metadata for explicit FlowContent, JSON, text, and Base64 conversions.

FluxFlow.Components.Observability.Composition

Typed observability registration and Designer metadata over host-owned expression, selector, context, and clock resources.

FluxFlow.Components.FileSystem.Composition

FluxFlow.Composition registration and Designer metadata for typed file-system transforms and sources over host-owned keyed clocks.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
7.0.0-rc.1 231 9/5/2026
6.0.0-rc.1 299 8/9/2026
5.0.0 669 8/3/2026
2.17.1 137 7/3/2026
2.17.0 565 7/2/2026
2.16.0 623 7/2/2026
1.0.1 1,974 6/5/2026
1.0.0 273 6/4/2026
0.1.0-alpha.1 77 6/3/2026

Adds neutral component, option, and port metadata contracts.