Skip to content

Commit

Permalink
Update docs for v2.12.0
Browse files Browse the repository at this point in the history
  • Loading branch information
linjie-firework committed Mar 5, 2024
1 parent cfc657c commit df445e2
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 1 deletion.
7 changes: 7 additions & 0 deletions CHANGELOG-V2.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# CHANGELOG

## [2.12.0]

### Added

- [iOS] Support customizing feed item shadow
- [iOS] Support disabling tap action on custom logo

## [2.11.3]

### Fixed
Expand Down
2 changes: 1 addition & 1 deletion docs/v2/assets/search.js

Large diffs are not rendered by default.

8 changes: 8 additions & 0 deletions docs/v2/interfaces/VideoFeedConfiguration.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ <h3 class="tsd-index-heading">Properties</h3>
<a href="VideoFeedConfiguration.html#itemSpacing" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>item<wbr/>Spacing?</span></a>
<a href="VideoFeedConfiguration.html#playIcon" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>play<wbr/>Icon?</span></a>
<a href="VideoFeedConfiguration.html#replayBadge" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>replay<wbr/>Badge?</span></a>
<a href="VideoFeedConfiguration.html#shadow" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>shadow?</span></a>
<a href="VideoFeedConfiguration.html#showAdBadge" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>show<wbr/>Ad<wbr/>Badge?</span></a>
<a href="VideoFeedConfiguration.html#title" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>title?</span></a>
<a href="VideoFeedConfiguration.html#titlePadding" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>title<wbr/>Padding?</span></a>
Expand Down Expand Up @@ -99,6 +100,12 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
<div class="tsd-comment tsd-typography"><p>The configuration of replay badge.
Only supported on iOS.</p>
</div></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="shadow" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>shadow</span><a href="#shadow" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">shadow<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">VideoFeedShadowConfiguration</span></div>
<div class="tsd-comment tsd-typography"><p>The shadow configuration of video feed item.
Only supported on iOS.</p>
</div></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="showAdBadge" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>show<wbr/>Ad<wbr/>Badge</span><a href="#showAdBadge" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">show<wbr/>Ad<wbr/>Badge<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
Expand Down Expand Up @@ -155,6 +162,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="VideoFeedConfiguration.html#itemSpacing" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>item<wbr/>Spacing?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="VideoFeedConfiguration.html#playIcon" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>play<wbr/>Icon?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="VideoFeedConfiguration.html#replayBadge" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>replay<wbr/>Badge?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="VideoFeedConfiguration.html#shadow" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>shadow?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="VideoFeedConfiguration.html#showAdBadge" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>show<wbr/>Ad<wbr/>Badge?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="VideoFeedConfiguration.html#title" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>title?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="VideoFeedConfiguration.html#titlePadding" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>title<wbr/>Padding?</a></li>
Expand Down
9 changes: 9 additions & 0 deletions docs/v2/interfaces/VideoPlayerLogoConfiguration.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ <h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabI
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Properties</h3>
<div class="tsd-index-list"><a href="VideoPlayerLogoConfiguration.html#encodedId" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>encoded<wbr/>Id?</span></a>
<a href="VideoPlayerLogoConfiguration.html#isClickable" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>is<wbr/>Clickable?</span></a>
<a href="VideoPlayerLogoConfiguration.html#option" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>option</span></a>
</div></section></div></details></section></section>
<section class="tsd-panel-group tsd-member-group">
Expand All @@ -38,6 +39,13 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
Required when option is &#39;creator&#39; or &#39;channelAggregator&#39;.
Only supported on iOS.</p>
</div></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="isClickable" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>is<wbr/>Clickable</span><a href="#isClickable" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">is<wbr/>Clickable<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
<div class="tsd-comment tsd-typography"><p>Specifies whether the logo is tappable and can open the details page.
Defaults to true.
Only supported on iOS.</p>
</div></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="option" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>option</span><a href="#option" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">option<span class="tsd-signature-symbol">:</span> <a href="../types/VideoPlayerLogoOption.html" class="tsd-signature-type" data-tsd-kind="Type alias">VideoPlayerLogoOption</a></div>
Expand Down Expand Up @@ -69,6 +77,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
<li class="current tsd-kind-interface"><a href="VideoPlayerLogoConfiguration.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>Video<wbr/>Player<wbr/>Logo<wbr/>Configuration</span></a>
<ul>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="VideoPlayerLogoConfiguration.html#encodedId" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>encoded<wbr/>Id?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="VideoPlayerLogoConfiguration.html#isClickable" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>is<wbr/>Clickable?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="VideoPlayerLogoConfiguration.html#option" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>option</a></li></ul></li></ul></nav></div></div>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
Expand Down

0 comments on commit df445e2

Please sign in to comment.