hendrik/lens
1
0 Fork 0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00
Code Issues Projects Releases Wiki Activity

Deployed 40f463183 to master with MkDocs 1.1.2 and mike 0.5.5

Browse Source
This commit is contained in:
GitHub Action committed 2021-04-08 14:32:39 +00:00
1 parent 006b5d87b2
commit 212727d813
210 files changed
+6395 -4778
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

master/extensions/api/classes/_renderer_api_components_.checkbox/index.html
+15 -15
View File
@@ -1010,7 +1010,7 @@
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
<h3 id="optional-unsafe_componentwillmount"><code>Optional</code> UNSAFE_componentWillMount<a class="headerlink" href="#optional-unsafe_componentwillmount" title="Permanent link">#</a></h3>
<p>▸ <strong>UNSAFE_componentWillMount</strong>(): <em>void</em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_components_.pagelayout/#optional-unsafe_componentwillmount">UNSAFE_componentWillMount</a></em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.subtitle/">SubTitle</a>.<a href="../_renderer_api_components_.subtitle/#optional-unsafe_componentwillmount">UNSAFE_componentWillMount</a></em></p>
<p>Defined in node_modules/@types/react/index.d.ts:711</p>
<p>Called immediately before mounting occurs, and before <code>Component#render</code>.
Avoid introducing any side-effects or subscriptions in this method.</p>
@@ -1024,7 +1024,7 @@ prevents this from being invoked.</p>
<hr />
<h3 id="optional-unsafe_componentwillreceiveprops"><code>Optional</code> UNSAFE_componentWillReceiveProps<a class="headerlink" href="#optional-unsafe_componentwillreceiveprops" title="Permanent link">#</a></h3>
<p>▸ <strong>UNSAFE_componentWillReceiveProps</strong>(<code>nextProps</code>: Readonly‹<a href="../../interfaces/_renderer_api_components_.checkboxprops/">CheckboxProps</a>›, <code>nextContext</code>: any): <em>void</em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_components_.pagelayout/#optional-unsafe_componentwillreceiveprops">UNSAFE_componentWillReceiveProps</a></em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.subtitle/">SubTitle</a>.<a href="../_renderer_api_components_.subtitle/#optional-unsafe_componentwillreceiveprops">UNSAFE_componentWillReceiveProps</a></em></p>
<p>Defined in node_modules/@types/react/index.d.ts:743</p>
<p>Called when the component may be receiving new props.
React may call this even if props have not changed, so be sure to compare new and existing
@@ -1059,7 +1059,7 @@ prevents this from being invoked.</p>
<hr />
<h3 id="optional-unsafe_componentwillupdate"><code>Optional</code> UNSAFE_componentWillUpdate<a class="headerlink" href="#optional-unsafe_componentwillupdate" title="Permanent link">#</a></h3>
<p>▸ <strong>UNSAFE_componentWillUpdate</strong>(<code>nextProps</code>: Readonly‹<a href="../../interfaces/_renderer_api_components_.checkboxprops/">CheckboxProps</a>›, <code>nextState</code>: Readonly‹S›, <code>nextContext</code>: any): <em>void</em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_components_.pagelayout/#optional-unsafe_componentwillupdate">UNSAFE_componentWillUpdate</a></em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.subtitle/">SubTitle</a>.<a href="../_renderer_api_components_.subtitle/#optional-unsafe_componentwillupdate">UNSAFE_componentWillUpdate</a></em></p>
<p>Defined in node_modules/@types/react/index.d.ts:771</p>
<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
<p>Note: You cannot call <code>Component#setState</code> here.</p>
@@ -1096,7 +1096,7 @@ prevents this from being invoked.</p>
<hr />
<h3 id="optional-componentdidcatch"><code>Optional</code> componentDidCatch<a class="headerlink" href="#optional-componentdidcatch" title="Permanent link">#</a></h3>
<p>▸ <strong>componentDidCatch</strong>(<code>error</code>: Error, <code>errorInfo</code>: ErrorInfo): <em>void</em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_components_.pagelayout/#optional-componentdidcatch">componentDidCatch</a></em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.subtitle/">SubTitle</a>.<a href="../_renderer_api_components_.subtitle/#optional-componentdidcatch">componentDidCatch</a></em></p>
<p>Defined in node_modules/@types/react/index.d.ts:640</p>
<p>Catches exceptions generated in descendant components. Unhandled exceptions will cause
the entire component tree to unmount.</p>
@@ -1123,14 +1123,14 @@ the entire component tree to unmount.</p>
<hr />
<h3 id="optional-componentdidmount"><code>Optional</code> componentDidMount<a class="headerlink" href="#optional-componentdidmount" title="Permanent link">#</a></h3>
<p>▸ <strong>componentDidMount</strong>(): <em>void</em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.wizardlayout/">WizardLayout</a>.<a href="../_renderer_api_components_.wizardlayout/#optional-componentdidmount">componentDidMount</a></em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.subtitle/">SubTitle</a>.<a href="../_renderer_api_components_.subtitle/#optional-componentdidmount">componentDidMount</a></em></p>
<p>Defined in node_modules/@types/react/index.d.ts:619</p>
<p>Called immediately after a component is mounted. Setting state here will trigger re-rendering.</p>
<p><strong>Returns:</strong> <em>void</em></p>
<hr />
<h3 id="optional-componentdidupdate"><code>Optional</code> componentDidUpdate<a class="headerlink" href="#optional-componentdidupdate" title="Permanent link">#</a></h3>
<p>▸ <strong>componentDidUpdate</strong>(<code>prevProps</code>: Readonly‹<a href="../../interfaces/_renderer_api_components_.checkboxprops/">CheckboxProps</a>›, <code>prevState</code>: Readonly‹S›, <code>snapshot?</code>: SS): <em>void</em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_components_.pagelayout/#optional-componentdidupdate">componentDidUpdate</a></em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.subtitle/">SubTitle</a>.<a href="../_renderer_api_components_.subtitle/#optional-componentdidupdate">componentDidUpdate</a></em></p>
<p>Defined in node_modules/@types/react/index.d.ts:682</p>
<p>Called immediately after updating occurs. Not called for the initial render.</p>
<p>The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.</p>
@@ -1161,7 +1161,7 @@ the entire component tree to unmount.</p>
<hr />
<h3 id="optional-componentwillmount"><code>Optional</code> componentWillMount<a class="headerlink" href="#optional-componentwillmount" title="Permanent link">#</a></h3>
<p>▸ <strong>componentWillMount</strong>(): <em>void</em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_components_.pagelayout/#optional-componentwillmount">componentWillMount</a></em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.subtitle/">SubTitle</a>.<a href="../_renderer_api_components_.subtitle/#optional-componentwillmount">componentWillMount</a></em></p>
<p>Defined in node_modules/@types/react/index.d.ts:697</p>
<p>Called immediately before mounting occurs, and before <code>Component#render</code>.
Avoid introducing any side-effects or subscriptions in this method.</p>
@@ -1174,7 +1174,7 @@ prevents this from being invoked.</p>
<hr />
<h3 id="optional-componentwillreceiveprops"><code>Optional</code> componentWillReceiveProps<a class="headerlink" href="#optional-componentwillreceiveprops" title="Permanent link">#</a></h3>
<p>▸ <strong>componentWillReceiveProps</strong>(<code>nextProps</code>: Readonly‹<a href="../../interfaces/_renderer_api_components_.checkboxprops/">CheckboxProps</a>›, <code>nextContext</code>: any): <em>void</em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_components_.pagelayout/#optional-componentwillreceiveprops">componentWillReceiveProps</a></em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.subtitle/">SubTitle</a>.<a href="../_renderer_api_components_.subtitle/#optional-componentwillreceiveprops">componentWillReceiveProps</a></em></p>
<p>Defined in node_modules/@types/react/index.d.ts:726</p>
<p>Called when the component may be receiving new props.
React may call this even if props have not changed, so be sure to compare new and existing
@@ -1208,7 +1208,7 @@ prevents this from being invoked.</p>
<hr />
<h3 id="optional-componentwillunmount"><code>Optional</code> componentWillUnmount<a class="headerlink" href="#optional-componentwillunmount" title="Permanent link">#</a></h3>
<p>▸ <strong>componentWillUnmount</strong>(): <em>void</em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.wizardlayout/">WizardLayout</a>.<a href="../_renderer_api_components_.wizardlayout/#optional-componentwillunmount">componentWillUnmount</a></em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.subtitle/">SubTitle</a>.<a href="../_renderer_api_components_.subtitle/#optional-componentwillunmount">componentWillUnmount</a></em></p>
<p>Defined in node_modules/@types/react/index.d.ts:635</p>
<p>Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as
cancelled network requests, or cleaning up any DOM elements created in <code>componentDidMount</code>.</p>
@@ -1216,7 +1216,7 @@ cancelled network requests, or cleaning up any DOM elements created in <code>com
<hr />
<h3 id="optional-componentwillupdate"><code>Optional</code> componentWillUpdate<a class="headerlink" href="#optional-componentwillupdate" title="Permanent link">#</a></h3>
<p>▸ <strong>componentWillUpdate</strong>(<code>nextProps</code>: Readonly‹<a href="../../interfaces/_renderer_api_components_.checkboxprops/">CheckboxProps</a>›, <code>nextState</code>: Readonly‹S›, <code>nextContext</code>: any): <em>void</em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_components_.pagelayout/#optional-componentwillupdate">componentWillUpdate</a></em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.subtitle/">SubTitle</a>.<a href="../_renderer_api_components_.subtitle/#optional-componentwillupdate">componentWillUpdate</a></em></p>
<p>Defined in node_modules/@types/react/index.d.ts:756</p>
<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
<p>Note: You cannot call <code>Component#setState</code> here.</p>
@@ -1252,7 +1252,7 @@ prevents this from being invoked.</p>
<hr />
<h3 id="optional-getsnapshotbeforeupdate"><code>Optional</code> getSnapshotBeforeUpdate<a class="headerlink" href="#optional-getsnapshotbeforeupdate" title="Permanent link">#</a></h3>
<p>▸ <strong>getSnapshotBeforeUpdate</strong>(<code>prevProps</code>: Readonly‹<a href="../../interfaces/_renderer_api_components_.checkboxprops/">CheckboxProps</a>›, <code>prevState</code>: Readonly‹S›): <em>SS | null</em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_components_.pagelayout/#optional-getsnapshotbeforeupdate">getSnapshotBeforeUpdate</a></em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.subtitle/">SubTitle</a>.<a href="../_renderer_api_components_.subtitle/#optional-getsnapshotbeforeupdate">getSnapshotBeforeUpdate</a></em></p>
<p>Defined in node_modules/@types/react/index.d.ts:676</p>
<p>Runs before React applies the result of <code>render</code> to the document, and
returns an object to be given to componentDidUpdate. Useful for saving
@@ -1282,12 +1282,12 @@ lifecycle events from running.</p>
<hr />
<h3 id="getvalue">getValue<a class="headerlink" href="#getvalue" title="Permanent link">#</a></h3>
<p>▸ <strong>getValue</strong>(): <em>boolean</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/465dcd0a6/src/renderer/components/checkbox/checkbox.tsx#L25">src/renderer/components/checkbox/checkbox.tsx:25</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/40f463183/src/renderer/components/checkbox/checkbox.tsx#L25">src/renderer/components/checkbox/checkbox.tsx:25</a></em></p>
<p><strong>Returns:</strong> <em>boolean</em></p>
<hr />
<h3 id="onchange">onChange<a class="headerlink" href="#onchange" title="Permanent link">#</a></h3>
<p>▸ <strong>onChange</strong>(<code>evt</code>: ChangeEvent‹HTMLInputElement›): <em>void</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/465dcd0a6/src/renderer/components/checkbox/checkbox.tsx#L19">src/renderer/components/checkbox/checkbox.tsx:19</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/40f463183/src/renderer/components/checkbox/checkbox.tsx#L19">src/renderer/components/checkbox/checkbox.tsx:19</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -1307,12 +1307,12 @@ lifecycle events from running.</p>
<hr />
<h3 id="render">render<a class="headerlink" href="#render" title="Permanent link">#</a></h3>
<p>▸ <strong>render</strong>(): <em>Element‹›</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/465dcd0a6/src/renderer/components/checkbox/checkbox.tsx#L31">src/renderer/components/checkbox/checkbox.tsx:31</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/40f463183/src/renderer/components/checkbox/checkbox.tsx#L31">src/renderer/components/checkbox/checkbox.tsx:31</a></em></p>
<p><strong>Returns:</strong> <em>Element‹›</em></p>
<hr />
<h3 id="optional-shouldcomponentupdate"><code>Optional</code> shouldComponentUpdate<a class="headerlink" href="#optional-shouldcomponentupdate" title="Permanent link">#</a></h3>
<p>▸ <strong>shouldComponentUpdate</strong>(<code>nextProps</code>: Readonly‹<a href="../../interfaces/_renderer_api_components_.checkboxprops/">CheckboxProps</a>›, <code>nextState</code>: Readonly‹S›, <code>nextContext</code>: any): <em>boolean</em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.pagelayout/">PageLayout</a>.<a href="../_renderer_api_components_.pagelayout/#optional-shouldcomponentupdate">shouldComponentUpdate</a></em></p>
<p><em>Inherited from <a href="../_renderer_api_components_.subtitle/">SubTitle</a>.<a href="../_renderer_api_components_.subtitle/#optional-shouldcomponentupdate">shouldComponentUpdate</a></em></p>
<p>Defined in node_modules/@types/react/index.d.ts:630</p>
<p>Called to determine whether the change in props and state should trigger a re-render.</p>
<p><code>Component</code> always returns true.