description.d.ts 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. import { EpPropFinalized, EpPropMergeType } from "../../../utils/vue/props/types.js";
  2. import { ComponentSize } from "../../../constants/size.js";
  3. import "../../../utils/index.js";
  4. import { _default } from "./description.vue.js";
  5. import * as vue from "vue";
  6. import { ExtractPublicPropTypes } from "vue";
  7. //#region ../../packages/components/descriptions/src/description.d.ts
  8. interface DescriptionProps {
  9. /**
  10. * @description with or without border
  11. * @default false
  12. */
  13. border?: boolean;
  14. /**
  15. * @description numbers of `Descriptions Item` in one line
  16. * @default 3
  17. */
  18. column?: number;
  19. /**
  20. * @description direction of list
  21. * @default 'horizontal'
  22. */
  23. direction?: 'horizontal' | 'vertical';
  24. /**
  25. * @description size of list
  26. * @default ''
  27. */
  28. size?: ComponentSize;
  29. /**
  30. * @description title text, display on the top left
  31. * @default ''
  32. */
  33. title?: string;
  34. /**
  35. * @description extra text, display on the top right
  36. * @default ''
  37. */
  38. extra?: string;
  39. /**
  40. * @description width of every label column
  41. */
  42. labelWidth?: string | number;
  43. }
  44. /**
  45. * @deprecated Removed after 3.0.0, Use `DescriptionProps` instead.
  46. */
  47. declare const descriptionProps: {
  48. readonly border: BooleanConstructor;
  49. readonly column: EpPropFinalized<NumberConstructor, unknown, unknown, 3, boolean>;
  50. readonly direction: EpPropFinalized<StringConstructor, "horizontal" | "vertical", unknown, "horizontal", boolean>;
  51. readonly size: {
  52. readonly type: vue.PropType<EpPropMergeType<StringConstructor, "" | "default" | "small" | "large", never>>;
  53. readonly required: false;
  54. readonly validator: ((val: unknown) => boolean) | undefined;
  55. __epPropKey: true;
  56. };
  57. readonly title: EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
  58. readonly extra: EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
  59. readonly labelWidth: {
  60. readonly type: vue.PropType<EpPropMergeType<readonly [StringConstructor, NumberConstructor], unknown, unknown>>;
  61. readonly required: false;
  62. readonly validator: ((val: unknown) => boolean) | undefined;
  63. __epPropKey: true;
  64. };
  65. };
  66. /**
  67. * @deprecated Removed after 3.0.0, Use `DescriptionProps` instead.
  68. */
  69. type DescriptionPropsPublic = ExtractPublicPropTypes<typeof descriptionProps>;
  70. type DescriptionInstance = InstanceType<typeof _default> & unknown;
  71. //#endregion
  72. export { DescriptionInstance, DescriptionProps, DescriptionPropsPublic, descriptionProps };