cg-select/docs/interfaces/interfaces_cg_select_interface.ICgSelect.html

1347 lines
60 KiB
HTML
Raw Normal View History

2023-01-27 20:06:32 +03:00
<!DOCTYPE html>
<html class="default" lang="en">
<head>
<meta charset="utf-8" />
<meta http-equiv="x-ua-compatible" content="IE=edge" />
<title>ICgSelect | cg-select</title>
<meta name="description" content="Documentation for cg-select" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="stylesheet" href="../assets/style.css" />
<link rel="stylesheet" href="../assets/highlight.css" />
<script async src="../assets/search.js" id="search-script"></script>
</head>
<body>
<script>
document.documentElement.dataset.theme = localStorage.getItem('tsd-theme') || 'os';
</script>
<header class="tsd-page-toolbar">
<div class="tsd-toolbar-contents container">
<div class="table-cell" id="tsd-search" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"
><svg width="16" height="16" viewBox="0 0 16 16" fill="none">
<path
d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z"
fill="var(--color-text)"
></path></svg></label
><input type="text" id="tsd-search-field" aria-label="Search" />
</div>
<div class="field">
<div id="tsd-toolbar-links"></div>
</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">cg-select</a>
</div>
<div class="table-cell" id="tsd-widgets">
<a
href="#"
class="tsd-widget tsd-toolbar-icon menu no-caption"
data-toggle="menu"
aria-label="Menu"
><svg width="16" height="16" viewBox="0 0 16 16" fill="none">
<rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect>
<rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect>
<rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg
></a>
</div>
</div>
</header>
<div class="container container-main">
<div class="col-8 col-content">
<div class="tsd-page-title">
<ul class="tsd-breadcrumb">
<li><a href="../modules.html">cg-select</a></li>
<li>
<a href="../modules/interfaces_cg_select_interface.html"
>interfaces/cg-select.interface</a
>
</li>
<li><a href="interfaces_cg_select_interface.ICgSelect.html">ICgSelect</a></li>
</ul>
<h1>Interface ICgSelect</h1>
</div>
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<h3>Description</h3>
<p>Select settings.</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">ICgSelect</span></li>
</ul>
</section>
<section class="tsd-panel">
<h4>Implemented by</h4>
<ul class="tsd-hierarchy">
<li>
<a
href="../classes/cg_select.CGSelect.html"
class="tsd-signature-type"
data-tsd-kind="Class"
>CGSelect</a
>
</li>
</ul>
</section>
<aside class="tsd-sources">
<ul>
<li>
Defined in
<a
2023-01-31 15:28:00 +03:00
href="https://github.com/apuc/cg-select/blob/31b10e2/src/interfaces/cg-select.interface.ts#L6"
2023-01-27 20:06:32 +03:00
>interfaces/cg-select.interface.ts:6</a
>
</li>
</ul>
</aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open>
<summary class="tsd-accordion-summary tsd-index-summary">
<h5
class="tsd-index-heading uppercase"
role="button"
aria-expanded="false"
tabindex="0"
>
<svg width="16" height="16" viewBox="0 0 16 16" fill="none">
<path
d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z"
fill="var(--color-text)"
></path>
</svg>
Index
</h5>
</summary>
<div class="tsd-accordion-details">
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Properties</h3>
<div class="tsd-index-list">
<a
href="interfaces_cg_select_interface.ICgSelect.html#closeOnSelect"
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>close<wbr />On<wbr />Select?</span></a
>
<a
href="interfaces_cg_select_interface.ICgSelect.html#event"
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>event?</span></a
>
<a
href="interfaces_cg_select_interface.ICgSelect.html#items"
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>items?</span></a
>
<a
href="interfaces_cg_select_interface.ICgSelect.html#lable"
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>lable?</span></a
>
<a
href="interfaces_cg_select_interface.ICgSelect.html#language"
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>language?</span></a
>
<a
href="interfaces_cg_select_interface.ICgSelect.html#listDisplayMode"
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>list<wbr />Display<wbr />Mode?</span></a
>
<a
href="interfaces_cg_select_interface.ICgSelect.html#multiselect"
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>multiselect?</span></a
>
<a
href="interfaces_cg_select_interface.ICgSelect.html#multiselectTag"
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>multiselect<wbr />Tag?</span></a
>
<a
href="interfaces_cg_select_interface.ICgSelect.html#nativeSelectMode"
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>native<wbr />Select<wbr />Mode?</span></a
>
<a
href="interfaces_cg_select_interface.ICgSelect.html#placeholder"
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>placeholder?</span></a
>
<a
href="interfaces_cg_select_interface.ICgSelect.html#searchMode"
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>search<wbr />Mode?</span></a
>
<a
href="interfaces_cg_select_interface.ICgSelect.html#selected"
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>selected?</span></a
>
<a
href="interfaces_cg_select_interface.ICgSelect.html#selector"
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>selector?</span></a
>
<a
href="interfaces_cg_select_interface.ICgSelect.html#styles"
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>styles?</span></a
>
2023-01-31 15:28:00 +03:00
<a
href="interfaces_cg_select_interface.ICgSelect.html#theme"
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>theme?</span></a
>
2023-01-27 20:06:32 +03:00
<a
href="interfaces_cg_select_interface.ICgSelect.html#url"
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>url?</span></a
>
</div>
</section>
</div>
</details>
</section>
</section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a id="closeOnSelect" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link">
<code class="tsd-tag ts-flagOptional">Optional</code>
<span>close<wbr />On<wbr />Select</span
><a href="#closeOnSelect" 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"
>
<path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path>
<path
d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"
id="icon-anchor-b"
></path>
<path
d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"
id="icon-anchor-c"
></path></svg
></a>
</h3>
<div class="tsd-signature">
close<wbr />On<wbr />Select<span class="tsd-signature-symbol">?:</span>
<span class="tsd-signature-type">boolean</span>
</div>
<div class="tsd-comment tsd-typography">
<p>
An optional parameter that is responsible for the behavior of the select when
opening, if closeOnSelect: false, then when an element is selected in the selector,
closing does not occur, and you can select another element by default,
closeOnSelect:true.
</p>
</div>
<aside class="tsd-sources">
<ul>
<li>
Defined in
<a
2023-01-31 15:28:00 +03:00
href="https://github.com/apuc/cg-select/blob/31b10e2/src/interfaces/cg-select.interface.ts#L44"
2023-01-27 20:06:32 +03:00
>interfaces/cg-select.interface.ts:44</a
>
</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a id="event" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link">
<code class="tsd-tag ts-flagOptional">Optional</code> <span>event</span
><a href="#event" 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">
event<span class="tsd-signature-symbol">?:</span>
<span class="tsd-signature-type">string</span>
</div>
<div class="tsd-comment tsd-typography">
<p>
An optional parameter that is responsible for the behavior of the select, passing to
this parameter an event of the &#39;mouseenter&#39; type, select will open on hover.
</p>
</div>
<aside class="tsd-sources">
<ul>
<li>
Defined in
<a
2023-01-31 15:28:00 +03:00
href="https://github.com/apuc/cg-select/blob/31b10e2/src/interfaces/cg-select.interface.ts#L76"
2023-01-27 20:06:32 +03:00
>interfaces/cg-select.interface.ts:76</a
>
</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a id="items" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link">
<code class="tsd-tag ts-flagOptional">Optional</code> <span>items</span
><a href="#items" 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">
items<span class="tsd-signature-symbol">?:</span>
<span class="tsd-signature-type">any</span>
</div>
<div class="tsd-comment tsd-typography">
<p>
*Required parameter (if no other way to get data (url) is specified), this is an
array of elements, which will be displayed in the select when selected.
</p>
</div>
<aside class="tsd-sources">
<ul>
<li>
Defined in
<a
2023-01-31 15:28:00 +03:00
href="https://github.com/apuc/cg-select/blob/31b10e2/src/interfaces/cg-select.interface.ts#L27"
2023-01-27 20:06:32 +03:00
>interfaces/cg-select.interface.ts:27</a
>
</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a id="lable" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link">
<code class="tsd-tag ts-flagOptional">Optional</code> <span>lable</span
><a href="#lable" 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">
lable<span class="tsd-signature-symbol">?:</span>
<span class="tsd-signature-type">string</span>
</div>
<div class="tsd-comment tsd-typography">
<p>An optional parameter that adds a lable before the select.</p>
</div>
<aside class="tsd-sources">
<ul>
<li>
Defined in
<a
2023-01-31 15:28:00 +03:00
href="https://github.com/apuc/cg-select/blob/31b10e2/src/interfaces/cg-select.interface.ts#L64"
2023-01-27 20:06:32 +03:00
>interfaces/cg-select.interface.ts:64</a
>
</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a id="language" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link">
<code class="tsd-tag ts-flagOptional">Optional</code> <span>language</span
><a href="#language" 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">
language<span class="tsd-signature-symbol">?:</span>
<span class="tsd-signature-type">string</span>
</div>
<div class="tsd-comment tsd-typography">
<p>Optional parameter responsible for the localization of some text elements.</p>
</div>
<aside class="tsd-sources">
<ul>
<li>
Defined in
<a
2023-01-31 15:28:00 +03:00
href="https://github.com/apuc/cg-select/blob/31b10e2/src/interfaces/cg-select.interface.ts#L59"
2023-01-27 20:06:32 +03:00
>interfaces/cg-select.interface.ts:59</a
>
</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a id="listDisplayMode" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link">
<code class="tsd-tag ts-flagOptional">Optional</code>
<span>list<wbr />Display<wbr />Mode</span
><a href="#listDisplayMode" 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">
list<wbr />Display<wbr />Mode<span class="tsd-signature-symbol">?:</span>
<span class="tsd-signature-type">boolean</span>
</div>
<div class="tsd-comment tsd-typography">
<p>
An optional parameter that is responsible for the behavior of the select when
opening.
</p>
</div>
<aside class="tsd-sources">
<ul>
<li>
Defined in
<a
2023-01-31 15:28:00 +03:00
href="https://github.com/apuc/cg-select/blob/31b10e2/src/interfaces/cg-select.interface.ts#L54"
2023-01-27 20:06:32 +03:00
>interfaces/cg-select.interface.ts:54</a
>
</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a id="multiselect" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link">
<code class="tsd-tag ts-flagOptional">Optional</code> <span>multiselect</span
><a href="#multiselect" 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">
multiselect<span class="tsd-signature-symbol">?:</span>
<span class="tsd-signature-type">boolean</span>
</div>
<div class="tsd-comment tsd-typography">
<p>
An optional parameter, which is responsible for the behavior of the select, adds the
ability to select multiple elements. Selected elements are rendered as plain text,
separated by commas.
</p>
</div>
<aside class="tsd-sources">
<ul>
<li>
Defined in
<a
2023-01-31 15:28:00 +03:00
href="https://github.com/apuc/cg-select/blob/31b10e2/src/interfaces/cg-select.interface.ts#L88"
2023-01-27 20:06:32 +03:00
>interfaces/cg-select.interface.ts:88</a
>
</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a id="multiselectTag" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link">
<code class="tsd-tag ts-flagOptional">Optional</code>
<span>multiselect<wbr />Tag</span
><a href="#multiselectTag" 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">
multiselect<wbr />Tag<span class="tsd-signature-symbol">?:</span>
<span class="tsd-signature-type">boolean</span>
</div>
<div class="tsd-comment tsd-typography">
<p>
An optional parameter that is responsible for the behavior of the select, for him,
*** works only in a place with a multiselect connection.
</p>
</div>
<aside class="tsd-sources">
<ul>
<li>
Defined in
<a
2023-01-31 15:28:00 +03:00
href="https://github.com/apuc/cg-select/blob/31b10e2/src/interfaces/cg-select.interface.ts#L94"
2023-01-27 20:06:32 +03:00
>interfaces/cg-select.interface.ts:94</a
>
</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a id="nativeSelectMode" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link">
<code class="tsd-tag ts-flagOptional">Optional</code>
<span>native<wbr />Select<wbr />Mode</span
><a href="#nativeSelectMode" 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">
native<wbr />Select<wbr />Mode<span class="tsd-signature-symbol">?:</span>
<span class="tsd-signature-type">boolean</span>
</div>
<div class="tsd-comment tsd-typography">
<p>
An optional parameter that is responsible for the behavior of the select when opened
on mobile devices.
</p>
</div>
<aside class="tsd-sources">
<ul>
<li>
Defined in
<a
2023-01-31 15:28:00 +03:00
href="https://github.com/apuc/cg-select/blob/31b10e2/src/interfaces/cg-select.interface.ts#L49"
2023-01-27 20:06:32 +03:00
>interfaces/cg-select.interface.ts:49</a
>
</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a id="placeholder" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link">
<code class="tsd-tag ts-flagOptional">Optional</code> <span>placeholder</span
><a href="#placeholder" 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">
placeholder<span class="tsd-signature-symbol">?:</span>
<span class="tsd-signature-type">string</span>
</div>
<div class="tsd-comment tsd-typography">
<p>
Placeholder optional parameter to which the text of the select placeholder is
passed.
</p>
</div>
<aside class="tsd-sources">
<ul>
<li>
Defined in
<a
2023-01-31 15:28:00 +03:00
href="https://github.com/apuc/cg-select/blob/31b10e2/src/interfaces/cg-select.interface.ts#L21"
2023-01-27 20:06:32 +03:00
>interfaces/cg-select.interface.ts:21</a
>
</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a id="searchMode" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link">
<code class="tsd-tag ts-flagOptional">Optional</code> <span>search<wbr />Mode</span
><a href="#searchMode" 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">
search<wbr />Mode<span class="tsd-signature-symbol">?:</span>
<span class="tsd-signature-type">boolean</span>
</div>
<div class="tsd-comment tsd-typography">
<p>An optional parameter that adds a live search on the select elements.</p>
</div>
<aside class="tsd-sources">
<ul>
<li>
Defined in
<a
2023-01-31 15:28:00 +03:00
href="https://github.com/apuc/cg-select/blob/31b10e2/src/interfaces/cg-select.interface.ts#L37"
2023-01-27 20:06:32 +03:00
>interfaces/cg-select.interface.ts:37</a
>
</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a id="selected" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link">
<code class="tsd-tag ts-flagOptional">Optional</code> <span>selected</span
><a href="#selected" 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">
selected<span class="tsd-signature-symbol">?:</span>
<span class="tsd-signature-type">string</span>
</div>
<div class="tsd-comment tsd-typography">
<p>
An optional parameter, which is passed the element that will be selected initially
in the select.
</p>
</div>
<aside class="tsd-sources">
<ul>
<li>
Defined in
<a
2023-01-31 15:28:00 +03:00
href="https://github.com/apuc/cg-select/blob/31b10e2/src/interfaces/cg-select.interface.ts#L16"
2023-01-27 20:06:32 +03:00
>interfaces/cg-select.interface.ts:16</a
>
</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a id="selector" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link">
<code class="tsd-tag ts-flagOptional">Optional</code> <span>selector</span
><a href="#selector" 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">
selector<span class="tsd-signature-symbol">?:</span>
<span class="tsd-signature-type">string</span>
</div>
<div class="tsd-comment tsd-typography">
<p>
Unique selector - *mandatory parameter (indicator) that is set when creating a
select.
</p>
</div>
<aside class="tsd-sources">
<ul>
<li>
Defined in
<a
2023-01-31 15:28:00 +03:00
href="https://github.com/apuc/cg-select/blob/31b10e2/src/interfaces/cg-select.interface.ts#L11"
2023-01-27 20:06:32 +03:00
>interfaces/cg-select.interface.ts:11</a
>
</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a id="styles" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link">
<code class="tsd-tag ts-flagOptional">Optional</code> <span>styles</span
><a href="#styles" 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">
styles<span class="tsd-signature-symbol">?:</span>
<a
href="interfaces_cg_select_interface.IStyle.html"
class="tsd-signature-type"
data-tsd-kind="Interface"
>IStyle</a
>
</div>
<div class="tsd-comment tsd-typography">
<p>
An optional parameter that is responsible for customizing the select elements,
objects with CSS properties for customizable elements are passed to it.
</p>
</div>
<aside class="tsd-sources">
<ul>
<li>
Defined in
<a
2023-01-31 15:28:00 +03:00
href="https://github.com/apuc/cg-select/blob/31b10e2/src/interfaces/cg-select.interface.ts#L70"
2023-01-27 20:06:32 +03:00
>interfaces/cg-select.interface.ts:70</a
>
</li>
</ul>
</aside>
</section>
2023-01-31 15:28:00 +03:00
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a id="theme" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link">
<code class="tsd-tag ts-flagOptional">Optional</code> <span>theme</span
><a href="#theme" 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">
theme<span class="tsd-signature-symbol">?:</span>
<span class="tsd-signature-type">string</span>
</div>
<div class="tsd-comment tsd-typography">
<p>
An optional parameter responsible for switching between different themes, the
classic theme is set by default.
</p>
</div>
<aside class="tsd-sources">
<ul>
<li>
Defined in
<a
href="https://github.com/apuc/cg-select/blob/31b10e2/src/interfaces/cg-select.interface.ts#L32"
>interfaces/cg-select.interface.ts:32</a
>
</li>
</ul>
</aside>
</section>
2023-01-27 20:06:32 +03:00
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a id="url" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link">
<code class="tsd-tag ts-flagOptional">Optional</code> <span>url</span
><a href="#url" 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">
url<span class="tsd-signature-symbol">?:</span>
<span class="tsd-signature-type">string</span>
</div>
<div class="tsd-comment tsd-typography">
<p>
Required parameter (if no other way to get data (items) is specified), data that
comes from the backend in the format { id: &quot;&quot;, title: &quot;&quot;, value:
&quot;&quot;}.
</p>
</div>
<aside class="tsd-sources">
<ul>
<li>
Defined in
<a
2023-01-31 15:28:00 +03:00
href="https://github.com/apuc/cg-select/blob/31b10e2/src/interfaces/cg-select.interface.ts#L82"
2023-01-27 20:06:32 +03:00
>interfaces/cg-select.interface.ts:82</a
>
</li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion">
<summary class="tsd-accordion-summary">
<h3>
<svg width="20" height="20" viewBox="0 0 24 24" fill="none">
<path
d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z"
fill="var(--color-text)"
></path>
</svg>
Settings
</h3>
</summary>
<div class="tsd-accordion-details">
<div class="tsd-filter-visibility">
<h4 class="uppercase">Member Visibility</h4>
<form>
<ul id="tsd-filter-options">
<li class="tsd-filter-item">
<label class="tsd-filter-input"
><input type="checkbox" id="tsd-filter-protected" name="protected" /><svg
width="32"
height="32"
viewBox="0 0 32 32"
aria-hidden="true"
>
<rect
class="tsd-checkbox-background"
width="30"
height="30"
x="1"
y="1"
rx="6"
fill="none"
></rect>
<path
class="tsd-checkbox-checkmark"
d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
stroke="none"
stroke-width="3.5"
stroke-linejoin="round"
fill="none"
></path></svg
><span>Protected</span></label
>
</li>
<li class="tsd-filter-item">
<label class="tsd-filter-input"
><input type="checkbox" id="tsd-filter-private" name="private" /><svg
width="32"
height="32"
viewBox="0 0 32 32"
aria-hidden="true"
>
<rect
class="tsd-checkbox-background"
width="30"
height="30"
x="1"
y="1"
rx="6"
fill="none"
></rect>
<path
class="tsd-checkbox-checkmark"
d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
stroke="none"
stroke-width="3.5"
stroke-linejoin="round"
fill="none"
></path></svg
><span>Private</span></label
>
</li>
<li class="tsd-filter-item">
<label class="tsd-filter-input"
><input
type="checkbox"
id="tsd-filter-inherited"
name="inherited"
checked
/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true">
<rect
class="tsd-checkbox-background"
width="30"
height="30"
x="1"
y="1"
rx="6"
fill="none"
></rect>
<path
class="tsd-checkbox-checkmark"
d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
stroke="none"
stroke-width="3.5"
stroke-linejoin="round"
fill="none"
></path></svg
><span>Inherited</span></label
>
</li>
<li class="tsd-filter-item">
<label class="tsd-filter-input"
><input type="checkbox" id="tsd-filter-external" name="external" /><svg
width="32"
height="32"
viewBox="0 0 32 32"
aria-hidden="true"
>
<rect
class="tsd-checkbox-background"
width="30"
height="30"
x="1"
y="1"
rx="6"
fill="none"
></rect>
<path
class="tsd-checkbox-checkmark"
d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
stroke="none"
stroke-width="3.5"
stroke-linejoin="round"
fill="none"
></path></svg
><span>External</span></label
>
</li>
</ul>
</form>
</div>
<div class="tsd-theme-toggle">
<h4 class="uppercase">Theme</h4>
<select id="theme">
<option value="os">OS</option>
<option value="light">Light</option>
<option value="dark">Dark</option>
</select>
</div>
</div>
</details>
</div>
<nav class="tsd-navigation primary">
<details class="tsd-index-accordion" open>
<summary class="tsd-accordion-summary">
<h3>
<svg width="20" height="20" viewBox="0 0 24 24" fill="none">
<path
d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z"
fill="var(--color-text)"
></path>
</svg>
Modules
</h3>
</summary>
<div class="tsd-accordion-details">
<ul>
<li class="current">
<a href="../modules.html">cg-<wbr />select</a>
<ul>
<li class="tsd-kind-module"><a href="../modules/Utils.html">Utils</a></li>
<li class="tsd-kind-module">
<a href="../modules/cg_select.html">cg-<wbr />select</a>
</li>
<li class="tsd-kind-module">
<a href="../modules/components_create_element_create_element.html"
>components/create-<wbr />element/create-<wbr />element</a
>
</li>
<li class="tsd-kind-module">
<a href="../modules/components_create_element_create_element_interface.html"
>components/create-<wbr />element/create-<wbr />element.interface</a
>
</li>
2023-01-31 15:28:00 +03:00
<li class="tsd-kind-module">
<a href="../modules/components_theme_theme.html">components/theme/theme</a>
</li>
2023-01-27 20:06:32 +03:00
<li class="tsd-kind-module">
<a href="../modules/components_utils_urils_interface.html"
>components/utils/urils.interface</a
>
</li>
<li class="current tsd-kind-module">
<a href="../modules/interfaces_cg_select_interface.html"
>interfaces/cg-<wbr />select.interface</a
>
</li>
<li class="tsd-kind-module">
<a href="../modules/interfaces_items_interface.html"
>interfaces/items.interface</a
>
</li>
<li class="tsd-kind-module">
<a href="../modules/interfaces_language_interface.html"
>interfaces/language.interface</a
>
</li>
<li class="tsd-kind-module">
<a href="../modules/language_language.html">language/language</a>
</li>
</ul>
</li>
</ul>
</div>
</details>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul>
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="interfaces_cg_select_interface.ICgSelect.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>ICg<wbr />Select</span></a
>
<ul>
<li class="tsd-kind-property tsd-parent-kind-interface">
<a
href="interfaces_cg_select_interface.ICgSelect.html#closeOnSelect"
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
>close<wbr />On<wbr />Select?</a
>
</li>
<li class="tsd-kind-property tsd-parent-kind-interface">
<a
href="interfaces_cg_select_interface.ICgSelect.html#event"
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
>event?</a
>
</li>
<li class="tsd-kind-property tsd-parent-kind-interface">
<a
href="interfaces_cg_select_interface.ICgSelect.html#items"
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
>items?</a
>
</li>
<li class="tsd-kind-property tsd-parent-kind-interface">
<a
href="interfaces_cg_select_interface.ICgSelect.html#lable"
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
>lable?</a
>
</li>
<li class="tsd-kind-property tsd-parent-kind-interface">
<a
href="interfaces_cg_select_interface.ICgSelect.html#language"
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
>language?</a
>
</li>
<li class="tsd-kind-property tsd-parent-kind-interface">
<a
href="interfaces_cg_select_interface.ICgSelect.html#listDisplayMode"
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
>list<wbr />Display<wbr />Mode?</a
>
</li>
<li class="tsd-kind-property tsd-parent-kind-interface">
<a
href="interfaces_cg_select_interface.ICgSelect.html#multiselect"
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
>multiselect?</a
>
</li>
<li class="tsd-kind-property tsd-parent-kind-interface">
<a
href="interfaces_cg_select_interface.ICgSelect.html#multiselectTag"
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
>multiselect<wbr />Tag?</a
>
</li>
<li class="tsd-kind-property tsd-parent-kind-interface">
<a
href="interfaces_cg_select_interface.ICgSelect.html#nativeSelectMode"
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
>native<wbr />Select<wbr />Mode?</a
>
</li>
<li class="tsd-kind-property tsd-parent-kind-interface">
<a
href="interfaces_cg_select_interface.ICgSelect.html#placeholder"
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
>placeholder?</a
>
</li>
<li class="tsd-kind-property tsd-parent-kind-interface">
<a
href="interfaces_cg_select_interface.ICgSelect.html#searchMode"
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
>search<wbr />Mode?</a
>
</li>
<li class="tsd-kind-property tsd-parent-kind-interface">
<a
href="interfaces_cg_select_interface.ICgSelect.html#selected"
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
>selected?</a
>
</li>
<li class="tsd-kind-property tsd-parent-kind-interface">
<a
href="interfaces_cg_select_interface.ICgSelect.html#selector"
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
>selector?</a
>
</li>
<li class="tsd-kind-property tsd-parent-kind-interface">
<a
href="interfaces_cg_select_interface.ICgSelect.html#styles"
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
>styles?</a
>
</li>
2023-01-31 15:28:00 +03:00
<li class="tsd-kind-property tsd-parent-kind-interface">
<a
href="interfaces_cg_select_interface.ICgSelect.html#theme"
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
>theme?</a
>
</li>
2023-01-27 20:06:32 +03:00
<li class="tsd-kind-property tsd-parent-kind-interface">
<a href="interfaces_cg_select_interface.ICgSelect.html#url" 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
>url?</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>
<div class="overlay"></div>
<script src="../assets/main.js"></script>
</body>
</html>