vhad/react-bootstrap-table2
1
0
Fork 0
mirror of https://github.com/gosticks/react-bootstrap-table2.git synced 2026-08-12 04:00:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

20190825 release

Browse Source
This commit is contained in:
AllenFang
2019-08-25 21:54:40 +08:00
parent 2d6f4faf89
commit 19aecc1911
61 changed files with 289 additions and 158 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/basic-filter.html
+28 -11
View File
@@ -101,21 +101,38 @@
<span class="hljs-comment">// omit...</span>
</code></pre>
<blockquote>
<p>Note, the <code>selectOptions</code> can be an array also:</p>
<p>Note, the <code>selectOptions</code> can be an array or a function as well:</p>
</blockquote>
<h3><a class="anchor" aria-hidden="true" name="array-as-options"></a><a href="#array-as-options" aria-hidden="true" class="hash-link" ><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Array as options</h3>
<pre><code class="hljs css js"><span class="hljs-keyword">const</span> selectOptions = [
{ <span class="hljs-attr">value</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">label</span>: <span class="hljs-string">'good'</span> },
{ <span class="hljs-attr">value</span>: <span class="hljs-number">1</span>, <span class="hljs-attr">label</span>: <span class="hljs-string">'Bad'</span> },
{ <span class="hljs-attr">value</span>: <span class="hljs-number">2</span>, <span class="hljs-attr">label</span>: <span class="hljs-string">'unknown'</span> }
{ <span class="hljs-attr">value</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">label</span>: <span class="hljs-string">'good'</span> },
{ <span class="hljs-attr">value</span>: <span class="hljs-number">1</span>, <span class="hljs-attr">label</span>: <span class="hljs-string">'Bad'</span> },
{ <span class="hljs-attr">value</span>: <span class="hljs-number">2</span>, <span class="hljs-attr">label</span>: <span class="hljs-string">'unknown'</span> }
];
<span class="hljs-keyword">const</span> columns = [
..., {
<span class="hljs-attr">dataField</span>: <span class="hljs-string">'quality'</span>,
<span class="hljs-attr">text</span>: <span class="hljs-string">'Product Quailty'</span>,
<span class="hljs-attr">formatter</span>: <span class="hljs-function"><span class="hljs-params">cell</span> =&gt;</span> selectOptions.find(<span class="hljs-function"><span class="hljs-params">opt</span> =&gt;</span> opt.value === cell).label,
<span class="hljs-attr">filter</span>: selectFilter({
<span class="hljs-attr">options</span>: selectOptions
})
..., {
<span class="hljs-attr">dataField</span>: <span class="hljs-string">'quality'</span>,
<span class="hljs-attr">text</span>: <span class="hljs-string">'Product Quailty'</span>,
<span class="hljs-attr">formatter</span>: <span class="hljs-function"><span class="hljs-params">cell</span> =&gt;</span> selectOptions.find(<span class="hljs-function"><span class="hljs-params">opt</span> =&gt;</span> opt.value === cell).label,
<span class="hljs-attr">filter</span>: selectFilter({
<span class="hljs-attr">options</span>: selectOptions
})
}];
</code></pre>
<h3><a class="anchor" aria-hidden="true" name="function-as-options"></a><a href="#function-as-options" aria-hidden="true" class="hash-link" ><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Function as options</h3>
<pre><code class="hljs css js"><span class="hljs-keyword">const</span> selectOptions = [
{ <span class="hljs-attr">value</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">label</span>: <span class="hljs-string">'good'</span> },
{ <span class="hljs-attr">value</span>: <span class="hljs-number">1</span>, <span class="hljs-attr">label</span>: <span class="hljs-string">'Bad'</span> },
{ <span class="hljs-attr">value</span>: <span class="hljs-number">2</span>, <span class="hljs-attr">label</span>: <span class="hljs-string">'unknown'</span> }
];
<span class="hljs-keyword">const</span> columns = [
..., {
<span class="hljs-attr">dataField</span>: <span class="hljs-string">'quality'</span>,
<span class="hljs-attr">text</span>: <span class="hljs-string">'Product Quailty'</span>,
<span class="hljs-attr">formatter</span>: <span class="hljs-function"><span class="hljs-params">cell</span> =&gt;</span> selectOptions.find(<span class="hljs-function"><span class="hljs-params">opt</span> =&gt;</span> opt.value === cell).label,
<span class="hljs-attr">filter</span>: selectFilter({
<span class="hljs-attr">options</span>: <span class="hljs-function"><span class="hljs-params">()</span> =&gt;</span> selectOptions
})
}];
</code></pre>
<p>The benifit is <code>react-bootstrap-table2</code> will render the select options by the order of array.</p>
docs/basic-row-expand.html
+6 -1
View File
@@ -30,11 +30,16 @@
<p>This is an example for <a href="../storybook/index.html?selectedKind=Row%20Expand&amp;selectedStory=Expand%20Management">manage on expands</a></p>
<h2><a class="anchor" aria-hidden="true" name="customization"></a><a href="#customization" aria-hidden="true" class="hash-link" ><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Customization</h2>
<h3><a class="anchor" aria-hidden="true" name="style-class"></a><a href="#style-class" aria-hidden="true" class="hash-link" ><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Style/Class</h3>
<p><code>expandRow.renderer</code> allow you to render everything in the content of expanding row. You can control the style or class by yourself. However, a expand row is wrapped by a HTML <code>tr</code> element(Parent row). Currently, we support following way to custom the class/style on parent row element:</p>
<p><code>expandRow.renderer</code> allow you to render everything in the content of expanding row. You can custom the style or class by yourself. However, a expand row is wrapped by a HTML <code>tr</code> element(Parent row). Currently, we support following way to custom the class/style on parent row element:</p>
<ul>
<li>For the class of parent row: <a href="./row-expand-props.html#expandrowparentclassname-string-function"><code>expandRow.parentClassName</code></a></li>
<li>For the style of parent row: N/A</li>
</ul>
<p>In addition, the way to custom the class/style on expanding row element:</p>
<ul>
<li>For the class of expanding row: <a href="./row-expand-props.html#expandrowclassname-string-function"><code>expandRow.className</code></a></li>
<li>For the style of expanding row: N/A</li>
</ul>
<h3><a class="anchor" aria-hidden="true" name="expand-column"></a><a href="#expand-column" aria-hidden="true" class="hash-link" ><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Expand Column</h3>
<p><code>react-bootstrap-table2</code> default doesn't render a additional indicator column, just like row selection. But if you want it, you can enable it via <a href="./row-expand-props.html#expandrowshowexpandcolumn-bool"><code>expandRow.showExpandColumn</code></a></p>
<p>In addition, we allow you to custom the expand columns in following ways:</p>
docs/column-props.html
+3
View File
@@ -54,6 +54,7 @@
<li><a href="#columneditorrenderer-function">editorRenderer</a></li>
<li><a href="#columnfilter-object">filter</a></li>
<li><a href="#columnfiltervalue-function">filterValue</a></li>
<li><a href="#columnsearchable-bool">searchable</a></li>
<li><a href="#columncsvType-object">csvType</a></li>
<li><a href="#columncsvFormatter-function">csvFormatter</a></li>
<li><a href="#columncsvText-string">csvText</a></li>
@@ -736,6 +737,8 @@ const columns = [
<span class="hljs-attr">filterValue</span>: <span class="hljs-function">(<span class="hljs-params">cell, row</span>) =&gt;</span> owners[cell]
}
</code></pre>
<h2><a class="anchor" aria-hidden="true" name="columnsearchable-bool"></a><a href="#columnsearchable-bool" aria-hidden="true" class="hash-link" ><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>column.searchable - [Bool]</h2>
<p>Default the column is searchable. Give <code>false</code> to disable search functionality on specified column.</p>
<h2><a class="anchor" aria-hidden="true" name="columncsvtype-object"></a><a href="#columncsvtype-object" aria-hidden="true" class="hash-link" ><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>column.csvType - [Object]</h2>
<p>Default is <code>String</code>. Currently, the available value is <code>String</code> and <code>Number</code>. If <code>Number</code> assigned, the cell value will not wrapped with double quote.</p>
<h2><a class="anchor" aria-hidden="true" name="columncsvformatter-function"></a><a href="#columncsvformatter-function" aria-hidden="true" class="hash-link" ><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>column.csvFormatter - [Function]</h2>
docs/row-expand-props.html
+24 -7
View File
@@ -24,6 +24,7 @@
<li><a href="#expandrowexpandcolumnposition-string">expandColumnPosition</a></li>
<li><a href="#expandrowexpandcolumnrenderer-function">expandColumnRenderer</a></li>
<li><a href="#expandrowexpandheadercolumnrenderer-function">expandHeaderColumnRenderer</a></li>
<li><a href="#expandrowclassname-string-function">className</a></li>
<li><a href="#expandrowparentclassname-string-function">parentClassName</a></li>
</ul>
<hr>
@@ -148,20 +149,36 @@ const expandRow = {
)
};
</code></pre>
<h2><a class="anchor" aria-hidden="true" name="expandrowclassname-string-function"></a><a href="#expandrowclassname-string-function" aria-hidden="true" class="hash-link" ><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>expandRow.className - [String | Function]</h2>
<p>Apply the custom class name on the expanding row. For example:</p>
<pre><code class="hljs css js"><span class="hljs-keyword">const</span> expandRow = {
<span class="hljs-attr">renderer</span>: <span class="hljs-function">(<span class="hljs-params">row</span>) =&gt;</span> ...,
<span class="hljs-attr">className</span>: <span class="hljs-string">'foo'</span>
};
</code></pre>
<p>Following case is more flexible way to custom the class name:</p>
<pre><code class="hljs css js"><span class="hljs-keyword">const</span> expandRow = {
<span class="hljs-attr">renderer</span>: <span class="hljs-function">(<span class="hljs-params">row</span>) =&gt;</span> ...,
<span class="hljs-attr">className</span>: <span class="hljs-function">(<span class="hljs-params">isExpanded, row, rowIndex</span>) =&gt;</span> {
<span class="hljs-keyword">if</span> (rowIndex &gt; <span class="hljs-number">2</span>) <span class="hljs-keyword">return</span> <span class="hljs-string">'foo'</span>;
<span class="hljs-keyword">return</span> <span class="hljs-string">'bar'</span>;
}
};
</code></pre>
<h2><a class="anchor" aria-hidden="true" name="expandrowparentclassname-string-function"></a><a href="#expandrowparentclassname-string-function" aria-hidden="true" class="hash-link" ><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>expandRow.parentClassName - [String | Function]</h2>
<p>Apply the custom class name on parent row of expanded row. For example:</p>
<pre><code class="hljs css js"><span class="hljs-keyword">const</span> expandRow = {
<span class="hljs-attr">renderer</span>: <span class="hljs-function">(<span class="hljs-params">row</span>) =&gt;</span> ...,
<span class="hljs-attr">parentClassName</span>: <span class="hljs-string">'foo'</span>
<span class="hljs-attr">renderer</span>: <span class="hljs-function">(<span class="hljs-params">row</span>) =&gt;</span> ...,
<span class="hljs-attr">parentClassName</span>: <span class="hljs-string">'foo'</span>
};
</code></pre>
<p>Below case is more flexible way to custom the class name:</p>
<pre><code class="hljs css js"><span class="hljs-keyword">const</span> expandRow = {
<span class="hljs-attr">renderer</span>: <span class="hljs-function">(<span class="hljs-params">row</span>) =&gt;</span> ...,
<span class="hljs-attr">parentClassName</span>: <span class="hljs-function">(<span class="hljs-params">isExpanded, row, rowIndex</span>) =&gt;</span> {
<span class="hljs-keyword">if</span> (rowIndex &gt; <span class="hljs-number">2</span>) <span class="hljs-keyword">return</span> <span class="hljs-string">'foo'</span>;
<span class="hljs-keyword">return</span> <span class="hljs-string">'bar'</span>;
}
<span class="hljs-attr">renderer</span>: <span class="hljs-function">(<span class="hljs-params">row</span>) =&gt;</span> ...,
<span class="hljs-attr">parentClassName</span>: <span class="hljs-function">(<span class="hljs-params">isExpanded, row, rowIndex</span>) =&gt;</span> {
<span class="hljs-keyword">if</span> (rowIndex &gt; <span class="hljs-number">2</span>) <span class="hljs-keyword">return</span> <span class="hljs-string">'foo'</span>;
<span class="hljs-keyword">return</span> <span class="hljs-string">'bar'</span>;
}
};
</code></pre>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="row-select-props.html">← Row Selection Props</a><a class="docs-next button" href="filter-props.html">Column Filter Props →</a></div></div></div></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/react-bootstrap-table2/" class="nav-home"></a><div><h5>Docs</h5><a href="/react-bootstrap-table2/docs/en/getting-started.html">Getting Started</a><a href="/react-bootstrap-table2/docs/en/table-props.html">API References</a></div><div><h5>Community</h5><a href="https://stackoverflow.com/questions/tagged/react-bootstrap-table" target="_blank">Stack Overflow</a><a href="https://discordapp.com/">Project Chat</a><a href="https://twitter.com/" target="_blank">Twitter</a></div><div><h5>More</h5><a href="/react-bootstrap-table2/blog/index.html">Blog</a><a href="https://github.com/react-bootstrap-table/react-bootstrap-table2">GitHub</a><a class="github-button" href="https://github.com/react-bootstrap-table/react-bootstrap-table2" data-icon="octicon-star" data-count-href="/facebook/docusaurus/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2019 react-bootstrap-table2.</section></footer></div></body></html>