carbon-components-angular
Version:
Next generation components
905 lines (780 loc) • 33.4 kB
HTML
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>carbon-components-angular documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/style.css">
<link rel="stylesheet" href="../styles/dark.css">
<style>
footer.carbon {
position: absolute;
bottom: 0;
width: 100%;
z-index: 9999;
}
#root > div {
/*
* Subtracting the height of the footer to prevent
* overlaying the footer ontop of content
*/
height: calc(100vh - 48px);
}
</style>
</head>
<body>
<script>
// Blocking script to avoid flickering dark mode
// Dark mode toggle button
var useDark = window.matchMedia('(prefers-color-scheme: dark)');
var darkModeState = useDark.matches;
var $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
var $darkModeToggles = document.querySelectorAll('.dark-mode-switch');
var darkModeStateLocal = localStorage.getItem('compodoc_darkmode-state');
function checkToggle(check) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].checked = check;
}
}
function toggleDarkMode(state) {
if (window.localStorage) {
localStorage.setItem('compodoc_darkmode-state', state);
}
checkToggle(state);
const hasClass = document.body.classList.contains('dark');
if (state) {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.add('dark');
}
if (!hasClass) {
document.body.classList.add('dark');
}
} else {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.remove('dark');
}
if (hasClass) {
document.body.classList.remove('dark');
}
}
}
useDark.addEventListener('change', function (evt) {
toggleDarkMode(evt.matches);
});
if (darkModeStateLocal) {
darkModeState = darkModeStateLocal === 'true';
}
toggleDarkMode(darkModeState);
</script>
<div class="navbar navbar-default navbar-fixed-top d-md-none p-0">
<div class="d-flex">
<a href="../" class="navbar-brand">carbon-components-angular documentation</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="d-none d-md-block menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content class">
<div class="content-data">
<ol class="breadcrumb">
<li class="breadcrumb-item">Classes</li>
<li class="breadcrumb-item" >TableItem</li>
</ol>
<ul class="nav nav-tabs" role="tablist">
<li class="nav-item">
<a href="#info"
class="nav-link"
class="nav-link active"
role="tab" id="info-tab" data-bs-toggle="tab" data-link="info">Info</a>
</li>
<li class="nav-item">
<a href="#source"
class="nav-link"
role="tab" id="source-tab" data-bs-toggle="tab" data-link="source">Source</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane fade active in" id="info">
<p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>src/table/table-item.class.ts</code>
</p>
<section data-compodoc="block-index">
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<tr>
<td class="col-md-4">
<h6><b>Properties</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier">Private</span>
<a href="#_title" >_title</a>
</li>
<li>
<a href="#colSpan" >colSpan</a>
</li>
<li>
<a href="#data" >data</a>
</li>
<li>
<a href="#expandAsTable" >expandAsTable</a>
</li>
<li>
<a href="#expandedData" >expandedData</a>
</li>
<li>
<a href="#expandedTemplate" >expandedTemplate</a>
</li>
<li>
<a href="#rowSpan" >rowSpan</a>
</li>
<li>
<a href="#template" >template</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Accessors</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#title" >title</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-constructor">
<h3 id="constructor">Constructor</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<code>constructor(rawData?: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="137" class="link-to-prism">src/table/table-item.class.ts:137</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Creates an instance of TableItem.</p>
</div>
<div>
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>rawData</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
Yes
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-properties">
<h3 id="inputs">
Properties
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="_title"></a>
<span class="name">
<span class="modifier">Private</span>
<span ><b>_title</b></span>
<a href="#_title"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="137" class="link-to-prism">src/table/table-item.class.ts:137</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="colSpan"></a>
<span class="name">
<span ><b>colSpan</b></span>
<a href="#colSpan"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>1</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="107" class="link-to-prism">src/table/table-item.class.ts:107</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>The number of columns to span</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="data"></a>
<span class="name">
<span ><b>data</b></span>
<a href="#data"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="9" class="link-to-prism">src/table/table-item.class.ts:9</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Data for the table item.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="expandAsTable"></a>
<span class="name">
<span ><b>expandAsTable</b></span>
<a href="#expandAsTable"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="97" class="link-to-prism">src/table/table-item.class.ts:97</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Setting this to <code>true</code> makes table interpret <code>expandedData</code> as additional rows to insert in place
for expanded data. <code>expandedTemplate</code> is then ignored.</p>
<p>You can apply the template for individual cells as usual.</p>
<p>Example model data:</p>
<b>Example :</b><div><pre class="line-numbers"><code class="language-typescript">this.model.data = [
[new TableItem({ data: "Name 4" }), new TableItem({ data: "twer" })], // regular row
[
new TableItem({
data: "Name 3.1",
// `expandedData` mimics the format of the rest of the table
expandedData: [
[
new TableItem({ data: "More names", expandedData: "No template" }),
new TableItem({ data: { name: "Morey", link: "#" }, template: this.customTableItemTemplate })
],
[
new TableItem({ data: "Core names", expandedData: "No template" }),
new TableItem({ data: { name: "Corey", link: "#" }, template: this.customTableItemTemplate })
]
],
// `expandAsTable` tells the table to interpret `expandedData` as table data
expandAsTable: true
}),
new TableItem({ data: "swer" })
],
[new TableItem({ data: "Name 7" }), new TableItem({data: "twer"})] // regular row
];</code></pre></div></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="expandedData"></a>
<span class="name">
<span ><b>expandedData</b></span>
<a href="#expandedData"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="19" class="link-to-prism">src/table/table-item.class.ts:19</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Data for the expanded part of the row.</p>
<p>You only need to set it for the first item in the row.</p>
<p>See <code>expandAsTable</code> documentation if you need to the table to expand to additional
table rows.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="expandedTemplate"></a>
<span class="name">
<span ><b>expandedTemplate</b></span>
<a href="#expandedTemplate"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>TemplateRef<any></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="61" class="link-to-prism">src/table/table-item.class.ts:61</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Template for rendering <code>expandedData</code></p>
<p>You only need to set it for the first item in the row.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="rowSpan"></a>
<span class="name">
<span ><b>rowSpan</b></span>
<a href="#rowSpan"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>1</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="102" class="link-to-prism">src/table/table-item.class.ts:102</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>The number of rows to span</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="template"></a>
<span class="name">
<span ><b>template</b></span>
<a href="#template"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>TemplateRef<any></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="53" class="link-to-prism">src/table/table-item.class.ts:53</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Used to display data in a desired way.</p>
<p>If not provided, displays data as a simple string.</p>
<p>Usage:</p>
<p>In a component where you're using the table create a template like:</p>
<b>Example :</b><div><pre class="line-numbers"><code class="language-html"><ng-template #customItemTemplate let-data="data">
<i><a [routerLink]="data.link">{{data.name}}</a></i>
</ng-template></code></pre></div><p>where we assume your data contains <code>link</code> and <code>name</code>. <code>let-data="data"</code> is
necessary for you to be able to access item's data in the template.</p>
<p>Create <code>ViewChild</code> property with:</p>
<b>Example :</b><div><pre class="line-numbers"><code class="language-typescript">(at)ViewChild("customItemTemplate")
protected customItemTemplate: TemplateRef<any>;</code></pre></div><p>Set the template to the table item, for example:</p>
<b>Example :</b><div><pre class="line-numbers"><code class="language-typescript">this.model.data = [
[new TableItem({data: {name: "Custom item", link: "/table"}, template: this.customItemTemplate})]
];</code></pre></div></div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-accessors">
<h3 id="accessors">
Accessors
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="title"></a>
<span class="name"><b>title</b><a href="#title"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="accessor"><b>get</b><code>title()</code></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="109" class="link-to-prism">src/table/table-item.class.ts:109</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="accessor"><b>set</b><code>title(title)</code></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="133" class="link-to-prism">src/table/table-item.class.ts:133</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>title</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
</td>
</tr>
</tbody>
</table>
</section>
</div>
<div class="tab-pane fade tab-source-code" id="source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import {
TemplateRef
} from "@angular/core";
export class TableItem {
/**
* Data for the table item.
*/
data: any;
/**
* Data for the expanded part of the row.
*
* You only need to set it for the first item in the row.
*
* See `expandAsTable` documentation if you need to the table to expand to additional
* table rows.
*/
expandedData: any;
/**
* Used to display data in a desired way.
*
* If not provided, displays data as a simple string.
*
* Usage:
*
* In a component where you're using the table create a template like:
*
* ```html
* <ng-template #customItemTemplate let-data="data">
* <i><a [routerLink]="data.link">{{data.name}}</a></i>
* </ng-template>
* ```
* where we assume your data contains `link` and `name`. `let-data="data"` is
* necessary for you to be able to access item's data in the template.
*
* Create `ViewChild` property with:
*
* ```typescript
* (at)ViewChild("customItemTemplate")
* protected customItemTemplate: TemplateRef<any>;
* ```
*
* Set the template to the table item, for example:
*
* ```typescript
* this.model.data = [
* [new TableItem({data: {name: "Custom item", link: "/table"}, template: this.customItemTemplate})]
* ];
* ```
*/
template: TemplateRef<any>;
/**
* Template for rendering `expandedData`
*
* You only need to set it for the first item in the row.
*
*/
expandedTemplate: TemplateRef<any>;
/**
* Setting this to `true` makes table interpret `expandedData` as additional rows to insert in place
* for expanded data. `expandedTemplate` is then ignored.
*
* You can apply the template for individual cells as usual.
*
* Example model data:
*
* ```typescript
* this.model.data = [
* [new TableItem({ data: "Name 4" }), new TableItem({ data: "twer" })], // regular row
* [
* new TableItem({
* data: "Name 3.1",
* // `expandedData` mimics the format of the rest of the table
* expandedData: [
* [
* new TableItem({ data: "More names", expandedData: "No template" }),
* new TableItem({ data: { name: "Morey", link: "#" }, template: this.customTableItemTemplate })
* ],
* [
* new TableItem({ data: "Core names", expandedData: "No template" }),
* new TableItem({ data: { name: "Corey", link: "#" }, template: this.customTableItemTemplate })
* ]
* ],
* // `expandAsTable` tells the table to interpret `expandedData` as table data
* expandAsTable: true
* }),
* new TableItem({ data: "swer" })
* ],
* [new TableItem({ data: "Name 7" }), new TableItem({data: "twer"})] // regular row
* ];
* ```
*/
expandAsTable: false;
/**
* The number of rows to span
*/
rowSpan = 1;
/**
* The number of columns to span
*/
colSpan = 1;
get title() {
if (typeof this._title === "string") {
return this._title;
}
if (!this.data) {
return "";
}
if (typeof this.data === "string") {
return this.data;
}
if (
this.data.toString &&
this.data.constructor !== ({}).constructor
) {
return this.data.toString();
}
// data can’t be reasonably converted to an end user readable string
return "";
}
set title(title) {
this._title = title;
}
private _title: string;
/**
* Creates an instance of TableItem.
*/
constructor(rawData?: any) {
// defaults so we dont leave things empty
const defaults = {
data: ""
};
// fill our object with provided props, and fallback to defaults
const data = Object.assign({}, defaults, rawData);
for (const property of Object.getOwnPropertyNames(data)) {
if (data.hasOwnProperty(property)) {
this[property] = data[property];
}
}
}
}
</code></pre>
</div>
</div>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>
<label class="dark-mode-switch">
<input type="checkbox">
<span class="slider">
<svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
<path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
</svg>
</span>
</label>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'class';
var COMPODOC_CURRENT_PAGE_URL = 'TableItem.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script>
$darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
checkToggle(darkModeState);
if ($darkModeToggleSwitchers.length > 0) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].addEventListener('change', function (event) {
darkModeState = !darkModeState;
toggleDarkMode(darkModeState);
});
}
}
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<script src="../js/menu-wc.js" defer></script>
<script nomodule src="../js/menu-wc_es5.js" defer></script>
<script src="../js/libs/bootstrap-native.js"></script>
<script src="../js/libs/es6-shim.min.js"></script>
<script src="../js/libs/EventDispatcher.js"></script>
<script src="../js/libs/promise.min.js"></script>
<script src="../js/libs/zepto.min.js"></script>
<script src="../js/compodoc.js"></script>
<script src="../js/tabs.js"></script>
<script src="../js/menu.js"></script>
<script src="../js/libs/clipboard.min.js"></script>
<script src="../js/libs/prism.js"></script>
<script src="../js/sourceCode.js"></script>
<script src="../js/search/search.js"></script>
<script src="../js/search/lunr.min.js"></script>
<script src="../js/search/search-lunr.js"></script>
<script src="../js/search/search_index.js"></script>
<script src="../js/lazy-load-graphs.js"></script>
<footer class="carbon">
<dds-footer-container key="footer" disable-locale-button="true" size="micro" />
</footer>
<script
key="8"
type="module"
src="https://1.www.s81c.com/common/carbon-for-ibm-dotcom/tag/v1/latest/footer.min.js">
</script>
<!-- Storybook override -->
<script>
document.title = "Carbon Components Angular";
</script>
<script
src="//1.www.s81c.com/common/stats/ibm-common.js"
type="text/javascript"
async="async">
</script>
</body>
</html>