UNPKG

2.94 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright Akveo. All Rights Reserved.
4 * Licensed under the MIT License. See License.txt in the project root for license information.
5 */
6import { EventEmitter } from '@angular/core';
7import { NbBooleanInput } from '../helpers';
8/**
9 * Route tabset components.
10 * Renders tabs inside of a router-outlet.
11 *
12 * ```ts
13 * tabs = [
14 * {
15 * title: 'Route tab #1',
16 * route: '/pages/description',
17 * icon: 'home',
18 * responsive: true, // hide title before `route-tabs-icon-only-max-width` value
19 * },
20 * {
21 * title: 'Route tab #2',
22 * route: '/pages/images',
23 * }
24 * ];
25 *
26 * <nb-route-tabset [tabs]="tabs"></nb-route-tabset>
27 * ```
28 * ### Installation
29 *
30 * Import `NbRouteTabsetModule` to your feature module.
31 * ```ts
32 * @NgModule({
33 * imports: [
34 * // ...
35 * NbRouteTabsetModule,
36 * ],
37 * })
38 * export class PageModule { }
39 * ```
40 *
41 * @stacked-example(Route Tabset, tabset/route-tabset-showcase.component)
42 *
43 * @styles
44 *
45 * route-tabset-background-color:
46 * route-tabset-border-radius:
47 * route-tabset-shadow:
48 * route-tabset-tab-background-color:
49 * route-tabset-tab-padding:
50 * route-tabset-tab-text-color:
51 * route-tabset-tab-text-font-family:
52 * route-tabset-tab-text-font-size:
53 * route-tabset-tab-text-font-weight:
54 * route-tabset-tab-text-line-height:
55 * route-tabset-tab-text-transform:
56 * route-tabset-tab-underline-width:
57 * route-tabset-tab-underline-color:
58 * route-tabset-tab-active-background-color:
59 * route-tabset-tab-active-text-color:
60 * route-tabset-tab-active-underline-color:
61 * route-tabset-tab-focus-background-color:
62 * route-tabset-tab-focus-text-color:
63 * route-tabset-tab-focus-underline-color:
64 * route-tabset-tab-hover-background-color:
65 * route-tabset-tab-hover-text-color:
66 * route-tabset-tab-hover-underline-color:
67 * route-tabset-tab-disabled-background-color:
68 * route-tabset-tab-disabled-text-color:
69 * route-tabset-tab-disabled-underline-color:
70 * route-tabset-divider-color:
71 * route-tabset-divider-style:
72 * route-tabset-divider-width:
73 * route-tabset-scrollbar-color:
74 * route-tabset-scrollbar-background-color:
75 * route-tabset-scrollbar-width:
76 * route-tabset-tab-text-hide-breakpoint:
77 */
78export declare class NbRouteTabsetComponent {
79 fullWidthValue: boolean;
80 /**
81 * Tabs configuration
82 * @param Object{route: string, title: string, tag?: string, responsive?: boolean, disabled?: boolean}
83 */
84 tabs: any[];
85 /**
86 * Options passed to `routerLinkActiveOptions` directive which set on tab links.
87 * `{ exact: true }` by default.
88 */
89 activeLinkOptions: {
90 exact: boolean;
91 };
92 /**
93 * Take full width of a parent
94 * @param {boolean} val
95 */
96 set fullWidth(val: boolean);
97 static ngAcceptInputType_fullWidth: NbBooleanInput;
98 /**
99 * Emits when tab is selected
100 * @type {EventEmitter<any>}
101 */
102 changeTab: EventEmitter<any>;
103 selectTab(tab: any): void;
104}