react-konva-grid
Version:
Declarative React Canvas Grid primitive for Data table, Pivot table, Excel Worksheets
231 lines • 10.5 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>"hooks/useSelection" | react-konva-grid</title>
<meta name="description" content="Documentation for react-konva-grid">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">react-konva-grid</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="_hooks_useselection_.html">"hooks/useSelection"</a>
</li>
</ul>
<h1>Module "hooks/useSelection"</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_hooks_useselection_.selectionresults.html" class="tsd-kind-icon">Selection<wbr>Results</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_hooks_useselection_.useselectionoptions.html" class="tsd-kind-icon">Use<wbr>Selection<wbr>Options</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-not-exported">
<h3>Variables</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"><a href="_hooks_useselection_.html#empty_selection" class="tsd-kind-icon">EMPTY_<wbr>SELECTION</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-module"><a href="_hooks_useselection_.html#useselection" class="tsd-kind-icon">use<wbr>Selection</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
<a name="empty_selection" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> EMPTY_<wbr>SELECTION</h3>
<div class="tsd-signature tsd-kind-icon">EMPTY_<wbr>SELECTION<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_grid_.selectionarea.html" class="tsd-signature-type">SelectionArea</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/hooks/useSelection.ts#L78">src/hooks/useSelection.ts:78</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="useselection" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> use<wbr>Selection</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">use<wbr>Selection<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_hooks_useselection_.useselectionoptions.html" class="tsd-signature-type">UseSelectionOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_hooks_useselection_.selectionresults.html" class="tsd-signature-type">SelectionResults</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/hooks/useSelection.ts#L84">src/hooks/useSelection.ts:84</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Hook to enable selection in datagrid</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/_hooks_useselection_.useselectionoptions.html" class="tsd-signature-type">UseSelectionOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_hooks_useselection_.selectionresults.html" class="tsd-signature-type">SelectionResults</a></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-module">
<a href="_cell_.html">"<wbr>Cell"</a>
</li>
<li class=" tsd-kind-module">
<a href="_grid_.html">"<wbr>Grid"</a>
</li>
<li class=" tsd-kind-module">
<a href="_helpers_.html">"helpers"</a>
</li>
<li class=" tsd-kind-module">
<a href="_hooks_useautosizer_.html">"hooks/use<wbr>Auto<wbr>Sizer"</a>
</li>
<li class=" tsd-kind-module">
<a href="_hooks_usecopypaste_.html">"hooks/use<wbr>Copy<wbr>Paste"</a>
</li>
<li class=" tsd-kind-module">
<a href="_hooks_useeditable_.html">"hooks/use<wbr>Editable"</a>
</li>
<li class=" tsd-kind-module">
<a href="_hooks_usepagination_.html">"hooks/use<wbr>Pagination"</a>
</li>
<li class="current tsd-kind-module">
<a href="_hooks_useselection_.html">"hooks/use<wbr>Selection"</a>
</li>
<li class=" tsd-kind-module">
<a href="_hooks_usetooltip_.html">"hooks/use<wbr>Tooltip"</a>
</li>
<li class=" tsd-kind-module">
<a href="_index_.html">"index"</a>
</li>
<li class=" tsd-kind-module">
<a href="_types_.html">"types"</a>
</li>
<li class=" tsd-kind-module">
<a href="_utils_.html">"utils"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/_hooks_useselection_.selectionresults.html" class="tsd-kind-icon">Selection<wbr>Results</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/_hooks_useselection_.useselectionoptions.html" class="tsd-kind-icon">Use<wbr>Selection<wbr>Options</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
<a href="_hooks_useselection_.html#empty_selection" class="tsd-kind-icon">EMPTY_<wbr>SELECTION</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="_hooks_useselection_.html#useselection" class="tsd-kind-icon">use<wbr>Selection</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>