Reduced publicapi, extend buildrendertree

Author: rolandVi

src/Components/Web/src/Media/FileDownload.cs

@@ -31,27 +31,20 @@ public sealed class FileDownload : MediaComponentBase
     /// </summary>
     [Parameter] public string? Text { get; set; }
 
-    /// <inheritdoc />
-    protected override string TagName => "a";
-
-    /// <inheritdoc />
-    protected override string TargetAttributeName => string.Empty; // Not used – object URL not tracked for downloads.
-
-    /// <inheritdoc />
-    protected override string MarkerAttributeName => "data-blazor-file-download";
+    internal override string TargetAttributeName => string.Empty; // Not used – object URL not tracked for downloads.
 
     /// <inheritdoc />
-    protected override bool ShouldAutoLoad => false;
+    internal override bool ShouldAutoLoad => false;
 
     /// <summary>
     /// Builds the anchor element with click handler wiring. The anchor is given an inert href (if one is not supplied)
     /// and the click default action is prevented so navigation does not occur. Styling into a button shape is left to the user.
     /// </summary>
-    protected override void BuildRenderTree(RenderTreeBuilder builder)
+    private protected override void BuildRenderTree(RenderTreeBuilder builder)
     {
-        builder.OpenElement(0, TagName);
+        builder.OpenElement(0, "a");
 
-        builder.AddAttribute(1, MarkerAttributeName, "");
+        builder.AddAttribute(1, "data-blazor-file-download", "");
 
         if (IsLoading)
         {

src/Components/Web/src/Media/Image.cs

@@ -1,6 +1,8 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using Microsoft.AspNetCore.Components.Rendering;
+
 namespace Microsoft.AspNetCore.Components.Web.Media;
 
 /* This is equivalent to a .razor file containing:
@@ -17,12 +19,31 @@ namespace Microsoft.AspNetCore.Components.Web.Media;
 /// </summary>
 public sealed class Image : MediaComponentBase
 {
-    /// <inheritdoc/>
-    protected override string TagName => "img";
+    internal override string TargetAttributeName => "src";
+
+    private protected override void BuildRenderTree(RenderTreeBuilder builder)
+    {
+        builder.OpenElement(0, "img");
+
+        if (!string.IsNullOrEmpty(_currentObjectUrl))
+        {
+            builder.AddAttribute(1, TargetAttributeName, _currentObjectUrl);
+        }
+
+        builder.AddAttribute(2, "data-blazor-image", "");
 
-    /// <inheritdoc/>
-    protected override string TargetAttributeName => "src";
+        var showInitial = Source != null && _currentSource == null && string.IsNullOrEmpty(_currentObjectUrl) && !_hasError;
+        if (IsLoading || showInitial)
+        {
+            builder.AddAttribute(3, "data-state", "loading");
+        }
+        else if (_hasError)
+        {
+            builder.AddAttribute(3, "data-state", "error");
+        }
 
-    /// <inheritdoc/>
-    protected override string MarkerAttributeName => "data-blazor-image";
+        builder.AddMultipleAttributes(4, AdditionalAttributes);
+        builder.AddElementReferenceCapture(5, r => Element = r);
+        builder.CloseElement();
+    }
 }

src/Components/Web/src/Media/MediaComponentBase.cs

@@ -9,8 +9,8 @@
 namespace Microsoft.AspNetCore.Components.Web.Media;
 
 /// <summary>
-/// Base component that handles turning a media stream into an object URL, caching and lifetime management.
-/// Derived components provide the element tag name (e.g., img, video) and target attribute (e.g., src, href).
+/// Base component that handles turning a media stream into an object URL plus caching and lifetime management.
+/// Subclasses implement their own rendering and provide the target attribute (e.g., <c>src</c> or <c>href</c>) used
 /// </summary>
 public abstract partial class MediaComponentBase : IComponent, IHandleAfterRender, IAsyncDisposable
 {
@@ -20,12 +20,12 @@ public abstract partial class MediaComponentBase : IComponent, IHandleAfterRende
     /// The current object URL (blob URL) assigned to the underlying element, or <c>null</c> if not yet loaded
     /// or if a previous load failed/was cancelled.
     /// </summary>
-    protected string? _currentObjectUrl;
+    internal string? _currentObjectUrl;
 
     /// <summary>
     /// Indicates whether the last load attempt ended in an error state for the active cache key.
     /// </summary>
-    protected bool _hasError;
+    internal bool _hasError;
 
     private bool _isDisposed;
     private bool _initialized;
@@ -35,68 +35,54 @@ public abstract partial class MediaComponentBase : IComponent, IHandleAfterRende
     /// The cache key associated with the currently active/most recent load operation. Used to ignore
     /// out-of-order JS interop responses belonging to stale operations.
     /// </summary>
-    protected string? _activeCacheKey;
+    internal string? _activeCacheKey;
 
     /// <summary>
     /// The <see cref="MediaSource"/> instance currently being processed (or <c>null</c> if none).
     /// </summary>
-    protected MediaSource? _currentSource;
+    internal MediaSource? _currentSource;
     private CancellationTokenSource? _loadCts;
 
     /// <summary>
     /// Gets a value indicating whether the component is currently loading the media content.
     /// True when a source has been provided, no object URL is available yet, and there is no error.
     /// </summary>
-    protected bool IsLoading => _currentSource != null && string.IsNullOrEmpty(_currentObjectUrl) && !_hasError;
+    internal bool IsLoading => _currentSource != null && string.IsNullOrEmpty(_currentObjectUrl) && !_hasError;
 
     /// <summary>
     /// Gets a value indicating whether the renderer is interactive so client-side JS interop can be performed.
     /// </summary>
-    protected bool IsInteractive => _renderHandle.IsInitialized && _renderHandle.RendererInfo.IsInteractive;
+    internal bool IsInteractive => _renderHandle.IsInitialized && _renderHandle.RendererInfo.IsInteractive;
 
     /// <summary>
     /// Gets the reference to the rendered HTML element for this media component.
     /// </summary>
-    protected ElementReference? Element { get; set; }
+    internal ElementReference? Element { get; set; }
 
     /// <summary>
     /// Gets or sets the JS runtime used for interop with the browser to materialize media object URLs.
     /// </summary>
-    [Inject] protected IJSRuntime JSRuntime { get; set; } = default!;
+    [Inject] internal IJSRuntime JSRuntime { get; set; } = default!;
 
     /// <summary>
     /// Gets or sets the logger factory used to create the <see cref="Logger"/> instance.
     /// </summary>
-    [Inject] protected ILoggerFactory LoggerFactory { get; set; } = default!;
+    [Inject] internal ILoggerFactory LoggerFactory { get; set; } = default!;
 
     /// <summary>
     /// Logger for media operations.
     /// </summary>
-    protected ILogger Logger => _logger ??= LoggerFactory.CreateLogger(GetType());
+    private ILogger Logger => _logger ??= LoggerFactory.CreateLogger(GetType());
     private ILogger? _logger;
 
-    /// <summary>
-    /// Gets the element tag name (e.g., "img", "video").
-    /// </summary>
-    protected abstract string TagName { get; }
-
-    /// <summary>
-    /// Gets the attribute name to assign the object URL to (e.g., "src" or "href").
-    /// </summary>
-    protected abstract string TargetAttributeName { get; }
-
-    /// <summary>
-    /// Gets the custom marker data-attribute name added to the rendered element for diagnostics and tests.
-    /// Derived components must override to provide a component-specific marker (e.g., "data-blazor-image").
-    /// </summary>
-    protected abstract string MarkerAttributeName { get; }
+    internal abstract string TargetAttributeName { get; }
 
     /// <summary>
     /// Determines whether the component should automatically invoke a media load after the first render
     /// and whenever the <see cref="Source"/> changes. Override and return <c>false</c> for components
     /// (such as download buttons) that defer loading until an explicit user action.
     /// </summary>
-    protected virtual bool ShouldAutoLoad => true;
+    internal virtual bool ShouldAutoLoad => true;
 
     /// <summary>
     /// Gets or sets the media source.
@@ -173,7 +159,7 @@ async Task IHandleAfterRender.OnAfterRenderAsync()
     /// Triggers a render of the component by invoking the <see cref="BuildRenderTree"/> method.
     /// Ensures that only one render operation is pending at a time to prevent redundant renders.
     /// </summary>
-    protected void Render()
+    internal void Render()
     {
         Debug.Assert(_renderHandle.IsInitialized);
 
@@ -185,38 +171,7 @@ protected void Render()
         }
     }
 
-    /// <summary>
-    /// Builds the component render tree for the underlying media element and common attributes.
-    /// Derived components can override to extend the markup.
-    /// </summary>
-    /// <param name="builder">The <see cref="RenderTreeBuilder"/> used to construct the render tree.</param>
-    protected virtual void BuildRenderTree(RenderTreeBuilder builder)
-    {
-        builder.OpenElement(0, TagName);
-
-        if (!string.IsNullOrEmpty(_currentObjectUrl))
-        {
-            builder.AddAttribute(1, TargetAttributeName, _currentObjectUrl);
-        }
-
-        builder.AddAttribute(2, MarkerAttributeName, "");
-
-        var showInitial = Source != null && _currentSource == null && string.IsNullOrEmpty(_currentObjectUrl) && !_hasError;
-
-        if (IsLoading || showInitial)
-        {
-            builder.AddAttribute(3, "data-state", "loading");
-        }
-        else if (_hasError)
-        {
-            builder.AddAttribute(3, "data-state", "error");
-        }
-
-        builder.AddMultipleAttributes(4, AdditionalAttributes);
-        builder.AddElementReferenceCapture(5, elementReference => Element = elementReference);
-
-        builder.CloseElement();
-    }
+    private protected virtual void BuildRenderTree(RenderTreeBuilder builder) { }
 
     private sealed class MediaLoadResult
     {
@@ -309,7 +264,7 @@ public ValueTask DisposeAsync()
     /// <summary>
     /// Cancels any in-flight media load operation, if one is active, by signalling its <see cref="CancellationTokenSource"/>.
     /// </summary>
-    protected void CancelPreviousLoad()
+    internal void CancelPreviousLoad()
     {
         try
         {
@@ -325,7 +280,7 @@ protected void CancelPreviousLoad()
     /// <summary>
     /// Creates a new <see cref="CancellationTokenSource"/> for an upcoming load operation and returns its token.
     /// </summary>
-    protected CancellationToken ResetCancellationToken()
+    internal CancellationToken ResetCancellationToken()
     {
         _loadCts = new CancellationTokenSource();
         return _loadCts.Token;

src/Components/Web/src/Media/Video.cs

@@ -1,6 +1,8 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using Microsoft.AspNetCore.Components.Rendering;
+
 namespace Microsoft.AspNetCore.Components.Web.Media;
 
 /* This is equivalent to a .razor file containing:
@@ -17,12 +19,31 @@ namespace Microsoft.AspNetCore.Components.Web.Media;
 /// </summary>
 public sealed class Video : MediaComponentBase
 {
-    /// <inheritdoc/>
-    protected override string TagName => "video";
+    internal override string TargetAttributeName => "src";
+
+    private protected override void BuildRenderTree(RenderTreeBuilder builder)
+    {
+        builder.OpenElement(0, "video");
+
+        if (!string.IsNullOrEmpty(_currentObjectUrl))
+        {
+            builder.AddAttribute(1, TargetAttributeName, _currentObjectUrl);
+        }
+
+        builder.AddAttribute(2, "data-blazor-video", "");
 
-    /// <inheritdoc/>
-    protected override string TargetAttributeName => "src";
+        var showInitial = Source != null && _currentSource == null && string.IsNullOrEmpty(_currentObjectUrl) && !_hasError;
+        if (IsLoading || showInitial)
+        {
+            builder.AddAttribute(3, "data-state", "loading");
+        }
+        else if (_hasError)
+        {
+            builder.AddAttribute(3, "data-state", "error");
+        }
 
-    /// <inheritdoc/>
-    protected override string MarkerAttributeName => "data-blazor-video";
+        builder.AddMultipleAttributes(4, AdditionalAttributes);
+        builder.AddElementReferenceCapture(5, r => Element = r);
+        builder.CloseElement();
+    }
 }

src/Components/Web/src/PublicAPI.Unshipped.txt

@@ -1,7 +1,4 @@
 #nullable enable
-abstract Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase.MarkerAttributeName.get -> string!
-abstract Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase.TagName.get -> string!
-abstract Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase.TargetAttributeName.get -> string!
 Microsoft.AspNetCore.Components.Forms.InputHidden
 Microsoft.AspNetCore.Components.Forms.InputHidden.Element.get -> Microsoft.AspNetCore.Components.ElementReference?
 Microsoft.AspNetCore.Components.Forms.InputHidden.Element.set -> void
@@ -15,29 +12,13 @@ Microsoft.AspNetCore.Components.Web.Media.FileDownload.Text.get -> string?
 Microsoft.AspNetCore.Components.Web.Media.FileDownload.Text.set -> void
 Microsoft.AspNetCore.Components.Web.Media.Image
 Microsoft.AspNetCore.Components.Web.Media.Image.Image() -> void
-Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase.CancelPreviousLoad() -> void
-Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase.Render() -> void
-Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase.ResetCancellationToken() -> System.Threading.CancellationToken
 Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase.Source.get -> Microsoft.AspNetCore.Components.Web.Media.MediaSource!
-Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase._activeCacheKey -> string?
-Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase._currentObjectUrl -> string?
-Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase._currentSource -> Microsoft.AspNetCore.Components.Web.Media.MediaSource?
-Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase._hasError -> bool
 Microsoft.AspNetCore.Components.Web.Media.Video
 Microsoft.AspNetCore.Components.Web.Media.Video.Video() -> void
 Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase
 Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase.AdditionalAttributes.get -> System.Collections.Generic.Dictionary<string!, object!>?
 Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase.AdditionalAttributes.set -> void
 Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase.DisposeAsync() -> System.Threading.Tasks.ValueTask
-Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase.Element.get -> Microsoft.AspNetCore.Components.ElementReference?
-Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase.Element.set -> void
-Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase.IsInteractive.get -> bool
-Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase.IsLoading.get -> bool
-Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase.JSRuntime.get -> Microsoft.JSInterop.IJSRuntime!
-Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase.JSRuntime.set -> void
-Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase.Logger.get -> Microsoft.Extensions.Logging.ILogger!
-Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase.LoggerFactory.get -> Microsoft.Extensions.Logging.ILoggerFactory!
-Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase.LoggerFactory.set -> void
 Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase.MediaComponentBase() -> void
 Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase.Source.set -> void
 Microsoft.AspNetCore.Components.Web.Media.MediaSource
@@ -50,5 +31,3 @@ Microsoft.AspNetCore.Components.Web.Media.MediaSource.Stream.get -> System.IO.St
 override Microsoft.AspNetCore.Components.Forms.InputHidden.BuildRenderTree(Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder! builder) -> void
 override Microsoft.AspNetCore.Components.Forms.InputHidden.TryParseValueFromString(string? value, out string? result, out string? validationErrorMessage) -> bool
 virtual Microsoft.AspNetCore.Components.Routing.NavLink.ShouldMatch(string! uriAbsolute) -> bool
-virtual Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase.BuildRenderTree(Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder! builder) -> void
-virtual Microsoft.AspNetCore.Components.Web.Media.MediaComponentBase.ShouldAutoLoad.get -> bool

src/Components/test/testassets/BasicTestApp/BasicTestApp.csproj

@@ -26,7 +26,6 @@
     <Reference Include="Microsoft.AspNetCore.Components.CustomElements" />
     <Reference Include="Microsoft.AspNetCore.Components.Authorization" />
     <Reference Include="Microsoft.AspNetCore.Components.QuickGrid" />
-    <Reference Include="Microsoft.AspNetCore.Components.Web" />
     <Reference Include="Microsoft.AspNetCore.SignalR.Client" />
     <Reference Include="Microsoft.Extensions.Logging.Configuration" />
     <Reference Include="Newtonsoft.Json" />