Skip to content

Commit

Permalink
JsComponent: Add doccomment remark
Browse files Browse the repository at this point in the history
  • Loading branch information
exyi committed Jun 8, 2024
1 parent 29a6392 commit 42b02bd
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/Framework/Framework/Controls/JsComponent.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@
namespace DotVVM.Framework.Controls
{
/// <summary> Control which initializes a client-side component. </summary>
/// <remark>
/// The client-side component is either exported from a view module referenced in the page's @js directive, or registered using the dotvvm.registerGlobalComponent method.
/// The module should export a $controls field with any number of named components, (TypeScript signature is <c>$controls?: { [name:string]: DotvvmJsComponentFactory }</c>)
/// </remark>
/// <seealso href="https://www.dotvvm.com/docs/latest/pages/concepts/client-side-development/integrate-third-party-controls/react" />
public class JsComponent : DotvvmControl
{
/// <summary> If set to true, view modules are ignored and JsComponents registered using <c>dotvvm.registerGlobalComponent</c> will be considered for client-side rendering. </summary>
Expand Down

0 comments on commit 42b02bd

Please sign in to comment.