@vodafone_de/brix-components 3.1.6 → 3.1.7

package/useLazyRipple/index.d.ts

@@ -0,0 +1 @@
+export { default } from "./useLazyRipple.js";

package/useLazyRipple/index.js

@@ -0,0 +1,14 @@
+"use strict";
+'use client';
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function () {
+    return _useLazyRipple.default;
+  }
+});
+var _useLazyRipple = _interopRequireDefault(require("./useLazyRipple"));

package/useLazyRipple/useLazyRipple.d.ts

@@ -0,0 +1,32 @@
+import * as React from 'react';
+import { TouchRippleActions } from "../ButtonBase/TouchRipple.js";
+type ControlledPromise<T = unknown> = Promise<T> & {
+  resolve: Function;
+  reject: Function;
+};
+/**
+ * Lazy initialization container for the Ripple instance. This improves
+ * performance by delaying mounting the ripple until it's needed.
+ */
+export declare class LazyRipple {
+  /** React ref to the ripple instance */
+  ref: React.RefObject<TouchRippleActions | null>;
+  /** If the ripple component should be mounted */
+  shouldMount: boolean;
+  /** Promise that resolves when the ripple component is mounted */
+  private mounted;
+  /** If the ripple component has been mounted */
+  private didMount;
+  /** React state hook setter */
+  private setShouldMount;
+  static create(): LazyRipple;
+  static use(): LazyRipple;
+  constructor();
+  mount(): ControlledPromise<unknown>;
+  mountEffect: () => void;
+  start(...args: Parameters<TouchRippleActions['start']>): void;
+  stop(...args: Parameters<TouchRippleActions['stop']>): void;
+  pulsate(...args: Parameters<TouchRippleActions['pulsate']>): void;
+}
+export default function useLazyRipple(): LazyRipple;
+export {};

package/useLazyRipple/useLazyRipple.js

@@ -0,0 +1,94 @@
+"use strict";
+'use client';
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.LazyRipple = void 0;
+exports.default = useLazyRipple;
+var React = _interopRequireWildcard(require("react"));
+var _useLazyRef = _interopRequireDefault(require("@mui/utils/useLazyRef"));
+/**
+ * Lazy initialization container for the Ripple instance. This improves
+ * performance by delaying mounting the ripple until it's needed.
+ */
+class LazyRipple {
+  /** React ref to the ripple instance */
+
+  /** If the ripple component should be mounted */
+
+  /** Promise that resolves when the ripple component is mounted */
+
+  /** If the ripple component has been mounted */
+
+  /** React state hook setter */
+
+  static create() {
+    return new LazyRipple();
+  }
+  static use() {
+    /* eslint-disable */
+    const ripple = (0, _useLazyRef.default)(LazyRipple.create).current;
+    const [shouldMount, setShouldMount] = React.useState(false);
+    ripple.shouldMount = shouldMount;
+    ripple.setShouldMount = setShouldMount;
+    React.useEffect(ripple.mountEffect, [shouldMount]);
+    /* eslint-enable */
+
+    return ripple;
+  }
+  constructor() {
+    this.ref = {
+      current: null
+    };
+    this.mounted = null;
+    this.didMount = false;
+    this.shouldMount = false;
+    this.setShouldMount = null;
+  }
+  mount() {
+    if (!this.mounted) {
+      this.mounted = createControlledPromise();
+      this.shouldMount = true;
+      this.setShouldMount(this.shouldMount);
+    }
+    return this.mounted;
+  }
+  mountEffect = () => {
+    if (this.shouldMount && !this.didMount) {
+      if (this.ref.current !== null) {
+        this.didMount = true;
+        this.mounted.resolve();
+      }
+    }
+  };
+
+  /* Ripple API */
+
+  start(...args) {
+    this.mount().then(() => this.ref.current?.start(...args));
+  }
+  stop(...args) {
+    this.mount().then(() => this.ref.current?.stop(...args));
+  }
+  pulsate(...args) {
+    this.mount().then(() => this.ref.current?.pulsate(...args));
+  }
+}
+exports.LazyRipple = LazyRipple;
+function useLazyRipple() {
+  return LazyRipple.use();
+}
+function createControlledPromise() {
+  let resolve;
+  let reject;
+  const p = new Promise((resolveFn, rejectFn) => {
+    resolve = resolveFn;
+    reject = rejectFn;
+  });
+  p.resolve = resolve;
+  p.reject = reject;
+  return p;
+}

package/useMediaQuery/index.d.ts

@@ -0,0 +1,7 @@
+import { UseMediaQueryOptions } from '@mui/system/useMediaQuery';
+import { Theme } from "../styles/createTheme.js";
+export * from '@mui/system/useMediaQuery';
+
+// TODO v7: remove the generic. It's only used to prevent a breaking change in v6 from system's useMediaQuery in https://github.com/mui/material-ui/pull/44339.
+declare function useMediaQuery<T = Theme>(queryInput: string | ((theme: T) => string), options?: UseMediaQueryOptions): boolean;
+export default useMediaQuery;

package/useMediaQuery/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _useMediaQuery = require("@mui/system/useMediaQuery");
+var _identifier = _interopRequireDefault(require("../styles/identifier"));
+const useMediaQuery = (0, _useMediaQuery.unstable_createUseMediaQuery)({
+  themeId: _identifier.default
+});
+var _default = exports.default = useMediaQuery;

package/usePagination/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from "./usePagination.js";
+export * from "./usePagination.js";

package/usePagination/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function () {
+    return _usePagination.default;
+  }
+});
+var _usePagination = _interopRequireDefault(require("./usePagination"));

package/usePagination/usePagination.d.ts

@@ -0,0 +1,74 @@
+import * as React from 'react';
+export interface UsePaginationProps {
+  /**
+   * Number of always visible pages at the beginning and end.
+   * @default 1
+   */
+  boundaryCount?: number;
+  /**
+   * The name of the component where this hook is used.
+   */
+  componentName?: string;
+  /**
+   * The total number of pages.
+   * @default 1
+   */
+  count?: number;
+  /**
+   * The page selected by default when the component is uncontrolled.
+   * @default 1
+   */
+  defaultPage?: number;
+  /**
+   * If `true`, the component is disabled.
+   * @default false
+   */
+  disabled?: boolean;
+  /**
+   * If `true`, hide the next-page button.
+   * @default false
+   */
+  hideNextButton?: boolean;
+  /**
+   * If `true`, hide the previous-page button.
+   * @default false
+   */
+  hidePrevButton?: boolean;
+  /**
+   * Callback fired when the page is changed.
+   *
+   * @param {React.ChangeEvent<unknown>} event The event source of the callback.
+   * @param {number} page The page selected.
+   */
+  onChange?: (event: React.ChangeEvent<unknown>, page: number) => void;
+  /**
+   * The current page. Unlike `TablePagination`, which starts numbering from `0`, this pagination starts from `1`.
+   */
+  page?: number;
+  /**
+   * If `true`, show the first-page button.
+   * @default false
+   */
+  showFirstButton?: boolean;
+  /**
+   * If `true`, show the last-page button.
+   * @default false
+   */
+  showLastButton?: boolean;
+  /**
+   * Number of always visible pages before and after the current page.
+   * @default 1
+   */
+  siblingCount?: number;
+}
+export interface UsePaginationItem {
+  onClick: React.ReactEventHandler;
+  type: 'page' | 'first' | 'last' | 'next' | 'previous' | 'start-ellipsis' | 'end-ellipsis';
+  page: number | null;
+  selected: boolean;
+  disabled: boolean;
+}
+export interface UsePaginationResult {
+  items: UsePaginationItem[];
+}
+export default function usePagination(props: UsePaginationProps): UsePaginationResult;

package/usePagination/usePagination.js

@@ -0,0 +1,119 @@
+"use strict";
+'use client';
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = usePagination;
+var _useControlled = _interopRequireDefault(require("@mui/utils/useControlled"));
+function usePagination(props = {}) {
+  // keep default values in sync with @default tags in Pagination.propTypes
+  const {
+    boundaryCount = 1,
+    componentName = 'usePagination',
+    count = 1,
+    defaultPage = 1,
+    disabled = false,
+    hideNextButton = false,
+    hidePrevButton = false,
+    onChange: handleChange,
+    page: pageProp,
+    showFirstButton = false,
+    showLastButton = false,
+    siblingCount = 1,
+    ...other
+  } = props;
+  const [page, setPageState] = (0, _useControlled.default)({
+    controlled: pageProp,
+    default: defaultPage,
+    name: componentName,
+    state: 'page'
+  });
+  const handleClick = (event, value) => {
+    if (!pageProp) {
+      setPageState(value);
+    }
+    if (handleChange) {
+      handleChange(event, value);
+    }
+  };
+
+  // https://dev.to/namirsab/comment/2050
+  const range = (start, end) => {
+    const length = end - start + 1;
+    return Array.from({
+      length
+    }, (_, i) => start + i);
+  };
+  const startPages = range(1, Math.min(boundaryCount, count));
+  const endPages = range(Math.max(count - boundaryCount + 1, boundaryCount + 1), count);
+  const siblingsStart = Math.max(Math.min(
+  // Natural start
+  page - siblingCount,
+  // Lower boundary when page is high
+  count - boundaryCount - siblingCount * 2 - 1),
+  // Greater than startPages
+  boundaryCount + 2);
+  const siblingsEnd = Math.min(Math.max(
+  // Natural end
+  page + siblingCount,
+  // Upper boundary when page is low
+  boundaryCount + siblingCount * 2 + 2),
+  // Less than endPages
+  count - boundaryCount - 1);
+
+  // Basic list of items to render
+  // for example itemList = ['first', 'previous', 1, 'ellipsis', 4, 5, 6, 'ellipsis', 10, 'next', 'last']
+  const itemList = [...(showFirstButton ? ['first'] : []), ...(hidePrevButton ? [] : ['previous']), ...startPages,
+  // Start ellipsis
+  // eslint-disable-next-line no-nested-ternary
+  ...(siblingsStart > boundaryCount + 2 ? ['start-ellipsis'] : boundaryCount + 1 < count - boundaryCount ? [boundaryCount + 1] : []),
+  // Sibling pages
+  ...range(siblingsStart, siblingsEnd),
+  // End ellipsis
+  // eslint-disable-next-line no-nested-ternary
+  ...(siblingsEnd < count - boundaryCount - 1 ? ['end-ellipsis'] : count - boundaryCount > boundaryCount ? [count - boundaryCount] : []), ...endPages, ...(hideNextButton ? [] : ['next']), ...(showLastButton ? ['last'] : [])];
+
+  // Map the button type to its page number
+  const buttonPage = type => {
+    switch (type) {
+      case 'first':
+        return 1;
+      case 'previous':
+        return page - 1;
+      case 'next':
+        return page + 1;
+      case 'last':
+        return count;
+      default:
+        return null;
+    }
+  };
+
+  // Convert the basic item list to PaginationItem props objects
+  const items = itemList.map(item => {
+    return typeof item === 'number' ? {
+      onClick: event => {
+        handleClick(event, item);
+      },
+      type: 'page',
+      page: item,
+      selected: item === page,
+      disabled,
+      'aria-current': item === page ? 'page' : undefined
+    } : {
+      onClick: event => {
+        handleClick(event, buttonPage(item));
+      },
+      type: item,
+      page: buttonPage(item),
+      selected: false,
+      disabled: disabled || !item.includes('ellipsis') && (item === 'next' || item === 'last' ? page >= count : page <= 1)
+    };
+  });
+  return {
+    items,
+    ...other
+  };
+}

package/useScrollTrigger/index.d.ts

@@ -0,0 +1 @@
+export { default } from "./useScrollTrigger.js";

package/useScrollTrigger/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function () {
+    return _useScrollTrigger.default;
+  }
+});
+var _useScrollTrigger = _interopRequireDefault(require("./useScrollTrigger"));

package/useScrollTrigger/useScrollTrigger.d.ts

@@ -0,0 +1,6 @@
+export interface UseScrollTriggerOptions {
+  disableHysteresis?: boolean;
+  target?: Node | Window | null;
+  threshold?: number;
+}
+export default function useScrollTrigger(options?: UseScrollTriggerOptions): boolean;

package/useScrollTrigger/useScrollTrigger.js

@@ -0,0 +1,61 @@
+"use strict";
+'use client';
+
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = useScrollTrigger;
+var React = _interopRequireWildcard(require("react"));
+function defaultTrigger(store, options) {
+  const {
+    disableHysteresis = false,
+    threshold = 100,
+    target
+  } = options;
+  const previous = store.current;
+  if (target) {
+    // Get vertical scroll
+    store.current = target.pageYOffset !== undefined ? target.pageYOffset : target.scrollTop;
+  }
+  if (!disableHysteresis && previous !== undefined) {
+    if (store.current < previous) {
+      return false;
+    }
+  }
+  return store.current > threshold;
+}
+const defaultTarget = typeof window !== 'undefined' ? window : null;
+function useScrollTrigger(options = {}) {
+  const {
+    getTrigger = defaultTrigger,
+    target = defaultTarget,
+    ...other
+  } = options;
+  const store = React.useRef();
+  const [trigger, setTrigger] = React.useState(() => getTrigger(store, other));
+  React.useEffect(() => {
+    if (target === null) {
+      return setTrigger(false);
+    }
+    const handleScroll = () => {
+      setTrigger(getTrigger(store, {
+        target,
+        ...other
+      }));
+    };
+    handleScroll(); // Re-evaluate trigger when dependencies change
+    target.addEventListener('scroll', handleScroll, {
+      passive: true
+    });
+    return () => {
+      target.removeEventListener('scroll', handleScroll, {
+        passive: true
+      });
+    };
+    // See Option 3. https://github.com/facebook/react/issues/14476#issuecomment-471199055
+    // TODO: uncomment once we enable eslint-plugin-react-compiler // eslint-disable-next-line react-compiler/react-compiler
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [target, getTrigger, JSON.stringify(other)]);
+  return trigger;
+}

package/utils/PolymorphicComponent.d.ts

@@ -0,0 +1,17 @@
+import * as React from 'react';
+import { DistributiveOmit, OverridableTypeMap } from '@mui/types';
+/**
+ * A component whose root component can be controlled explicitly with a generic type parameter.
+ * Adjusts valid props based on the type of `RootComponent`.
+ *
+ * @template TypeMap The interface the defines the props and a default root element of the component.
+ */
+export type PolymorphicComponent<TypeMap extends OverridableTypeMap> = {
+  <RootComponent extends React.ElementType = TypeMap['defaultComponent']>(props: PolymorphicProps<TypeMap, RootComponent>): React.JSX.Element | null;
+  propTypes?: any;
+  displayName?: string | undefined;
+};
+/**
+ * Own props of the component augmented with props of the root component.
+ */
+export type PolymorphicProps<TypeMap extends OverridableTypeMap, RootComponent extends React.ElementType> = TypeMap['props'] & DistributiveOmit<React.ComponentPropsWithRef<RootComponent>, keyof TypeMap['props']>;

package/utils/PolymorphicComponent.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/utils/areArraysEqual.d.ts

@@ -0,0 +1,3 @@
+type ItemComparer<Item> = (a: Item, b: Item) => boolean;
+declare function areArraysEqual<Item>(array1: ReadonlyArray<Item>, array2: ReadonlyArray<Item>, itemComparer?: ItemComparer<Item>): boolean;
+export default areArraysEqual;

package/utils/areArraysEqual.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+function areArraysEqual(array1, array2, itemComparer = (a, b) => a === b) {
+  return array1.length === array2.length && array1.every((value, index) => itemComparer(value, array2[index]));
+}
+var _default = exports.default = areArraysEqual;

package/utils/capitalize.d.ts

@@ -0,0 +1,2 @@
+import capitalize from '@mui/utils/capitalize';
+export default capitalize;

package/utils/capitalize.js

@@ -0,0 +1,9 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _capitalize = _interopRequireDefault(require("@mui/utils/capitalize"));
+var _default = exports.default = _capitalize.default;

package/utils/createChainedFunction.d.ts

@@ -0,0 +1,2 @@
+import createChainedFunction from '@mui/utils/createChainedFunction';
+export default createChainedFunction;

package/utils/createChainedFunction.js

@@ -0,0 +1,9 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _createChainedFunction = _interopRequireDefault(require("@mui/utils/createChainedFunction"));
+var _default = exports.default = _createChainedFunction.default;

package/utils/createSimplePaletteValueFilter.d.ts

@@ -0,0 +1,12 @@
+import { PaletteColorOptions, SimplePaletteColorOptions } from "../styles/createPalette.js";
+type AdditionalPropertiesToCheck = (keyof Omit<SimplePaletteColorOptions, 'main'>)[];
+/**
+ * Creates a filter function used to filter simple palette color options.
+ * The minimum requirement is that the object has a "main" property of type string, this is always checked.
+ * Optionally, you can pass additional properties to check.
+ *
+ * @param additionalPropertiesToCheck - Array containing "light", "dark", and/or "contrastText"
+ * @returns ([, value]: [any, PaletteColorOptions]) => boolean
+ */
+export default function createSimplePaletteValueFilter(additionalPropertiesToCheck?: AdditionalPropertiesToCheck): ([, value]: [any, PaletteColorOptions]) => boolean;
+export {};

package/utils/createSimplePaletteValueFilter.js

@@ -0,0 +1,47 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = createSimplePaletteValueFilter;
+/**
+ * Type guard to check if the object has a "main" property of type string.
+ *
+ * @param obj - the object to check
+ * @returns boolean
+ */
+function hasCorrectMainProperty(obj) {
+  return typeof obj.main === 'string';
+}
+/**
+ * Checks if the object conforms to the SimplePaletteColorOptions type.
+ * The minimum requirement is that the object has a "main" property of type string, this is always checked.
+ * Optionally, you can pass additional properties to check.
+ *
+ * @param obj - The object to check
+ * @param additionalPropertiesToCheck - Array containing "light", "dark", and/or "contrastText"
+ * @returns boolean
+ */
+function checkSimplePaletteColorValues(obj, additionalPropertiesToCheck = []) {
+  if (!hasCorrectMainProperty(obj)) {
+    return false;
+  }
+  for (const value of additionalPropertiesToCheck) {
+    if (!obj.hasOwnProperty(value) || typeof obj[value] !== 'string') {
+      return false;
+    }
+  }
+  return true;
+}
+
+/**
+ * Creates a filter function used to filter simple palette color options.
+ * The minimum requirement is that the object has a "main" property of type string, this is always checked.
+ * Optionally, you can pass additional properties to check.
+ *
+ * @param additionalPropertiesToCheck - Array containing "light", "dark", and/or "contrastText"
+ * @returns ([, value]: [any, PaletteColorOptions]) => boolean
+ */
+function createSimplePaletteValueFilter(additionalPropertiesToCheck = []) {
+  return ([, value]) => value && checkSimplePaletteColorValues(value, additionalPropertiesToCheck);
+}

package/utils/createSvgIcon.d.ts

@@ -0,0 +1,2 @@
+import SvgIcon from "../SvgIcon/index.js";
+export default function createSvgIcon(path: React.ReactNode, displayName: string): typeof SvgIcon;

package/utils/createSvgIcon.js

@@ -0,0 +1,31 @@
+"use strict";
+'use client';
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = createSvgIcon;
+var React = _interopRequireWildcard(require("react"));
+var _SvgIcon = _interopRequireDefault(require("../SvgIcon"));
+var _jsxRuntime = require("react/jsx-runtime");
+/**
+ * Private module reserved for @mui packages.
+ */function createSvgIcon(path, displayName) {
+  function Component(props, ref) {
+    return /*#__PURE__*/(0, _jsxRuntime.jsx)(_SvgIcon.default, {
+      "data-testid": process.env.NODE_ENV !== 'production' ? `${displayName}Icon` : undefined,
+      ref: ref,
+      ...props,
+      children: path
+    });
+  }
+  if (process.env.NODE_ENV !== 'production') {
+    // Need to set `displayName` on the inner component for React.memo.
+    // React prior to 16.14 ignores `displayName` on the wrapper.
+    Component.displayName = `${displayName}Icon`;
+  }
+  Component.muiName = _SvgIcon.default.muiName;
+  return /*#__PURE__*/React.memo(/*#__PURE__*/React.forwardRef(Component));
+}

package/utils/debounce.d.ts

@@ -0,0 +1,2 @@
+import debounce from '@mui/utils/debounce';
+export default debounce;

package/utils/debounce.js

@@ -0,0 +1,9 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _debounce = _interopRequireDefault(require("@mui/utils/debounce"));
+var _default = exports.default = _debounce.default;

package/utils/deprecatedPropType.d.ts

@@ -0,0 +1,2 @@
+import deprecatedPropType from '@mui/utils/deprecatedPropType';
+export default deprecatedPropType;

package/utils/deprecatedPropType.js

@@ -0,0 +1,9 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _deprecatedPropType = _interopRequireDefault(require("@mui/utils/deprecatedPropType"));
+var _default = exports.default = _deprecatedPropType.default;