@dnb/eufemia
Version:
DNB Eufemia Design System UI Library
39 lines (38 loc) • 1.38 kB
TypeScript
/**
* Web FormLabel Component
*
*/
import React from 'react';
import { FormElementProps } from '../../shared/helpers/filterValidProps';
import type { DynamicElement, SpacingProps } from '../../shared/types';
export type FormLabelProps = {
forId?: string;
element?: DynamicElement<HTMLLabelElement>;
text?: React.ReactNode;
size?: 'basis' | 'medium' | 'large';
id?: string;
skeleton?: boolean;
label?: React.ReactNode;
vertical?: boolean;
srOnly?: boolean;
innerRef?: React.RefObject<HTMLElement>;
/** Is not a part of HTMLLabelElement and not documented as of now */
disabled?: boolean;
/**
* For internal use only
*/
labelDirection?: FormElementProps['labelDirection'];
/** @deprecated use forId instead */
for_id?: string;
/** @deprecated use srOnly instead */
sr_only?: boolean;
/** @deprecated use "vertical" (or "labelDirection" for internal use) instead (was not documented before) */
label_direction?: FormElementProps['label_direction'];
};
export type FormLabelAllProps = FormLabelProps & React.HTMLAttributes<HTMLLabelElement> & SpacingProps;
declare function FormLabel(localProps: FormLabelAllProps): import("react/jsx-runtime").JSX.Element;
declare namespace FormLabel {
var _formElement: boolean;
var _supportsSpacingProps: boolean;
}
export default FormLabel;