col.d.ts 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. import { EpPropFinalized } from "../../../utils/vue/props/types.js";
  2. import { Mutable } from "../../../utils/typescript.js";
  3. import "../../../utils/index.js";
  4. import { _default } from "./col.vue.js";
  5. import { ExtractPublicPropTypes } from "vue";
  6. //#region ../../packages/components/col/src/col.d.ts
  7. type ColSizeObject = {
  8. span?: number;
  9. offset?: number;
  10. pull?: number;
  11. push?: number;
  12. };
  13. type ColSize = number | ColSizeObject;
  14. interface ColProps {
  15. /**
  16. * @description custom element tag
  17. */
  18. tag?: string;
  19. /**
  20. * @description number of column the grid spans
  21. */
  22. span?: number;
  23. /**
  24. * @description number of spacing on the left side of the grid
  25. */
  26. offset?: number;
  27. /**
  28. * @description number of columns that grid moves to the left
  29. */
  30. pull?: number;
  31. /**
  32. * @description number of columns that grid moves to the right
  33. */
  34. push?: number;
  35. /**
  36. * @description `<768px` Responsive columns or column props object
  37. */
  38. xs?: ColSize;
  39. /**
  40. * @description `≥768px` Responsive columns or column props object
  41. */
  42. sm?: ColSize;
  43. /**
  44. * @description `≥992px` Responsive columns or column props object
  45. */
  46. md?: ColSize;
  47. /**
  48. * @description `≥1200px` Responsive columns or column props object
  49. */
  50. lg?: ColSize;
  51. /**
  52. * @description `≥1920px` Responsive columns or column props object
  53. */
  54. xl?: ColSize;
  55. }
  56. /**
  57. * @deprecated Removed after 3.0.0, Use `ColProps` instead.
  58. */
  59. declare const colProps: {
  60. readonly tag: EpPropFinalized<StringConstructor, unknown, unknown, "div", boolean>;
  61. readonly span: EpPropFinalized<NumberConstructor, unknown, unknown, 24, boolean>;
  62. readonly offset: EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
  63. readonly pull: EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
  64. readonly push: EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
  65. readonly xs: EpPropFinalized<(new (...args: any[]) => number | ColSizeObject) | (() => ColSize) | (((new (...args: any[]) => number | ColSizeObject) | (() => ColSize)) | null)[], unknown, unknown, () => Mutable<{}>, boolean>;
  66. readonly sm: EpPropFinalized<(new (...args: any[]) => number | ColSizeObject) | (() => ColSize) | (((new (...args: any[]) => number | ColSizeObject) | (() => ColSize)) | null)[], unknown, unknown, () => Mutable<{}>, boolean>;
  67. readonly md: EpPropFinalized<(new (...args: any[]) => number | ColSizeObject) | (() => ColSize) | (((new (...args: any[]) => number | ColSizeObject) | (() => ColSize)) | null)[], unknown, unknown, () => Mutable<{}>, boolean>;
  68. readonly lg: EpPropFinalized<(new (...args: any[]) => number | ColSizeObject) | (() => ColSize) | (((new (...args: any[]) => number | ColSizeObject) | (() => ColSize)) | null)[], unknown, unknown, () => Mutable<{}>, boolean>;
  69. readonly xl: EpPropFinalized<(new (...args: any[]) => number | ColSizeObject) | (() => ColSize) | (((new (...args: any[]) => number | ColSizeObject) | (() => ColSize)) | null)[], unknown, unknown, () => Mutable<{}>, boolean>;
  70. };
  71. /**
  72. * @deprecated Removed after 3.0.0, Use `ColProps` instead.
  73. */
  74. type ColPropsPublic = ExtractPublicPropTypes<typeof colProps>;
  75. type ColInstance = InstanceType<typeof _default> & unknown;
  76. //#endregion
  77. export { ColInstance, ColProps, ColPropsPublic, ColSize, ColSizeObject, colProps };