@workday/canvas-kit-react/dist/commonjs/text/lib/LabelText.d.ts

The parent module that contains all Workday Canvas Kit React components

import { system } from '@workday/canvas-tokens-web';
import { BoxProps } from '@workday/canvas-kit-react/layout';
/**
 * @deprecated ⚠️ `TypeLabelProps` has been deprecated and will be removed in a future major version.
 */
export interface TypeLabelProps extends BoxProps {
    typeLevel?: `${keyof typeof system.type}.${'large' | 'medium' | 'small'}`;
    /**
     * Disabled state as a boolean
     *
     * ```tsx
     * <LabelText disabled={true}>Error text</LabelText>
     * ```
     */
    disabled?: boolean;
    /**
     * Type variant token names: `error`, `hint` or `inverse`.
     *
     * ```tsx
     * <LabelText variant="error">Error text</LabelText>
     * ```
     */
    variant?: 'error' | 'hint' | 'inverse';
}
/**
 * This component is intended to be used for labeling input fields.
 * By default, it renders a semantic `label` element.
 *
 * It also uses the `subtext.large` typeLevel by default:
 * - font-size: 14px (0.875rem)
 * - font-weight: regular (400)
 *
 * ```tsx
 * import { LabelText } from '@workday/canvas-kit-react/text';
 *
 * const CustomLabelText = () => (
 *   <LabelText>Input Label Text</LabelText>
 * );
 * ```
 *
 * @deprecated ⚠️ `LabelText` has been deprecated and will be removed in a future major version. Please use [FormField.Label](https://workday.github.io/canvas-kit/?path=/docs/preview-inputs-form-field--basic) from Preview instead.
 */
export declare const LabelText: import("@workday/canvas-kit-react/common").ElementComponent<"label", TypeLabelProps>;
//# sourceMappingURL=LabelText.d.ts.map