@fiddle-digital/string-tune 1.1.5 → 1.1.6

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.
package/dist/index.d.mts CHANGED
@@ -1727,15 +1727,40 @@ interface ScrollMarkRule {
1727
1727
  }
1728
1728
 
1729
1729
  /**
1730
- * Module that updates the `--lerp` CSS variable on elements
1731
- * based on current scroll velocity.
1730
+ * Module that manages sequence states for elements based on slider step events.
1731
+ * Updates element classes (ACTIVE, HIDE, DISABLE) according to the current sequence position.
1732
1732
  */
1733
1733
  declare class StringSequence extends StringModule {
1734
- constructor(context: StringContext);
1734
+ /**
1735
+ * Stores the current active step index for each slider.
1736
+ */
1735
1737
  private activeStepForSlides;
1738
+ /**
1739
+ * Stores the last active step index for each slider to hide the previous element.
1740
+ */
1736
1741
  private hideStepForSlides;
1742
+ /**
1743
+ * @param context StringContext instance for dependency injection.
1744
+ */
1745
+ constructor(context: StringContext);
1746
+ /**
1747
+ * Subscribes to slider step events and updates element states:
1748
+ * - Sets ACTIVE for the current element.
1749
+ * - Sets HIDE for the previously active element.
1750
+ * - Sets DISABLE for all others.
1751
+ */
1737
1752
  onInit(): void;
1753
+ /**
1754
+ * Sets initial state DISABLE for a newly connected element.
1755
+ * @param object The connected StringObject.
1756
+ */
1738
1757
  onObjectConnected(object: StringObject): void;
1758
+ /**
1759
+ * Updates the element's class according to the given SequenceState.
1760
+ * Removes all possible sequence state classes before applying the new one.
1761
+ * @param object The target StringObject.
1762
+ * @param state The state to set (ACTIVE, HIDE, DISABLE).
1763
+ */
1739
1764
  private setSequenceState;
1740
1765
  }
1741
1766
 
package/dist/index.d.ts CHANGED
@@ -1727,15 +1727,40 @@ interface ScrollMarkRule {
1727
1727
  }
1728
1728
 
1729
1729
  /**
1730
- * Module that updates the `--lerp` CSS variable on elements
1731
- * based on current scroll velocity.
1730
+ * Module that manages sequence states for elements based on slider step events.
1731
+ * Updates element classes (ACTIVE, HIDE, DISABLE) according to the current sequence position.
1732
1732
  */
1733
1733
  declare class StringSequence extends StringModule {
1734
- constructor(context: StringContext);
1734
+ /**
1735
+ * Stores the current active step index for each slider.
1736
+ */
1735
1737
  private activeStepForSlides;
1738
+ /**
1739
+ * Stores the last active step index for each slider to hide the previous element.
1740
+ */
1736
1741
  private hideStepForSlides;
1742
+ /**
1743
+ * @param context StringContext instance for dependency injection.
1744
+ */
1745
+ constructor(context: StringContext);
1746
+ /**
1747
+ * Subscribes to slider step events and updates element states:
1748
+ * - Sets ACTIVE for the current element.
1749
+ * - Sets HIDE for the previously active element.
1750
+ * - Sets DISABLE for all others.
1751
+ */
1737
1752
  onInit(): void;
1753
+ /**
1754
+ * Sets initial state DISABLE for a newly connected element.
1755
+ * @param object The connected StringObject.
1756
+ */
1738
1757
  onObjectConnected(object: StringObject): void;
1758
+ /**
1759
+ * Updates the element's class according to the given SequenceState.
1760
+ * Removes all possible sequence state classes before applying the new one.
1761
+ * @param object The target StringObject.
1762
+ * @param state The state to set (ACTIVE, HIDE, DISABLE).
1763
+ */
1739
1764
  private setSequenceState;
1740
1765
  }
1741
1766