src/input/text-input-label.component.ts
Get started with importing the module:
import { InputModule } from 'carbon-components-angular';<cds-text-label>
Label
<input cdsText type="text" class="input-field">
</cds-text-label>
AfterViewInit
| selector | cds-text-label, ibm-text-label |
| template | |
Properties |
|
Methods |
|
Inputs |
HostBindings |
constructor(changeDetectorRef: ChangeDetectorRef)
|
||||||
|
Defined in src/input/text-input-label.component.ts:139
|
||||||
|
Creates an instance of Label.
Parameters :
|
| ariaLabel | |
Type : string
|
|
|
Defined in src/input/text-input-label.component.ts:134
|
|
|
Set the arialabel for label |
|
| disabled | |
Type : boolean
|
|
Default value : false
|
|
|
Defined in src/input/text-input-label.component.ts:99
|
|
|
Set to |
|
| helperText | |
Type : string | TemplateRef<any>
|
|
|
Defined in src/input/text-input-label.component.ts:114
|
|
|
Optional helper text that appears under the label. |
|
| invalid | |
Type : boolean
|
|
Default value : false
|
|
|
Defined in src/input/text-input-label.component.ts:122
|
|
|
Set to |
|
| invalidText | |
Type : string | TemplateRef<any>
|
|
|
Defined in src/input/text-input-label.component.ts:118
|
|
|
Sets the invalid text. |
|
| labelInputID | |
Type : string
|
|
Default value : "ibm-text-input-" + TextInputLabelComponent.labelCounter++
|
|
|
Defined in src/input/text-input-label.component.ts:94
|
|
|
The id of the input item associated with the |
|
| labelTemplate | |
Type : TemplateRef<any>
|
|
|
Defined in src/input/text-input-label.component.ts:109
|
|
|
Helper input property for ease of migration Since we cannot pass ng-content down easily from label component, we will accept the templates |
|
| skeleton | |
Type : boolean
|
|
Default value : false
|
|
|
Defined in src/input/text-input-label.component.ts:103
|
|
|
Set to |
|
| textInputTemplate | |
Type : TemplateRef<any>
|
|
|
Defined in src/input/text-input-label.component.ts:110
|
|
| warn | |
Type : boolean
|
|
Default value : false
|
|
|
Defined in src/input/text-input-label.component.ts:126
|
|
|
Set to |
|
| warnText | |
Type : string | TemplateRef<any>
|
|
|
Defined in src/input/text-input-label.component.ts:130
|
|
|
Sets the warning text |
|
| class.cds--form-item |
Type : boolean
|
Default value : true
|
|
Defined in src/input/text-input-label.component.ts:139
|
| Public isTemplate | ||||
isTemplate(value)
|
||||
|
Defined in src/input/text-input-label.component.ts:174
|
||||
|
Parameters :
Returns :
boolean
|
| ngAfterViewInit |
ngAfterViewInit()
|
|
Defined in src/input/text-input-label.component.ts:149
|
|
Sets the id on the input item associated with the
Returns :
void
|
| labelClass |
Default value : true
|
Decorators :
@HostBinding('class.cds--form-item')
|
|
Defined in src/input/text-input-label.component.ts:139
|
| Static labelCounter |
Type : number
|
Default value : 0
|
|
Defined in src/input/text-input-label.component.ts:89
|
|
Used to build the id of the input item associated with the |
| wrapper |
Type : ElementRef<HTMLDivElement>
|
Decorators :
@ViewChild('wrapper', {static: false})
|
|
Defined in src/input/text-input-label.component.ts:137
|
import {
Component,
Input,
AfterViewInit,
ElementRef,
HostBinding,
TemplateRef,
ViewChild,
ChangeDetectorRef
} from "@angular/core";
/**
* Get started with importing the module:
*
* ```typescript
* import { InputModule } from 'carbon-components-angular';
* ```
*
* ```html
* <cds-text-label>
* Label
* <input cdsText type="text" class="input-field">
* </cds-text-label>
* ```
*
* [See demo](../../?path=/story/components-input--basic)
*/
@Component({
selector: "cds-text-label, ibm-text-label",
template: `
<label
[for]="labelInputID"
[attr.aria-label]="ariaLabel"
class="cds--label"
[ngClass]="{
'cds--label--disabled': disabled,
'cds--skeleton': skeleton
}">
<ng-template *ngIf="labelTemplate; else labelContent" [ngTemplateOutlet]="labelTemplate"></ng-template>
<ng-template #labelContent>
<ng-content></ng-content>
</ng-template>
</label>
<div
class="cds--text-input__field-wrapper"
[ngClass]="{
'cds--text-input__field-wrapper--warning': warn
}"
[attr.data-invalid]="(invalid ? true : null)"
#wrapper>
<svg
*ngIf="invalid"
cdsIcon="warning--filled"
size="16"
class="cds--text-input__invalid-icon">
</svg>
<svg
*ngIf="!invalid && warn"
cdsIcon="warning--alt--filled"
size="16"
class="cds--text-input__invalid-icon cds--text-input__invalid-icon--warning">
</svg>
<ng-template *ngIf="textInputTemplate; else textInputContent" [ngTemplateOutlet]="textInputTemplate"></ng-template>
<ng-template #textInputContent>
<ng-content select="[cdsText],[ibmText],input[type=text],div"></ng-content>
</ng-template>
</div>
<div
*ngIf="!skeleton && helperText && !invalid && !warn"
class="cds--form__helper-text"
[ngClass]="{'cds--form__helper-text--disabled': disabled}">
<ng-container *ngIf="!isTemplate(helperText)">{{helperText}}</ng-container>
<ng-template *ngIf="isTemplate(helperText)" [ngTemplateOutlet]="helperText"></ng-template>
</div>
<div *ngIf="invalid" class="cds--form-requirement">
<ng-container *ngIf="!isTemplate(invalidText)">{{invalidText}}</ng-container>
<ng-template *ngIf="isTemplate(invalidText)" [ngTemplateOutlet]="invalidText"></ng-template>
</div>
<div *ngIf="!invalid && warn" class="cds--form-requirement">
<ng-container *ngIf="!isTemplate(warnText)">{{warnText}}</ng-container>
<ng-template *ngIf="isTemplate(warnText)" [ngTemplateOutlet]="warnText"></ng-template>
</div>
`
})
export class TextInputLabelComponent implements AfterViewInit {
/**
* Used to build the id of the input item associated with the `Label`.
*/
static labelCounter = 0;
/**
* The id of the input item associated with the `Label`. This value is also used to associate the `Label` with
* its input counterpart through the 'for' attribute.
*/
@Input() labelInputID = "ibm-text-input-" + TextInputLabelComponent.labelCounter++;
/**
* Set to `true` for a disabled label.
*/
@Input() disabled = false;
/**
* Set to `true` for a loading label.
*/
@Input() skeleton = false;
/**
* Helper input property for ease of migration
* Since we cannot pass ng-content down easily from label component, we will accept the templates
*/
@Input() labelTemplate: TemplateRef<any>;
@Input() textInputTemplate: TemplateRef<any>;
/**
* Optional helper text that appears under the label.
*/
@Input() helperText: string | TemplateRef<any>;
/**
* Sets the invalid text.
*/
@Input() invalidText: string | TemplateRef<any>;
/**
* Set to `true` for an invalid label component.
*/
@Input() invalid = false;
/**
* Set to `true` to show a warning (contents set by warningText)
*/
@Input() warn = false;
/**
* Sets the warning text
*/
@Input() warnText: string | TemplateRef<any>;
/**
* Set the arialabel for label
*/
@Input() ariaLabel: string;
// @ts-ignore
@ViewChild("wrapper", { static: false }) wrapper: ElementRef<HTMLDivElement>;
@HostBinding("class.cds--form-item") labelClass = true;
/**
* Creates an instance of Label.
*/
constructor(protected changeDetectorRef: ChangeDetectorRef) {}
/**
* Sets the id on the input item associated with the `Label`.
*/
ngAfterViewInit() {
if (this.wrapper) {
// Prioritize setting id to `input` over div
const inputElement = this.wrapper.nativeElement.querySelector("input");
if (inputElement) {
// avoid overriding ids already set by the user reuse it instead
if (inputElement.id) {
this.labelInputID = inputElement.id;
this.changeDetectorRef.detectChanges();
}
inputElement.setAttribute("id", this.labelInputID);
return;
}
const divElement = this.wrapper.nativeElement.querySelector("div");
if (divElement) {
if (divElement.id) {
this.labelInputID = divElement.id;
this.changeDetectorRef.detectChanges();
}
divElement.setAttribute("id", this.labelInputID);
}
}
}
public isTemplate(value) {
return value instanceof TemplateRef;
}
}