You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

173 line
5.8 KiB

  1. declare const _default: import("vue-demi").DefineComponent<{
  2. /**
  3. * By default SimpleBar automatically hides the scrollbar if the user is not scrolling
  4. * (it emulates Mac OSX Lion's scrollbar). You can make the scrollbar always visible
  5. * by passing `false`.
  6. *
  7. * Default value is `true`.
  8. *
  9. * You can also control the animation via CSS as it's a simple CSS opacity transition.
  10. */
  11. autoHide: {
  12. type: BooleanConstructor;
  13. default: undefined;
  14. };
  15. /**
  16. * It is possible to change the default class names that SimpleBar uses.
  17. * To get your own styles to work refer to simplebar.css to get an idea how to setup your css.
  18. * - `content` represents the wrapper for the content being scrolled.
  19. * - `scrollContent` represents the container containing the elements being scrolled.
  20. * - `scrollbar` defines the style of the scrollbar with which the user can interact to scroll the content.
  21. * - `track` styles the area surrounding the `scrollbar`.
  22. *
  23. * ```js
  24. * classNames: {
  25. * // defaults
  26. * content: 'simplebar-content',
  27. * scrollContent: 'simplebar-scroll-content',
  28. * scrollbar: 'simplebar-scrollbar',
  29. * track: 'simplebar-track'
  30. * }
  31. * ```
  32. */
  33. classNames: ObjectConstructor;
  34. /**
  35. * Force the track to be visible (same behaviour as `overflow: scroll`).
  36. * Can be `boolean | 'x' | 'y'`, defaults to `false`, which behaves like `overflow: auto`.
  37. */
  38. forceVisible: {
  39. type: (BooleanConstructor | StringConstructor)[];
  40. validator: (v: boolean | 'x' | 'y') => boolean;
  41. default: undefined;
  42. };
  43. /**
  44. * Set custom aria-label attribute for users with screen reader.
  45. */
  46. ariaLabel: StringConstructor;
  47. /**
  48. * Set custom tabIndex attribute.
  49. */
  50. tabIndex: NumberConstructor;
  51. /**
  52. * Activate RTL support by passing `'rtl'`.
  53. * You will also need a css rule with `direction: rtl`.
  54. */
  55. direction: {
  56. type: StringConstructor;
  57. validator: (v: string) => boolean;
  58. };
  59. /**
  60. * Define the delay until the scrollbar hides. Has no effect if `autoHide` is `false`.
  61. * Default value is `1000`.
  62. */
  63. timeout: NumberConstructor;
  64. /**
  65. * Controls the click on track behaviour.
  66. * Default to `true`.
  67. */
  68. clickOnTrack: {
  69. type: BooleanConstructor;
  70. default: undefined;
  71. };
  72. /**
  73. * Controls the min size of the scrollbar in `px`.
  74. * Default is `25`.
  75. */
  76. scrollbarMinSize: NumberConstructor;
  77. /**
  78. * Controls the max size of the scrollbar in `px`.
  79. * Default is `0` (no max size).
  80. */
  81. scrollbarMaxSize: NumberConstructor;
  82. }, unknown, {}, {}, {
  83. recalculate(): void;
  84. }, import("vue-demi").ComponentOptionsMixin, import("vue-demi").ComponentOptionsMixin, "scroll"[], "scroll", import("vue-demi").VNodeProps & import("vue-demi").AllowedComponentProps & import("vue-demi").ComponentCustomProps, Readonly<import("vue-demi").ExtractPropTypes<{
  85. /**
  86. * By default SimpleBar automatically hides the scrollbar if the user is not scrolling
  87. * (it emulates Mac OSX Lion's scrollbar). You can make the scrollbar always visible
  88. * by passing `false`.
  89. *
  90. * Default value is `true`.
  91. *
  92. * You can also control the animation via CSS as it's a simple CSS opacity transition.
  93. */
  94. autoHide: {
  95. type: BooleanConstructor;
  96. default: undefined;
  97. };
  98. /**
  99. * It is possible to change the default class names that SimpleBar uses.
  100. * To get your own styles to work refer to simplebar.css to get an idea how to setup your css.
  101. * - `content` represents the wrapper for the content being scrolled.
  102. * - `scrollContent` represents the container containing the elements being scrolled.
  103. * - `scrollbar` defines the style of the scrollbar with which the user can interact to scroll the content.
  104. * - `track` styles the area surrounding the `scrollbar`.
  105. *
  106. * ```js
  107. * classNames: {
  108. * // defaults
  109. * content: 'simplebar-content',
  110. * scrollContent: 'simplebar-scroll-content',
  111. * scrollbar: 'simplebar-scrollbar',
  112. * track: 'simplebar-track'
  113. * }
  114. * ```
  115. */
  116. classNames: ObjectConstructor;
  117. /**
  118. * Force the track to be visible (same behaviour as `overflow: scroll`).
  119. * Can be `boolean | 'x' | 'y'`, defaults to `false`, which behaves like `overflow: auto`.
  120. */
  121. forceVisible: {
  122. type: (BooleanConstructor | StringConstructor)[];
  123. validator: (v: boolean | 'x' | 'y') => boolean;
  124. default: undefined;
  125. };
  126. /**
  127. * Set custom aria-label attribute for users with screen reader.
  128. */
  129. ariaLabel: StringConstructor;
  130. /**
  131. * Set custom tabIndex attribute.
  132. */
  133. tabIndex: NumberConstructor;
  134. /**
  135. * Activate RTL support by passing `'rtl'`.
  136. * You will also need a css rule with `direction: rtl`.
  137. */
  138. direction: {
  139. type: StringConstructor;
  140. validator: (v: string) => boolean;
  141. };
  142. /**
  143. * Define the delay until the scrollbar hides. Has no effect if `autoHide` is `false`.
  144. * Default value is `1000`.
  145. */
  146. timeout: NumberConstructor;
  147. /**
  148. * Controls the click on track behaviour.
  149. * Default to `true`.
  150. */
  151. clickOnTrack: {
  152. type: BooleanConstructor;
  153. default: undefined;
  154. };
  155. /**
  156. * Controls the min size of the scrollbar in `px`.
  157. * Default is `25`.
  158. */
  159. scrollbarMinSize: NumberConstructor;
  160. /**
  161. * Controls the max size of the scrollbar in `px`.
  162. * Default is `0` (no max size).
  163. */
  164. scrollbarMaxSize: NumberConstructor;
  165. }>> & {
  166. onScroll?: ((...args: any[]) => any) | undefined;
  167. }, {
  168. autoHide: boolean;
  169. forceVisible: string | boolean;
  170. clickOnTrack: boolean;
  171. }>;
  172. export default _default;