huahaofeng
/
aspnetcore
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Enable invoking a `ViewComponent` without arguments inside of a controller. 

- Also updated doc comments to properly reflect `ViewComponent` `arguments` parameter.
This commit is contained in:
N. Taylor Mullen 2016-02-02 16:14:05 -08:00
parent f888ced1f2
commit acd88d08ba
3 changed files with 40 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
src/Microsoft.AspNetCore.Mvc.ViewFeatures/Controller.cs
View File

@ -209,6 +209,32 @@ namespace Microsoft.AspNetCore.Mvc
};
}
/// <summary>
/// Creates a <see cref="ViewComponentResult"/> by specifying the name of a view component to render.
/// </summary>
/// <param name="componentName">
/// The view component name. Can be a view component
/// <see cref="ViewComponents.ViewComponentDescriptor.ShortName"/> or
/// <see cref="ViewComponents.ViewComponentDescriptor.FullName"/>.</param>
/// <returns>The created <see cref="ViewComponentResult"/> object for the response.</returns>
[NonAction]
public virtual ViewComponentResult ViewComponent(string componentName)
{
return ViewComponent(componentName, arguments: null);
}
/// <summary>
/// Creates a <see cref="ViewComponentResult"/> by specifying the <see cref="Type"/> of a view component to
/// render.
/// </summary>
/// <param name="componentType">The view component <see cref="Type"/>.</param>
/// <returns>The created <see cref="ViewComponentResult"/> object for the response.</returns>
[NonAction]
public virtual ViewComponentResult ViewComponent(Type componentType)
{
return ViewComponent(componentType, arguments: null);
}
/// <summary>
/// Creates a <see cref="ViewComponentResult"/> by specifying the name of a view component to render.
/// </summary>
@ -217,9 +243,9 @@ namespace Microsoft.AspNetCore.Mvc
/// <see cref="ViewComponents.ViewComponentDescriptor.ShortName"/> or
/// <see cref="ViewComponents.ViewComponentDescriptor.FullName"/>.</param>
/// <param name="arguments">
/// An anonymous <see cref="object"/> containing arguments to be passed to the invoked view component method.
/// Alternatively, an <see cref="System.Collections.Generic.IDictionary{string, object}"/> instance containing
/// the invocation arguments.
/// An <see cref="object"/> with properties representing arguments to be passed to the invoked view component
/// method. Alternatively, an <see cref="System.Collections.Generic.IDictionary{string, object}"/> instance
/// containing the invocation arguments.
/// </param>
/// <returns>The created <see cref="ViewComponentResult"/> object for the response.</returns>
[NonAction]
@ -240,9 +266,9 @@ namespace Microsoft.AspNetCore.Mvc
/// </summary>
/// <param name="componentType">The view component <see cref="Type"/>.</param>
/// <param name="arguments">
/// An anonymous <see cref="object"/> containing arguments to be passed to the invoked view component method.
/// Alternatively, an <see cref="System.Collections.Generic.IDictionary{string, object}"/> instance containing
/// the invocation arguments.
/// An <see cref="object"/> with properties representing arguments to be passed to the invoked view component
/// method. Alternatively, an <see cref="System.Collections.Generic.IDictionary{string, object}"/> instance
/// containing the invocation arguments.
/// </param>
/// <returns>The created <see cref="ViewComponentResult"/> object for the response.</returns>
[NonAction]

12
src/Microsoft.AspNetCore.Mvc.ViewFeatures/IViewComponentHelper.cs
View File

@ -17,9 +17,9 @@ namespace Microsoft.AspNetCore.Mvc
/// </summary>
/// <param name="name">The name of the view component.</param>
/// <param name="arguments">
/// An anonymous <see cref="object"/> containing arguments to be passed to the invoked view component method.
/// Alternatively, an <see cref="System.Collections.Generic.IDictionary{string, object}"/> instance containing
/// the invocation arguments.
/// An <see cref="object"/> with properties representing arguments to be passed to the invoked view component
/// method. Alternatively, an <see cref="System.Collections.Generic.IDictionary{string, object}"/> instance
/// containing the invocation arguments.
/// </param>
/// <returns>A <see cref="Task"/> that on completion returns the rendered <see cref="IHtmlContent" />.
/// </returns>
@ -30,9 +30,9 @@ namespace Microsoft.AspNetCore.Mvc
/// </summary>
/// <param name="componentType">The view component <see cref="Type"/>.</param>
/// <param name="arguments">
/// An anonymous <see cref="object"/> containing arguments to be passed to the invoked view component method.
/// Alternatively, an <see cref="System.Collections.Generic.IDictionary{string, object}"/> instance containing
/// the invocation arguments.
/// An <see cref="object"/> with properties representing arguments to be passed to the invoked view component
/// method. Alternatively, an <see cref="System.Collections.Generic.IDictionary{string, object}"/> instance
/// containing the invocation arguments.
/// </param>
/// <returns>A <see cref="Task"/> that on completion returns the rendered <see cref="IHtmlContent" />.
/// </returns>

4
test/Microsoft.AspNetCore.Mvc.ViewFeatures.Test/ControllerUnitTestabilityTests.cs
View File

@ -560,7 +560,7 @@ namespace Microsoft.AspNetCore.Mvc
var controller = new TestabilityController();
// Act
var result = controller.ViewComponent("TagCloud", arguments: null);
var result = controller.ViewComponent("TagCloud");
// Assert
Assert.NotNull(result);
@ -575,7 +575,7 @@ namespace Microsoft.AspNetCore.Mvc
var controller = new TestabilityController();
// Act
var result = controller.ViewComponent(typeof(TagCloudViewComponent), arguments: null);
var result = controller.ViewComponent(typeof(TagCloudViewComponent));
// Assert
Assert.NotNull(result);