carbon-components-angular/input/label.component.d.ts

Next generation components

/**
 *
 * carbon-angular v0.0.0 | label.component.d.ts
 *
 * Copyright 2014, 2026 IBM
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0

 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


import { AfterViewInit, ElementRef, TemplateRef, AfterContentInit, ChangeDetectorRef } from "@angular/core";
import { TextArea } from "./text-area.directive";
import { TextInput } from "./input.directive";
import { PasswordInput } from "./password.directive";
import * as i0 from "@angular/core";
/**
 * Get started with importing the module:
 *
 * ```typescript
 * import { InputModule } from 'carbon-components-angular';
 * ```
 *
 * To prevent attribute drilling, use `ibm-text-label` or `ibm-textarea-label` components
 *
 * ```html
 * <cds-label>
 * 	Label
 * 	<input cdsText type="text" class="input-field">
 * </cds-label>
 * ```
 *
 * [See demo](../../?path=/story/components-input--basic)
 */
export declare class Label implements AfterContentInit, AfterViewInit {
    protected changeDetectorRef: ChangeDetectorRef;
    /**
     * Used to build the id of the input item associated with the `Label`.
     */
    static labelCounter: number;
    /**
     * 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.
     */
    labelInputID: string;
    /**
     * Set to `true` for disabled state.
     */
    disabled: boolean;
    /**
     * Set to `true` for a loading label.
     */
    skeleton: boolean;
    /**
     * Optional helper text that appears under the label.
     */
    helperText: string | TemplateRef<any>;
    /**
     * Sets the invalid text.
     */
    invalidText: string | TemplateRef<any>;
    /**
     * Set to `true` for an invalid label component.
     */
    invalid: boolean;
    /**
     * Set to `true` to show a warning (contents set by warningText)
     */
    warn: boolean;
    /**
     * Sets the warning text
     */
    warnText: string | TemplateRef<any>;
    /**
     * Set the arialabel for label
     */
    ariaLabel: string;
    /**
     * Set to `true` to hide the label visually, but keep accessible to
     * screen readers.
     */
    hideLabel: boolean;
    /**
     * Set to `true` to render the label and field side-by-side instead of stacked.
     * Applies to `TextInput` and `PasswordInput` label variants.
     */
    inline: boolean;
    /**
     * The render size for the `TextInput`. Used to compute INLINE label size
     * variant classes.
     */
    size: "sm" | "md" | "lg";
    /**
     * Set to `true` (`maxCount` must be set) to displays a live character/word
     * counter alongside the label.
     */
    enableCounter: boolean;
    /**
     * Maximum number of characters (or words) allowed. Required for the
     * counter to display.
     */
    maxCount: number;
    /**
     * Determines whether the `TextArea` counter counts characters or words.
     */
    counterMode: "character" | "word";
    wrapper: ElementRef<HTMLDivElement>;
    textArea: TextArea;
    textInput: TextInput;
    passwordInput: PasswordInput;
    get labelClass(): boolean;
    type: "TextArea" | "TextInput" | "PasswordInput";
    /**
     * Creates an instance of Label.
     */
    constructor(changeDetectorRef: ChangeDetectorRef);
    /**
     * Update wrapper class if a textarea is hosted.
     */
    ngAfterContentInit(): void;
    /**
     * Sets the id on the input item associated with the `Label`.
     */
    ngAfterViewInit(): void;
    isTemplate(value: any): boolean;
    static ɵfac: i0.ɵɵFactoryDeclaration<Label, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<Label, "cds-label, ibm-label", never, { "labelInputID": "labelInputID"; "disabled": "disabled"; "skeleton": "skeleton"; "helperText": "helperText"; "invalidText": "invalidText"; "invalid": "invalid"; "warn": "warn"; "warnText": "warnText"; "ariaLabel": "ariaLabel"; "hideLabel": "hideLabel"; "inline": "inline"; "size": "size"; "enableCounter": "enableCounter"; "maxCount": "maxCount"; "counterMode": "counterMode"; }, {}, ["textArea", "textInput", "passwordInput"], ["input,textarea,div", "*"], false>;
}