igniteui-grid-lite 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +234 -9
- package/components/grid.d.ts +1 -1
- package/components/grid.js +4 -3
- package/components/grid.js.map +1 -1
- package/components/header.d.ts +1 -0
- package/components/header.js +6 -0
- package/components/header.js.map +1 -1
- package/docs/assets/highlight.css +27 -13
- package/docs/assets/main.js +2 -2
- package/docs/classes/IgcGridLite.html +20 -20
- package/docs/hierarchy.html +1 -1
- package/docs/index.html +193 -11
- package/docs/interfaces/BaseColumnConfiguration.html +11 -11
- package/docs/interfaces/BaseColumnSortConfiguration.html +4 -4
- package/docs/interfaces/BaseFilterExpression.html +6 -6
- package/docs/interfaces/BaseIgcCellContext.html +6 -6
- package/docs/interfaces/BaseSortExpression.html +4 -4
- package/docs/interfaces/ColumnFilterConfiguration.html +3 -3
- package/docs/interfaces/DataPipelineConfiguration.html +4 -4
- package/docs/interfaces/GridSortConfiguration.html +4 -4
- package/docs/interfaces/IgcFilteredEvent.html +4 -4
- package/docs/interfaces/IgcFilteringEvent.html +5 -5
- package/docs/interfaces/IgcGridLiteEventMap.html +5 -5
- package/docs/interfaces/IgcHeaderContext.html +4 -4
- package/docs/media/LICENSE +9 -0
- package/docs/modules.html +1 -1
- package/docs/types/BasePropertyType.html +2 -2
- package/docs/types/BaseSortComparer.html +2 -2
- package/docs/types/ColumnConfiguration.html +2 -2
- package/docs/types/ColumnSortConfiguration.html +2 -2
- package/docs/types/DataPipelineHook.html +2 -2
- package/docs/types/DataPipelineParams.html +5 -5
- package/docs/types/DataType.html +2 -2
- package/docs/types/FilterCriteria.html +2 -2
- package/docs/types/FilterExpression.html +2 -2
- package/docs/types/IgcCellContext.html +2 -2
- package/docs/types/Keys.html +2 -2
- package/docs/types/PropertyType.html +2 -2
- package/docs/types/SortComparer.html +2 -2
- package/docs/types/SortExpression.html +2 -2
- package/docs/types/SortState.html +2 -2
- package/docs/types/SortingDirection.html +2 -2
- package/internal/theming.js +5 -7
- package/internal/theming.js.map +1 -1
- package/operations/filter/tree.d.ts +1 -1
- package/package.json +2 -2
- package/styles/_common.css.js +1 -1
- package/styles/_common.css.js.map +1 -1
- package/styles/body-cell/body-cell.css.js +1 -1
- package/styles/body-cell/body-cell.css.js.map +1 -1
- package/styles/body-row/body-row.css.js +1 -1
- package/styles/body-row/body-row.css.js.map +1 -1
- package/styles/filter-row/filter-row.css.js +1 -1
- package/styles/filter-row/filter-row.css.js.map +1 -1
- package/styles/header-cell/header-cell.css.js +1 -1
- package/styles/header-cell/header-cell.css.js.map +1 -1
- package/styles/header-row/header-row.base.css.js +1 -1
- package/styles/header-row/header-row.base.css.js.map +1 -1
- package/styles/themes/dark/_themes.css.js +3 -0
- package/styles/themes/dark/_themes.css.js.map +1 -0
- package/styles/themes/dark/grid.bootstrap.css.js +3 -0
- package/styles/themes/dark/grid.bootstrap.css.js.map +1 -0
- package/styles/themes/dark/grid.fluent.css.js +3 -0
- package/styles/themes/dark/grid.fluent.css.js.map +1 -0
- package/styles/themes/dark/grid.indigo.css.js +3 -0
- package/styles/themes/dark/grid.indigo.css.js.map +1 -0
- package/styles/themes/dark/grid.material.css.js +3 -0
- package/styles/themes/dark/grid.material.css.js.map +1 -0
- package/styles/themes/grid-header-themes.d.ts +2 -0
- package/styles/themes/grid-header-themes.js +21 -0
- package/styles/themes/grid-header-themes.js.map +1 -0
- package/styles/themes/grid-themes.d.ts +2 -0
- package/styles/{grid/themes/themes.js → themes/grid-themes.js} +17 -9
- package/styles/themes/grid-themes.js.map +1 -0
- package/styles/themes/grid.base.css.js +3 -0
- package/styles/themes/grid.base.css.js.map +1 -0
- package/styles/themes/light/_themes.css.js +3 -0
- package/styles/themes/light/_themes.css.js.map +1 -0
- package/styles/themes/light/grid.bootstrap.css.js +3 -0
- package/styles/themes/light/grid.bootstrap.css.js.map +1 -0
- package/styles/themes/light/grid.fluent.css.js +3 -0
- package/styles/themes/light/grid.fluent.css.js.map +1 -0
- package/styles/themes/light/grid.indigo.css.d.ts +1 -0
- package/styles/themes/light/grid.indigo.css.js +3 -0
- package/styles/themes/light/grid.indigo.css.js.map +1 -0
- package/styles/themes/light/grid.material.css.d.ts +1 -0
- package/styles/themes/light/grid.material.css.js +3 -0
- package/styles/themes/light/grid.material.css.js.map +1 -0
- package/styles/themes/light/grid.shared.css.d.ts +1 -0
- package/styles/themes/light/grid.shared.css.js +3 -0
- package/styles/themes/light/grid.shared.css.js.map +1 -0
- package/styles/themes/shared/grid.common.css.d.ts +1 -0
- package/styles/themes/shared/grid.common.css.js +3 -0
- package/styles/themes/shared/grid.common.css.js.map +1 -0
- package/styles/themes/shared/header.bootstrap.css.d.ts +1 -0
- package/styles/themes/shared/header.bootstrap.css.js +3 -0
- package/styles/themes/shared/header.bootstrap.css.js.map +1 -0
- package/styles/themes/shared/header.fluent.css.d.ts +1 -0
- package/styles/themes/shared/header.fluent.css.js +3 -0
- package/styles/themes/shared/header.fluent.css.js.map +1 -0
- package/styles/grid/themes/dark/grid.bootstrap.css.js +0 -3
- package/styles/grid/themes/dark/grid.bootstrap.css.js.map +0 -1
- package/styles/grid/themes/dark/grid.fluent.css.js +0 -3
- package/styles/grid/themes/dark/grid.fluent.css.js.map +0 -1
- package/styles/grid/themes/dark/grid.indigo.css.js +0 -3
- package/styles/grid/themes/dark/grid.indigo.css.js.map +0 -1
- package/styles/grid/themes/dark/grid.material.css.js +0 -3
- package/styles/grid/themes/dark/grid.material.css.js.map +0 -1
- package/styles/grid/themes/grid.base.css.js +0 -3
- package/styles/grid/themes/grid.base.css.js.map +0 -1
- package/styles/grid/themes/light/grid.bootstrap.css.js +0 -3
- package/styles/grid/themes/light/grid.bootstrap.css.js.map +0 -1
- package/styles/grid/themes/light/grid.fluent.css.js +0 -3
- package/styles/grid/themes/light/grid.fluent.css.js.map +0 -1
- package/styles/grid/themes/light/grid.indigo.css.js +0 -3
- package/styles/grid/themes/light/grid.indigo.css.js.map +0 -1
- package/styles/grid/themes/light/grid.material.css.js +0 -3
- package/styles/grid/themes/light/grid.material.css.js.map +0 -1
- package/styles/grid/themes/themes.d.ts +0 -2
- package/styles/grid/themes/themes.js.map +0 -1
- /package/styles/{grid/themes/dark/grid.bootstrap.css.d.ts → themes/dark/_themes.css.d.ts} +0 -0
- /package/styles/{grid/themes/light → themes/dark}/grid.bootstrap.css.d.ts +0 -0
- /package/styles/{grid/themes → themes}/dark/grid.fluent.css.d.ts +0 -0
- /package/styles/{grid/themes → themes}/dark/grid.indigo.css.d.ts +0 -0
- /package/styles/{grid/themes → themes}/dark/grid.material.css.d.ts +0 -0
- /package/styles/{grid/themes → themes}/grid.base.css.d.ts +0 -0
- /package/styles/{grid/themes/light/grid.fluent.css.d.ts → themes/light/_themes.css.d.ts} +0 -0
- /package/styles/{grid/themes/light/grid.indigo.css.d.ts → themes/light/grid.bootstrap.css.d.ts} +0 -0
- /package/styles/{grid/themes/light/grid.material.css.d.ts → themes/light/grid.fluent.css.d.ts} +0 -0
package/docs/hierarchy.html
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>igniteui-grid-lite</title><meta name="description" content="Documentation for igniteui-grid-lite"/><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 defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">igniteui-grid-lite</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>igniteui-grid-lite</h1></div><h2>Hierarchy Summary</h2></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><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></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">igniteui-grid-lite</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>igniteui-grid-lite-workspace</title><meta name="description" content="Documentation for igniteui-grid-lite-workspace"/><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 defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">igniteui-grid-lite-workspace</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>igniteui-grid-lite-workspace</h1></div><h2>Hierarchy Summary</h2></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><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></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">igniteui-grid-lite-workspace</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
package/docs/index.html
CHANGED
|
@@ -1,11 +1,193 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>igniteui-grid-lite</title><meta name="description" content="Documentation for igniteui-grid-lite"/><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 defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">igniteui-grid-lite</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>igniteui-grid-lite</h1></div><div class="tsd-panel tsd-typography"><h1 id="ignite-ui-grid-lite" class="tsd-anchor-link">Ignite UI Grid Lite<a href="#ignite-ui-grid-lite" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p><a href="https://github.com/IgniteUI/igniteui-grid-lite/actions/workflows/node.js.yml"><img src="https://github.com/IgniteUI/igniteui-grid-lite/actions/workflows/node.js.yml/badge.svg" alt="Node.js CI"></a>
|
|
2
|
-
<a href="https://coveralls.io/github/IgniteUI/igniteui-grid-lite?branch=master"><img src="https://coveralls.io/repos/github/IgniteUI/igniteui-grid-lite/badge.svg?branch=master" alt="Coverage Status"></a
|
|
3
|
-
<
|
|
4
|
-
<
|
|
5
|
-
<
|
|
6
|
-
<li
|
|
7
|
-
<li
|
|
8
|
-
<li>
|
|
9
|
-
</
|
|
10
|
-
<
|
|
11
|
-
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>igniteui-grid-lite-workspace</title><meta name="description" content="Documentation for igniteui-grid-lite-workspace"/><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 defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">igniteui-grid-lite-workspace</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>igniteui-grid-lite-workspace</h1></div><div class="tsd-panel tsd-typography"><h1 id="ignite-ui-grid-lite-for-web-components" class="tsd-anchor-link">Ignite UI Grid Lite for Web Components<a href="#ignite-ui-grid-lite-for-web-components" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p><a href="https://github.com/IgniteUI/igniteui-grid-lite/actions/workflows/node.js.yml"><img src="https://github.com/IgniteUI/igniteui-grid-lite/actions/workflows/node.js.yml/badge.svg" alt="Node.js CI"></a>
|
|
2
|
+
<a href="https://coveralls.io/github/IgniteUI/igniteui-grid-lite?branch=master"><img src="https://coveralls.io/repos/github/IgniteUI/igniteui-grid-lite/badge.svg?branch=master" alt="Coverage Status"></a>
|
|
3
|
+
<a href="https://badge.fury.io/js/igniteui-grid-lite"><img src="https://badge.fury.io/js/igniteui-grid-lite.svg" alt="npm version"></a></p>
|
|
4
|
+
<p>Ignite UI Grid Lite for Web Components is a high-performance, lightweight data grid built as a web component using <a href="https://lit.dev/">Lit</a>. It provides essential grid functionality with a small footprint, making it perfect for applications that need fast, efficient data visualization without the overhead of a full-featured grid.</p>
|
|
5
|
+
<h2 id="table-of-contents" class="tsd-anchor-link">Table of Contents<a href="#table-of-contents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
|
|
6
|
+
<li><a href="#features">Features</a></li>
|
|
7
|
+
<li><a href="#browser-support">Browser Support</a></li>
|
|
8
|
+
<li><a href="#getting-started">Getting Started</a></li>
|
|
9
|
+
<li><a href="#usage">Usage</a></li>
|
|
10
|
+
<li><a href="#building-the-library">Building the Library</a></li>
|
|
11
|
+
<li><a href="#running-tests">Running Tests</a></li>
|
|
12
|
+
<li><a href="#documentation">Documentation</a></li>
|
|
13
|
+
<li><a href="https://www.infragistics.com/products/ignite-ui-web-components/web-components/components/general-open-source-vs-premium">Ignite UI Open-Source vs. Premium for Web Comonents</a></li>
|
|
14
|
+
<li><a href="#contributing">Contributing</a></li>
|
|
15
|
+
<li><a href="#support">Support</a></li>
|
|
16
|
+
<li><a href="#license">License</a></li>
|
|
17
|
+
</ul>
|
|
18
|
+
<h2 id="features" class="tsd-anchor-link">Features<a href="#features" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Ignite UI Grid Lite for Web Components provides core data grid capabilities with an emphasis on performance and simplicity:</p>
|
|
19
|
+
<ul>
|
|
20
|
+
<li><strong>High Performance Row Virtualization</strong> - Handles large datasets efficiently with built-in virtual scrolling</li>
|
|
21
|
+
<li><strong>Column Filtering</strong> - Built-in column filtering capabilities</li>
|
|
22
|
+
<li><strong>Sorting</strong> - Column sorting support for better data organization</li>
|
|
23
|
+
<li><strong>Lightweight</strong> - Minimal bundle size for fast load times</li>
|
|
24
|
+
<li><strong>Web Standards</strong> - Built with web components for framework-agnostic usage</li>
|
|
25
|
+
<li><strong>Modern Architecture</strong> - Built with Lit and TypeScript for maintainability</li>
|
|
26
|
+
<li><strong>Customizable</strong> - Flexible theming and styling options</li>
|
|
27
|
+
<li><strong>Cell Templating</strong> - Custom cell rendering for flexible data display</li>
|
|
28
|
+
<li><strong>Header Templating</strong> - Custom header rendering for enhanced grid headers</li>
|
|
29
|
+
<li><strong>Accessible</strong> - Designed with accessibility in mind</li>
|
|
30
|
+
</ul>
|
|
31
|
+
<h2 id="browser-support" class="tsd-anchor-link">Browser Support<a href="#browser-support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Ignite UI Grid Lite for Web Components supports all modern browsers:</p>
|
|
32
|
+
<table>
|
|
33
|
+
<thead>
|
|
34
|
+
<tr>
|
|
35
|
+
<th style="text-align:center"><img src="https://user-images.githubusercontent.com/2188411/168109445-fbd7b217-35f9-44d1-8002-1eb97e39cdc6.png" alt="chrome" title="Google Chrome"></th>
|
|
36
|
+
<th style="text-align:center"><img src="https://user-images.githubusercontent.com/2188411/168109465-e46305ee-f69f-4fa5-8f4a-14876f7fd3ca.png" alt="firefox" title="Mozilla Firefox"></th>
|
|
37
|
+
<th style="text-align:center"><img src="https://user-images.githubusercontent.com/2188411/168109472-a730f8c0-3822-4ae6-9f54-785a66695245.png" alt="edge" title="Microsoft Edge"></th>
|
|
38
|
+
<th style="text-align:center"><img src="https://user-images.githubusercontent.com/2188411/168109527-6c58f2cf-7386-4b97-98b1-cfe0ab4e8626.png" alt="safari" title="Safari"></th>
|
|
39
|
+
<th style="text-align:center"><img src="https://user-images.githubusercontent.com/2188411/168109520-b6865a6c-b69f-44a4-9948-748d8afd687c.png" alt="opera" title="Opera"></th>
|
|
40
|
+
</tr>
|
|
41
|
+
</thead>
|
|
42
|
+
<tbody>
|
|
43
|
+
<tr>
|
|
44
|
+
<td style="text-align:center">Latest ✔</td>
|
|
45
|
+
<td style="text-align:center">Latest ✔</td>
|
|
46
|
+
<td style="text-align:center">Latest ✔</td>
|
|
47
|
+
<td style="text-align:center">Latest ✔</td>
|
|
48
|
+
<td style="text-align:center">Latest ✔</td>
|
|
49
|
+
</tr>
|
|
50
|
+
</tbody>
|
|
51
|
+
</table>
|
|
52
|
+
<h2 id="getting-started" class="tsd-anchor-link">Getting Started<a href="#getting-started" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><h3 id="installation" class="tsd-anchor-link">Installation<a href="#installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Install via npm:</p>
|
|
53
|
+
<pre><code class="bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-2">igniteui-grid-lite</span>
|
|
54
|
+
</code><button type="button">Copy</button></pre>
|
|
55
|
+
|
|
56
|
+
<h3 id="quick-start" class="tsd-anchor-link">Quick Start<a href="#quick-start" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ol>
|
|
57
|
+
<li>Import the grid component in your JavaScript/TypeScript file:</li>
|
|
58
|
+
</ol>
|
|
59
|
+
<pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> </span><span class="hl-2">'igniteui-grid-lite'</span><span class="hl-1">;</span>
|
|
60
|
+
</code><button type="button">Copy</button></pre>
|
|
61
|
+
|
|
62
|
+
<ol start="2">
|
|
63
|
+
<li>Use the grid in your HTML:</li>
|
|
64
|
+
</ol>
|
|
65
|
+
<pre><code class="html"><span class="hl-4"><</span><span class="hl-5">igc-grid-lite</span><span class="hl-4">></span><br/><span class="hl-1"> </span><span class="hl-6"><!-- Grid configuration here --></span><br/><span class="hl-4"></</span><span class="hl-5">igc-grid-lite</span><span class="hl-4">></span>
|
|
66
|
+
</code><button type="button">Copy</button></pre>
|
|
67
|
+
|
|
68
|
+
<ol start="3">
|
|
69
|
+
<li>For a complete example, check out the <a href="media/demo">demo application</a>.</li>
|
|
70
|
+
</ol>
|
|
71
|
+
<h2 id="usage" class="tsd-anchor-link">Usage<a href="#usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>For detailed usage instructions and API documentation, visit:</p>
|
|
72
|
+
<ul>
|
|
73
|
+
<li><a href="https://www.infragistics.com/products/ignite-ui-web-components/web-components/components/grid-lite/overview">Grid Lite Overview</a></li>
|
|
74
|
+
<li><a href="https://igniteui.github.io/igniteui-grid-lite/">API Documentation</a></li>
|
|
75
|
+
</ul>
|
|
76
|
+
<h2 id="building-the-library" class="tsd-anchor-link">Building the Library<a href="#building-the-library" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><h3 id="setup" class="tsd-anchor-link">Setup<a href="#setup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Clone the repository and install dependencies:</p>
|
|
77
|
+
<pre><code class="bash"><span class="hl-0">git</span><span class="hl-1"> </span><span class="hl-2">clone</span><span class="hl-1"> </span><span class="hl-2">https://github.com/IgniteUI/igniteui-grid-lite.git</span><br/><span class="hl-0">cd</span><span class="hl-1"> </span><span class="hl-2">igniteui-grid-lite</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span>
|
|
78
|
+
</code><button type="button">Copy</button></pre>
|
|
79
|
+
|
|
80
|
+
<h3 id="build" class="tsd-anchor-link">Build<a href="#build" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>To build the library:</p>
|
|
81
|
+
<pre><code class="bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">build</span>
|
|
82
|
+
</code><button type="button">Copy</button></pre>
|
|
83
|
+
|
|
84
|
+
<p>This will:</p>
|
|
85
|
+
<ul>
|
|
86
|
+
<li>Analyze custom elements</li>
|
|
87
|
+
<li>Build the TypeScript source</li>
|
|
88
|
+
<li>Generate API documentation</li>
|
|
89
|
+
</ul>
|
|
90
|
+
<h3 id="development" class="tsd-anchor-link">Development<a href="#development" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Start the development server with live reload:</p>
|
|
91
|
+
<pre><code class="bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">start</span>
|
|
92
|
+
</code><button type="button">Copy</button></pre>
|
|
93
|
+
|
|
94
|
+
<p>This will open the demo page at <code>demo/index.html</code> with automatic rebuilding on file changes.</p>
|
|
95
|
+
<h2 id="running-tests" class="tsd-anchor-link">Running Tests<a href="#running-tests" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Run tests once:</p>
|
|
96
|
+
<pre><code class="bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">test</span>
|
|
97
|
+
</code><button type="button">Copy</button></pre>
|
|
98
|
+
|
|
99
|
+
<p>Run tests in watch mode:</p>
|
|
100
|
+
<pre><code class="bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">test:watch</span>
|
|
101
|
+
</code><button type="button">Copy</button></pre>
|
|
102
|
+
|
|
103
|
+
<p>Tests are written using <a href="https://modern-web.dev/docs/test-runner/overview/">@web/test-runner</a> and <a href="https://open-wc.org/docs/testing/helpers/">@open-wc/testing</a>.</p>
|
|
104
|
+
<h2 id="documentation" class="tsd-anchor-link">Documentation<a href="#documentation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><h3 id="api-documentation" class="tsd-anchor-link">API Documentation<a href="#api-documentation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>The API documentation is generated using <a href="https://typedoc.org/">TypeDoc</a>. To build the docs:</p>
|
|
105
|
+
<pre><code class="bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">build</span>
|
|
106
|
+
</code><button type="button">Copy</button></pre>
|
|
107
|
+
|
|
108
|
+
<p>Documentation will be available in the build output.</p>
|
|
109
|
+
<h3 id="additional-resources" class="tsd-anchor-link">Additional Resources<a href="#additional-resources" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
|
|
110
|
+
<li><a href="https://www.infragistics.com/products/ignite-ui-web-components/web-components/components/general-getting-started">Ignite UI Web Components Product Documentation</a></li>
|
|
111
|
+
<li><a href="https://www.infragistics.com/products/ignite-ui-web-components/web-components/components/grid-lite/overview">Grid Lite Documentation</a></li>
|
|
112
|
+
<li><a href="https://lit.dev/">Web Components Guide</a></li>
|
|
113
|
+
</ul>
|
|
114
|
+
<h2 id="ignite-ui-grid-lite-vs-ignite-ui-for-web-components" class="tsd-anchor-link">Ignite UI Grid Lite vs. Ignite UI for Web Components<a href="#ignite-ui-grid-lite-vs-ignite-ui-for-web-components" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Ignite UI Grid Lite is designed as a lightweight, open-source alternative to the full-featured <a href="https://www.infragistics.com/products/ignite-ui-web-components/web-components/components/grids/data-grid">Ignite UI for Web Components Data Grid</a>, while allowing for an easy swap with the full-featured grid, if application needs require it.</p>
|
|
115
|
+
<h3 id="ignite-ui-grid-lite-for-web-components-open-source-mit" class="tsd-anchor-link">Ignite UI Grid Lite for Web Components (Open Source - MIT)<a href="#ignite-ui-grid-lite-for-web-components-open-source-mit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><strong>Best for:</strong></p>
|
|
116
|
+
<ul>
|
|
117
|
+
<li>Applications requiring basic grid functionality</li>
|
|
118
|
+
<li>Projects where bundle size is critical</li>
|
|
119
|
+
<li>Framework-agnostic web applications</li>
|
|
120
|
+
<li>Community-driven development</li>
|
|
121
|
+
</ul>
|
|
122
|
+
<p><strong>Includes:</strong></p>
|
|
123
|
+
<ul>
|
|
124
|
+
<li>Core data virtualization</li>
|
|
125
|
+
<li>Basic filtering and sorting</li>
|
|
126
|
+
<li>Lightweight and fast</li>
|
|
127
|
+
<li>MIT licensed and free for all use</li>
|
|
128
|
+
</ul>
|
|
129
|
+
<p><strong>Best for:</strong></p>
|
|
130
|
+
<ul>
|
|
131
|
+
<li>Enterprise applications requiring advanced features</li>
|
|
132
|
+
<li>Complex data scenarios with editing, grouping, and aggregation</li>
|
|
133
|
+
<li>Applications needing professional support and SLA</li>
|
|
134
|
+
</ul>
|
|
135
|
+
<p><strong>Includes:</strong></p>
|
|
136
|
+
<ul>
|
|
137
|
+
<li>All Grid Lite features plus:
|
|
138
|
+
<ul>
|
|
139
|
+
<li>Advanced filtering with query builder</li>
|
|
140
|
+
<li>Excel-style column filtering</li>
|
|
141
|
+
<li>Grouping</li>
|
|
142
|
+
<li>Cell editing, row editing, batch editing</li>
|
|
143
|
+
<li>Summaries and aggregations</li>
|
|
144
|
+
<li>Excel, PDF, and CSV export</li>
|
|
145
|
+
<li>Column pinning, hiding, and resizing</li>
|
|
146
|
+
<li>Row selection</li>
|
|
147
|
+
<li>Paging</li>
|
|
148
|
+
<li>Multi-column headers and collapsible column groups</li>
|
|
149
|
+
<li>Cell merging</li>
|
|
150
|
+
<li>Custom row layouts</li>
|
|
151
|
+
<li>Master-detail views</li>
|
|
152
|
+
<li>Hierarchical grid</li>
|
|
153
|
+
<li>Tree grid</li>
|
|
154
|
+
<li>Pivot grid</li>
|
|
155
|
+
<li>24/5 developer support</li>
|
|
156
|
+
</ul>
|
|
157
|
+
</li>
|
|
158
|
+
</ul>
|
|
159
|
+
<p><a href="https://www.infragistics.com/products/ignite-ui-web-components/web-components/components/general-open-source-vs-premium">Learn more about Open-Source vs Premium Ignite UI options</a></p>
|
|
160
|
+
<h2 id="contributing" class="tsd-anchor-link">Contributing<a href="#contributing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>We welcome contributions! Please see our <a href="CONTRIBUTING.md">contributing guidelines</a> for details on:</p>
|
|
161
|
+
<ul>
|
|
162
|
+
<li>Code of conduct</li>
|
|
163
|
+
<li>Development workflow</li>
|
|
164
|
+
<li>Submitting pull requests</li>
|
|
165
|
+
<li>Coding standards</li>
|
|
166
|
+
</ul>
|
|
167
|
+
<p>To contribute:</p>
|
|
168
|
+
<ol>
|
|
169
|
+
<li>Fork the repository</li>
|
|
170
|
+
<li>Create a feature branch (<code>git checkout -b feature/amazing-feature</code>)</li>
|
|
171
|
+
<li>Commit your changes (<code>git commit -m 'Add amazing feature'</code>)</li>
|
|
172
|
+
<li>Push to the branch (<code>git push origin feature/amazing-feature</code>)</li>
|
|
173
|
+
<li>Open a Pull Request</li>
|
|
174
|
+
</ol>
|
|
175
|
+
<h2 id="support" class="tsd-anchor-link">Support<a href="#support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><h3 id="community-support" class="tsd-anchor-link">Community Support<a href="#community-support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Community support for open source usage of this product is available at:</p>
|
|
176
|
+
<ul>
|
|
177
|
+
<li><a href="https://github.com/IgniteUI/igniteui-grid-lite/issues">GitHub Issues</a> - Report bugs or request features</li>
|
|
178
|
+
<li><a href="https://stackoverflow.com/questions/tagged/igniteui">Stack Overflow</a> - Ask questions using the <code>igniteui</code> tag</li>
|
|
179
|
+
</ul>
|
|
180
|
+
<h3 id="commercial-support" class="tsd-anchor-link">Commercial Support<a href="#commercial-support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>For professional support and access to the full Ignite UI for Web Components suite with advanced grid features:</p>
|
|
181
|
+
<ul>
|
|
182
|
+
<li>Visit <a href="https://www.infragistics.com/support">Infragistics Support</a></li>
|
|
183
|
+
<li>Explore <a href="https://www.infragistics.com/products/ignite-ui-web-components">Ignite UI for Web Components</a></li>
|
|
184
|
+
<li><a href="https://www.infragistics.com/products/ignite-ui-web-components/web-components/components/general-getting-started">Register for a trial</a></li>
|
|
185
|
+
</ul>
|
|
186
|
+
<h2 id="license" class="tsd-anchor-link">License<a href="#license" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>This project is licensed under the MIT License - see the <a href="media/LICENSE">LICENSE</a> file for details.</p>
|
|
187
|
+
<p><strong>MIT License</strong> - Free for commercial and non-commercial use.</p>
|
|
188
|
+
<p>© Copyright 2025 INFRAGISTICS. All Rights Reserved.</p>
|
|
189
|
+
<p>For the commercial Ignite UI for Angular product, please visit <a href="https://www.infragistics.com/legal/license">Infragistics Licensing</a>.</p>
|
|
190
|
+
<hr>
|
|
191
|
+
<p><strong>Built with ❤️ by <a href="https://www.infragistics.com/">Infragistics</a></strong></p>
|
|
192
|
+
<!-- Browser Logos -->
|
|
193
|
+
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><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></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#ignite-ui-grid-lite-for-web-components"><span>Ignite <wbr/>UI <wbr/>Grid <wbr/>Lite for <wbr/>Web <wbr/>Components</span></a><ul><li><a href="#table-of-contents"><span>Table of <wbr/>Contents</span></a></li><li><a href="#features"><span>Features</span></a></li><li><a href="#browser-support"><span>Browser <wbr/>Support</span></a></li><li><a href="#getting-started"><span>Getting <wbr/>Started</span></a></li><li><ul><li><a href="#installation"><span>Installation</span></a></li><li><a href="#quick-start"><span>Quick <wbr/>Start</span></a></li></ul></li><li><a href="#usage"><span>Usage</span></a></li><li><a href="#building-the-library"><span>Building the <wbr/>Library</span></a></li><li><ul><li><a href="#setup"><span>Setup</span></a></li><li><a href="#build"><span>Build</span></a></li><li><a href="#development"><span>Development</span></a></li></ul></li><li><a href="#running-tests"><span>Running <wbr/>Tests</span></a></li><li><a href="#documentation"><span>Documentation</span></a></li><li><ul><li><a href="#api-documentation"><span>API <wbr/>Documentation</span></a></li><li><a href="#additional-resources"><span>Additional <wbr/>Resources</span></a></li></ul></li><li><a href="#ignite-ui-grid-lite-vs-ignite-ui-for-web-components"><span>Ignite <wbr/>UI <wbr/>Grid <wbr/>Lite vs. <wbr/>Ignite <wbr/>UI for <wbr/>Web <wbr/>Components</span></a></li><li><ul><li><a href="#ignite-ui-grid-lite-for-web-components-open-source-mit"><span>Ignite <wbr/>UI <wbr/>Grid <wbr/>Lite for <wbr/>Web <wbr/>Components (<wbr/>Open <wbr/>Source -<wbr/> <wbr/>MIT)</span></a></li></ul></li><li><a href="#contributing"><span>Contributing</span></a></li><li><a href="#support"><span>Support</span></a></li><li><ul><li><a href="#community-support"><span>Community <wbr/>Support</span></a></li><li><a href="#commercial-support"><span>Commercial <wbr/>Support</span></a></li></ul></li><li><a href="#license"><span>License</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">igniteui-grid-lite-workspace</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BaseColumnConfiguration | igniteui-grid-lite</title><meta name="description" content="Documentation for igniteui-grid-lite"/><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">igniteui-grid-lite</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">BaseColumnConfiguration</a></li></ul><h1>Interface BaseColumnConfiguration<T, K></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Configuration object for grid columns.</p>
|
|
2
|
-
</div
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BaseColumnConfiguration | igniteui-grid-lite-workspace</title><meta name="description" content="Documentation for igniteui-grid-lite-workspace"/><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">igniteui-grid-lite-workspace</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">BaseColumnConfiguration</a></li></ul><h1>Interface BaseColumnConfiguration<T, K></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Configuration object for grid columns.</p>
|
|
2
|
+
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BaseColumnConfiguration</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a> <span class="tsd-signature-keyword">extends</span> <a href="../types/Keys.html" class="tsd-signature-type tsd-kind-type-alias">Keys</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">=</span> <a href="../types/Keys.html" class="tsd-signature-type tsd-kind-type-alias">Keys</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#celltemplate">cellTemplate</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <a href="../types/IgcCellContext.html" class="tsd-signature-type tsd-kind-type-alias">IgcCellContext</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#filter">filter</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <a href="ColumnFilterConfiguration.html" class="tsd-signature-type tsd-kind-interface">ColumnFilterConfiguration</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#headertemplate">headerTemplate</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <a href="IgcHeaderContext.html" class="tsd-signature-type tsd-kind-interface">IgcHeaderContext</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#headertext">headerText</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hidden">hidden</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#key">key</a><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#resizable">resizable</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#sort">sort</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <a href="../types/ColumnSortConfiguration.html" class="tsd-signature-type tsd-kind-type-alias">ColumnSortConfiguration</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#type">type</a><span class="tsd-signature-symbol">?:</span> <a href="../types/DataType.html" class="tsd-signature-type tsd-kind-type-alias">DataType</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#width">width</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="t"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">object</span></span></li><li><span id="k"><span class="tsd-kind-type-parameter">K</span> <span class="tsd-signature-keyword">extends</span> <a href="../types/Keys.html" class="tsd-signature-type tsd-kind-type-alias">Keys</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span> = <a href="../types/Keys.html" class="tsd-signature-type tsd-kind-type-alias">Keys</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span></span></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">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="#celltemplate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cell<wbr/>Template?</span></a>
|
|
3
3
|
<a href="#filter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filter?</span></a>
|
|
4
4
|
<a href="#headertemplate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>header<wbr/>Template?</span></a>
|
|
5
5
|
<a href="#headertext" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>header<wbr/>Text?</span></a>
|
|
@@ -10,19 +10,19 @@
|
|
|
10
10
|
<a href="#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type?</span></a>
|
|
11
11
|
<a href="#width" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>width?</span></a>
|
|
12
12
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="celltemplate"><code class="tsd-tag">Optional</code><span>cell<wbr/>Template</span><a href="#celltemplate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cellTemplate</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <a href="../types/IgcCellContext.html" class="tsd-signature-type tsd-kind-type-alias">IgcCellContext</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">unknown</span></div><div class="tsd-comment tsd-typography"><p>Cell template callback.</p>
|
|
13
|
-
</div
|
|
14
|
-
</div
|
|
15
|
-
</div
|
|
13
|
+
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="filter"><code class="tsd-tag">Optional</code><span>filter</span><a href="#filter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <a href="ColumnFilterConfiguration.html" class="tsd-signature-type tsd-kind-interface">ColumnFilterConfiguration</a></div><div class="tsd-comment tsd-typography"><p>Whether filter operation can be applied on the column or not.</p>
|
|
14
|
+
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="headertemplate"><code class="tsd-tag">Optional</code><span>header<wbr/>Template</span><a href="#headertemplate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">headerTemplate</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <a href="IgcHeaderContext.html" class="tsd-signature-type tsd-kind-interface">IgcHeaderContext</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">unknown</span></div><div class="tsd-comment tsd-typography"><p>Header template callback.</p>
|
|
15
|
+
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="headertext"><code class="tsd-tag">Optional</code><span>header<wbr/>Text</span><a href="#headertext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">headerText</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Optional text to display in the column header. By default, the column key is used
|
|
16
16
|
to render the header text.</p>
|
|
17
|
-
</div
|
|
18
|
-
</div
|
|
19
|
-
</div
|
|
20
|
-
</div
|
|
21
|
-
</div
|
|
17
|
+
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hidden"><code class="tsd-tag">Optional</code><span>hidden</span><a href="#hidden" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hidden</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the column is hidden or not.</p>
|
|
18
|
+
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="key"><span>key</span><a href="#key" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">key</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a></div><div class="tsd-comment tsd-typography"><p>The field for from the data the this column will reference.</p>
|
|
19
|
+
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="resizable"><code class="tsd-tag">Optional</code><span>resizable</span><a href="#resizable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">resizable</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the the column can be resized or not.</p>
|
|
20
|
+
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sort"><code class="tsd-tag">Optional</code><span>sort</span><a href="#sort" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <a href="../types/ColumnSortConfiguration.html" class="tsd-signature-type tsd-kind-type-alias">ColumnSortConfiguration</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Whether the column can be sorted or not.</p>
|
|
21
|
+
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="type"><code class="tsd-tag">Optional</code><span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">?:</span> <a href="../types/DataType.html" class="tsd-signature-type tsd-kind-type-alias">DataType</a></div><div class="tsd-comment tsd-typography"><p>The type of data this column will reference.</p>
|
|
22
22
|
<p>Affects the default filter operands if the column is with filtering enabled.</p>
|
|
23
23
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks">Remarks<a href="#remarks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If not passed, <code>string</code> is assumed to be the default type.</p>
|
|
24
24
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="width"><code class="tsd-tag">Optional</code><span>width</span><a href="#width" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">width</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Width for the current column.</p>
|
|
25
25
|
<p>Accepts most CSS units for controlling width.</p>
|
|
26
26
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-1">Remarks<a href="#remarks-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If not passed, the column will try to size itself based on the number of other
|
|
27
27
|
columns and the total width of the grid.</p>
|
|
28
|
-
</div></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><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></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#celltemplate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cell<wbr/>Template</span></a><a href="#filter"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filter</span></a><a href="#headertemplate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>header<wbr/>Template</span></a><a href="#headertext"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>header<wbr/>Text</span></a><a href="#hidden"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hidden</span></a><a href="#key"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>key</span></a><a href="#resizable"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>resizable</span></a><a href="#sort"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sort</span></a><a href="#type"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#width"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>width</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">igniteui-grid-lite</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
28
|
+
</div></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><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></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#celltemplate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cell<wbr/>Template</span></a><a href="#filter"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filter</span></a><a href="#headertemplate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>header<wbr/>Template</span></a><a href="#headertext"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>header<wbr/>Text</span></a><a href="#hidden"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hidden</span></a><a href="#key"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>key</span></a><a href="#resizable"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>resizable</span></a><a href="#sort"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sort</span></a><a href="#type"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#width"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>width</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">igniteui-grid-lite-workspace</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BaseColumnSortConfiguration | igniteui-grid-lite</title><meta name="description" content="Documentation for igniteui-grid-lite"/><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">igniteui-grid-lite</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">BaseColumnSortConfiguration</a></li></ul><h1>Interface BaseColumnSortConfiguration<T, K></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Extended sort configuration for a column.</p>
|
|
2
|
-
</div
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BaseColumnSortConfiguration | igniteui-grid-lite-workspace</title><meta name="description" content="Documentation for igniteui-grid-lite-workspace"/><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">igniteui-grid-lite-workspace</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">BaseColumnSortConfiguration</a></li></ul><h1>Interface BaseColumnSortConfiguration<T, K></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Extended sort configuration for a column.</p>
|
|
2
|
+
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BaseColumnSortConfiguration</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a> <span class="tsd-signature-keyword">extends</span> <a href="../types/Keys.html" class="tsd-signature-type tsd-kind-type-alias">Keys</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">=</span> <a href="../types/Keys.html" class="tsd-signature-type tsd-kind-type-alias">Keys</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#casesensitive">caseSensitive</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#comparer">comparer</a><span class="tsd-signature-symbol">?:</span> <a href="../types/SortComparer.html" class="tsd-signature-type tsd-kind-type-alias">SortComparer</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="t"><span class="tsd-kind-type-parameter">T</span></span></li><li><span id="k"><span class="tsd-kind-type-parameter">K</span> <span class="tsd-signature-keyword">extends</span> <a href="../types/Keys.html" class="tsd-signature-type tsd-kind-type-alias">Keys</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span> = <a href="../types/Keys.html" class="tsd-signature-type tsd-kind-type-alias">Keys</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span></span></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">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="#casesensitive" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>case<wbr/>Sensitive?</span></a>
|
|
3
3
|
<a href="#comparer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>comparer?</span></a>
|
|
4
4
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="casesensitive"><code class="tsd-tag">Optional</code><span>case<wbr/>Sensitive</span><a href="#casesensitive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">caseSensitive</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the sort operations will be case sensitive.</p>
|
|
5
|
-
</div
|
|
6
|
-
</div
|
|
5
|
+
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="comparer"><code class="tsd-tag">Optional</code><span>comparer</span><a href="#comparer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">comparer</span><span class="tsd-signature-symbol">?:</span> <a href="../types/SortComparer.html" class="tsd-signature-type tsd-kind-type-alias">SortComparer</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Custom comparer function for sort operations for this column.</p>
|
|
6
|
+
</div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><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></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#casesensitive"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>case<wbr/>Sensitive</span></a><a href="#comparer"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>comparer</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">igniteui-grid-lite-workspace</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|