offcanvas.d.ts 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. /** Returns a new `BaseComponent` instance. */
  2. declare class BaseComponent {
  3. element: Element;
  4. options?: BaseOptions;
  5. /**
  6. * @param target `Element` or selector string
  7. * @param config component instance options
  8. */
  9. constructor(target: Element | string, config?: BaseOptions);
  10. get version(): string;
  11. get name(): string;
  12. get defaults(): {};
  13. /** just to have something to extend from */
  14. _toggleEventListeners: () => void;
  15. /** Removes component from target element. */
  16. dispose(): void;
  17. }
  18. declare interface BaseOptions {
  19. [key: string]: unknown;
  20. }
  21. /** Returns a new `Offcanvas` instance. */
  22. declare class Offcanvas extends BaseComponent {
  23. static selector: string;
  24. static init: (element: Element) => Offcanvas;
  25. static getInstance: (element: Element) => Offcanvas | null;
  26. element: HTMLElement;
  27. options: OffcanvasOptions;
  28. triggers: HTMLElement[];
  29. relatedTarget: EventTarget & HTMLElement | undefined;
  30. /**
  31. * @param target usually an `.offcanvas` element
  32. * @param config instance options
  33. */
  34. constructor(target: Element | string, config?: Partial<OffcanvasOptions>);
  35. /**
  36. * Returns component name string.
  37. */
  38. get name(): string;
  39. /**
  40. * Returns component default options.
  41. */
  42. get defaults(): {
  43. backdrop: boolean;
  44. keyboard: boolean;
  45. scroll: boolean;
  46. };
  47. /** Shows or hides the offcanvas from the user. */
  48. toggle(): void;
  49. /** Shows the offcanvas to the user. */
  50. show(): void;
  51. /** Hides the offcanvas from the user. */
  52. hide(): void;
  53. /**
  54. * Toggles on/off the `click` event listeners.
  55. *
  56. * @param self the `Offcanvas` instance
  57. * @param add when *true*, listeners are added
  58. */
  59. _toggleEventListeners: (add?: boolean) => void;
  60. /** Removes the `Offcanvas` from the target element. */
  61. dispose(): void;
  62. }
  63. export default Offcanvas;
  64. declare interface OffcanvasOptions extends BaseOptions {
  65. backdrop: boolean | "static";
  66. keyboard: boolean;
  67. }
  68. export { }