@empathyco/x-components 5.0.0-alpha.21 → 5.0.0-alpha.23

package/types/components/sliding-panel.vue.d.ts

@@ -1,5 +1,3 @@
-import { VueCSSClasses } from '../utils/types';
-declare const SlidingPanel_base: import("vue-class-component/lib/declarations").VueClass<object & import("vue/types/v3-component-options").ExtractComputedReturns<{}> & Record<never, any> & Partial<Record<"buttonClass" | "scrollContainerClass", string>> & import("vue").ShallowUnwrapRef<{}>>;
 /**
  * This component allows for any other component or element inside it to be horizontally
  * navigable. It also implements customizable buttons as well as other minor customizations to its
@@ -10,101 +8,66 @@ declare const SlidingPanel_base: import("vue-class-component/lib/declarations").
  *
  * @public
  */
-export default class SlidingPanel extends SlidingPanel_base {
+declare const _default: import("vue").DefineComponent<{
     /**
      * Scroll factor that will dictate how much the scroll moves when pressing a navigation button.
-     *
-     * @public
      */
-    scrollFactor: number;
-    /**
-     * Would make the navigation buttons visible when they're needed or always hide them.
-     *
-     * @public
-     */
-    showButtons: boolean;
+    scrollFactor: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /** Would make the navigation buttons visible when they're needed or always hide them. */
+    showButtons: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * When true, whenever the DOM content in the sliding panel slot changes, it will reset
      * the scroll position to 0.
-     *
-     * @public
-     */
-    resetOnContentChange: boolean;
-    /**
-     * Indicates if the scroll is at the start of the sliding panel.
-     *
-     * @internal
      */
-    protected isScrollAtStart: boolean;
-    /**
-     * Indicates if the scroll is at the end of the sliding panel.
-     *
-     * @internal
-     */
-    protected isScrollAtEnd: boolean;
-    /**
-     * HTMLElement referencing the scroll of the component.
-     *
-     * @internal
-     */
-    $refs: {
-        scrollContainer: HTMLElement;
+    resetOnContentChange: {
+        type: BooleanConstructor;
+        default: boolean;
     };
+    buttonClass: StringConstructor;
+    scrollContainerClass: StringConstructor;
+}, {
+    cssClasses: import("vue").ComputedRef<{
+        'x-sliding-panel-at-start': boolean;
+        'x-sliding-panel-at-end': boolean;
+    }>;
+    debouncedUpdateScroll: import("..").DebouncedFunction<[]>;
+    scrollContainerRef: import("vue").Ref<HTMLDivElement | undefined>;
+    scrollLeft: () => void;
+    scrollRight: () => void;
+    slots: import("vue/types/v3-setup-context").Slots;
+}, {}, {}, {}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
     /**
-     * CSS classes to apply based on the scroll position.
-     *
-     * @returns The CSS classes to apply.
-     *
-     * @internal
-     */
-    protected get cssClasses(): VueCSSClasses;
-    /**
-     * Initialises browser platform code:
-     * - Creates a mutation observer to detect content changes and reset scroll position.
-     * - Stores initial size and scroll position values.
-     *
-     * @internal
-     */
-    mounted(): void;
-    /**
-     * Resets the scroll and updates the values of the scroll for the buttons to react.
-     *
-     * @internal
-     */
-    restoreAndUpdateScroll(): void;
-    /**
-     * Updates the values of the scroll positions to show or hide the buttons depending on it.
-     *
-     * @internal
-     */
-    protected updateScrollPosition(): void;
-    /**
-     * Debounced version of the {@link SlidingPanel.updateScrollPosition}
-     * method.
-     *
-     * @internal
-     */
-    debouncedUpdateScrollPosition(): void;
-    /**
-     * Scrolls the wrapper element to the left.
-     *
-     * @internal
-     */
-    protected scrollLeft(): void;
-    /**
-     * Scrolls the wrapper element to the right.
-     *
-     * @internal
+     * Scroll factor that will dictate how much the scroll moves when pressing a navigation button.
      */
-    protected scrollRight(): void;
+    scrollFactor: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /** Would make the navigation buttons visible when they're needed or always hide them. */
+    showButtons: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
-     * Scrolls the wrapper element towards the provided scroll value.
-     *
-     * @param scrollValue - The value the scroll will go towards.
-     *
-     * @internal
+     * When true, whenever the DOM content in the sliding panel slot changes, it will reset
+     * the scroll position to 0.
      */
-    protected scrollTo(scrollValue: number): void;
-}
-export {};
+    resetOnContentChange: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    buttonClass: StringConstructor;
+    scrollContainerClass: StringConstructor;
+}>>, {
+    scrollFactor: number;
+    showButtons: boolean;
+    resetOnContentChange: boolean;
+}>;
+export default _default;
 //# sourceMappingURL=sliding-panel.vue?rollup-plugin-vue=script.d.ts.map

package/types/components/sliding-panel.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sliding-panel.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../src/components/sliding-panel.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AAuCE,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;;AAI/C;;;;;;;;;GASG;AAEH,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,iBAEzC;IACC;;;;OAIG;IAEI,YAAY,EAAG,MAAM,CAAC;IAE7B;;;;OAIG;IAEI,WAAW,EAAG,OAAO,CAAC;IAE7B;;;;;OAKG;IAEI,oBAAoB,EAAG,OAAO,CAAC;IAEtC;;;;OAIG;IACH,SAAS,CAAC,eAAe,UAAQ;IAEjC;;;;OAIG;IACH,SAAS,CAAC,aAAa,UAAQ;IAE/B;;;;OAIG;IACI,KAAK,EAAG;QACb,eAAe,EAAE,WAAW,CAAC;KAC9B,CAAC;IAEF;;;;;;OAMG;IACH,SAAS,KAAK,UAAU,IAAI,aAAa,CAKxC;IAED;;;;;;OAMG;IACH,OAAO,IAAI,IAAI;IA8Bf;;;;OAIG;IAEH,sBAAsB,IAAI,IAAI;IAK9B;;;;OAIG;IACH,SAAS,CAAC,oBAAoB,IAAI,IAAI;IAUtC;;;;;OAKG;IAEH,6BAA6B,IAAI,IAAI;IAIrC;;;;OAIG;IACH,SAAS,CAAC,UAAU,IAAI,IAAI;IAI5B;;;;OAIG;IACH,SAAS,CAAC,WAAW,IAAI,IAAI;IAI7B;;;;;;OAMG;IACH,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;CAM9C"}
+{"version":3,"file":"sliding-panel.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../src/components/sliding-panel.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AAyCE;;;;;;;;;GASG;;IAIC;;OAEG;;;;;IAKH,yFAAyF;;;;;IAKzF;;;OAGG;;;;;;;;;;;;;;;;;;IAfH;;OAEG;;;;;IAKH,yFAAyF;;;;;IAKzF;;;OAGG;;;;;;;;;;;;AAlBP,wBA2IG"}

package/types/x-modules/facets/components/lists/sliced-filters.vue.d.ts

@@ -18,18 +18,12 @@ declare const _default: import("vue").DefineComponent<{
     /**
      * This prop is used in the `HierarchicalFilter` component and only in that case. It is necessary
      * to make the `renderedFilters` to return only the filters of each level of the hierarchy.
-     *
-     * @public
      */
     parentId: {
         type: PropType<string | number>;
         required: false;
     };
-    /**
-     * The maximum number of filters to show.
-     *
-     * @public
-     */
+    /** The maximum number of filters to show. */
     max: {
         type: NumberConstructor;
         required: true;
@@ -52,18 +46,12 @@ declare const _default: import("vue").DefineComponent<{
     /**
      * This prop is used in the `HierarchicalFilter` component and only in that case. It is necessary
      * to make the `renderedFilters` to return only the filters of each level of the hierarchy.
-     *
-     * @public
      */
     parentId: {
         type: PropType<string | number>;
         required: false;
     };
-    /**
-     * The maximum number of filters to show.
-     *
-     * @public
-     */
+    /** The maximum number of filters to show. */
     max: {
         type: NumberConstructor;
         required: true;

package/types/x-modules/facets/components/lists/sliced-filters.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sliced-filters.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../../../src/x-modules/facets/components/lists/sliced-filters.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AA+CE,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAA6B,QAAQ,EAAgB,MAAM,KAAK,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAKlD;;;;;;GAMG;;IAKC;;;;OAIG;;IAGH;;;;;OAKG;;;;;IAMH;;;;OAIG;;;;;;;;mCAqDmC,UAAU,KAAG,IAAI;;;;;;IA3EvD;;;;OAIG;;IAGH;;;;;OAKG;;;;;IAMH;;;;OAIG;;;;;;;AA1BP,wBAyGG"}
+{"version":3,"file":"sliced-filters.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../../../src/x-modules/facets/components/lists/sliced-filters.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AA+CE,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAA6B,QAAQ,EAAgB,MAAM,KAAK,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAKlD;;;;;;GAMG;;IAKC;;;;OAIG;;IAEH;;;OAGG;;;;;IAKH,6CAA6C;;;;;;;;mCAoDP,UAAU,KAAG,IAAI;;;;;;IAlEvD;;;;OAIG;;IAEH;;;OAGG;;;;;IAKH,6CAA6C;;;;;;;AAlBjD,wBAgGG"}

package/docs/API-reference/api/x-components.basemodal._refs.md

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BaseModal](./x-components.basemodal.md) &gt; [$refs](./x-components.basemodal._refs.md)
-
-## BaseModal.$refs property
-
-**Signature:**
-
-```typescript
-$refs: {
-        modal: HTMLDivElement;
-        modalContent: HTMLDivElement;
-    };
-```

package/docs/API-reference/api/x-components.basemodal.animation.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BaseModal](./x-components.basemodal.md) &gt; [animation](./x-components.basemodal.animation.md)
-
-## BaseModal.animation property
-
-Animation to use for opening/closing the modal. This animation only affects the content.
-
-**Signature:**
-
-```typescript
-animation: Vue | string;
-```

package/docs/API-reference/api/x-components.basemodal.focusonopen.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BaseModal](./x-components.basemodal.md) &gt; [focusOnOpen](./x-components.basemodal.focusonopen.md)
-
-## BaseModal.focusOnOpen property
-
-Determines if the focused element changes to one inside the modal when it opens. Either the first element with a positive tabindex or just the first focusable element.
-
-**Signature:**
-
-```typescript
-focusOnOpen: boolean;
-```

package/docs/API-reference/api/x-components.basemodal.iswaitingforleave.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BaseModal](./x-components.basemodal.md) &gt; [isWaitingForLeave](./x-components.basemodal.iswaitingforleave.md)
-
-## BaseModal.isWaitingForLeave property
-
-Boolean to delay the leave animation until it has completed.
-
-**Signature:**
-
-```typescript
-protected isWaitingForLeave: boolean;
-```

package/docs/API-reference/api/x-components.basemodal.mounted.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BaseModal](./x-components.basemodal.md) &gt; [mounted](./x-components.basemodal.mounted.md)
-
-## BaseModal.mounted() method
-
-**Signature:**
-
-```typescript
-protected mounted(): void;
-```
-**Returns:**
-
-void
-

package/docs/API-reference/api/x-components.basemodal.open.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BaseModal](./x-components.basemodal.md) &gt; [open](./x-components.basemodal.open.md)
-
-## BaseModal.open property
-
-Determines if the modal is open or not.
-
-**Signature:**
-
-```typescript
-open: boolean;
-```

package/docs/API-reference/api/x-components.basemodal.overlayanimation.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BaseModal](./x-components.basemodal.md) &gt; [overlayAnimation](./x-components.basemodal.overlayanimation.md)
-
-## BaseModal.overlayAnimation property
-
-Animation to use for the overlay (backdrop) part of the modal. By default, it uses a fade transition.
-
-**Signature:**
-
-```typescript
-overlayAnimation: Vue | string;
-```

package/docs/API-reference/api/x-components.basemodal.previousbodyoverflow.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BaseModal](./x-components.basemodal.md) &gt; [previousBodyOverflow](./x-components.basemodal.previousbodyoverflow.md)
-
-## BaseModal.previousBodyOverflow property
-
-The previous value of the body overflow style.
-
-**Signature:**
-
-```typescript
-protected previousBodyOverflow: string;
-```

package/docs/API-reference/api/x-components.basemodal.previoushtmloverflow.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BaseModal](./x-components.basemodal.md) &gt; [previousHTMLOverflow](./x-components.basemodal.previoushtmloverflow.md)
-
-## BaseModal.previousHTMLOverflow property
-
-The previous value of the HTML element overflow style.
-
-**Signature:**
-
-```typescript
-protected previousHTMLOverflow: string;
-```

package/docs/API-reference/api/x-components.basemodal.referenceelement.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BaseModal](./x-components.basemodal.md) &gt; [referenceElement](./x-components.basemodal.referenceelement.md)
-
-## BaseModal.referenceElement property
-
-The reference element to use to find the modal's position.
-
-**Signature:**
-
-```typescript
-protected referenceElement: HTMLElement;
-```

package/docs/API-reference/api/x-components.basemodal.referenceselector.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BaseModal](./x-components.basemodal.md) &gt; [referenceSelector](./x-components.basemodal.referenceselector.md)
-
-## BaseModal.referenceSelector property
-
-The reference selector of a DOM element to use as reference to position the modal. This selector can be an ID or a class, if it is a class, it will use the first element that matches.
-
-**Signature:**
-
-```typescript
-referenceSelector?: string;
-```

package/docs/API-reference/api/x-components.basevariablecolumngrid.animation.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BaseVariableColumnGrid](./x-components.basevariablecolumngrid.md) &gt; [animation](./x-components.basevariablecolumngrid.animation.md)
-
-## BaseVariableColumnGrid.animation property
-
-Animation component that will be used to animate the grid.
-
-**Signature:**
-
-```typescript
-protected animation: Vue | string;
-```

package/docs/API-reference/api/x-components.basevariablecolumngrid.items.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BaseVariableColumnGrid](./x-components.basevariablecolumngrid.md) &gt; [items](./x-components.basevariablecolumngrid.items.md)
-
-## BaseVariableColumnGrid.items property
-
-The list of items to be rendered.
-
-**Signature:**
-
-```typescript
-protected items?: ListItem[];
-```
-
-## Remarks
-
-The items must have an id property.
-

package/docs/API-reference/api/x-components.slidingpanel.resetoncontentchange.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [SlidingPanel](./x-components.slidingpanel.md) &gt; [resetOnContentChange](./x-components.slidingpanel.resetoncontentchange.md)
-
-## SlidingPanel.resetOnContentChange property
-
-When true, whenever the DOM content in the sliding panel slot changes, it will reset the scroll position to 0.
-
-**Signature:**
-
-```typescript
-resetOnContentChange: boolean;
-```

package/docs/API-reference/api/x-components.slidingpanel.scrollfactor.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [SlidingPanel](./x-components.slidingpanel.md) &gt; [scrollFactor](./x-components.slidingpanel.scrollfactor.md)
-
-## SlidingPanel.scrollFactor property
-
-Scroll factor that will dictate how much the scroll moves when pressing a navigation button.
-
-**Signature:**
-
-```typescript
-scrollFactor: number;
-```

package/docs/API-reference/api/x-components.slidingpanel.showbuttons.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [SlidingPanel](./x-components.slidingpanel.md) &gt; [showButtons](./x-components.slidingpanel.showbuttons.md)
-
-## SlidingPanel.showButtons property
-
-Would make the navigation buttons visible when they're needed or always hide them.
-
-**Signature:**
-
-```typescript
-showButtons: boolean;
-```