index.d.ts 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. import * as React from 'react';
  2. import type { Breakpoint } from '../_util/responsiveObserver';
  3. import DescriptionsContext from './DescriptionsContext';
  4. import type { DescriptionsItemProps } from './Item';
  5. import DescriptionsItem from './Item';
  6. interface CompoundedComponent {
  7. Item: typeof DescriptionsItem;
  8. }
  9. export interface InternalDescriptionsItemType extends Omit<DescriptionsItemProps, 'span'> {
  10. key?: React.Key;
  11. filled?: boolean;
  12. span?: number;
  13. }
  14. export interface DescriptionsItemType extends Omit<DescriptionsItemProps, 'prefixCls'> {
  15. key?: React.Key;
  16. }
  17. type SemanticName = 'root' | 'header' | 'title' | 'extra' | 'label' | 'content';
  18. export interface DescriptionsProps {
  19. prefixCls?: string;
  20. className?: string;
  21. rootClassName?: string;
  22. style?: React.CSSProperties;
  23. bordered?: boolean;
  24. size?: 'middle' | 'small' | 'default';
  25. /**
  26. * @deprecated use `items` instead
  27. */
  28. children?: React.ReactNode;
  29. title?: React.ReactNode;
  30. extra?: React.ReactNode;
  31. column?: number | Partial<Record<Breakpoint, number>>;
  32. layout?: 'horizontal' | 'vertical';
  33. colon?: boolean;
  34. labelStyle?: React.CSSProperties;
  35. contentStyle?: React.CSSProperties;
  36. styles?: Partial<Record<SemanticName, React.CSSProperties>>;
  37. classNames?: Partial<Record<SemanticName, string>>;
  38. items?: DescriptionsItemType[];
  39. id?: string;
  40. }
  41. declare const Descriptions: React.FC<DescriptionsProps> & CompoundedComponent;
  42. export type { DescriptionsContextProps } from './DescriptionsContext';
  43. export { DescriptionsContext };
  44. export default Descriptions;