@studiometa/ui 1.6.0 → 1.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (105) hide show
  1. package/Accordion/Accordion.d.ts +1 -1
  2. package/Accordion/Accordion.js.map +1 -1
  3. package/Action/Action.d.ts +1 -1
  4. package/Action/Action.js.map +1 -1
  5. package/AnchorNav/AnchorNav.d.ts +1 -1
  6. package/AnchorNav/AnchorNav.js.map +1 -1
  7. package/AnchorScrollTo/AnchorScrollTo.d.ts +1 -1
  8. package/AnchorScrollTo/AnchorScrollTo.js.map +1 -1
  9. package/CircularMarquee/CircularMarquee.d.ts +1 -1
  10. package/CircularMarquee/CircularMarquee.js.map +1 -1
  11. package/Cursor/Cursor.d.ts +1 -1
  12. package/Cursor/Cursor.js.map +1 -1
  13. package/Data/DataBind.d.ts +2 -2
  14. package/Data/DataBind.js.map +1 -1
  15. package/Draggable/Draggable.d.ts +1 -1
  16. package/Draggable/Draggable.js.map +1 -1
  17. package/Fetch/Fetch.d.ts +18 -18
  18. package/Fetch/Fetch.js.map +2 -2
  19. package/Fetch/utils.js +1 -4
  20. package/Fetch/utils.js.map +2 -2
  21. package/Figure/Figure.d.ts +1 -1
  22. package/Figure/Figure.js.map +1 -1
  23. package/Figure/FigureShopify.d.ts +1 -1
  24. package/Figure/FigureShopify.js.map +1 -1
  25. package/Figure/FigureTwicpics.d.ts +1 -1
  26. package/Figure/FigureTwicpics.js.map +1 -1
  27. package/FigureVideo/FigureVideo.d.ts +1 -1
  28. package/FigureVideo/FigureVideo.js.map +1 -1
  29. package/FigureVideo/FigureVideoTwicpics.d.ts +1 -1
  30. package/FigureVideo/FigureVideoTwicpics.js.map +1 -1
  31. package/Frame/Frame.d.ts +5 -5
  32. package/Frame/Frame.js.map +1 -1
  33. package/Frame/FrameForm.d.ts +1 -1
  34. package/Frame/FrameTarget.d.ts +4 -4
  35. package/Frame/FrameTarget.js.map +2 -2
  36. package/Hoverable/Hoverable.d.ts +1 -1
  37. package/Hoverable/Hoverable.js.map +1 -1
  38. package/LargeText/LargeText.d.ts +1 -1
  39. package/LargeText/LargeText.js.map +1 -1
  40. package/LazyInclude/LazyInclude.d.ts +1 -1
  41. package/LazyInclude/LazyInclude.js.map +1 -1
  42. package/Menu/Menu.d.ts +1 -1
  43. package/Menu/Menu.js.map +1 -1
  44. package/Menu/MenuList.js +1 -0
  45. package/Menu/MenuList.js.map +2 -2
  46. package/Modal/Modal.d.ts +1 -1
  47. package/Modal/Modal.js.map +1 -1
  48. package/Panel/Panel.d.ts +1 -1
  49. package/Panel/Panel.js.map +1 -1
  50. package/Prefetch/AbstractPrefetch.d.ts +1 -1
  51. package/Prefetch/AbstractPrefetch.js.map +1 -1
  52. package/Prefetch/PrefetchWhenOver.d.ts +1 -1
  53. package/Prefetch/PrefetchWhenOver.js.map +1 -1
  54. package/Prefetch/PrefetchWhenVisible.d.ts +1 -1
  55. package/Prefetch/PrefetchWhenVisible.js.map +1 -1
  56. package/README.md +1 -1
  57. package/ScrollAnimation/AbstractScrollAnimation.d.ts +8 -0
  58. package/ScrollAnimation/AbstractScrollAnimation.js +20 -1
  59. package/ScrollAnimation/AbstractScrollAnimation.js.map +2 -2
  60. package/ScrollAnimation/ScrollAnimation.d.ts +7 -1
  61. package/ScrollAnimation/ScrollAnimation.js +12 -0
  62. package/ScrollAnimation/ScrollAnimation.js.map +2 -2
  63. package/ScrollAnimation/ScrollAnimationChild.d.ts +6 -0
  64. package/ScrollAnimation/ScrollAnimationChild.js +17 -4
  65. package/ScrollAnimation/ScrollAnimationChild.js.map +2 -2
  66. package/ScrollAnimation/ScrollAnimationChildWithEase.d.ts +7 -1
  67. package/ScrollAnimation/ScrollAnimationChildWithEase.js +12 -0
  68. package/ScrollAnimation/ScrollAnimationChildWithEase.js.map +2 -2
  69. package/ScrollAnimation/ScrollAnimationParent.d.ts +6 -0
  70. package/ScrollAnimation/ScrollAnimationParent.js +12 -0
  71. package/ScrollAnimation/ScrollAnimationParent.js.map +2 -2
  72. package/ScrollAnimation/ScrollAnimationTarget.d.ts +43 -0
  73. package/ScrollAnimation/ScrollAnimationTarget.js +68 -0
  74. package/ScrollAnimation/ScrollAnimationTarget.js.map +7 -0
  75. package/ScrollAnimation/ScrollAnimationTimeline.d.ts +35 -0
  76. package/ScrollAnimation/ScrollAnimationTimeline.js +28 -0
  77. package/ScrollAnimation/ScrollAnimationTimeline.js.map +7 -0
  78. package/ScrollAnimation/ScrollAnimationWithEase.d.ts +7 -1
  79. package/ScrollAnimation/ScrollAnimationWithEase.js +12 -0
  80. package/ScrollAnimation/ScrollAnimationWithEase.js.map +2 -2
  81. package/ScrollAnimation/animationScrollWithEase.d.ts +2 -0
  82. package/ScrollAnimation/animationScrollWithEase.js +12 -1
  83. package/ScrollAnimation/animationScrollWithEase.js.map +2 -2
  84. package/ScrollAnimation/index.d.ts +3 -0
  85. package/ScrollAnimation/index.js +3 -0
  86. package/ScrollAnimation/index.js.map +2 -2
  87. package/ScrollAnimation/withScrollAnimationDebug.d.ts +28 -0
  88. package/ScrollAnimation/withScrollAnimationDebug.js +309 -0
  89. package/ScrollAnimation/withScrollAnimationDebug.js.map +7 -0
  90. package/ScrollReveal/ScrollReveal.d.ts +1 -1
  91. package/ScrollReveal/ScrollReveal.js.map +1 -1
  92. package/Sentinel/Sentinel.d.ts +1 -1
  93. package/Sentinel/Sentinel.js.map +1 -1
  94. package/Slider/Slider.d.ts +1 -1
  95. package/Slider/Slider.js.map +1 -1
  96. package/Sticky/Sticky.d.ts +1 -1
  97. package/Sticky/Sticky.js.map +1 -1
  98. package/Tabs/Tabs.d.ts +1 -1
  99. package/Tabs/Tabs.js.map +1 -1
  100. package/Transition/Transition.d.ts +23 -1
  101. package/Transition/Transition.js.map +2 -2
  102. package/decorators/withTransition.d.ts +11 -0
  103. package/decorators/withTransition.js +49 -0
  104. package/decorators/withTransition.js.map +2 -2
  105. package/package.json +3 -3
package/Tabs/Tabs.js.map CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
3
  "sources": ["../../packages/ui/Tabs/Tabs.ts"],
4
- "sourcesContent": ["import { Base } from '@studiometa/js-toolkit';\nimport type { BaseProps, BaseConfig } from '@studiometa/js-toolkit';\nimport { transition } from '@studiometa/js-toolkit/utils';\n\ntype TabItem = {\n btn: HTMLElement;\n content: HTMLElement;\n isEnabled: boolean;\n};\n\ntype TabsStates = Partial<\n Record<'open' | 'active' | 'closed', string | Partial<CSSStyleDeclaration>>\n>;\n// eslint-disable-next-line no-use-before-define\ntype TabsStylesOption = Partial<Record<keyof TabsProps['$refs'], TabsStates>>;\n\nexport interface TabsProps extends BaseProps {\n $options: {\n styles: TabsStylesOption;\n };\n $refs: {\n btn: HTMLElement[];\n content: HTMLElement[];\n };\n}\n\n/**\n * Tabs class.\n * @link https://ui.studiometa.dev/-/components/Tabs/\n */\nexport class Tabs<T extends BaseProps = BaseProps> extends Base<T & TabsProps> {\n /**\n * Config.\n */\n static config: BaseConfig = {\n name: 'Tabs',\n refs: ['btn[]', 'content[]'],\n emits: ['enable', 'disable'],\n options: {\n styles: {\n type: Object,\n default: (): TabsStylesOption => ({\n content: {\n closed: {\n position: 'absolute',\n opacity: '0',\n pointerEvents: 'none',\n visibility: 'hidden',\n },\n },\n }),\n merge: true,\n },\n },\n };\n\n items: TabItem[];\n\n /**\n * Initialize the component's behaviours.\n * @returns {void}\n */\n mounted() {\n this.items = this.$refs.btn.map((btn, index) => {\n const id = `${this.$id}-${index}`;\n const content = this.$refs.content[index];\n btn.setAttribute('id', id);\n content.setAttribute('aria-labelledby', id);\n\n const item = { btn, content, isEnabled: index > 0 };\n if (index > 0) {\n this.disableItem(item);\n } else {\n this.enableItem(item);\n }\n return item;\n });\n }\n\n /**\n * Switch tab on button click.\n */\n onBtnClick({ index }: { index: number }) {\n this.items.forEach((item, i) => {\n if (i !== index) {\n this.disableItem(item);\n }\n });\n\n this.enableItem(this.items[index]);\n }\n\n /**\n * Enable the given tab and its associated content.\n */\n async enableItem(item: TabItem): Promise<this> {\n if (!item || item.isEnabled) {\n return Promise.resolve(this);\n }\n\n item.isEnabled = true;\n const { btn, content } = item;\n const btnStyles = this.$options.styles.btn || {};\n const contentStyles = this.$options.styles.content || {};\n\n content.setAttribute('aria-hidden', 'false');\n this.$emit('enable', item);\n\n return Promise.all([\n transition(\n btn,\n {\n from: btnStyles.closed,\n active: btnStyles.active,\n to: btnStyles.open,\n },\n 'keep',\n ),\n transition(\n content,\n {\n from: contentStyles.closed,\n active: contentStyles.active,\n to: contentStyles.open,\n },\n 'keep',\n ),\n ]).then(() => Promise.resolve(this));\n }\n\n /**\n * Disable the given tab and its associated content.\n */\n async disableItem(item: TabItem): Promise<this> {\n if (!item || !item.isEnabled) {\n return Promise.resolve(this);\n }\n\n item.isEnabled = false;\n const { btn, content } = item;\n const btnStyles = this.$options.styles.btn || {};\n const contentStyles = this.$options.styles.content || {};\n\n content.setAttribute('aria-hidden', 'true');\n this.$emit('disable', item);\n\n return Promise.all([\n transition(\n btn,\n {\n from: btnStyles.open,\n active: btnStyles.active,\n to: btnStyles.closed,\n },\n 'keep',\n ),\n transition(\n content,\n {\n from: contentStyles.open,\n active: contentStyles.active,\n to: contentStyles.closed,\n },\n 'keep',\n ),\n ]).then(() => Promise.resolve(this));\n }\n}\n"],
4
+ "sourcesContent": ["import { Base } from '@studiometa/js-toolkit';\nimport type { BaseProps, BaseConfig } from '@studiometa/js-toolkit';\nimport { transition } from '@studiometa/js-toolkit/utils';\n\ntype TabItem = {\n btn: HTMLElement;\n content: HTMLElement;\n isEnabled: boolean;\n};\n\ntype TabsStates = Partial<\n Record<'open' | 'active' | 'closed', string | Partial<CSSStyleDeclaration>>\n>;\n// eslint-disable-next-line no-use-before-define\ntype TabsStylesOption = Partial<Record<keyof TabsProps['$refs'], TabsStates>>;\n\nexport interface TabsProps extends BaseProps {\n $options: {\n styles: TabsStylesOption;\n };\n $refs: {\n btn: HTMLElement[];\n content: HTMLElement[];\n };\n}\n\n/**\n * Tabs class.\n * @link https://ui.studiometa.dev/components/Tabs/\n */\nexport class Tabs<T extends BaseProps = BaseProps> extends Base<T & TabsProps> {\n /**\n * Config.\n */\n static config: BaseConfig = {\n name: 'Tabs',\n refs: ['btn[]', 'content[]'],\n emits: ['enable', 'disable'],\n options: {\n styles: {\n type: Object,\n default: (): TabsStylesOption => ({\n content: {\n closed: {\n position: 'absolute',\n opacity: '0',\n pointerEvents: 'none',\n visibility: 'hidden',\n },\n },\n }),\n merge: true,\n },\n },\n };\n\n items: TabItem[];\n\n /**\n * Initialize the component's behaviours.\n * @returns {void}\n */\n mounted() {\n this.items = this.$refs.btn.map((btn, index) => {\n const id = `${this.$id}-${index}`;\n const content = this.$refs.content[index];\n btn.setAttribute('id', id);\n content.setAttribute('aria-labelledby', id);\n\n const item = { btn, content, isEnabled: index > 0 };\n if (index > 0) {\n this.disableItem(item);\n } else {\n this.enableItem(item);\n }\n return item;\n });\n }\n\n /**\n * Switch tab on button click.\n */\n onBtnClick({ index }: { index: number }) {\n this.items.forEach((item, i) => {\n if (i !== index) {\n this.disableItem(item);\n }\n });\n\n this.enableItem(this.items[index]);\n }\n\n /**\n * Enable the given tab and its associated content.\n */\n async enableItem(item: TabItem): Promise<this> {\n if (!item || item.isEnabled) {\n return Promise.resolve(this);\n }\n\n item.isEnabled = true;\n const { btn, content } = item;\n const btnStyles = this.$options.styles.btn || {};\n const contentStyles = this.$options.styles.content || {};\n\n content.setAttribute('aria-hidden', 'false');\n this.$emit('enable', item);\n\n return Promise.all([\n transition(\n btn,\n {\n from: btnStyles.closed,\n active: btnStyles.active,\n to: btnStyles.open,\n },\n 'keep',\n ),\n transition(\n content,\n {\n from: contentStyles.closed,\n active: contentStyles.active,\n to: contentStyles.open,\n },\n 'keep',\n ),\n ]).then(() => Promise.resolve(this));\n }\n\n /**\n * Disable the given tab and its associated content.\n */\n async disableItem(item: TabItem): Promise<this> {\n if (!item || !item.isEnabled) {\n return Promise.resolve(this);\n }\n\n item.isEnabled = false;\n const { btn, content } = item;\n const btnStyles = this.$options.styles.btn || {};\n const contentStyles = this.$options.styles.content || {};\n\n content.setAttribute('aria-hidden', 'true');\n this.$emit('disable', item);\n\n return Promise.all([\n transition(\n btn,\n {\n from: btnStyles.open,\n active: btnStyles.active,\n to: btnStyles.closed,\n },\n 'keep',\n ),\n transition(\n content,\n {\n from: contentStyles.open,\n active: contentStyles.active,\n to: contentStyles.closed,\n },\n 'keep',\n ),\n ]).then(() => Promise.resolve(this));\n }\n}\n"],
5
5
  "mappings": "AAAA,SAAS,YAAY;AAErB,SAAS,kBAAkB;AA4BpB,MAAM,aAA8C,KAAoB;AAAA;AAAA;AAAA;AAAA,EAI7E,OAAO,SAAqB;AAAA,IAC1B,MAAM;AAAA,IACN,MAAM,CAAC,SAAS,WAAW;AAAA,IAC3B,OAAO,CAAC,UAAU,SAAS;AAAA,IAC3B,SAAS;AAAA,MACP,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,SAAS,OAAyB;AAAA,UAChC,SAAS;AAAA,YACP,QAAQ;AAAA,cACN,UAAU;AAAA,cACV,SAAS;AAAA,cACT,eAAe;AAAA,cACf,YAAY;AAAA,YACd;AAAA,UACF;AAAA,QACF;AAAA,QACA,OAAO;AAAA,MACT;AAAA,IACF;AAAA,EACF;AAAA,EAEA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,UAAU;AACR,SAAK,QAAQ,KAAK,MAAM,IAAI,IAAI,CAAC,KAAK,UAAU;AAC9C,YAAM,KAAK,GAAG,KAAK,GAAG,IAAI,KAAK;AAC/B,YAAM,UAAU,KAAK,MAAM,QAAQ,KAAK;AACxC,UAAI,aAAa,MAAM,EAAE;AACzB,cAAQ,aAAa,mBAAmB,EAAE;AAE1C,YAAM,OAAO,EAAE,KAAK,SAAS,WAAW,QAAQ,EAAE;AAClD,UAAI,QAAQ,GAAG;AACb,aAAK,YAAY,IAAI;AAAA,MACvB,OAAO;AACL,aAAK,WAAW,IAAI;AAAA,MACtB;AACA,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA,EAKA,WAAW,EAAE,MAAM,GAAsB;AACvC,SAAK,MAAM,QAAQ,CAAC,MAAM,MAAM;AAC9B,UAAI,MAAM,OAAO;AACf,aAAK,YAAY,IAAI;AAAA,MACvB;AAAA,IACF,CAAC;AAED,SAAK,WAAW,KAAK,MAAM,KAAK,CAAC;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,WAAW,MAA8B;AAC7C,QAAI,CAAC,QAAQ,KAAK,WAAW;AAC3B,aAAO,QAAQ,QAAQ,IAAI;AAAA,IAC7B;AAEA,SAAK,YAAY;AACjB,UAAM,EAAE,KAAK,QAAQ,IAAI;AACzB,UAAM,YAAY,KAAK,SAAS,OAAO,OAAO,CAAC;AAC/C,UAAM,gBAAgB,KAAK,SAAS,OAAO,WAAW,CAAC;AAEvD,YAAQ,aAAa,eAAe,OAAO;AAC3C,SAAK,MAAM,UAAU,IAAI;AAEzB,WAAO,QAAQ,IAAI;AAAA,MACjB;AAAA,QACE;AAAA,QACA;AAAA,UACE,MAAM,UAAU;AAAA,UAChB,QAAQ,UAAU;AAAA,UAClB,IAAI,UAAU;AAAA,QAChB;AAAA,QACA;AAAA,MACF;AAAA,MACA;AAAA,QACE;AAAA,QACA;AAAA,UACE,MAAM,cAAc;AAAA,UACpB,QAAQ,cAAc;AAAA,UACtB,IAAI,cAAc;AAAA,QACpB;AAAA,QACA;AAAA,MACF;AAAA,IACF,CAAC,EAAE,KAAK,MAAM,QAAQ,QAAQ,IAAI,CAAC;AAAA,EACrC;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,YAAY,MAA8B;AAC9C,QAAI,CAAC,QAAQ,CAAC,KAAK,WAAW;AAC5B,aAAO,QAAQ,QAAQ,IAAI;AAAA,IAC7B;AAEA,SAAK,YAAY;AACjB,UAAM,EAAE,KAAK,QAAQ,IAAI;AACzB,UAAM,YAAY,KAAK,SAAS,OAAO,OAAO,CAAC;AAC/C,UAAM,gBAAgB,KAAK,SAAS,OAAO,WAAW,CAAC;AAEvD,YAAQ,aAAa,eAAe,MAAM;AAC1C,SAAK,MAAM,WAAW,IAAI;AAE1B,WAAO,QAAQ,IAAI;AAAA,MACjB;AAAA,QACE;AAAA,QACA;AAAA,UACE,MAAM,UAAU;AAAA,UAChB,QAAQ,UAAU;AAAA,UAClB,IAAI,UAAU;AAAA,QAChB;AAAA,QACA;AAAA,MACF;AAAA,MACA;AAAA,QACE;AAAA,QACA;AAAA,UACE,MAAM,cAAc;AAAA,UACpB,QAAQ,cAAc;AAAA,UACtB,IAAI,cAAc;AAAA,QACpB;AAAA,QACA;AAAA,MACF;AAAA,IACF,CAAC,EAAE,KAAK,MAAM,QAAQ,QAAQ,IAAI,CAAC;AAAA,EACrC;AACF;",
6
6
  "names": []
7
7
  }
@@ -1,11 +1,33 @@
1
1
  import { Base, BaseProps } from '@studiometa/js-toolkit';
2
2
  import type { BaseConfig } from '@studiometa/js-toolkit';
3
+ export type TransitionConstructor<T extends Transition = Transition> = {
4
+ new (...args: any[]): T;
5
+ prototype: Transition;
6
+ EVENTS: {
7
+ TRANSITION_TOGGLE: 'transition-toggle';
8
+ TRANSITION_ENTER: 'transition-enter';
9
+ TRANSITION_ENTER_START: 'transition-enter-start';
10
+ TRANSITION_ENTER_END: 'transition-enter-end';
11
+ TRANSITION_LEAVE: 'transition-leave';
12
+ TRANSITION_LEAVE_START: 'transition-leave-start';
13
+ TRANSITION_LEAVE_END: 'transition-leave-end';
14
+ };
15
+ STATES: {
16
+ ENTERING: 'entering';
17
+ LEAVING: 'leaving';
18
+ };
19
+ } & Pick<typeof Transition, keyof typeof Transition>;
3
20
  declare const Transition_base: import("@studiometa/js-toolkit").BaseDecorator<import("#private/index.js").TransitionInterface, Base<BaseProps>, import("#private/index.js").TransitionProps>;
4
21
  /**
5
22
  * Transition class.
6
- * @link https://ui.studiometa.dev/-/components/Transition/
23
+ * @link https://ui.studiometa.dev/components/Transition/
7
24
  */
8
25
  export declare class Transition<T extends BaseProps = BaseProps> extends Transition_base<T> {
26
+ /**
27
+ * Declare the `this.constructor` type
28
+ * @link https://github.com/microsoft/TypeScript/issues/3841#issuecomment-2381594311
29
+ */
30
+ ['constructor']: TransitionConstructor;
9
31
  /**
10
32
  * Config.
11
33
  */
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
3
  "sources": ["../../packages/ui/Transition/Transition.ts"],
4
- "sourcesContent": ["import { Base, BaseProps } from '@studiometa/js-toolkit';\nimport type { BaseConfig } from '@studiometa/js-toolkit';\nimport { withTransition } from '../decorators/index.js';\n\n/**\n * Transition class.\n * @link https://ui.studiometa.dev/-/components/Transition/\n */\nexport class Transition<T extends BaseProps = BaseProps> extends withTransition<Base>(Base)<T> {\n /**\n * Config.\n */\n static config: BaseConfig = {\n name: 'Transition',\n };\n}\n"],
5
- "mappings": "AAAA,SAAS,YAAuB;AAEhC,SAAS,sBAAsB;AAMxB,MAAM,mBAAoD,eAAqB,IAAI,EAAK;AAAA;AAAA;AAAA;AAAA,EAI7F,OAAO,SAAqB;AAAA,IAC1B,MAAM;AAAA,EACR;AACF;",
4
+ "sourcesContent": ["import { Base, BaseProps } from '@studiometa/js-toolkit';\nimport type { BaseConfig } from '@studiometa/js-toolkit';\nimport { withTransition } from '../decorators/index.js';\n\nexport type TransitionConstructor<T extends Transition = Transition> = {\n new (...args: any[]): T;\n prototype: Transition;\n EVENTS: {\n TRANSITION_TOGGLE: 'transition-toggle';\n TRANSITION_ENTER: 'transition-enter';\n TRANSITION_ENTER_START: 'transition-enter-start';\n TRANSITION_ENTER_END: 'transition-enter-end';\n TRANSITION_LEAVE: 'transition-leave';\n TRANSITION_LEAVE_START: 'transition-leave-start';\n TRANSITION_LEAVE_END: 'transition-leave-end';\n };\n\n STATES: {\n ENTERING: 'entering';\n LEAVING: 'leaving';\n };\n} & Pick<typeof Transition, keyof typeof Transition>;\n\n/**\n * Transition class.\n * @link https://ui.studiometa.dev/components/Transition/\n */\nexport class Transition<T extends BaseProps = BaseProps> extends withTransition<Base>(Base)<T> {\n /**\n * Declare the `this.constructor` type\n * @link https://github.com/microsoft/TypeScript/issues/3841#issuecomment-2381594311\n */\n declare ['constructor']: TransitionConstructor;\n\n /**\n * Config.\n */\n static config: BaseConfig = {\n name: 'Transition',\n };\n}\n"],
5
+ "mappings": "AAAA,SAAS,YAAuB;AAEhC,SAAS,sBAAsB;AAyBxB,MAAM,mBAAoD,eAAqB,IAAI,EAAK;AAAA;AAAA;AAAA;AAAA,EAU7F,OAAO,SAAqB;AAAA,IAC1B,MAAM;AAAA,EACR;AACF;",
6
6
  "names": []
7
7
  }
@@ -21,6 +21,11 @@ export interface TransitionInterface extends BaseInterface {
21
21
  * Get the group targets.
22
22
  */
23
23
  get targets(): HTMLElement[];
24
+ /**
25
+ * Current state.
26
+ * @internal
27
+ */
28
+ state: null | 'entering' | 'leaving';
24
29
  /**
25
30
  * Trigger the enter transition.
26
31
  */
@@ -29,8 +34,14 @@ export interface TransitionInterface extends BaseInterface {
29
34
  * Trigger the leave transition.
30
35
  */
31
36
  leave(target?: HTMLElement | HTMLElement[]): Promise<void>;
37
+ /**
38
+ * Toggle the leave or enter transition.
39
+ * Defaults to the enter transition if no transition has been triggered yet.
40
+ */
41
+ toggle(target?: HTMLElement | HTMLElement[]): Promise<void>;
32
42
  }
33
43
  /**
34
44
  * Extend a class to add transition capabilities.
45
+ * @link https://ui.studiometa.dev/components/Transition/
35
46
  */
36
47
  export declare function withTransition<S extends Base>(BaseClass: typeof Base): BaseDecorator<TransitionInterface, S, TransitionProps>;
@@ -2,11 +2,24 @@ import { getInstances } from "@studiometa/js-toolkit";
2
2
  import { nextFrame, removeClass, transition } from "@studiometa/js-toolkit/utils";
3
3
  function withTransition(BaseClass) {
4
4
  class Transition extends BaseClass {
5
+ /**
6
+ * Events.
7
+ */
8
+ static EVENTS = {
9
+ TRANSITION_TOGGLE: "transition-toggle",
10
+ TRANSITION_ENTER: "transition-enter",
11
+ TRANSITION_ENTER_START: "transition-enter-start",
12
+ TRANSITION_ENTER_END: "transition-enter-end",
13
+ TRANSITION_LEAVE: "transition-leave",
14
+ TRANSITION_LEAVE_START: "transition-leave-start",
15
+ TRANSITION_LEAVE_END: "transition-leave-end"
16
+ };
5
17
  /**
6
18
  * Config.
7
19
  */
8
20
  static config = {
9
21
  name: "Transition",
22
+ emits: Object.values(this.EVENTS),
10
23
  options: {
11
24
  enterFrom: String,
12
25
  enterActive: String,
@@ -19,6 +32,17 @@ function withTransition(BaseClass) {
19
32
  group: String
20
33
  }
21
34
  };
35
+ /**
36
+ * States.
37
+ */
38
+ static STATES = {
39
+ ENTERING: "entering",
40
+ LEAVING: "leaving"
41
+ };
42
+ /**
43
+ * Current state.
44
+ */
45
+ state = null;
22
46
  /**
23
47
  * Get the transition target.
24
48
  */
@@ -44,7 +68,11 @@ function withTransition(BaseClass) {
44
68
  * Trigger the enter transition.
45
69
  */
46
70
  async enter(target) {
71
+ const { STATES, EVENTS } = this.constructor;
47
72
  const { enterFrom, enterActive, enterTo, enterKeep, leaveTo } = this.$options;
73
+ this.state = STATES.ENTERING;
74
+ this.$emit(EVENTS.TRANSITION_ENTER);
75
+ this.$emit(EVENTS.TRANSITION_ENTER_START);
48
76
  removeClass(target ?? this.targets, leaveTo);
49
77
  await nextFrame();
50
78
  await transition(
@@ -56,12 +84,17 @@ function withTransition(BaseClass) {
56
84
  },
57
85
  enterKeep ? "keep" : void 0
58
86
  );
87
+ this.$emit(EVENTS.TRANSITION_ENTER_END);
59
88
  }
60
89
  /**
61
90
  * Trigger the leave transition.
62
91
  */
63
92
  async leave(target) {
93
+ const { STATES, EVENTS } = this.constructor;
64
94
  const { leaveFrom, leaveActive, leaveTo, leaveKeep, enterTo } = this.$options;
95
+ this.state = STATES.LEAVING;
96
+ this.$emit(EVENTS.TRANSITION_LEAVE);
97
+ this.$emit(EVENTS.TRANSITION_LEAVE_START);
65
98
  removeClass(target ?? this.targets, enterTo);
66
99
  await nextFrame();
67
100
  await transition(
@@ -73,6 +106,22 @@ function withTransition(BaseClass) {
73
106
  },
74
107
  leaveKeep ? "keep" : void 0
75
108
  );
109
+ this.$emit(EVENTS.TRANSITION_LEAVE_END);
110
+ }
111
+ /**
112
+ * Toggle the leave or enter transition.
113
+ * Defaults to the enter transition if no transition has been triggered yet.
114
+ */
115
+ async toggle(target) {
116
+ const { STATES, EVENTS } = this.constructor;
117
+ this.$emit(EVENTS.TRANSITION_TOGGLE);
118
+ switch (this.state) {
119
+ case STATES.ENTERING:
120
+ return this.leave(target);
121
+ case STATES.LEAVING:
122
+ default:
123
+ return this.enter(target);
124
+ }
76
125
  }
77
126
  }
78
127
  return Transition;
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
3
  "sources": ["../../packages/ui/decorators/withTransition.ts"],
4
- "sourcesContent": ["import { getInstances } from '@studiometa/js-toolkit';\nimport { nextFrame, removeClass, transition } from '@studiometa/js-toolkit/utils';\nimport type {\n Base,\n BaseDecorator,\n BaseProps,\n BaseConfig,\n BaseInterface,\n} from '@studiometa/js-toolkit';\n\nexport interface TransitionProps extends BaseProps {\n $options: {\n enterFrom: string;\n enterActive: string;\n enterTo: string;\n enterKeep: boolean;\n leaveFrom: string;\n leaveActive: string;\n leaveTo: string;\n leaveKeep: boolean;\n group: string;\n };\n}\n\nexport interface TransitionInterface extends BaseInterface {\n /**\n * Get the transition target.\n */\n get target(): HTMLElement | HTMLElement[];\n /**\n * Get the group targets.\n */\n get targets(): HTMLElement[];\n /**\n * Trigger the enter transition.\n */\n enter(target?: HTMLElement | HTMLElement[]): Promise<void>;\n /**\n * Trigger the leave transition.\n */\n leave(target?: HTMLElement | HTMLElement[]): Promise<void>;\n}\n\n/**\n * Extend a class to add transition capabilities.\n */\nexport function withTransition<S extends Base>(\n BaseClass: typeof Base,\n): BaseDecorator<TransitionInterface, S, TransitionProps> {\n /**\n * Class.\n */\n class Transition<T extends BaseProps = BaseProps> extends BaseClass<T & TransitionProps> {\n /**\n * Config.\n */\n static config: BaseConfig = {\n name: 'Transition',\n options: {\n enterFrom: String,\n enterActive: String,\n enterTo: String,\n enterKeep: Boolean,\n leaveFrom: String,\n leaveActive: String,\n leaveTo: String,\n leaveKeep: Boolean,\n group: String,\n },\n };\n\n /**\n * Get the transition target.\n */\n get target(): HTMLElement | HTMLElement[] {\n return this.$el;\n }\n\n /**\n * Get the group targets.\n */\n get targets(): HTMLElement[] {\n const { group } = this.$options;\n const targets = [this.target];\n\n if (group) {\n for (const instance of getInstances(this.constructor as typeof Transition)) {\n if (instance !== this && instance.$options.group === group) {\n targets.push(instance.target);\n }\n }\n }\n\n return targets.flat();\n }\n\n /**\n * Trigger the enter transition.\n */\n async enter(target?: HTMLElement | HTMLElement[]): Promise<void> {\n const { enterFrom, enterActive, enterTo, enterKeep, leaveTo } = this.$options;\n\n removeClass(target ?? this.targets, leaveTo);\n await nextFrame();\n await transition(\n target ?? this.targets,\n {\n from: enterFrom,\n active: enterActive as string,\n to: enterTo as string,\n },\n enterKeep ? 'keep' : undefined,\n );\n }\n\n /**\n * Trigger the leave transition.\n */\n async leave(target?: HTMLElement | HTMLElement[]): Promise<void> {\n const { leaveFrom, leaveActive, leaveTo, leaveKeep, enterTo } = this.$options;\n\n removeClass(target ?? this.targets, enterTo);\n await nextFrame();\n await transition(\n target ?? this.targets,\n {\n from: leaveFrom,\n active: leaveActive as string,\n to: leaveTo as string,\n },\n leaveKeep ? 'keep' : undefined,\n );\n }\n }\n\n // @ts-ignore\n return Transition;\n}\n"],
5
- "mappings": "AAAA,SAAS,oBAAoB;AAC7B,SAAS,WAAW,aAAa,kBAAkB;AA6C5C,SAAS,eACd,WACwD;AAAA,EAIxD,MAAM,mBAAoD,UAA+B;AAAA;AAAA;AAAA;AAAA,IAIvF,OAAO,SAAqB;AAAA,MAC1B,MAAM;AAAA,MACN,SAAS;AAAA,QACP,WAAW;AAAA,QACX,aAAa;AAAA,QACb,SAAS;AAAA,QACT,WAAW;AAAA,QACX,WAAW;AAAA,QACX,aAAa;AAAA,QACb,SAAS;AAAA,QACT,WAAW;AAAA,QACX,OAAO;AAAA,MACT;AAAA,IACF;AAAA;AAAA;AAAA;AAAA,IAKA,IAAI,SAAsC;AACxC,aAAO,KAAK;AAAA,IACd;AAAA;AAAA;AAAA;AAAA,IAKA,IAAI,UAAyB;AAC3B,YAAM,EAAE,MAAM,IAAI,KAAK;AACvB,YAAM,UAAU,CAAC,KAAK,MAAM;AAE5B,UAAI,OAAO;AACT,mBAAW,YAAY,aAAa,KAAK,WAAgC,GAAG;AAC1E,cAAI,aAAa,QAAQ,SAAS,SAAS,UAAU,OAAO;AAC1D,oBAAQ,KAAK,SAAS,MAAM;AAAA,UAC9B;AAAA,QACF;AAAA,MACF;AAEA,aAAO,QAAQ,KAAK;AAAA,IACtB;AAAA;AAAA;AAAA;AAAA,IAKA,MAAM,MAAM,QAAqD;AAC/D,YAAM,EAAE,WAAW,aAAa,SAAS,WAAW,QAAQ,IAAI,KAAK;AAErE,kBAAY,UAAU,KAAK,SAAS,OAAO;AAC3C,YAAM,UAAU;AAChB,YAAM;AAAA,QACJ,UAAU,KAAK;AAAA,QACf;AAAA,UACE,MAAM;AAAA,UACN,QAAQ;AAAA,UACR,IAAI;AAAA,QACN;AAAA,QACA,YAAY,SAAS;AAAA,MACvB;AAAA,IACF;AAAA;AAAA;AAAA;AAAA,IAKA,MAAM,MAAM,QAAqD;AAC/D,YAAM,EAAE,WAAW,aAAa,SAAS,WAAW,QAAQ,IAAI,KAAK;AAErE,kBAAY,UAAU,KAAK,SAAS,OAAO;AAC3C,YAAM,UAAU;AAChB,YAAM;AAAA,QACJ,UAAU,KAAK;AAAA,QACf;AAAA,UACE,MAAM;AAAA,UACN,QAAQ;AAAA,UACR,IAAI;AAAA,QACN;AAAA,QACA,YAAY,SAAS;AAAA,MACvB;AAAA,IACF;AAAA,EACF;AAGA,SAAO;AACT;",
4
+ "sourcesContent": ["import { getInstances } from '@studiometa/js-toolkit';\nimport { nextFrame, removeClass, transition } from '@studiometa/js-toolkit/utils';\nimport type {\n Base,\n BaseDecorator,\n BaseProps,\n BaseConfig,\n BaseInterface,\n} from '@studiometa/js-toolkit';\n\nexport interface TransitionProps extends BaseProps {\n $options: {\n enterFrom: string;\n enterActive: string;\n enterTo: string;\n enterKeep: boolean;\n leaveFrom: string;\n leaveActive: string;\n leaveTo: string;\n leaveKeep: boolean;\n group: string;\n };\n}\n\nexport interface TransitionInterface extends BaseInterface {\n /**\n * Get the transition target.\n */\n get target(): HTMLElement | HTMLElement[];\n /**\n * Get the group targets.\n */\n get targets(): HTMLElement[];\n /**\n * Current state.\n * @internal\n */\n state: null | 'entering' | 'leaving';\n /**\n * Trigger the enter transition.\n */\n enter(target?: HTMLElement | HTMLElement[]): Promise<void>;\n /**\n * Trigger the leave transition.\n */\n leave(target?: HTMLElement | HTMLElement[]): Promise<void>;\n /**\n * Toggle the leave or enter transition.\n * Defaults to the enter transition if no transition has been triggered yet.\n */\n toggle(target?: HTMLElement | HTMLElement[]): Promise<void>;\n}\n\n/**\n * Extend a class to add transition capabilities.\n * @link https://ui.studiometa.dev/components/Transition/\n */\nexport function withTransition<S extends Base>(\n BaseClass: typeof Base,\n): BaseDecorator<TransitionInterface, S, TransitionProps> {\n type TransitionConstructor<T extends Transition = Transition> = {\n new (...args: any[]): T;\n prototype: Transition;\n } & Pick<typeof Transition, keyof typeof Transition>;\n\n /**\n * Class.\n */\n class Transition<T extends BaseProps = BaseProps> extends BaseClass<T & TransitionProps> {\n /**\n * Declare the `this.constructor` type\n * @link https://github.com/microsoft/TypeScript/issues/3841#issuecomment-2381594311\n */\n declare ['constructor']: TransitionConstructor;\n\n /**\n * Events.\n */\n static EVENTS = {\n TRANSITION_TOGGLE: 'transition-toggle',\n TRANSITION_ENTER: 'transition-enter',\n TRANSITION_ENTER_START: 'transition-enter-start',\n TRANSITION_ENTER_END: 'transition-enter-end',\n TRANSITION_LEAVE: 'transition-leave',\n TRANSITION_LEAVE_START: 'transition-leave-start',\n TRANSITION_LEAVE_END: 'transition-leave-end',\n } as const;\n\n /**\n * Config.\n */\n static config: BaseConfig = {\n name: 'Transition',\n emits: Object.values(this.EVENTS),\n options: {\n enterFrom: String,\n enterActive: String,\n enterTo: String,\n enterKeep: Boolean,\n leaveFrom: String,\n leaveActive: String,\n leaveTo: String,\n leaveKeep: Boolean,\n group: String,\n },\n };\n\n /**\n * States.\n */\n static STATES = {\n ENTERING: 'entering',\n LEAVING: 'leaving',\n } as const;\n\n /**\n * Current state.\n */\n state: 'entering' | 'leaving' = null;\n\n /**\n * Get the transition target.\n */\n get target(): HTMLElement | HTMLElement[] {\n return this.$el;\n }\n\n /**\n * Get the group targets.\n */\n get targets(): HTMLElement[] {\n const { group } = this.$options;\n const targets = [this.target];\n\n if (group) {\n for (const instance of getInstances(this.constructor as typeof Transition)) {\n if (instance !== this && instance.$options.group === group) {\n targets.push(instance.target);\n }\n }\n }\n\n return targets.flat();\n }\n\n /**\n * Trigger the enter transition.\n */\n async enter(target?: HTMLElement | HTMLElement[]): Promise<void> {\n const { STATES, EVENTS } = this.constructor;\n const { enterFrom, enterActive, enterTo, enterKeep, leaveTo } = this.$options;\n this.state = STATES.ENTERING;\n this.$emit(EVENTS.TRANSITION_ENTER);\n this.$emit(EVENTS.TRANSITION_ENTER_START);\n removeClass(target ?? this.targets, leaveTo);\n await nextFrame();\n await transition(\n target ?? this.targets,\n {\n from: enterFrom,\n active: enterActive as string,\n to: enterTo as string,\n },\n enterKeep ? 'keep' : undefined,\n );\n this.$emit(EVENTS.TRANSITION_ENTER_END);\n }\n\n /**\n * Trigger the leave transition.\n */\n async leave(target?: HTMLElement | HTMLElement[]): Promise<void> {\n const { STATES, EVENTS } = this.constructor;\n const { leaveFrom, leaveActive, leaveTo, leaveKeep, enterTo } = this.$options;\n this.state = STATES.LEAVING;\n this.$emit(EVENTS.TRANSITION_LEAVE);\n this.$emit(EVENTS.TRANSITION_LEAVE_START);\n removeClass(target ?? this.targets, enterTo);\n await nextFrame();\n await transition(\n target ?? this.targets,\n {\n from: leaveFrom,\n active: leaveActive as string,\n to: leaveTo as string,\n },\n leaveKeep ? 'keep' : undefined,\n );\n this.$emit(EVENTS.TRANSITION_LEAVE_END);\n }\n\n /**\n * Toggle the leave or enter transition.\n * Defaults to the enter transition if no transition has been triggered yet.\n */\n async toggle(target?: HTMLElement | HTMLElement[]): Promise<void> {\n const { STATES, EVENTS } = this.constructor;\n\n this.$emit(EVENTS.TRANSITION_TOGGLE);\n\n switch (this.state) {\n case STATES.ENTERING:\n return this.leave(target);\n case STATES.LEAVING:\n default:\n return this.enter(target);\n }\n }\n }\n\n // @ts-ignore\n return Transition;\n}\n"],
5
+ "mappings": "AAAA,SAAS,oBAAoB;AAC7B,SAAS,WAAW,aAAa,kBAAkB;AAwD5C,SAAS,eACd,WACwD;AAAA,EASxD,MAAM,mBAAoD,UAA+B;AAAA;AAAA;AAAA;AAAA,IAUvF,OAAO,SAAS;AAAA,MACd,mBAAmB;AAAA,MACnB,kBAAkB;AAAA,MAClB,wBAAwB;AAAA,MACxB,sBAAsB;AAAA,MACtB,kBAAkB;AAAA,MAClB,wBAAwB;AAAA,MACxB,sBAAsB;AAAA,IACxB;AAAA;AAAA;AAAA;AAAA,IAKA,OAAO,SAAqB;AAAA,MAC1B,MAAM;AAAA,MACN,OAAO,OAAO,OAAO,KAAK,MAAM;AAAA,MAChC,SAAS;AAAA,QACP,WAAW;AAAA,QACX,aAAa;AAAA,QACb,SAAS;AAAA,QACT,WAAW;AAAA,QACX,WAAW;AAAA,QACX,aAAa;AAAA,QACb,SAAS;AAAA,QACT,WAAW;AAAA,QACX,OAAO;AAAA,MACT;AAAA,IACF;AAAA;AAAA;AAAA;AAAA,IAKA,OAAO,SAAS;AAAA,MACd,UAAU;AAAA,MACV,SAAS;AAAA,IACX;AAAA;AAAA;AAAA;AAAA,IAKA,QAAgC;AAAA;AAAA;AAAA;AAAA,IAKhC,IAAI,SAAsC;AACxC,aAAO,KAAK;AAAA,IACd;AAAA;AAAA;AAAA;AAAA,IAKA,IAAI,UAAyB;AAC3B,YAAM,EAAE,MAAM,IAAI,KAAK;AACvB,YAAM,UAAU,CAAC,KAAK,MAAM;AAE5B,UAAI,OAAO;AACT,mBAAW,YAAY,aAAa,KAAK,WAAgC,GAAG;AAC1E,cAAI,aAAa,QAAQ,SAAS,SAAS,UAAU,OAAO;AAC1D,oBAAQ,KAAK,SAAS,MAAM;AAAA,UAC9B;AAAA,QACF;AAAA,MACF;AAEA,aAAO,QAAQ,KAAK;AAAA,IACtB;AAAA;AAAA;AAAA;AAAA,IAKA,MAAM,MAAM,QAAqD;AAC/D,YAAM,EAAE,QAAQ,OAAO,IAAI,KAAK;AAChC,YAAM,EAAE,WAAW,aAAa,SAAS,WAAW,QAAQ,IAAI,KAAK;AACrE,WAAK,QAAQ,OAAO;AACpB,WAAK,MAAM,OAAO,gBAAgB;AAClC,WAAK,MAAM,OAAO,sBAAsB;AACxC,kBAAY,UAAU,KAAK,SAAS,OAAO;AAC3C,YAAM,UAAU;AAChB,YAAM;AAAA,QACJ,UAAU,KAAK;AAAA,QACf;AAAA,UACE,MAAM;AAAA,UACN,QAAQ;AAAA,UACR,IAAI;AAAA,QACN;AAAA,QACA,YAAY,SAAS;AAAA,MACvB;AACA,WAAK,MAAM,OAAO,oBAAoB;AAAA,IACxC;AAAA;AAAA;AAAA;AAAA,IAKA,MAAM,MAAM,QAAqD;AAC/D,YAAM,EAAE,QAAQ,OAAO,IAAI,KAAK;AAChC,YAAM,EAAE,WAAW,aAAa,SAAS,WAAW,QAAQ,IAAI,KAAK;AACrE,WAAK,QAAQ,OAAO;AACpB,WAAK,MAAM,OAAO,gBAAgB;AAClC,WAAK,MAAM,OAAO,sBAAsB;AACxC,kBAAY,UAAU,KAAK,SAAS,OAAO;AAC3C,YAAM,UAAU;AAChB,YAAM;AAAA,QACJ,UAAU,KAAK;AAAA,QACf;AAAA,UACE,MAAM;AAAA,UACN,QAAQ;AAAA,UACR,IAAI;AAAA,QACN;AAAA,QACA,YAAY,SAAS;AAAA,MACvB;AACA,WAAK,MAAM,OAAO,oBAAoB;AAAA,IACxC;AAAA;AAAA;AAAA;AAAA;AAAA,IAMA,MAAM,OAAO,QAAqD;AAChE,YAAM,EAAE,QAAQ,OAAO,IAAI,KAAK;AAEhC,WAAK,MAAM,OAAO,iBAAiB;AAEnC,cAAQ,KAAK,OAAO;AAAA,QAClB,KAAK,OAAO;AACV,iBAAO,KAAK,MAAM,MAAM;AAAA,QAC1B,KAAK,OAAO;AAAA,QACZ;AACE,iBAAO,KAAK,MAAM,MAAM;AAAA,MAC5B;AAAA,IACF;AAAA,EACF;AAGA,SAAO;AACT;",
6
6
  "names": []
7
7
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@studiometa/ui",
3
- "version": "1.6.0",
3
+ "version": "1.8.0",
4
4
  "description": "A set of opiniated, unstyled and accessible components",
5
5
  "publishConfig": {
6
6
  "access": "public"
@@ -30,10 +30,10 @@
30
30
  "homepage": "https://github.com/studiometa/ui#readme",
31
31
  "dependencies": {
32
32
  "deepmerge": "^4.3.1",
33
- "morphdom": "^2.7.5"
33
+ "morphdom": "^2.7.8"
34
34
  },
35
35
  "devDependencies": {
36
- "@studiometa/js-toolkit": "3.4.1"
36
+ "@studiometa/js-toolkit": "3.4.3"
37
37
  },
38
38
  "peerDependencies": {
39
39
  "@studiometa/js-toolkit": "^3.4.0"