Publish website

Author: realityforge

api-diff/data/react4j/0.205-0.206.json

@@ -0,0 +1,18 @@
+[
+  {
+    "code": "java.method.attributeWithDefaultAddedToAnnotationType",
+    "description": "The annotation has a new attribute with a default value.",
+    "newElement": "method react4j.annotations.Feature react4j.annotations.Input::observeOnRender()",
+    "classification": {
+      "SOURCE": "NON_BREAKING",
+      "BINARY": "NON_BREAKING"
+    },
+    "attachments": {
+      "classQualifiedName": "react4j.annotations.Input",
+      "classSimpleName": "Input",
+      "elementKind": "method",
+      "methodName": "observeOnRender",
+      "package": "react4j.annotations"
+    }
+  }
+]

api/index-all.html

@@ -3130,6 +3130,11 @@ <h2 class="title" id="I:O">O</h2>
 <dd>
 <div class="block">Indicate whether the input should be annotated by <a href="https://arez.github.io/api/arez/annotations/Observable.html" title="class or interface in arez.annotations" class="external-link"><code>Observable</code></a>.</div>
 </dd>
+<dt><a href="react4j/annotations/Input.html#observeOnRender()" class="member-name-link">observeOnRender()</a> - Element in annotation interface react4j.annotations.<a href="react4j/annotations/Input.html" title="annotation interface in react4j.annotations">Input</a></dt>
+<dd>
+<div class="block">Return an enum indicating whether tracked renders should observe the input value during the generated render
+ prelude so that disposing the input can invalidate the render and trigger a rerender.</div>
+</dd>
 <dt><a href="react4j/ReactNode.html#of(byte)" class="member-name-link">of(byte)</a> - Static method in interface react4j.<a href="react4j/ReactNode.html" title="interface in react4j">ReactNode</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="react4j/ReactNode.html#of(double)" class="member-name-link">of(double)</a> - Static method in interface react4j.<a href="react4j/ReactNode.html" title="interface in react4j">ReactNode</a></dt>

api/member-search-index.js

@@ -85,7 +85,7 @@ <h1 title="Enum Class Input.Source" class="title">Enum Class Input.Source</h1>
 <dd><a href="Input.html" title="annotation interface in react4j.annotations">Input</a></dd>
 </dl>
 <hr>
-<div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-161">Input.Source</a></span>
+<div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-176">Input.Source</a></span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a>&gt;</span></div>
 <div class="block">Enum where the input is sourced from.</div>
 </section>
@@ -164,14 +164,14 @@ <h2>Enum Constant Details</h2>
 <li>
 <section class="detail" id="DEFAULT">
 <h3>DEFAULT</h3>
-<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-166">DEFAULT</a></span></div>
+<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-181">DEFAULT</a></span></div>
 <div class="block">The input value is passed to the view during construction.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="CONTEXT">
 <h3>CONTEXT</h3>
-<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-170">CONTEXT</a></span></div>
+<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-185">CONTEXT</a></span></div>
 <div class="block">The input value is retrieved from the react context.</div>
 </section>
 </li>
@@ -186,7 +186,7 @@ <h2>Method Details</h2>
 <li>
 <section class="detail" id="values()">
 <h3>values</h3>
-<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a>[]</span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-161">values</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a>[]</span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-176">values</a></span>()</div>
 <div class="block">Returns an array containing the constants of this enum class, in
 the order they are declared.</div>
 <dl class="notes">
@@ -198,7 +198,7 @@ <h3>values</h3>
 <li>
 <section class="detail" id="valueOf(java.lang.String)">
 <h3>valueOf</h3>
-<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-161">valueOf</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
+<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-176">valueOf</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
 <div class="block">Returns the enum constant of this class with the specified name.
 The string must match <i>exactly</i> an identifier used to declare an
 enum constant in this class.  (Extraneous whitespace characters are 

api/react4j/annotations/Input.Source.html

@@ -153,19 +153,25 @@ <h2>Optional Element Summary</h2>
 <div class="col-last even-row-color">
 <div class="block">Indicate whether the input should be annotated by <a href="https://arez.github.io/api/arez/annotations/Observable.html" title="class or interface in arez.annotations" class="external-link"><code>Observable</code></a>.</div>
 </div>
-<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
-<div class="col-second odd-row-color"><code><a href="#qualifier()" class="member-name-link">qualifier</a></code></div>
+<div class="col-first odd-row-color"><code><a href="Feature.html" title="enum class in react4j.annotations">Feature</a></code></div>
+<div class="col-second odd-row-color"><code><a href="#observeOnRender()" class="member-name-link">observeOnRender</a></code></div>
 <div class="col-last odd-row-color">
-<div class="block">Return the qualifier used to access value from context.</div>
+<div class="block">Return an enum indicating whether tracked renders should observe the input value during the generated render
+ prelude so that disposing the input can invalidate the render and trigger a rerender.</div>
 </div>
-<div class="col-first even-row-color"><code><a href="Feature.html" title="enum class in react4j.annotations">Feature</a></code></div>
-<div class="col-second even-row-color"><code><a href="#require()" class="member-name-link">require</a></code></div>
+<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
+<div class="col-second even-row-color"><code><a href="#qualifier()" class="member-name-link">qualifier</a></code></div>
 <div class="col-last even-row-color">
-<div class="block">Setting indicating whether the input should be supplied when the view is constructed.</div>
+<div class="block">Return the qualifier used to access value from context.</div>
 </div>
-<div class="col-first odd-row-color"><code><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></code></div>
-<div class="col-second odd-row-color"><code><a href="#source()" class="member-name-link">source</a></code></div>
+<div class="col-first odd-row-color"><code><a href="Feature.html" title="enum class in react4j.annotations">Feature</a></code></div>
+<div class="col-second odd-row-color"><code><a href="#require()" class="member-name-link">require</a></code></div>
 <div class="col-last odd-row-color">
+<div class="block">Setting indicating whether the input should be supplied when the view is constructed.</div>
+</div>
+<div class="col-first even-row-color"><code><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></code></div>
+<div class="col-second even-row-color"><code><a href="#source()" class="member-name-link">source</a></code></div>
+<div class="col-last even-row-color">
 <div class="block">The setting controlling where the input value is source from.</div>
 </div>
 </div>
@@ -279,16 +285,12 @@ <h3>observable</h3>
 <li>
 <section class="detail" id="disposable()">
 <h3>disposable</h3>
-<div class="member-signature"><span class="return-type"><a href="Feature.html" title="enum class in react4j.annotations">Feature</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-119">disposable</a></span></div>
+<div class="member-signature"><span class="return-type"><a href="Feature.html" title="enum class in react4j.annotations">Feature</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-115">disposable</a></span></div>
 <div class="block">Return an enum indicating whether the view should check whether the value of the input is disposed
  prior to rendering. If the value is disposed then the render method will exit early and return null.
  If this parameter is set to <a href="Feature.html#AUTODETECT"><code>Feature.AUTODETECT</code></a> then the annotation processor will inspect the
  type of the input and treat it as <a href="Feature.html#ENABLE"><code>Feature.ENABLE</code></a> if the type is annotated with the <a href="https://arez.github.io/api/arez/annotations/ArezComponent.html" title="class or interface in arez.annotations" class="external-link"><code>ArezComponent</code></a>
- annotation or the <a href="https://arez.github.io/api/arez/annotations/ActAsComponent.html" title="class or interface in arez.annotations" class="external-link"><code>ActAsComponent</code></a> annotation.
-
- <p>For tracked renders, disposable inputs whose declared type is annotated with <a href="https://arez.github.io/api/arez/annotations/ArezComponent.html" title="class or interface in arez.annotations" class="external-link"><code>ArezComponent</code></a> or
- <a href="https://arez.github.io/api/arez/annotations/ActAsComponent.html" title="class or interface in arez.annotations" class="external-link"><code>ActAsComponent</code></a> will also be observed during render so that disposing the input can invalidate the
- render and trigger a rerender.</p></div>
+ annotation or the <a href="https://arez.github.io/api/arez/annotations/ActAsComponent.html" title="class or interface in arez.annotations" class="external-link"><code>ActAsComponent</code></a> annotation.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>an enum indicating whether the view should check whether the value of the input is disposed prior to rendering.</dd>
@@ -300,9 +302,36 @@ <h3>disposable</h3>
 </section>
 </li>
 <li>
+<section class="detail" id="observeOnRender()">
+<h3>observeOnRender</h3>
+<div class="member-signature"><span class="return-type"><a href="Feature.html" title="enum class in react4j.annotations">Feature</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-134">observeOnRender</a></span></div>
+<div class="block">Return an enum indicating whether tracked renders should observe the input value during the generated render
+ prelude so that disposing the input can invalidate the render and trigger a rerender.
+ This parameter is independent of <a href="#disposable()"><code>disposable()</code></a> and is only relevant to views with render tracking enabled.
+
+ <p>If this parameter is set to <a href="Feature.html#AUTODETECT"><code>Feature.AUTODETECT</code></a> then the annotation processor will inspect the
+ type of the input and treat it as <a href="Feature.html#ENABLE"><code>Feature.ENABLE</code></a> in the following circumstances:</p>
+ <ul>
+ <li>the type is compatible with <code>arez.component.ComponentObservable</code>.</li>
+ <li>the type is annotated with <a href="https://arez.github.io/api/arez/annotations/ArezComponent.html" title="class or interface in arez.annotations" class="external-link"><code>ArezComponent</code></a> and the <a href="https://arez.github.io/api/arez/annotations/ArezComponent.html#observable()" title="class or interface in arez.annotations" class="external-link"><code>ArezComponent.observable()</code></a> parameter
+ resolves to enabled.</li>
+ <li>the type is annotated with <a href="https://arez.github.io/api/arez/annotations/ActAsComponent.html" title="class or interface in arez.annotations" class="external-link"><code>ActAsComponent</code></a>. In this scenario the generated code will verify
+ compatibility with <code>arez.component.ComponentObservable</code> at runtime before observing the value.</li>
+ </ul></div>
+<dl class="notes">
+<dt>Returns:</dt>
+<dd>an enum indicating whether tracked renders should observe the input value during render.</dd>
+</dl>
+<dl class="notes">
+<dt>Default:</dt>
+<dd>AUTODETECT</dd>
+</dl>
+</section>
+</li>
+<li>
 <section class="detail" id="dependency()">
 <h3>dependency</h3>
-<div class="member-signature"><span class="return-type"><a href="Feature.html" title="enum class in react4j.annotations">Feature</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-131">dependency</a></span></div>
+<div class="member-signature"><span class="return-type"><a href="Feature.html" title="enum class in react4j.annotations">Feature</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-146">dependency</a></span></div>
 <div class="block">Return an enum indicating whether the view should be disposed if the input is disposed. To enable this feature,
  the input MUST set <a href="#immutable()"><code>immutable()</code></a> to <code>true</code>, <a href="#disposable()"><code>disposable()</code></a> MUST resolve to
  <a href="Feature.html#ENABLE"><code>Feature.ENABLE</code></a>. The type of the input is expected to implement the <a href="https://arez.github.io/api/arez/component/DisposeNotifier.html" title="class or interface in arez.component" class="external-link"><code>DisposeNotifier</code></a>
@@ -322,7 +351,7 @@ <h3>dependency</h3>
 <li>
 <section class="detail" id="immutable()">
 <h3>immutable</h3>
-<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-156">immutable</a></span></div>
+<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-171">immutable</a></span></div>
 <div class="block">True if the input is not expected to change after initial value is set. If the value of the input does change
  then it is expected that the view will be unmounted and a new view created. This is implemented
  by synthesizing a key for the view every time the view that is derived from this input. To enable this