/**
 * (c) Copyright Ascensio System SIA 2026
 *
 * 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.
 *
 * @license
 */
/**
 * Field name in the form.
 *
 * @category Label
 *
 * @categoryDescription Content
 *
 * Here is a description of the category Content.
 *
 * @categoryDescription Appearance
 *
 * Here is a description of the category Appearance.
 *
 * @example
 *
 * Required field label with inline display
 *
 * ```typescript
 * const emailLabel: ILabel = {
 *   text: "Email Address",
 *   isRequired: true,
 *   error: false,
 *   isInline: true,
 *   title: "Enter your email address",
 *   htmlFor: "email-input",
 *   display: "flex"
 * }
 * ```
 *
 * @example
 *
 * Error state label with truncation and block display
 *
 * ```typescript
 * const longFieldLabel: ILabel = {
 *   text: "Document Processing Configuration Settings",
 *   isRequired: false,
 *   error: true,
 *   truncate: true,
 *   title: "Configure document processing settings",
 *   htmlFor: "doc-settings",
 *   display: "block"
 * }
 * ```
 */
export interface ILabel {
    /** Defines the element text
     *
     * @category Content
     */
    text: string;
    /** Specifies whether the field to which the label is attached is required
     *
     * @category Appearance
     */
    isRequired?: boolean;
    /** Specifies whether the field to which the label is attached is incorrect
     *
     * @category Content
     */
    error?: boolean;
    /** Specifies whether the "display: inline-block" property is set
    isInline?: boolean;
  
    /** Defines the label title
     *
     * @category Content
     */
    title?: string;
    /** Specifies whether the word wrapping is disabled
     *
     * @category Appearance
     */
    truncate?: boolean;
    /** Defines the field ID to which the label is attached
     *
     * @category Appearance
     */
    htmlFor?: string;
    /** Specifies whether the "display" property is set
     *
     * @category Appearance
     */
    display?: string;
    /**
     * Defines the CSS class for styling the component.
     * Can be used to override or extend the default component styles.
     *
     * @category Appearance
     */
    className?: string;
}