Skip to content

Commit 6e773ce

Browse files
rynowakRyan Nowak
rynowak
authored and
Ryan Nowak
committed
Move public rendering types to .RenderTree
Fixes: #12552 We're not documenting these types for public use in this release. We already have an analyzer implemented to chase you away from taking a dependency.
1 parent f890c91 commit 6e773ce

25 files changed

+128
-123
lines changed

‎src/Components/Blazor/Blazor/ref/Microsoft.AspNetCore.Blazor.netstandard2.0.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ namespace Microsoft.AspNetCore.Blazor.Rendering
6868
public static partial class WebAssemblyEventDispatcher
6969
{
7070
[Microsoft.JSInterop.JSInvokableAttribute("DispatchEvent")]
71-
public static System.Threading.Tasks.Task DispatchEvent(Microsoft.AspNetCore.Components.Web.WebEventDescriptor eventDescriptor, string eventArgsJson) { throw null; }
71+
public static System.Threading.Tasks.Task DispatchEvent(Microsoft.AspNetCore.Components.RenderTree.WebEventDescriptor eventDescriptor, string eventArgsJson) { throw null; }
7272
}
7373
}
7474
namespace Microsoft.AspNetCore.Components.Builder

‎src/Components/Blazor/Blazor/src/Rendering/WebAssemblyEventDispatcher.cs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
33

44
using System.Threading.Tasks;
5+
using Microsoft.AspNetCore.Components.RenderTree;
56
using Microsoft.AspNetCore.Components.Web;
67
using Microsoft.JSInterop;
78

‎src/Components/Blazor/Blazor/src/Rendering/WebAssemblyRenderer.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
using System.Threading.Tasks;
77
using Microsoft.AspNetCore.Blazor.Services;
88
using Microsoft.AspNetCore.Components;
9-
using Microsoft.AspNetCore.Components.Rendering;
9+
using Microsoft.AspNetCore.Components.RenderTree;
1010
using Microsoft.Extensions.Logging;
1111

1212
namespace Microsoft.AspNetCore.Blazor.Rendering

‎src/Components/Components/ref/Microsoft.AspNetCore.Components.netcoreapp3.0.cs‎

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -360,39 +360,6 @@ public static partial class RuntimeHelpers
360360
}
361361
namespace Microsoft.AspNetCore.Components.Rendering
362362
{
363-
public partial class EventFieldInfo
364-
{
365-
public EventFieldInfo() { }
366-
public int ComponentId { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } [System.Runtime.CompilerServices.CompilerGeneratedAttribute]set { } }
367-
public object FieldValue { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } [System.Runtime.CompilerServices.CompilerGeneratedAttribute]set { } }
368-
}
369-
[System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
370-
public readonly partial struct RenderBatch
371-
{
372-
private readonly object _dummy;
373-
public Microsoft.AspNetCore.Components.RenderTree.ArrayRange<int> DisposedComponentIDs { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
374-
public Microsoft.AspNetCore.Components.RenderTree.ArrayRange<ulong> DisposedEventHandlerIDs { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
375-
public Microsoft.AspNetCore.Components.RenderTree.ArrayRange<Microsoft.AspNetCore.Components.RenderTree.RenderTreeFrame> ReferenceFrames { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
376-
public Microsoft.AspNetCore.Components.RenderTree.ArrayRange<Microsoft.AspNetCore.Components.RenderTree.RenderTreeDiff> UpdatedComponents { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
377-
}
378-
public abstract partial class Renderer : System.IDisposable
379-
{
380-
public Renderer(System.IServiceProvider serviceProvider, Microsoft.Extensions.Logging.ILoggerFactory loggerFactory) { }
381-
public abstract Microsoft.AspNetCore.Components.Dispatcher Dispatcher { get; }
382-
public event System.UnhandledExceptionEventHandler UnhandledSynchronizationException { add { } remove { } }
383-
protected internal int AssignRootComponentId(Microsoft.AspNetCore.Components.IComponent component) { throw null; }
384-
public virtual System.Threading.Tasks.Task DispatchEventAsync(ulong eventHandlerId, Microsoft.AspNetCore.Components.Rendering.EventFieldInfo fieldInfo, System.EventArgs eventArgs) { throw null; }
385-
public void Dispose() { }
386-
protected virtual void Dispose(bool disposing) { }
387-
protected Microsoft.AspNetCore.Components.RenderTree.ArrayRange<Microsoft.AspNetCore.Components.RenderTree.RenderTreeFrame> GetCurrentRenderTreeFrames(int componentId) { throw null; }
388-
protected abstract void HandleException(System.Exception exception);
389-
protected Microsoft.AspNetCore.Components.IComponent InstantiateComponent(System.Type componentType) { throw null; }
390-
protected virtual void ProcessPendingRender() { }
391-
protected System.Threading.Tasks.Task RenderRootComponentAsync(int componentId) { throw null; }
392-
[System.Diagnostics.DebuggerStepThroughAttribute]
393-
protected System.Threading.Tasks.Task RenderRootComponentAsync(int componentId, Microsoft.AspNetCore.Components.ParameterView initialParameters) { throw null; }
394-
protected abstract System.Threading.Tasks.Task UpdateDisplayAsync(in Microsoft.AspNetCore.Components.Rendering.RenderBatch renderBatch);
395-
}
396363
public sealed partial class RenderTreeBuilder : System.IDisposable
397364
{
398365
public RenderTreeBuilder() { }
@@ -448,6 +415,39 @@ public readonly partial struct ArrayRange<T>
448415
public ArrayRange(T[] array, int count) { throw null; }
449416
public Microsoft.AspNetCore.Components.RenderTree.ArrayRange<T> Clone() { throw null; }
450417
}
418+
public partial class EventFieldInfo
419+
{
420+
public EventFieldInfo() { }
421+
public int ComponentId { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } [System.Runtime.CompilerServices.CompilerGeneratedAttribute]set { } }
422+
public object FieldValue { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } [System.Runtime.CompilerServices.CompilerGeneratedAttribute]set { } }
423+
}
424+
[System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
425+
public readonly partial struct RenderBatch
426+
{
427+
private readonly object _dummy;
428+
public Microsoft.AspNetCore.Components.RenderTree.ArrayRange<int> DisposedComponentIDs { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
429+
public Microsoft.AspNetCore.Components.RenderTree.ArrayRange<ulong> DisposedEventHandlerIDs { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
430+
public Microsoft.AspNetCore.Components.RenderTree.ArrayRange<Microsoft.AspNetCore.Components.RenderTree.RenderTreeFrame> ReferenceFrames { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
431+
public Microsoft.AspNetCore.Components.RenderTree.ArrayRange<Microsoft.AspNetCore.Components.RenderTree.RenderTreeDiff> UpdatedComponents { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
432+
}
433+
public abstract partial class Renderer : System.IDisposable
434+
{
435+
public Renderer(System.IServiceProvider serviceProvider, Microsoft.Extensions.Logging.ILoggerFactory loggerFactory) { }
436+
public abstract Microsoft.AspNetCore.Components.Dispatcher Dispatcher { get; }
437+
public event System.UnhandledExceptionEventHandler UnhandledSynchronizationException { add { } remove { } }
438+
protected internal int AssignRootComponentId(Microsoft.AspNetCore.Components.IComponent component) { throw null; }
439+
public virtual System.Threading.Tasks.Task DispatchEventAsync(ulong eventHandlerId, Microsoft.AspNetCore.Components.RenderTree.EventFieldInfo fieldInfo, System.EventArgs eventArgs) { throw null; }
440+
public void Dispose() { }
441+
protected virtual void Dispose(bool disposing) { }
442+
protected Microsoft.AspNetCore.Components.RenderTree.ArrayRange<Microsoft.AspNetCore.Components.RenderTree.RenderTreeFrame> GetCurrentRenderTreeFrames(int componentId) { throw null; }
443+
protected abstract void HandleException(System.Exception exception);
444+
protected Microsoft.AspNetCore.Components.IComponent InstantiateComponent(System.Type componentType) { throw null; }
445+
protected virtual void ProcessPendingRender() { }
446+
protected System.Threading.Tasks.Task RenderRootComponentAsync(int componentId) { throw null; }
447+
[System.Diagnostics.DebuggerStepThroughAttribute]
448+
protected System.Threading.Tasks.Task RenderRootComponentAsync(int componentId, Microsoft.AspNetCore.Components.ParameterView initialParameters) { throw null; }
449+
protected abstract System.Threading.Tasks.Task UpdateDisplayAsync(in Microsoft.AspNetCore.Components.RenderTree.RenderBatch renderBatch);
450+
}
451451
[System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
452452
public readonly partial struct RenderTreeDiff
453453
{

‎src/Components/Components/ref/Microsoft.AspNetCore.Components.netstandard2.0.cs‎

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -360,39 +360,6 @@ public static partial class RuntimeHelpers
360360
}
361361
namespace Microsoft.AspNetCore.Components.Rendering
362362
{
363-
public partial class EventFieldInfo
364-
{
365-
public EventFieldInfo() { }
366-
public int ComponentId { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } [System.Runtime.CompilerServices.CompilerGeneratedAttribute]set { } }
367-
public object FieldValue { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } [System.Runtime.CompilerServices.CompilerGeneratedAttribute]set { } }
368-
}
369-
[System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
370-
public readonly partial struct RenderBatch
371-
{
372-
private readonly object _dummy;
373-
public Microsoft.AspNetCore.Components.RenderTree.ArrayRange<int> DisposedComponentIDs { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
374-
public Microsoft.AspNetCore.Components.RenderTree.ArrayRange<ulong> DisposedEventHandlerIDs { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
375-
public Microsoft.AspNetCore.Components.RenderTree.ArrayRange<Microsoft.AspNetCore.Components.RenderTree.RenderTreeFrame> ReferenceFrames { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
376-
public Microsoft.AspNetCore.Components.RenderTree.ArrayRange<Microsoft.AspNetCore.Components.RenderTree.RenderTreeDiff> UpdatedComponents { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
377-
}
378-
public abstract partial class Renderer : System.IDisposable
379-
{
380-
public Renderer(System.IServiceProvider serviceProvider, Microsoft.Extensions.Logging.ILoggerFactory loggerFactory) { }
381-
public abstract Microsoft.AspNetCore.Components.Dispatcher Dispatcher { get; }
382-
public event System.UnhandledExceptionEventHandler UnhandledSynchronizationException { add { } remove { } }
383-
protected internal int AssignRootComponentId(Microsoft.AspNetCore.Components.IComponent component) { throw null; }
384-
public virtual System.Threading.Tasks.Task DispatchEventAsync(ulong eventHandlerId, Microsoft.AspNetCore.Components.Rendering.EventFieldInfo fieldInfo, System.EventArgs eventArgs) { throw null; }
385-
public void Dispose() { }
386-
protected virtual void Dispose(bool disposing) { }
387-
protected Microsoft.AspNetCore.Components.RenderTree.ArrayRange<Microsoft.AspNetCore.Components.RenderTree.RenderTreeFrame> GetCurrentRenderTreeFrames(int componentId) { throw null; }
388-
protected abstract void HandleException(System.Exception exception);
389-
protected Microsoft.AspNetCore.Components.IComponent InstantiateComponent(System.Type componentType) { throw null; }
390-
protected virtual void ProcessPendingRender() { }
391-
protected System.Threading.Tasks.Task RenderRootComponentAsync(int componentId) { throw null; }
392-
[System.Diagnostics.DebuggerStepThroughAttribute]
393-
protected System.Threading.Tasks.Task RenderRootComponentAsync(int componentId, Microsoft.AspNetCore.Components.ParameterView initialParameters) { throw null; }
394-
protected abstract System.Threading.Tasks.Task UpdateDisplayAsync(in Microsoft.AspNetCore.Components.Rendering.RenderBatch renderBatch);
395-
}
396363
public sealed partial class RenderTreeBuilder : System.IDisposable
397364
{
398365
public RenderTreeBuilder() { }
@@ -448,6 +415,39 @@ public readonly partial struct ArrayRange<T>
448415
public ArrayRange(T[] array, int count) { throw null; }
449416
public Microsoft.AspNetCore.Components.RenderTree.ArrayRange<T> Clone() { throw null; }
450417
}
418+
public partial class EventFieldInfo
419+
{
420+
public EventFieldInfo() { }
421+
public int ComponentId { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } [System.Runtime.CompilerServices.CompilerGeneratedAttribute]set { } }
422+
public object FieldValue { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } [System.Runtime.CompilerServices.CompilerGeneratedAttribute]set { } }
423+
}
424+
[System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
425+
public readonly partial struct RenderBatch
426+
{
427+
private readonly object _dummy;
428+
public Microsoft.AspNetCore.Components.RenderTree.ArrayRange<int> DisposedComponentIDs { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
429+
public Microsoft.AspNetCore.Components.RenderTree.ArrayRange<ulong> DisposedEventHandlerIDs { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
430+
public Microsoft.AspNetCore.Components.RenderTree.ArrayRange<Microsoft.AspNetCore.Components.RenderTree.RenderTreeFrame> ReferenceFrames { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
431+
public Microsoft.AspNetCore.Components.RenderTree.ArrayRange<Microsoft.AspNetCore.Components.RenderTree.RenderTreeDiff> UpdatedComponents { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
432+
}
433+
public abstract partial class Renderer : System.IDisposable
434+
{
435+
public Renderer(System.IServiceProvider serviceProvider, Microsoft.Extensions.Logging.ILoggerFactory loggerFactory) { }
436+
public abstract Microsoft.AspNetCore.Components.Dispatcher Dispatcher { get; }
437+
public event System.UnhandledExceptionEventHandler UnhandledSynchronizationException { add { } remove { } }
438+
protected internal int AssignRootComponentId(Microsoft.AspNetCore.Components.IComponent component) { throw null; }
439+
public virtual System.Threading.Tasks.Task DispatchEventAsync(ulong eventHandlerId, Microsoft.AspNetCore.Components.RenderTree.EventFieldInfo fieldInfo, System.EventArgs eventArgs) { throw null; }
440+
public void Dispose() { }
441+
protected virtual void Dispose(bool disposing) { }
442+
protected Microsoft.AspNetCore.Components.RenderTree.ArrayRange<Microsoft.AspNetCore.Components.RenderTree.RenderTreeFrame> GetCurrentRenderTreeFrames(int componentId) { throw null; }
443+
protected abstract void HandleException(System.Exception exception);
444+
protected Microsoft.AspNetCore.Components.IComponent InstantiateComponent(System.Type componentType) { throw null; }
445+
protected virtual void ProcessPendingRender() { }
446+
protected System.Threading.Tasks.Task RenderRootComponentAsync(int componentId) { throw null; }
447+
[System.Diagnostics.DebuggerStepThroughAttribute]
448+
protected System.Threading.Tasks.Task RenderRootComponentAsync(int componentId, Microsoft.AspNetCore.Components.ParameterView initialParameters) { throw null; }
449+
protected abstract System.Threading.Tasks.Task UpdateDisplayAsync(in Microsoft.AspNetCore.Components.RenderTree.RenderBatch renderBatch);
450+
}
451451
[System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
452452
public readonly partial struct RenderTreeDiff
453453
{

‎src/Components/Components/src/Dispatcher.cs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
using System;
55
using System.Threading.Tasks;
66
using Microsoft.AspNetCore.Components.Rendering;
7+
using Microsoft.AspNetCore.Components.RenderTree;
78

89
namespace Microsoft.AspNetCore.Components
910
{

‎src/Components/Components/src/RenderHandle.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
33

44
using System;
5-
using Microsoft.AspNetCore.Components.Rendering;
5+
using Microsoft.AspNetCore.Components.RenderTree;
66

77
namespace Microsoft.AspNetCore.Components
88
{

‎src/Components/Components/src/Rendering/EventFieldInfo.cs‎ renamed to ‎src/Components/Components/src/RenderTree/EventFieldInfo.cs‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
// Copyright (c) .NET Foundation. All rights reserved.
22
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
33

4-
namespace Microsoft.AspNetCore.Components.Rendering
4+
namespace Microsoft.AspNetCore.Components.RenderTree
55
{
66
/// <summary>
7-
/// Information supplied with an event notification that can be used to update an existing
8-
/// render tree to match the latest UI state when a form field has mutated. To determine
9-
/// which field has been mutated, the renderer matches it based on the event handler ID.
7+
/// Types in the Microsoft.AspNetCore.Components.RenderTree are not recommended for use outside
8+
/// of the Blazor framework. These types will change in a future release.
109
/// </summary>
10+
//
11+
// Information supplied with an event notification that can be used to update an existing
12+
// render tree to match the latest UI state when a form field has mutated. To determine
13+
// which field has been mutated, the renderer matches it based on the event handler ID.
1114
public class EventFieldInfo
1215
{
1316
/// <summary>

‎src/Components/Components/src/Rendering/RenderBatch.cs‎ renamed to ‎src/Components/Components/src/RenderTree/RenderBatch.cs‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
// Copyright (c) .NET Foundation. All rights reserved.
22
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
33

4-
using Microsoft.AspNetCore.Components.RenderTree;
5-
6-
namespace Microsoft.AspNetCore.Components.Rendering
4+
namespace Microsoft.AspNetCore.Components.RenderTree
75
{
86
/// <summary>
9-
/// Describes a set of UI changes.
7+
/// Types in the Microsoft.AspNetCore.Components.RenderTree are not recommended for use outside
8+
/// of the Blazor framework. These types will change in a future release.
109
/// </summary>
10+
//
11+
// Describes a set of UI changes.
1112
public readonly struct RenderBatch
1213
{
1314
/// <summary>

‎src/Components/Components/src/Rendering/Renderer.Log.cs‎ renamed to ‎src/Components/Components/src/RenderTree/Renderer.Log.cs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
33

44
using System;
5+
using Microsoft.AspNetCore.Components.Rendering;
56
using Microsoft.Extensions.Logging;
67

7-
namespace Microsoft.AspNetCore.Components.Rendering
8+
namespace Microsoft.AspNetCore.Components.RenderTree
89
{
910
public abstract partial class Renderer
1011
{

0 commit comments

Comments
 (0)