TKCode.Arc 1.1.1-preview.2

TKCode.Arc

English | 简体中文

The visual language and spring motion of Arc, as native Avalonia controls.

TKCode.Arc is a UI kit for .NET applications on Avalonia 12. It ports Arc's 112 free components and adds what a full product needs around them: page-level blocks and whole screens, a spreadsheet-style data grid, a workflow canvas, IDE-style docking, a terminal, a PDF viewer, and audio and video playback.

Live gallery and documentation · Changelog

Why Arc

• Native controls. Every control derives from Avalonia base types and uses public Avalonia APIs only.
• One token system. Colors, radii, shadows and fonts come from design tokens, so light and dark, the eight accent presets and whole-theme packages apply across every control.
• Motion built in. A spring engine drives the components, with Full, Reduced and Off levels for the whole app.
• Ready for NativeAOT. The libraries are built as trimming and AOT compatible.
• Documented in three languages. Each of the 400+ component and block pages has live examples and a generated API table, in English, 简体中文 and 繁體中文.
• Readable by AI assistants. The site publishes llms.txt, every page as Markdown and an agent skill.

Quick start

Start from a template:

dotnet new install TKCode.Arc.Templates
dotnet new tkcode-arc -n MyApp          # add --layout sidebar|header|dock, --mvvm toolkit, --i18n, --tests ...
cd MyApp
dotnet run

Or add Arc to an existing Avalonia 12 app:

dotnet add package TKCode.Arc

using TKCode.Arc;

public static AppBuilder BuildAvaloniaApp() =>
    AppBuilder.Configure<App>()
              .UsePlatformDetect()
              .UseArc(arc => arc
                  .UseArcControls()   // Arc's controls, themes and design tokens
                  .WithTheme(t => t.Appearance(ArcAppearance.System).Accent(ArcAccentPreset.Neutral)));

<Window xmlns="https://github.com/avaloniaui"
        xmlns:arc="https://github.com/AIDotNet/TKCode.Arc">
    <arc:Button Content="Save" />
</Window>

Each further package registers itself in the same UseArc(...) call: UseArcBlocks(), UseArcSpecial(), UseArcAdvancedCharts(), UseArcMobile(), UseArcWorkflow(), UseArcDock(), UseArcPdf(), UseArcVideo(), UseArcPixelTheme() and UseArcCorners(). Change the theme at run time with ArcTheme.Apply(t => t.Appearance(...).Accent(...)).

What's inside

All 23 packages are released together on one version; keep them on the same one.

Components

Application features

Theming and assets

Foundation and tooling

Status and compatibility

Arc follows Semantic Versioning: from 1.0.0 on, breaking API changes come only with a new major version, and a public member is never removed or renamed in one step (it stays as [Obsolete] for at least two stable releases). CHANGELOG.md lists each release and its migration notes.

Repository

The gallery and documentation site, with its desktop and browser hosts, the docs pages and the demos, is a separate repository: AIDotNet/ArcGallery. It builds against a checkout of this one.

Working on the library

Building needs the .NET 11 SDK (see global.json) and the .NET 10 runtime, which the tests run on.

dotnet build TKCode.Arc.slnx
dotnet test tests/TKCode.Arc.Core.Tests
dotnet test tests/TKCode.Arc.Foundation.Tests
dotnet test tests/TKCode.Arc.Tests --filter "FullyQualifiedName~ButtonTests"   # the whole suite takes 8 minutes or more

To run the gallery, clone ArcGallery next to this repository as ../ArcGallery (or anywhere, with ARC_ROOT pointing at this checkout) and run dotnet run --project gallery/TKCode.Arc.Gallery.Desktop -f net10.0 there.

PDFium and pdf.js are not committed: tools/pdf/sync-native.sh and tools/pdf/sync-pdfjs.sh download them and check their checksums. Without them the desktop gallery shows a simulated document in the PDF demos, and a browser build has no pdf.js to import.

Project rules and conventions are in AGENTS.md, and the guide to writing a component is design/engineering/implementation-guide.md.

Community

Ask questions and talk about Avalonia in the QQ group Avalonia入门交流群 (group number 922379598). Scan the code or search for the number.

<img src="https://raw.githubusercontent.com/AIDotNet/TKCode.Arc/main/images/qq.jpg" alt="QQ group QR code" width="260">

Sponsors

TKCode.Arc is mainly sponsored by nextco.work, which provides affordable, easy-to-use access to Claude, OpenAI and DeepSeek models. Thank you for supporting the project.

License

MIT. Arc depends only on Avalonia (MIT) and MIT packages of its own, so closed-source applications can ship it in a single file or a NativeAOT build. THIRD-PARTY-NOTICES.md covers Arc (MIT), Lucide (ISC), fonts (OFL), StreamMark, TextMateSharp, Oniguruma and Markdig.