UNPKG

5.91 kBTypeScriptView Raw
1import { NbStatusService } from '../../services/status.service';
2import { NbComponentSize } from '../component-size';
3import { NbComponentOrCustomStatus, NbComponentStatus } from '../component-status';
4import * as i0 from "@angular/core";
5/**
6 * Component intended to be used within the `<nb-card>` component.
7 * It adds styles for a preset header section.
8 *
9 * @styles
10 *
11 * card-header-text-color:
12 * card-header-text-font-family:
13 * card-header-text-font-size:
14 * card-header-text-font-weight:
15 * card-header-text-line-height:
16 * card-header-basic-background-color:
17 * card-header-basic-text-color:
18 * card-header-primary-background-color:
19 * card-header-primary-text-color:
20 * card-header-info-background-color:
21 * card-header-info-text-color:
22 * card-header-success-background-color:
23 * card-header-success-text-color:
24 * card-header-warning-background-color:
25 * card-header-warning-text-color:
26 * card-header-danger-background-color:
27 * card-header-danger-text-color:
28 * card-header-control-background-color:
29 * card-header-control-text-color:
30 */
31export declare class NbCardHeaderComponent {
32 static ɵfac: i0.ɵɵFactoryDeclaration<NbCardHeaderComponent, never>;
33 static ɵcmp: i0.ɵɵComponentDeclaration<NbCardHeaderComponent, "nb-card-header", never, {}, {}, never, ["*"], false, never>;
34}
35/**
36 * Component intended to be used within the `<nb-card>` component.
37 * Adds styles for a preset body section.
38 */
39export declare class NbCardBodyComponent {
40 static ɵfac: i0.ɵɵFactoryDeclaration<NbCardBodyComponent, never>;
41 static ɵcmp: i0.ɵɵComponentDeclaration<NbCardBodyComponent, "nb-card-body", never, {}, {}, never, ["*"], false, never>;
42}
43/**
44 * Component intended to be used within the `<nb-card>` component.
45 * Adds styles for a preset footer section.
46 */
47export declare class NbCardFooterComponent {
48 static ɵfac: i0.ɵɵFactoryDeclaration<NbCardFooterComponent, never>;
49 static ɵcmp: i0.ɵɵComponentDeclaration<NbCardFooterComponent, "nb-card-footer", never, {}, {}, never, ["*"], false, never>;
50}
51/**
52 * Basic content container component.
53 *
54 * Basic card example:
55 * @stacked-example(Showcase, card/card-showcase.component)
56 *
57 * Basic card configuration:
58 *
59 * ```html
60 * <nb-card>
61 * <nb-card-body>
62 * Card
63 * </nb-card-body>
64 * </nb-card>
65 * ```
66 *
67 * ### Installation
68 *
69 * Import `NbCardModule` to your feature module.
70 * ```ts
71 * @NgModule({
72 * imports: [
73 * // ...
74 * NbCardModule,
75 * ],
76 * })
77 * export class PageModule { }
78 * ```
79 * ### Usage
80 *
81 * Card with header and footer:
82 * @stacked-example(With Header & Footer, card/card-full.component)
83 *
84 * Most of the time main card content goes to `nb-card-body`,
85 * so it is styled and aligned in accordance with the header and footer.
86 * In case you need a higher level of control, you can pass contend directly to `nb-card`,
87 * so `nb-card-body` styling will not be applied.
88 *
89 * Consider an example with `nb-list` component:
90 * @stacked-example(Card with list, card/card-without-body.component)
91 *
92 * Colored cards could be simply configured by providing a `status` property:
93 * @stacked-example(Colored Card, card/card-colors.component)
94 *
95 * It is also possible to assign an `accent` property for a slight card highlight
96 * as well as combine it with `status`:
97 * @stacked-example(Accent Card, card/card-accents.component)
98 *
99 * Cards of smaller sizes could be combined and put on the same row with a bigger card so they have the same heights.
100 * @stacked-example(Card sizes combinations, card/card-sizes-combinations.component)
101 *
102 * @additional-example(Multiple Sizes, card/card-sizes.component)
103 *
104 * @styles
105 *
106 * card-background-color:
107 * card-text-color:
108 * card-text-font-family:
109 * card-text-font-size:
110 * card-text-font-weight:
111 * card-text-line-height:
112 * card-border-width:
113 * card-border-style:
114 * card-border-color:
115 * card-border-radius:
116 * card-padding:
117 * card-shadow:
118 * card-divider-color:
119 * card-divider-style:
120 * card-divider-width:
121 * card-height-tiny:
122 * card-height-small:
123 * card-height-medium:
124 * card-height-large:
125 * card-height-giant:
126 * card-margin-bottom:
127 * card-scrollbar-color:
128 * card-scrollbar-background-color:
129 * card-scrollbar-width:
130 */
131export declare class NbCardComponent {
132 protected statusService: NbStatusService;
133 /**
134 * Card size, available sizes:
135 * tiny, small, medium, large, giant
136 */
137 get size(): '' | NbComponentSize;
138 set size(value: '' | NbComponentSize);
139 _size: '' | NbComponentSize;
140 /**
141 * Card status:
142 * `basic`, `primary`, `info`, `success`, `warning`, `danger`, `control`
143 */
144 status: '' | NbComponentOrCustomStatus;
145 /**
146 * Card accent (color of the top border):
147 * `basic`, `primary`, `info`, `success`, `warning`, `danger`, `control`
148 */
149 accent: '' | NbComponentStatus;
150 get tiny(): boolean;
151 get small(): boolean;
152 get medium(): boolean;
153 get large(): boolean;
154 get giant(): boolean;
155 get primary(): boolean;
156 get info(): boolean;
157 get success(): boolean;
158 get warning(): boolean;
159 get danger(): boolean;
160 get basic(): boolean;
161 get control(): boolean;
162 get hasAccent(): "" | NbComponentStatus;
163 get primaryAccent(): boolean;
164 get infoAccent(): boolean;
165 get successAccent(): boolean;
166 get warningAccent(): boolean;
167 get dangerAccent(): boolean;
168 get basicAccent(): boolean;
169 get controlAccent(): boolean;
170 get additionalClasses(): string[];
171 constructor(statusService: NbStatusService);
172 static ɵfac: i0.ɵɵFactoryDeclaration<NbCardComponent, never>;
173 static ɵcmp: i0.ɵɵComponentDeclaration<NbCardComponent, "nb-card", never, { "size": { "alias": "size"; "required": false; }; "status": { "alias": "status"; "required": false; }; "accent": { "alias": "accent"; "required": false; }; }, {}, never, ["nb-card-header", "nb-card-body", "*", "nb-card-footer"], false, never>;
174}