avatar-group-props.d.ts 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178
  1. import { EpPropFinalized, EpPropMergeType } from "../../../utils/vue/props/types.js";
  2. import { PopperEffect } from "../../popper/src/popper.js";
  3. import { Placement } from "../../popper/index.js";
  4. import * as _$vue from "vue";
  5. import { ExtractPropTypes, ExtractPublicPropTypes, StyleValue } from "vue";
  6. //#region ../../packages/components/avatar/src/avatar-group-props.d.ts
  7. declare const avatarGroupProps: {
  8. /**
  9. * @description control the size of avatars in this avatar-group
  10. */
  11. readonly size: {
  12. readonly type: _$vue.PropType<number | "" | "default" | "small" | "large" | undefined>;
  13. readonly values: readonly ["", "default", "small", "large"];
  14. readonly validator: (val: unknown) => val is number;
  15. };
  16. /**
  17. * @description control the shape of avatars in this avatar-group
  18. */
  19. readonly shape: {
  20. readonly type: _$vue.PropType<"square" | "circle" | undefined>;
  21. readonly values: readonly ["circle", "square"];
  22. };
  23. /**
  24. * @description whether to collapse avatars
  25. */
  26. readonly collapseAvatars: BooleanConstructor;
  27. /**
  28. * @description whether show all collapsed avatars when mouse hover text of the collapse-avatar. To use this, `collapse-avatars` must be true
  29. */
  30. readonly collapseAvatarsTooltip: BooleanConstructor;
  31. /**
  32. * @description the max avatars number to be shown. To use this, `collapse-avatars` must be true
  33. */
  34. readonly maxCollapseAvatars: {
  35. readonly type: NumberConstructor;
  36. readonly default: 1;
  37. };
  38. /**
  39. * @description tooltip theme, built-in theme: `dark` / `light`
  40. */
  41. readonly effect: {
  42. readonly type: _$vue.PropType<PopperEffect>;
  43. readonly default: "light";
  44. };
  45. /**
  46. * @description placement of tooltip
  47. */
  48. readonly placement: {
  49. readonly type: _$vue.PropType<Placement>;
  50. readonly values: Placement[];
  51. readonly default: "top";
  52. };
  53. /**
  54. * @description custom class name for tooltip
  55. */
  56. readonly popperClass: {
  57. readonly type: _$vue.PropType<EpPropMergeType<(new (...args: any[]) => string | {
  58. [x: string]: boolean;
  59. } | (string | {
  60. [x: string]: boolean;
  61. } | (string | {
  62. [x: string]: boolean;
  63. } | (string | {
  64. [x: string]: boolean;
  65. } | (string | {
  66. [x: string]: boolean;
  67. } | (string | {
  68. [x: string]: boolean;
  69. } | (string | {
  70. [x: string]: boolean;
  71. } | (string | {
  72. [x: string]: boolean;
  73. } | (string | {
  74. [x: string]: boolean;
  75. } | (string | {
  76. [x: string]: boolean;
  77. } | (string | {
  78. [x: string]: boolean;
  79. } | (string | {
  80. [x: string]: boolean;
  81. } | /*elided*/any)[])[])[])[])[])[])[])[])[])[])[]) | (() => string | {
  82. [x: string]: boolean;
  83. } | (string | {
  84. [x: string]: boolean;
  85. } | (string | {
  86. [x: string]: boolean;
  87. } | (string | {
  88. [x: string]: boolean;
  89. } | (string | {
  90. [x: string]: boolean;
  91. } | (string | {
  92. [x: string]: boolean;
  93. } | (string | {
  94. [x: string]: boolean;
  95. } | (string | {
  96. [x: string]: boolean;
  97. } | (string | {
  98. [x: string]: boolean;
  99. } | (string | {
  100. [x: string]: boolean;
  101. } | (string | {
  102. [x: string]: boolean;
  103. } | (string | {
  104. [x: string]: boolean;
  105. } | /*elided*/any)[])[])[])[])[])[])[])[])[])[])[]) | (((new (...args: any[]) => string | {
  106. [x: string]: boolean;
  107. } | (string | {
  108. [x: string]: boolean;
  109. } | (string | {
  110. [x: string]: boolean;
  111. } | (string | {
  112. [x: string]: boolean;
  113. } | (string | {
  114. [x: string]: boolean;
  115. } | (string | {
  116. [x: string]: boolean;
  117. } | (string | {
  118. [x: string]: boolean;
  119. } | (string | {
  120. [x: string]: boolean;
  121. } | (string | {
  122. [x: string]: boolean;
  123. } | (string | {
  124. [x: string]: boolean;
  125. } | (string | {
  126. [x: string]: boolean;
  127. } | (string | {
  128. [x: string]: boolean;
  129. } | /*elided*/any)[])[])[])[])[])[])[])[])[])[])[]) | (() => string | {
  130. [x: string]: boolean;
  131. } | (string | {
  132. [x: string]: boolean;
  133. } | (string | {
  134. [x: string]: boolean;
  135. } | (string | {
  136. [x: string]: boolean;
  137. } | (string | {
  138. [x: string]: boolean;
  139. } | (string | {
  140. [x: string]: boolean;
  141. } | (string | {
  142. [x: string]: boolean;
  143. } | (string | {
  144. [x: string]: boolean;
  145. } | (string | {
  146. [x: string]: boolean;
  147. } | (string | {
  148. [x: string]: boolean;
  149. } | (string | {
  150. [x: string]: boolean;
  151. } | (string | {
  152. [x: string]: boolean;
  153. } | /*elided*/any)[])[])[])[])[])[])[])[])[])[])[])) | null)[], unknown, unknown>>;
  154. readonly required: false;
  155. readonly validator: ((val: unknown) => boolean) | undefined;
  156. __epPropKey: true;
  157. };
  158. /**
  159. * @description custom style for tooltip
  160. */
  161. readonly popperStyle: EpPropFinalized<(new (...args: any[]) => string | false | _$vue.CSSProperties | StyleValue[]) | (() => StyleValue) | (((new (...args: any[]) => string | false | _$vue.CSSProperties | StyleValue[]) | (() => StyleValue)) | null)[], unknown, unknown, undefined, boolean>;
  162. /**
  163. * @description custom class name for the collapse-avatar
  164. */
  165. readonly collapseClass: StringConstructor;
  166. /**
  167. * @description custom style for the collapse-avatar
  168. */
  169. readonly collapseStyle: {
  170. readonly type: _$vue.PropType<StyleValue>;
  171. readonly default: undefined;
  172. };
  173. };
  174. type AvatarGroupProps = ExtractPropTypes<typeof avatarGroupProps>;
  175. type AvatarGroupPropsPublic = ExtractPublicPropTypes<typeof avatarGroupProps>;
  176. //#endregion
  177. export { AvatarGroupProps, AvatarGroupPropsPublic, avatarGroupProps };