@veracity/vui/dist/label/label.types.d.ts

Veracity UI is a React component library crafted for use within Veracity applications and pages. Based on Styled Components and @xstyled.

import { ThemingProps } from "../theme/types.js";
import { SystemProps } from "../system/system.js";
import { ReactNode } from "react";

//#region src/label/label.types.d.ts
type LabelProps = SystemProps & ThemingProps<'P'> & {
  /** Displays given text, if no children are provided. */text?: string; /** Displays an optional indication next to the label text. Only takes effect when `text` is also provided. */
  markAsOptional?: boolean; /** Overrides the text shown for the optional indicator. Defaults to `"(optional)"`. Only takes effect when `markAsOptional` and `text` are provided. */
  optionalText?: string; /** Displays a tooltip icon next to the label text. Only takes effect when `text` is also provided. */
  tooltipText?: ReactNode;
};
//#endregion
export { LabelProps };

//# sourceMappingURL=label.types.d.ts.map