@nebular/theme
Version:
@nebular/theme
257 lines (256 loc) • 9.36 kB
TypeScript
/**
* @license
* Copyright Akveo. All Rights Reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*/
import { OnDestroy, OnInit, ElementRef, SimpleChanges, OnChanges, DoCheck, AfterViewInit, Renderer2, NgZone } from '@angular/core';
import { Subject, BehaviorSubject } from 'rxjs';
import { NbStatusService } from '../../services/status.service';
import { NbBooleanInput } from '../helpers';
import { NbComponentSize } from '../component-size';
import { NbComponentShape } from '../component-shape';
import { NbComponentOrCustomStatus } from '../component-status';
import { NbFormFieldControl } from '../form-field/form-field-control';
import { NbFocusMonitor } from '../cdk/a11y/a11y.module';
/**
* Basic input directive.
*
* ```html
* <input nbInput></input>
* ```
*
* ### Installation
*
* Import `NbInputModule` to your feature module.
* ```ts
* @NgModule({
* imports: [
* // ...
* NbInputModule,
* ],
* })
* export class PageModule { }
* ```
* ### Usage
*
* Default input size is `medium`:
* @stacked-example(Showcase, input/input-showcase.component)
*
* Inputs are available in multiple colors using `status` property:
* @stacked-example(Input Colors, input/input-colors.component)
*
* There are three input sizes:
*
* @stacked-example(Input Sizes, input/input-sizes.component)
*
* Inputs available in different shapes, which could be combined with the other properties:
* @stacked-example(Input Shapes, input/input-shapes.component)
*
* `nbInput` could be applied to the following selectors - `input`, `textarea`:
* @stacked-example(Input Elements, input/input-types.component)
*
* You can add `fullWidth` attribute to make element fill container:
* @stacked-example(Full width inputs, input/input-full-width.component)
*
* Or you can bind control with form controls or ngModel:
* @stacked-example(Input form binding, input/input-form.component)
*
* Use `<nb-form-field>` to add custom content to the input field.
* First import `NbFormFieldModule`. Then put the input field and custom content into
* `<nb-form-field>` and add `nbPrefix` or `nbSuffix` directive to the custom content.
* `nbPrefix` puts content before input and `nbSuffix` after.
*
* @stacked-example(Input with icon, form-field/form-field-input.component)
* @stacked-example(Input with button, form-field/form-field-password.component)
*
* @styles
*
* input-border-style:
* input-border-width:
* input-outline-color:
* input-outline-width:
* input-placeholder-text-font-family:
* input-text-font-family:
* input-basic-text-color:
* input-basic-placeholder-text-color:
* input-basic-background-color:
* input-basic-border-color:
* input-basic-focus-background-color:
* input-basic-focus-border-color:
* input-basic-hover-background-color:
* input-basic-hover-border-color:
* input-basic-disabled-background-color:
* input-basic-disabled-border-color:
* input-basic-disabled-text-color:
* input-basic-disabled-placeholder-text-color:
* input-primary-text-color:
* input-primary-placeholder-text-color:
* input-primary-background-color:
* input-primary-border-color:
* input-primary-focus-background-color:
* input-primary-focus-border-color:
* input-primary-hover-background-color:
* input-primary-hover-border-color:
* input-primary-disabled-background-color:
* input-primary-disabled-border-color:
* input-primary-disabled-text-color:
* input-primary-disabled-placeholder-text-color:
* input-success-text-color:
* input-success-placeholder-text-color:
* input-success-background-color:
* input-success-border-color:
* input-success-focus-background-color:
* input-success-focus-border-color:
* input-success-hover-background-color:
* input-success-hover-border-color:
* input-success-disabled-background-color:
* input-success-disabled-border-color:
* input-success-disabled-text-color:
* input-success-disabled-placeholder-text-color:
* input-info-text-color:
* input-info-placeholder-text-color:
* input-info-background-color:
* input-info-border-color:
* input-info-focus-background-color:
* input-info-focus-border-color:
* input-info-hover-background-color:
* input-info-hover-border-color:
* input-info-disabled-background-color:
* input-info-disabled-border-color:
* input-info-disabled-text-color:
* input-info-disabled-placeholder-text-color:
* input-warning-text-color:
* input-warning-placeholder-text-color:
* input-warning-background-color:
* input-warning-border-color:
* input-warning-focus-background-color:
* input-warning-focus-border-color:
* input-warning-hover-background-color:
* input-warning-hover-border-color:
* input-warning-disabled-background-color:
* input-warning-disabled-border-color:
* input-warning-disabled-text-color:
* input-warning-disabled-placeholder-text-color:
* input-danger-text-color:
* input-danger-placeholder-text-color:
* input-danger-background-color:
* input-danger-border-color:
* input-danger-focus-background-color:
* input-danger-focus-border-color:
* input-danger-hover-background-color:
* input-danger-hover-border-color:
* input-danger-disabled-background-color:
* input-danger-disabled-border-color:
* input-danger-disabled-text-color:
* input-danger-disabled-placeholder-text-color:
* input-control-text-color:
* input-control-placeholder-text-color:
* input-control-background-color:
* input-control-border-color:
* input-control-focus-background-color:
* input-control-focus-border-color:
* input-control-hover-background-color:
* input-control-hover-border-color:
* input-control-disabled-background-color:
* input-control-disabled-border-color:
* input-control-disabled-text-color:
* input-control-disabled-placeholder-text-color:
* input-rectangle-border-radius:
* input-semi-round-border-radius:
* input-round-border-radius:
* input-tiny-text-font-size:
* input-tiny-text-font-weight:
* input-tiny-text-line-height:
* input-tiny-placeholder-text-font-size:
* input-tiny-placeholder-text-font-weight:
* input-tiny-placeholder-text-line-height:
* input-tiny-padding:
* input-tiny-max-width:
* input-small-text-font-size:
* input-small-text-font-weight:
* input-small-text-line-height:
* input-small-placeholder-text-font-size:
* input-small-placeholder-text-font-weight:
* input-small-placeholder-text-line-height:
* input-small-padding:
* input-small-max-width:
* input-medium-text-font-size:
* input-medium-text-font-weight:
* input-medium-text-line-height:
* input-medium-placeholder-text-font-size:
* input-medium-placeholder-text-font-weight:
* input-medium-placeholder-text-line-height:
* input-medium-padding:
* input-medium-max-width:
* input-large-text-font-size:
* input-large-text-font-weight:
* input-large-text-line-height:
* input-large-placeholder-text-font-size:
* input-large-placeholder-text-font-weight:
* input-large-placeholder-text-line-height:
* input-large-padding:
* input-large-max-width:
* input-giant-text-font-size:
* input-giant-text-font-weight:
* input-giant-text-line-height:
* input-giant-placeholder-text-font-size:
* input-giant-placeholder-text-font-weight:
* input-giant-placeholder-text-line-height:
* input-giant-padding:
* input-giant-max-width:
*/
export declare class NbInputDirective implements DoCheck, OnChanges, OnInit, AfterViewInit, OnDestroy, NbFormFieldControl {
protected elementRef: ElementRef<HTMLInputElement | HTMLTextAreaElement>;
protected focusMonitor: NbFocusMonitor;
protected renderer: Renderer2;
protected zone: NgZone;
protected statusService: NbStatusService;
protected destroy$: Subject<void>;
/**
* Field size modifications. Possible values: `small`, `medium` (default), `large`.
*/
fieldSize: NbComponentSize;
/**
* Field status (adds specific styles):
* `basic`, `primary`, `info`, `success`, `warning`, `danger`, `control`
*/
status: NbComponentOrCustomStatus;
/**
* Field shapes modifications. Possible values: `rectangle` (default), `round`, `semi-round`.
*/
shape: NbComponentShape;
/**
* If set element will fill container. `false` by default.
*/
get fullWidth(): boolean;
set fullWidth(value: boolean);
private _fullWidth;
static ngAcceptInputType_fullWidth: NbBooleanInput;
get additionalClasses(): string[];
constructor(elementRef: ElementRef<HTMLInputElement | HTMLTextAreaElement>, focusMonitor: NbFocusMonitor, renderer: Renderer2, zone: NgZone, statusService: NbStatusService);
ngDoCheck(): void;
ngOnChanges({ status, fieldSize, fullWidth }: SimpleChanges): void;
ngOnInit(): void;
ngAfterViewInit(): void;
ngOnDestroy(): void;
get tiny(): boolean;
get small(): boolean;
get medium(): boolean;
get large(): boolean;
get giant(): boolean;
get primary(): boolean;
get info(): boolean;
get success(): boolean;
get warning(): boolean;
get danger(): boolean;
get basic(): boolean;
get control(): boolean;
get rectangle(): boolean;
get semiRound(): boolean;
get round(): boolean;
status$: BehaviorSubject<string>;
size$: BehaviorSubject<NbComponentSize>;
focused$: BehaviorSubject<boolean>;
disabled$: BehaviorSubject<boolean>;
fullWidth$: BehaviorSubject<boolean>;
}