ipsos-components/src/lib/core/label/label-options.ts

Material Design components for Angular

/**
 * @license
 * Copyright Google LLC All Rights Reserved.
 *
 * Use of this source code is governed by an MIT-style license that can be
 * found in the LICENSE file at https://angular.io/license
 */

import {InjectionToken} from '@angular/core';

/** InjectionToken that can be used to specify the global label options. */
export const MAT_LABEL_GLOBAL_OPTIONS =
  new InjectionToken<LabelOptions>('mat-label-global-options');

/** Type for the available floatLabel values. */
export type FloatLabelType = 'always' | 'never' | 'auto';

/** Configurable options for floating labels. */
export interface LabelOptions {
  /**
   * Whether the label should float `always`, `never`, or `auto` (only when necessary).
   * Default behavior is assumed to be `auto`.
   */
  float?: FloatLabelType;
}