Packages
Every package — the framework's, the icon set and each component package — is released at one version number, all of them
together: a release takes every package to the same X.Y.Z, a package with nothing new of its own included. A component package
accepts the framework it was released with or a later one of the same X, so packages of one version always work together.
Start here
An application is a class library over the platform-independent packages, hosted by a web project that adds the platform
(getting started). The library needs the engine, which brings the built-in components and the
generators: the engine carries them as a dependency whose analyzers reach the application, so a controller's observable
members are written without a package of their own. The host needs the web host and its renderers. Any package that does not
reference the engine — a component package on the foundation or on the built-in components — adds
NE.Standard.UI.Generators itself.
dotnet add App package NE.Standard.UI
dotnet add App.Web package NE.Standard.UI.Web
dotnet add App.Web package NE.Standard.UI.Web.Renderers
Every add-on comes in two halves the same way: the platform-independent one (NE.Standard.UI.CodeInput) in the library, the
rendering for a platform (NE.Standard.UI.Web.CodeInput) in the host. NE.Standard.UI.Extensions, the presets, is a
separate install in the library: nothing depends on it. So is NE.Standard.UI.Testing, for the library's test project.
Each package brings the namespaces an application writes against as global usings, so an application needs no
using line for the framework; <NEStandardUIImplicitUsings>false</NEStandardUIImplicitUsings> in a project
keeps them out. The namespaces only a package author needs — NE.Standard.UI.Compiled,
NE.Standard.UI.Web.Abstractions, the renderer foundation — are not among them.
The UI framework
| Package | What it carries |
|---|---|
NE.Standard.UI.Primitives |
The bottom layer: enums, attributes and constants — UIAlignment, UIOrientation, the styling and binding vocabulary. No dependencies. |
NE.Standard.UI.Abstractions |
The binding and addressing model, RecursiveObservable, the styling value types (UIThickness, UIResponsive<T>), the items and interaction contracts, the ClientEffect vocabulary. |
NE.Standard.UI.Authoring |
What an application author writes against: the component, view and controller base contracts. |
NE.Standard.UI.Compiled |
The compiler's output: CompiledView, its indexes and the resolution over them. |
NE.Standard.UI.Shell |
Hosting and runtime contracts: IUIHost, IUIRuntime, IUIUpdateSink, sessions, services. |
NE.Standard.UI |
The engine: view compilation, the two-way runtime, hosting, routing, scheduling. |
NE.Standard.UI.Components.Foundation |
The authoring foundation: the component bases (VisualComponentBase, TemplatedComponentBase, RowItemsComponentBase, the input bases), the template bindings and the input extension methods a package's own component builds on — none of the built-ins. |
NE.Standard.UI.Components |
The built-in components and their default templates, over the foundation. |
NE.Standard.UI.Client |
The platform-neutral C# client runtime (UIClientPage, IUIClientTransport, InProcessUIClientTransport, RemoteUIClientSession, RemoteUIClientTransport, UIClientStore) shared by NE.Standard.UI.Testing and native C# clients. |
NE.Standard.UI.Generators |
The two Roslyn source generators the stack is built on, usable by anything defining its own components or observable models. |
NE.Standard.UI.Extensions |
Presets over the components: a text in a role (UIText), a page's regions (UIPage), the arrangements (UILayout), buttons and their rows (UIButtons), a form's pieces (UIForm, UIDetails), and ShownWhen/HiddenWhen/EnabledWhen — one call each, nothing the client has to know about. See presets. |
NE.Standard.UI.Testing |
An application's tests without a browser: UITestApp boots its own startup with no platform under it, UITestPage opens a page through the host's real path, finds its components, writes values, presses and reads back what the page received. No test framework or assertion library. See testing an application. |
The web platform
| Package | What it carries |
|---|---|
NE.Standard.UI.Server |
The API-only ASP.NET Core host (UIServerStartupBase<TStartup>, UIServerStartupBuilder, MapStandardUIServerAsync): /_ne/view, SignalR /_ne/hub, file transfer, and value staging for remote C# clients without HTML shell rendering or Web assets. |
NE.Standard.UI.Web |
The ASP.NET Core host: shell, SignalR channel, file transfer, and the embedded TypeScript client. |
NE.Standard.UI.Web.Abstractions |
The render contracts an add-on implements to render a component of its own. |
NE.Standard.UI.Web.Renderers.Foundation |
The renderer base (WebComponentRendererBase) and the shared style, text and input helpers an add-on's own renderer builds on. |
NE.Standard.UI.Web.Renderers |
The HTML renderers for the built-in components, over the foundation. |
NE.Standard.UI.Desktop |
The Windows WebView2 desktop host (DesktopStartupBase<TStartup>, DesktopStartupBuilder, DesktopWindow, DesktopShellControl): runs the full NE.Standard.UI.Web stack inside a native desktop window over an in-process HTTP/2 loopback server (127.0.0.1:0) or a remote server (--server), with zero-copy local file transfers, native Windows Toast notifications, Win32 DWM caption sync, native file download dialogs, and localized leave-guard close confirmation. |
Add-ons
The icon set and the component packages ship separately, each from a repository of its own
(AkiEvansDev/NE.Standard.UI.Icons, AkiEvansDev/NE.Standard.UI.CodeInput, …), on the framework's version number —
developed alongside the framework so a package and the renderer it plugs into are never out of step. The set or a
component is two packages: the platform-independent half, and the rendering for a platform. The add-ons page has
each one's install, its registration in the host and an example, and links to its README.
| Package | What it carries |
|---|---|
NE.Standard.UI.Icons.Material / NE.Standard.UI.Web.Icons.Material |
Material Symbols: every rounded glyph, filled and outlined; see the Icons README. |
NE.Standard.UI.CodeInput / NE.Standard.UI.Web.CodeInput |
A code editor field: syntax highlighting for JSON, CSS and LESS, JavaScript and TypeScript, HTML, Bash, C#, Python and Markdown, inline completions, custom mark and span styles, line numbers, and find and replace in the browser; and a Markdown display that shows a document as formatted text. |
NE.Standard.UI.DataGrid / NE.Standard.UI.Web.DataGrid |
A data grid over the table: sorting by header, typed columns, editing in place, filters and search, paging, a footer of totals, pinned and responsive columns with a chooser, a detail row and CSV export. |
NE.Standard.UI.Charts / NE.Standard.UI.Web.Charts |
Line, area, bar, pie, share bar, scatter, radar, sparkline and gauge, as SVG the server writes and the browser keeps, over keyed collections. |
NE.Standard.UI.Graph / NE.Standard.UI.Web.Graph |
A node canvas, a layered graph of the application's own nodes, and a production graph with a planner. |
NE.Standard.UI.Graph.Calculator |
A calculator's node kinds for the node canvas — arithmetic, rounding, sums, the least or the most, clamps, comparisons and a result — beside an application's own. |
NE.Standard.UI.Graph.Image |
Picture node kinds worked on the server with SkiaSharp — size, resize, crop, rotate, flip, greyscale, blur, convert — over an image store the application chooses, an in-memory one included. |
The icon set ships no stylesheet — the whole of it would be over half a megabyte of CSS per drawing, while an application draws tens of
glyphs. Its web package carries the Material Symbols font (woff2), every glyph in it, and serves it as an asset
of its own, then builds a stylesheet at startup from the glyphs the application registers: that decides which names
draw, not what downloads.
From elsewhere
| Package | What it carries |
|---|---|
NE.Colors |
The colour palette, a repository of its own because more than this framework needs it. MIT, netstandard2.1, no dependencies. Arrives as a dependency of NE.Standard.UI.Abstractions. |
NE.Common |
General-purpose .NET helpers. MIT, its own repository, and not a dependency of anything here — it used to ship from this repository under the name NE.Standard and moved out because nothing in the framework used it. |
Licence
Every package on this page is under the Prosperity Public License 3.0.0 — the framework and the component packages alike — except the icon packages, which are MIT, and the packages from elsewhere, which carry their own. Prosperity is free for noncommercial use, with a thirty-day trial for commercial use; personal projects, research, education, charities and public institutions are not commercial use. See LICENSE.md.
The icons being MIT does not make the framework MIT: they are only useful inside it, and using them commercially still means licensing the framework itself.