@vodafone_de/brix-components 3.1.0 → 3.1.2

package/dist/Slider/useSlider.types.d.ts

@@ -0,0 +1,226 @@
+import * as React from 'react';
+export interface UseSliderParameters {
+  /**
+   * The id of the element containing a label for the slider.
+   */
+  'aria-labelledby'?: string;
+  /**
+   * The default value. Use when the component is not controlled.
+   */
+  defaultValue?: number | ReadonlyArray<number>;
+  /**
+   * If `true`, the component is disabled.
+   * @default false
+   */
+  disabled?: boolean;
+  /**
+   * If `true`, the active thumb doesn't swap when moving pointer over a thumb while dragging another thumb.
+   * @default false
+   */
+  disableSwap?: boolean;
+  /**
+   * If `true` the Slider will be rendered right-to-left (with the lowest value on the right-hand side).
+   * @default false
+   */
+  isRtl?: boolean;
+  /**
+   * Marks indicate predetermined values to which the user can move the slider.
+   * If `true` the marks are spaced according the value of the `step` prop.
+   * If an array, it should contain objects with `value` and an optional `label` keys.
+   * @default false
+   */
+  marks?: boolean | ReadonlyArray<Mark>;
+  /**
+   * The maximum allowed value of the slider.
+   * Should not be equal to min.
+   * @default 100
+   */
+  max?: number;
+  /**
+   * The minimum allowed value of the slider.
+   * Should not be equal to max.
+   * @default 0
+   */
+  min?: number;
+  /**
+   * Name attribute of the hidden `input` element.
+   */
+  name?: string;
+  /**
+   * Callback function that is fired when the slider's value changed.
+   *
+   * @param {Event} event The event source of the callback.
+   * You can pull out the new value by accessing `event.target.value` (any).
+   * **Warning**: This is a generic event not a change event.
+   * @param {number | number[]} value The new value.
+   * @param {number} activeThumb Index of the currently moved thumb.
+   */
+  onChange?: (event: Event, value: number | number[], activeThumb: number) => void;
+  /**
+   * Callback function that is fired when the `mouseup` is triggered.
+   *
+   * @param {React.SyntheticEvent | Event} event The event source of the callback. **Warning**: This is a generic event not a change event.
+   * @param {number | number[]} value The new value.
+   */
+  onChangeCommitted?: (event: React.SyntheticEvent | Event, value: number | number[]) => void;
+  /**
+   * The component orientation.
+   * @default 'horizontal'
+   */
+  orientation?: 'horizontal' | 'vertical';
+  /**
+   * The ref attached to the root of the Slider.
+   */
+  rootRef?: React.Ref<Element>;
+  /**
+   * A transformation function, to change the scale of the slider.
+   * @param {any} x
+   * @returns {any}
+   * @default function Identity(x) {
+   *   return x;
+   * }
+   */
+  scale?: (value: number) => number;
+  /**
+   * The granularity with which the slider can step through values when using Page Up/Page Down or Shift + Arrow Up/Arrow Down.
+   * @default 10
+   */
+  shiftStep?: number;
+  /**
+   * The granularity with which the slider can step through values. (A "discrete" slider.)
+   * The `min` prop serves as the origin for the valid values.
+   * We recommend (max - min) to be evenly divisible by the step.
+   *
+   * When step is `null`, the thumb can only be slid onto marks provided with the `marks` prop.
+   * @default 1
+   */
+  step?: number | null;
+  /**
+   * Tab index attribute of the hidden `input` element.
+   */
+  tabIndex?: number;
+  /**
+   * The value of the slider.
+   * For ranged sliders, provide an array with two values.
+   */
+  value?: number | ReadonlyArray<number>;
+}
+export interface Mark {
+  value: number;
+  label?: React.ReactNode;
+}
+export type UseSliderRootSlotOwnProps = {
+  onMouseDown: React.MouseEventHandler;
+  ref: React.RefCallback<Element> | null;
+};
+export type UseSliderRootSlotProps<ExternalProps = {}> = Omit<ExternalProps, keyof UseSliderRootSlotOwnProps> & UseSliderRootSlotOwnProps;
+export type UseSliderThumbSlotOwnProps = {
+  onMouseLeave: React.MouseEventHandler;
+  onMouseOver: React.MouseEventHandler;
+};
+export type UseSliderThumbSlotProps<ExternalProps = {}> = Omit<ExternalProps, keyof UseSliderThumbSlotOwnProps> & UseSliderThumbSlotOwnProps;
+export type UseSliderHiddenInputOwnProps = {
+  'aria-labelledby'?: string;
+  'aria-orientation'?: React.AriaAttributes['aria-orientation'];
+  'aria-valuemax'?: React.AriaAttributes['aria-valuemax'];
+  'aria-valuemin'?: React.AriaAttributes['aria-valuemin'];
+  disabled: boolean;
+  name?: string;
+  onBlur: React.FocusEventHandler;
+  onChange: React.ChangeEventHandler;
+  onFocus: React.FocusEventHandler;
+  step?: number | 'any';
+  style: React.CSSProperties;
+  tabIndex?: number;
+  type?: React.InputHTMLAttributes<HTMLInputElement>['type'];
+};
+export type UseSliderHiddenInputProps<ExternalProps = {}> = Omit<ExternalProps, keyof UseSliderHiddenInputOwnProps> & UseSliderHiddenInputOwnProps;
+export type Axis = 'horizontal' | 'vertical' | 'horizontal-reverse';
+export interface AxisProps<T extends Axis> {
+  offset: (percent: number) => T extends 'horizontal' ? {
+    left: string;
+  } : T extends 'vertical' ? {
+    bottom: string;
+  } : T extends 'horizontal-reverse' ? {
+    right: string;
+  } : never;
+  leap: (percent: number) => T extends 'horizontal' | 'horizontal-reverse' ? {
+    width: string;
+  } : T extends 'vertical' ? {
+    height: string;
+  } : never;
+}
+export interface UseSliderReturnValue {
+  /**
+   * The active index of the slider.
+   */
+  active: number;
+  /**
+   * The orientation of the slider.
+   */
+  axis: Axis;
+  /**
+   * Returns the `offset` and `leap` methods to calculate the positioning styles based on the slider axis.
+   */
+  axisProps: { [key in Axis]: AxisProps<key> };
+  /**
+   * If `true`, the slider is being dragged.
+   */
+  dragging: boolean;
+  /**
+   * The index of the thumb which is focused on the slider.
+   */
+  focusedThumbIndex: number;
+  /**
+   * Resolver for the hidden input slot's props.
+   * @param externalProps props for the hidden input slot
+   * @returns props that should be spread on the hidden input slot
+   */
+  getHiddenInputProps: <ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseSliderHiddenInputProps<ExternalProps>;
+  /**
+   * Resolver for the root slot's props.
+   * @param externalProps props for the root slot
+   * @returns props that should be spread on the root slot
+   */
+  getRootProps: <ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseSliderRootSlotProps<ExternalProps>;
+  /**
+   * Resolver for the thumb slot's props.
+   * @param externalProps props for the thumb slot
+   * @returns props that should be spread on the thumb slot
+   */
+  getThumbProps: <ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseSliderThumbSlotProps<ExternalProps>;
+  /**
+   * Resolver for the thumb slot's style prop.
+   * @param index of the currently moved thumb
+   * @returns props that should be spread on the style prop of thumb slot
+   */
+  getThumbStyle: (index: number) => object;
+  /**
+   * The marks of the slider. Marks indicate predetermined values to which the user can move the slider.
+   */
+  marks: Mark[];
+  /**
+   * The thumb index for the current value when in hover state.
+   */
+  open: number;
+  /**
+   * If `true`, the slider is a range slider when the `value` prop passed is an array.
+   */
+  range: boolean;
+  /**
+   * Ref to the root slot's DOM node.
+   */
+  rootRef: React.RefCallback<Element> | null;
+  /**
+   * The track leap for the current value of the slider.
+   */
+  trackLeap: number;
+  /**
+   * The track offset for the current value of the slider.
+   */
+  trackOffset: number;
+  /**
+   * The possible values of the slider.
+   */
+  values: number[];
+}

package/dist/Slider/useSlider.types.js

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

package/dist/Snackbar/Snackbar.d.ts

@@ -0,0 +1,182 @@
+import * as React from 'react';
+import { SxProps } from '@mui/system';
+import ClickAwayListener, { ClickAwayListenerProps } from "../ClickAwayListener/index.js";
+import { Theme } from "../styles/index.js";
+import { InternalStandardProps as StandardProps } from "../index.js";
+import { SnackbarContentProps } from "../SnackbarContent/index.js";
+import { TransitionProps } from "../transitions/transition.js";
+import { SnackbarClasses } from "./snackbarClasses.js";
+import { CreateSlotsAndSlotProps, SlotComponentProps, SlotProps } from "../utils/types.js";
+export interface SnackbarSlots {
+  /**
+   * The component that renders the root slot.
+   * @default 'div'
+   */
+  root: React.ElementType;
+  /**
+   * The component that renders the content slot.
+   * @default SnackbarContent
+   */
+  content: React.ElementType;
+  /**
+   * The component that renders the clickAwayListener slot.
+   * @default ClickAwayListener
+   */
+  clickAwayListener: React.ElementType;
+  /**
+   * The component that renders the transition.
+   * [Follow this guide](/material-ui/transitions/#transitioncomponent-prop) to learn more about the requirements for this component.
+   * @default Grow
+   */
+  transition: React.ElementType;
+}
+export interface SnackbarRootSlotPropsOverrides {}
+export interface SnackbarContentSlotPropsOverrides {}
+export interface SnackbarClickAwayListenerSlotPropsOverrides {}
+export interface SnackbarTransitionSlotPropsOverrides {}
+export type SnackbarSlotsAndSlotProps = CreateSlotsAndSlotProps<SnackbarSlots, {
+  /**
+   * Props forwarded to the root slot.
+   * By default, the avaible props are based on the div element.
+   */
+  root: SlotProps<'div', SnackbarRootSlotPropsOverrides, SnackbarOwnerState>;
+  /**
+   * Props forwarded to the content slot.
+   * By default, the avaible props are based on the [SnackbarContent](https://mui.com/material-ui/api/snackbar-content/#props) component.
+   */
+  content: SlotProps<React.ElementType<SnackbarContentProps>, SnackbarContentSlotPropsOverrides, SnackbarOwnerState>;
+  /**
+   * Props forwarded to the clickAwayListener slot.
+   * By default, the avaible props are based on the [ClickAwayListener](https://mui.com/material-ui/api/click-away-listener/#props) component.
+   */
+  clickAwayListener: SlotComponentProps<typeof ClickAwayListener, SnackbarClickAwayListenerSlotPropsOverrides, SnackbarOwnerState>;
+  /**
+   * Props applied to the transition element.
+   * By default, the element is based on the [Grow](https://mui.com/material-ui/api/grow/#props) component.
+   */
+  transition: SlotComponentProps<React.ElementType, TransitionProps & SnackbarTransitionSlotPropsOverrides, SnackbarOwnerState>;
+}>;
+export interface SnackbarOrigin {
+  vertical: 'top' | 'bottom';
+  horizontal: 'left' | 'center' | 'right';
+}
+export type SnackbarCloseReason = 'timeout' | 'clickaway' | 'escapeKeyDown';
+export interface SnackbarProps extends Omit<StandardProps<React.HTMLAttributes<HTMLDivElement>>, 'slots' | 'slotProps'>, SnackbarSlotsAndSlotProps {
+  /**
+   * The action to display. It renders after the message, at the end of the snackbar.
+   */
+  action?: SnackbarContentProps['action'];
+  /**
+   * The anchor of the `Snackbar`.
+   * On smaller screens, the component grows to occupy all the available width,
+   * the horizontal alignment is ignored.
+   * @default { vertical: 'bottom', horizontal: 'left' }
+   */
+  anchorOrigin?: SnackbarOrigin;
+  /**
+   * The number of milliseconds to wait before automatically calling the
+   * `onClose` function. `onClose` should then set the state of the `open`
+   * prop to hide the Snackbar. This behavior is disabled by default with
+   * the `null` value.
+   * @default null
+   */
+  autoHideDuration?: number | null;
+  /**
+   * Replace the `SnackbarContent` component.
+   */
+  children?: React.ReactElement<unknown, any>;
+  /**
+   * Override or extend the styles applied to the component.
+   */
+  classes?: Partial<SnackbarClasses>;
+  /**
+   * Props applied to the `ClickAwayListener` element.
+   * @deprecated Use `slotProps.clickAwayListener` instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](/material-ui/migration/migrating-from-deprecated-apis/) for more details.
+   */
+  ClickAwayListenerProps?: Partial<ClickAwayListenerProps>;
+  /**
+   * Props applied to the [`SnackbarContent`](https://mui.com/material-ui/api/snackbar-content/) element.
+   * @deprecated Use `slotProps.content` instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](/material-ui/migration/migrating-from-deprecated-apis/) for more details.
+   */
+  ContentProps?: Partial<SnackbarContentProps>;
+  /**
+   * If `true`, the `autoHideDuration` timer will expire even if the window is not focused.
+   * @default false
+   */
+  disableWindowBlurListener?: boolean;
+  /**
+   * When displaying multiple consecutive snackbars using a single parent-rendered
+   * `<Snackbar/>`, add the `key` prop to ensure independent treatment of each message.
+   * For instance, use `<Snackbar key={message} />`. Otherwise, messages might update
+   * in place, and features like `autoHideDuration` could be affected.
+   */
+  key?: any;
+  /**
+   * The message to display.
+   */
+  message?: SnackbarContentProps['message'];
+  /**
+   * Callback fired when the component requests to be closed.
+   * Typically `onClose` is used to set state in the parent component,
+   * which is used to control the `Snackbar` `open` prop.
+   * The `reason` parameter can optionally be used to control the response to `onClose`,
+   * for example ignoring `clickaway`.
+   *
+   * @param {React.SyntheticEvent<any> | Event} event The event source of the callback.
+   * @param {string} reason Can be: `"timeout"` (`autoHideDuration` expired), `"clickaway"`, or `"escapeKeyDown"`.
+   */
+  onClose?: (event: React.SyntheticEvent<any> | Event, reason: SnackbarCloseReason) => void;
+  /**
+   * If `true`, the component is shown.
+   */
+  open?: boolean;
+  /**
+   * The number of milliseconds to wait before dismissing after user interaction.
+   * If `autoHideDuration` prop isn't specified, it does nothing.
+   * If `autoHideDuration` prop is specified but `resumeHideDuration` isn't,
+   * we default to `autoHideDuration / 2` ms.
+   */
+  resumeHideDuration?: number;
+  /**
+   * The system prop that allows defining system overrides as well as additional CSS styles.
+   */
+  sx?: SxProps<Theme>;
+  /**
+   * The component used for the transition.
+   * [Follow this guide](https://mui.com/material-ui/transitions/#transitioncomponent-prop) to learn more about the requirements for this component.
+   * @deprecated Use `slots.transition` instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](/material-ui/migration/migrating-from-deprecated-apis/) for more details.
+   * @default Grow
+   */
+  TransitionComponent?: React.JSXElementConstructor<TransitionProps & {
+    children: React.ReactElement<unknown, any>;
+  }>;
+  /**
+   * The duration for the transition, in milliseconds.
+   * You may specify a single timeout for all transitions, or individually with an object.
+   * @default {
+   *   enter: theme.transitions.duration.enteringScreen,
+   *   exit: theme.transitions.duration.leavingScreen,
+   * }
+   */
+  transitionDuration?: TransitionProps['timeout'];
+  /**
+   * Props applied to the transition element.
+   * By default, the element is based on this [`Transition`](https://reactcommunity.org/react-transition-group/transition/) component.
+   * @deprecated Use `slotProps.transition` instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](/material-ui/migration/migrating-from-deprecated-apis/) for more details.
+   * @default {}
+   */
+  TransitionProps?: TransitionProps;
+}
+
+/**
+ *
+ * Demos:
+ *
+ * - [Snackbar](https://mui.com/material-ui/react-snackbar/)
+ *
+ * API:
+ *
+ * - [Snackbar API](https://mui.com/material-ui/api/snackbar/)
+ */
+export default function Snackbar(props: SnackbarProps): React.JSX.Element;
+export interface SnackbarOwnerState extends Omit<SnackbarProps, 'slots' | 'slotProps'> {}