@veracity/vui/dist/definition/definition.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 { IconProp } from "../icon/icon.types.js";
import { JSX, ReactNode } from "react";

//#region src/definition/definition.types.d.ts
type DefinitionItem = SystemProps & {
  key: string;
  keyHasIcon?: boolean;
  value: string | number | string[] | ReactNode;
  valueHasIcon?: boolean;
};
type DefinitionProps = SystemProps & ThemingProps<'Definition'> & {
  /** Icon displayed on the leading (left) side of the content. */startIcon?: IconProp | JSX.Element; /** Icon displayed on the trailing (right) side of the content. */
  endIcon?: IconProp | JSX.Element; /** Deprecated alias for `startIcon`. @deprecated */
  iconLeft?: IconProp | JSX.Element; /** Deprecated alias for `endIcon`. @deprecated */
  iconRight?: IconProp | JSX.Element;
  isLabelBold?: boolean;
  isValueBold?: boolean;
  items?: DefinitionItem[]; /** Socket defining orientation. */
  orientation?: 'horizontal' | 'vertical';
  size?: 'sm' | 'md';
  variant?: 'light' | 'dark';
};
//#endregion
export { DefinitionProps };

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