UNPKG

@nebular/theme

Version:
160 lines (159 loc) 4.57 kB
/** * @license * Copyright Akveo. All Rights Reserved. * Licensed under the MIT License. See License.txt in the project root for license information. */ import { NbComponentSize } from '../component-size'; import { NbComponentStatus } from '../component-status'; /** * Component intended to be used within the `<nb-card>` component. * It adds styles for a preset header section. * * @styles * * card-header-text-color: * card-header-text-font-family: * card-header-text-font-size: * card-header-text-font-weight: * card-header-text-line-height: * card-header-primary-background-color: * card-header-primary-text-color: * card-header-info-background-color: * card-header-info-text-color: * card-header-success-background-color: * card-header-success-text-color: * card-header-warning-background-color: * card-header-warning-text-color: * card-header-danger-background-color: * card-header-danger-text-color: */ export declare class NbCardHeaderComponent { } /** * Component intended to be used within the `<nb-card>` component. * Adds styles for a preset body section. */ export declare class NbCardBodyComponent { } /** * Component intended to be used within the `<nb-card>` component. * Adds styles for a preset footer section. */ export declare class NbCardFooterComponent { } /** * Basic content container component. * * Basic card example: * @stacked-example(Showcase, card/card-showcase.component) * * Basic card configuration: * * ```html * <nb-card> * <nb-card-body> * Card * </nb-card-body> * </nb-card> * ``` * * ### Installation * * Import `NbCardModule` to your feature module. * ```ts * @NgModule({ * imports: [ * // ... * NbCardModule, * ], * }) * export class PageModule { } * ``` * ### Usage * * Card with header and footer: * @stacked-example(With Header & Footer, card/card-full.component) * * Most of the time main card content goes to `nb-card-body`, * so it is styled and aligned in accordance with the header and footer. * In case you need a higher level of control, you can pass contend directly to `nb-card`, * so `nb-card-body` styling will not be applied. * * Consider an example with `nb-list` component: * @stacked-example(Card with list, card/card-without-body.component) * * Colored cards could be simply configured by providing a `status` property: * @stacked-example(Colored Card, card/card-colors.component) * * It is also possible to assign an `accent` property for a slight card highlight * as well as combine it with `status`: * @stacked-example(Accent Card, card/card-accents.component) * * Cards of smaller sizes could be combined and put on the same row with a bigger card so they have the same heights. * @stacked-example(Card sizes combinations, card/card-sizes-combinations.component) * * @additional-example(Multiple Sizes, card/card-sizes.component) * * @styles * * card-background-color: * card-text-color: * card-text-font-family: * card-text-font-size: * card-text-font-weight: * card-text-line-height: * card-border-width: * card-border-style: * card-border-color: * card-border-radius: * card-padding: * card-shadow: * card-divider-color: * card-divider-style: * card-divider-width: * card-height-tiny: * card-height-small: * card-height-medium: * card-height-large: * card-height-giant: * card-margin-bottom: * card-scrollbar-color: * card-scrollbar-background-color: * card-scrollbar-width: */ export declare class NbCardComponent { /** * Card size, available sizes: * tiny, small, medium, large, giant */ size: '' | NbComponentSize; _size: '' | NbComponentSize; /** * Card status: * primary, info, success, warning, danger */ status: '' | NbComponentStatus; _status: '' | NbComponentStatus; /** * Card accent (color of the top border): * primary, info, success, warning, danger */ accent: '' | NbComponentStatus; _accent: '' | NbComponentStatus; readonly tiny: boolean; readonly small: boolean; readonly medium: boolean; readonly large: boolean; readonly giant: boolean; readonly primary: boolean; readonly info: boolean; readonly success: boolean; readonly warning: boolean; readonly danger: boolean; readonly hasAccent: "" | "primary" | "success" | "warning" | "danger" | "info"; readonly primaryAccent: boolean; readonly infoAccent: boolean; readonly successAccent: boolean; readonly warningAccent: boolean; readonly dangerAccent: boolean; }