Skip to content

API Stability

This document outlines ngDiagram’s API stability levels and version support policy. Understanding these stability levels helps you make informed decisions about which APIs to use in production and plan for future upgrades.

ngDiagram uses TSDoc tags to indicate API stability:

TagLevelBreaking ChangesMigration SupportProduction Use
@publicStableOnly in major versionsYes, guaranteed✅ Safe
@betaPreviewPossible in minor versionsYes, provided⚠️ Use with caution
@experimentalUnstableMay change or be removed anytimeNot guaranteed❌ Testing only
@internalPrivateMay change without noticeNo❌ Do not use

Note: APIs without tags are treated as @beta before v1.0, and @public after v1.0.

ngDiagram follows Angular’s official support policy:

Supported Versions: Current Angular version + 2 previous major versions (3 versions total)

Angular VersionngDiagram SupportAngular EOL
Angular 20✅ SupportedNov 2026
Angular 19✅ SupportedMay 2026
Angular 18✅ SupportedNov 2025
Angular 17⚠️ Not testedMay 2025

Current Requirement: Angular 18.0.0+

When a new Angular version releases:

  • Added to ngDiagram within 2 months
  • Oldest supported version deprecated
  • Deprecated version support ends after 6 months
ngDiagram VersionSupport StatusUpdates
Latest (0.8.x)ActiveFeatures, bugs, security
Previous majorMaintenanceCritical bugs, security (6 months)
Older versionsUnsupportedNo updates

ngDiagram follows semver:

  • Major (X.0.0): Breaking changes
  • Minor (X.Y.0): New features, backward-compatible
  • Patch (X.Y.Z): Bug fixes only

See Deprecation Policy for breaking change process.