Skip to content

Commit

Permalink
Deployed 2d79196 with MkDocs version: 1.4.2
Browse files Browse the repository at this point in the history
  • Loading branch information
ZacSweers committed Nov 29, 2023
1 parent 1b79f17 commit 91122d6
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 6 deletions.
8 changes: 4 additions & 4 deletions circuitx/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -870,9 +870,9 @@ <h3 id="navigation">Navigation<a class="headerlink" href="#navigation" title="Pe
and route through here, but you should be sure to implement your own <code>AndroidScreenStarter</code> to
handle them accordingly.</p>
<h2 id="effects">Effects<a class="headerlink" href="#effects" title="Permanent link">&para;</a></h2>
<p>CircuitX provides some effects for use with logging/analytics. These effects are typically used in
circuit presenters for tracking <code>impressions</code> and will run only once until forgotten based on the
current circuit retained strategy.</p>
<p>CircuitX provides some effects for use with logging/analytics. These effects are typically used in
Circuit presenters for tracking <code>impressions</code> and will run only once until forgotten based on the
current circuit-retained strategy.</p>
<div class="highlight"><pre><span></span><code><span class="n">dependencies</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="n">implementation</span><span class="p">(</span><span class="s">&quot;com.slack.circuit:circuitx-effects:&lt;version&gt;&quot;</span><span class="p">)</span>
<span class="p">}</span>
Expand Down Expand Up @@ -986,10 +986,10 @@ <h3 id="fullscreenoverlay">FullScreenOverlay<a class="headerlink" href="#fullscr
</code></pre></div>
<div class="admonition info">
<p class="admonition-title">When to use <code>FullScreenOverlay</code> vs navigating to a <code>Screen</code>?</p>
</div>
<p>While they achieve similar results, the key difference is that <code>FullScreenOverlay</code> is
inherently an ephemeral UI that is <em>controlled</em> by an underlying primary UI. It cannot
navigate elsewhere and it does not participate in the backstack.</p>
</div>



Expand Down
7 changes: 6 additions & 1 deletion code-gen/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -666,7 +666,7 @@


<h1 id="code-generation">Code Generation<a class="headerlink" href="#code-generation" title="Permanent link">&para;</a></h1>
<p>If using Dagger and Anvil, Circuit offers a KSP-based code gen solution to ease boilerplate around generating factories.</p>
<p>If using Dagger and Anvil or Hilt, Circuit offers a KSP-based code gen solution to ease boilerplate around generating factories.</p>
<h2 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">&para;</a></h2>
<div class="highlight"><pre><span></span><code><span class="n">plugins</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="n">id</span><span class="p">(</span><span class="s">&quot;com.google.devtools.ksp&quot;</span><span class="p">)</span>
Expand All @@ -677,6 +677,11 @@ <h2 id="installation">Installation<a class="headerlink" href="#installation" tit
<span class="w"> </span><span class="n">ksp</span><span class="p">(</span><span class="s">&quot;com.slack.circuit:circuit-codegen:&lt;version&gt;&quot;</span><span class="p">)</span>
<span class="p">}</span>
</code></pre></div>
<p>Note that Anvil is enabled by default. If you are using Hilt, you must specify the mode as a KSP arg.</p>
<div class="highlight"><pre><span></span><code><span class="n">ksp</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="n">arg</span><span class="p">(</span><span class="s">&quot;circuit.codegen.mode&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;hilt&quot;</span><span class="p">)</span>
<span class="p">}</span>
</code></pre></div>
<h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">&para;</a></h2>
<p>The primary entry point is the <code>CircuitInject</code> annotation.</p>
<p>This annotation is used to mark a UI or presenter class or function for code generation. When
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

Binary file modified sitemap.xml.gz
Binary file not shown.

0 comments on commit 91122d6

Please sign in to comment.