# @terminus/ui-tabs

> Tabs

Latest version **4.0.0** (published 2020-12-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @terminus/ui-tabs
pnpm add @terminus/ui-tabs
yarn add @terminus/ui-tabs
bun add @terminus/ui-tabs
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.0 |
| Published | 2020-12-16 |
| First published | 2020-06-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 773.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11 |
| Author | @terminus |
| Maintainers | benjamincharity, bmalinconico-terminus, atlwendy, terminus_devops |

## Links

- npm: https://www.npmjs.com/package/@terminus/ui-tabs
- Repository: https://github.com/GetTerminus/terminus-oss
- Issues: https://github.com/GetTerminus/terminus-oss/issues
- npm.io page: https://npm.io/package/@terminus/ui-tabs

## Dependencies (3)

- [tslib](https://npm.io/package/tslib.md) ^2.0.3
- [@schematics/angular](https://npm.io/package/@schematics/angular.md) 11.0.4
- [@angular-devkit/schematics](https://npm.io/package/@angular-devkit/schematics.md) 11.0.4

## Recent versions

- 4.0.0 (latest) — 2020-12-16
- 4.0.1 (next) — 2021-12-01
- 3.0.2 — 2020-11-11
- 3.0.1 — 2020-11-11
- 3.0.0 — 2020-10-05
- 2.1.2 — 2020-09-14
- 2.1.1 — 2020-09-11
- 2.1.0 — 2020-09-08
- 2.0.13 — 2020-09-04
- 2.0.12 — 2020-09-03
- 2.0.11 — 2020-08-28
- 2.0.10 — 2020-08-14
- 2.0.9 — 2020-08-10
- 2.0.8 — 2020-08-10
- 2.0.7 — 2020-08-06
- … 17 more at https://npm.io/package/@terminus/ui-tabs/versions

## README

<h1>Tabs</h1>

[![CI/CD Status][github-action-badge]][github-action-link] [![Codecov][codecov-badge]][codecov-project] [![MIT License][license-image]][license-url]  
[![NPM version][npm-version-image]][npm-package] [![Library size][file-size-badge]][raw-distribution-js]

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
## Table of Contents

- [Installation](#installation)
  - [CSS imports](#css-imports)
  - [CSS resources](#css-resources)
- [Usage](#usage)
  - [Label alignment](#label-alignment)
  - [Header position](#header-position)
  - [Dynamically insert a tab](#dynamically-insert-a-tab)
  - [Custom label template](#custom-label-template)
  - [Lazy load tab content](#lazy-load-tab-content)
  - [Events](#events)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Installation

Use the `ng add` command to quickly install all the needed dependencies:

```bash
ng add @terminus/ui-tabs
```

### CSS imports

In your top-level stylesheet, add these imports:

```css
@import '~@terminus/design-tokens/css/library-design-tokens.css';
@import '~@terminus/ui-styles/terminus-ui.css';
```  

### CSS resources

Load the needed font families by adding this link to the `<head>` of your application:

```css
<link href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
```

## Usage

In its most simple form this must consist of a collection with at least one tab:

```html
<ts-tab-collection>
  <ts-tab label="First">Content 1</ts-tab>
</ts-tab-collection>
```

### Label alignment

There are four horizontal layout options for tab labels.

| Position  | Description                                  |
|-----------|----------------------------------------------|
| `start`   | Align tab labels to the left (default)       |
| `center`  | Center tab labels to content                 |
| `end`     | Align tab labels to the right                |
| `stretch` | Force tab labels to fill all available space |

```html
<ts-tab-collection headerPosition="stretch">
  ...
</ts-tab-collection>
```

### Header position

The collection of tab labels are positioned above the tab content by default. This can be inverted so the labels appear below the tab
content:

```html
<ts-tab-collection headerPosition="below">
  ...
</ts-tab-collection>
```

### Dynamically insert a tab

Tabs can be dynamically added and removed by using a loop to generate the tabs:

```html
<ts-tab-collection>
  <ts-tab *ngFor="let tab of myTabs; let index = index" [label]="tab">
    Content for {{ tab }} tab
  </ts-tab>
</ts-tab-collection>
```

Or by showing and hiding via `ngIf`:

```html
<ts-tab-collection>
  <ts-tab label="First">
    Content 1
  </ts-tab>

  <ts-tab label="Second" *ngIf="shouldIncludeTab">
    Content 2
  </ts-tab>
</ts-tab-collection>
```

### Custom label template

If label customization is needed a template can be defined to contain custom label markup by using the `tsTabLabel` directive on an
`ng-template` tag:

```html
<ts-tab-collection>
  <ts-tab>
    <ng-template tsTabLabel>
      <ts-icon>home</ts-icon>
      First
    </ng-template>

    Content 1
  </ts-tab>
</ts-tab-collection>
```

### Lazy load tab content

By default tab content is eagerly loaded. Tab content can be lazily loaded by using the `tsTabContent` directive on an `ng-template` tag:

```html
<ts-tab-collection>
  <ts-tab label="First">
    <ng-template tsTabContent>
      Content 1
    </ng-template>
  </ts-tab>
</ts-tab-collection>
```

### Events

| Event                 | Description                                      | Payload            |
|:----------------------|:-------------------------------------------------|:-------------------|
| `animationFinished`   | Fired when the tab animation is finished         | `void`             |
| `focusChange`         | Fired when the tab labels focus changes          | `TsTabChangeEvent` |
| `selectedIndexChange` | Fired when the index of the selected tab changes | `number`           |
| `selectedTabChange`   | Fired when the selected tab changes              | `TsTabChangeEvent` |

```html
<ts-tab-collection (selectedTabChange)="whenTabChanges($event)">
  ...
</ts-tab-collection>
```

The `TsTabChangeEvent` structure:

```typescript
class TsTabChangeEvent {
  constructor(
    // The tab's current index
    public index: number,
    // The tab
    public tab: TsTabComponent,
  ) {}
}
```

<!-- Links -->
[license-url]:         https://github.com/GetTerminus/terminus-oss/blob/release/LICENSE
[license-image]:       http://img.shields.io/badge/license-MIT-blue.svg
[codecov-project]:     https://codecov.io/gh/GetTerminus/terminus-oss
[codecov-badge]:       https://codecov.io/gh/GetTerminus/terminus-oss/branch/release/graph/badge.svg
[npm-version-image]:   http://img.shields.io/npm/v/@terminus/ui-tabs.svg
[npm-package]:         https://www.npmjs.com/package/@terminus/ui-tabs
[github-action-badge]: https://github.com/GetTerminus/terminus-oss/workflows/Release%20CI/badge.svg
[github-action-link]:  https://github.com/GetTerminus/terminus-oss/actions?query=workflow%3A%22CI+Release%22
[file-size-badge]:     http://img.badgesize.io/https://unpkg.com/@terminus/ui-tabs/bundles/terminus-ui-tabs.umd.min.js?compression=gzip
[raw-distribution-js]: https://unpkg.com/@terminus/ui-tabs/bundles/terminus-ui-tabs.umd.js

---
_Source: https://npm.io/package/@terminus/ui-tabs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._