@base-ui/react 1.2.0 → 1.4.0

package/esm/temporal-adapter-luxon/TemporalAdapterLuxon.js

@@ -0,0 +1,327 @@
+// Intentionally ignore TS issues in this file to avoid docs being built with `| DateTime`
+// TODO: Remove if temporal adapters are supported
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-nocheck
+'use client';
+
+import { DateTime, Info } from 'luxon';
+const FORMATS = {
+  // Digit formats with leading zeroes
+  yearPadded: 'yyyy',
+  monthPadded: 'MM',
+  dayOfMonthPadded: 'dd',
+  hours24hPadded: 'HH',
+  hours12hPadded: 'hh',
+  minutesPadded: 'mm',
+  secondsPadded: 'ss',
+  // Digit formats without leading zeroes
+  dayOfMonth: 'd',
+  hours24h: 'H',
+  hours12h: 'h',
+  // Letter formats
+  month3Letters: 'MMM',
+  monthFullLetter: 'MMMM',
+  weekday: 'cccc',
+  weekday3Letters: 'ccc',
+  weekday1Letter: 'ccccc',
+  meridiem: 'a',
+  // Full formats
+  localizedDateWithFullMonthAndWeekDay: 'DDDD',
+  localizedNumericDate: 'D',
+  fullMonthAndYear: 'MMMM yyyy'
+};
+
+// Temporarily disabled to avoid docs being built with `| DateTime`
+// declare module '@base-ui/react/types' {
+//   interface TemporalSupportedObjectLookup {
+//     luxon: DateTime;
+//   }
+// }
+
+export class TemporalAdapterLuxon {
+  isTimezoneCompatible = true;
+  lib = 'luxon';
+  formats = FORMATS;
+  escapedCharacters = {
+    start: "'",
+    end: "'"
+  };
+  constructor({
+    locale
+  } = {}) {
+    this.locale = locale ?? 'en-US';
+  }
+  setLocaleToValue = value => {
+    const expectedLocale = this.getCurrentLocaleCode();
+    if (expectedLocale === value.locale) {
+      return value;
+    }
+    return value.setLocale(expectedLocale);
+  };
+  now = timezone => {
+    // @ts-expect-error locale is not identified as a field
+    return DateTime.fromJSDate(new Date(), {
+      locale: this.locale,
+      zone: timezone
+    });
+  };
+  date = (value, timezone) => {
+    if (value === null) {
+      return null;
+    }
+    return DateTime.fromISO(value, {
+      locale: this.locale,
+      zone: timezone
+    });
+  };
+  parse = (value, format, timezone) => {
+    return DateTime.fromFormat(value, format, {
+      locale: this.locale,
+      zone: timezone
+    });
+  };
+  getTimezone = value => {
+    // When using the system zone, we want to return "system", not something like "Europe/Paris"
+    if (value.zone.type === 'system') {
+      return 'system';
+    }
+    return value.zoneName;
+  };
+  setTimezone = (value, timezone) => {
+    if (!value.zone.equals(Info.normalizeZone(timezone))) {
+      return value.setZone(timezone);
+    }
+    return value;
+  };
+  toJsDate = value => {
+    return value.toJSDate();
+  };
+  getCurrentLocaleCode = () => {
+    return this.locale;
+  };
+  isValid = value => {
+    if (value == null) {
+      return false;
+    }
+    return value.isValid;
+  };
+  format = (value, formatKey) => {
+    return this.formatByString(value, this.formats[formatKey]);
+  };
+  formatByString = (value, format) => {
+    return value.setLocale(this.locale).toFormat(format);
+  };
+  isEqual = (value, comparing) => {
+    if (value === null && comparing === null) {
+      return true;
+    }
+    if (value === null || comparing === null) {
+      return false;
+    }
+    return +value === +comparing;
+  };
+  isSameYear = (value, comparing) => {
+    const comparingInValueTimezone = this.setTimezone(comparing, this.getTimezone(value));
+    return value.hasSame(comparingInValueTimezone, 'year');
+  };
+  isSameMonth = (value, comparing) => {
+    const comparingInValueTimezone = this.setTimezone(comparing, this.getTimezone(value));
+    return value.hasSame(comparingInValueTimezone, 'month');
+  };
+  isSameDay = (value, comparing) => {
+    const comparingInValueTimezone = this.setTimezone(comparing, this.getTimezone(value));
+    return value.hasSame(comparingInValueTimezone, 'day');
+  };
+  isSameHour = (value, comparing) => {
+    const comparingInValueTimezone = this.setTimezone(comparing, this.getTimezone(value));
+    return value.hasSame(comparingInValueTimezone, 'hour');
+  };
+  isAfter = (value, comparing) => {
+    return value > comparing;
+  };
+  isBefore = (value, comparing) => {
+    return value < comparing;
+  };
+  isWithinRange = (value, [start, end]) => {
+    if (this.isAfter(value, start) && this.isBefore(value, end)) {
+      return true;
+    }
+    return this.isEqual(value, start) || this.isEqual(value, end);
+  };
+  startOfYear = value => {
+    return value.startOf('year');
+  };
+  startOfMonth = value => {
+    return value.startOf('month');
+  };
+  startOfWeek = value => {
+    return this.setLocaleToValue(value).startOf('week', {
+      useLocaleWeeks: true
+    });
+  };
+  startOfDay = value => {
+    return value.startOf('day');
+  };
+  startOfHour = value => {
+    return value.startOf('hour');
+  };
+  startOfMinute = value => {
+    return value.startOf('minute');
+  };
+  startOfSecond = value => {
+    return value.startOf('second');
+  };
+  endOfYear = value => {
+    return value.endOf('year');
+  };
+  endOfMonth = value => {
+    return value.endOf('month');
+  };
+  endOfWeek = value => {
+    return this.setLocaleToValue(value).endOf('week', {
+      useLocaleWeeks: true
+    });
+  };
+  endOfDay = value => {
+    return value.endOf('day');
+  };
+  endOfHour = value => {
+    return value.endOf('hour');
+  };
+  endOfMinute = value => {
+    return value.endOf('minute');
+  };
+  endOfSecond = value => {
+    return value.endOf('second');
+  };
+  addYears = (value, amount) => {
+    return value.plus({
+      years: amount
+    });
+  };
+  addMonths = (value, amount) => {
+    return value.plus({
+      months: amount
+    });
+  };
+  addWeeks = (value, amount) => {
+    return value.plus({
+      weeks: amount
+    });
+  };
+  addDays = (value, amount) => {
+    return value.plus({
+      days: amount
+    });
+  };
+  addHours = (value, amount) => {
+    return value.plus({
+      hours: amount
+    });
+  };
+  addMinutes = (value, amount) => {
+    return value.plus({
+      minutes: amount
+    });
+  };
+  addSeconds = (value, amount) => {
+    return value.plus({
+      seconds: amount
+    });
+  };
+  addMilliseconds = (value, amount) => {
+    return value.plus({
+      milliseconds: amount
+    });
+  };
+  getYear = value => {
+    return value.get('year');
+  };
+  getMonth = value => {
+    // See https://github.com/moment/luxon/blob/master/docs/moment.md#major-functional-differences
+    return value.get('month') - 1;
+  };
+  getDate = value => {
+    return value.get('day');
+  };
+  getHours = value => {
+    return value.get('hour');
+  };
+  getMinutes = value => {
+    return value.get('minute');
+  };
+  getSeconds = value => {
+    return value.get('second');
+  };
+  getMilliseconds = value => {
+    return value.get('millisecond');
+  };
+  getTime = value => {
+    return value.toMillis();
+  };
+  setYear = (value, year) => {
+    return value.set({
+      year
+    });
+  };
+  setMonth = (value, month) => {
+    // See https://github.com/moment/luxon/blob/master/docs/moment.md#major-functional-differences
+    return value.set({
+      month: month + 1
+    });
+  };
+  setDate = (value, date) => {
+    return value.set({
+      day: date
+    });
+  };
+  setHours = (value, hours) => {
+    return value.set({
+      hour: hours
+    });
+  };
+  setMinutes = (value, minutes) => {
+    return value.set({
+      minute: minutes
+    });
+  };
+  setSeconds = (value, seconds) => {
+    return value.set({
+      second: seconds
+    });
+  };
+  setMilliseconds = (value, milliseconds) => {
+    return value.set({
+      millisecond: milliseconds
+    });
+  };
+  differenceInYears = (value, comparing) => {
+    return Math.floor(value.diff(comparing, 'years').as('years'));
+  };
+  differenceInMonths = (value, comparing) => {
+    return Math.floor(value.diff(comparing, 'months').as('months'));
+  };
+  differenceInWeeks = (value, comparing) => {
+    return Math.floor(value.diff(comparing, 'weeks').as('weeks'));
+  };
+  differenceInDays = (value, comparing) => {
+    return Math.floor(value.diff(comparing, 'days').as('days'));
+  };
+  differenceInHours = (value, comparing) => {
+    return Math.floor(value.diff(comparing, 'hours').as('hours'));
+  };
+  differenceInMinutes = (value, comparing) => {
+    return Math.floor(value.diff(comparing, 'minutes').as('minutes'));
+  };
+  getDaysInMonth = value => {
+    return value.daysInMonth;
+  };
+  getWeekNumber = value => {
+    /* istanbul ignore next */
+    return value.localWeekNumber ?? value.weekNumber;
+  };
+  getDayOfWeek = value => {
+    /* istanbul ignore next */
+    return value.localWeekday ?? value.weekday;
+  };
+}

package/esm/temporal-adapter-luxon/index.d.ts

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

package/esm/temporal-adapter-luxon/index.js

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

package/esm/temporal-adapter-provider/TemporalAdapterContext.d.ts

@@ -0,0 +1,10 @@
+import * as React from 'react';
+import { TemporalAdapter } from "../types/temporal/index.js";
+export type TemporalAdapterContext = {
+  adapter: TemporalAdapter;
+};
+/**
+ * @internal
+ */
+export declare const TemporalAdapterContext: React.Context<TemporalAdapterContext | undefined>;
+export declare function useTemporalAdapter(): TemporalAdapter;

package/esm/temporal-adapter-provider/TemporalAdapterContext.js

@@ -0,0 +1,19 @@
+'use client';
+
+import _formatErrorMessage from "@base-ui/utils/formatErrorMessage";
+import * as React from 'react';
+import { TemporalAdapterDateFns } from "../temporal-adapter-date-fns/TemporalAdapterDateFns.js";
+/**
+ * @internal
+ */
+export const TemporalAdapterContext = /*#__PURE__*/React.createContext({
+  adapter: new TemporalAdapterDateFns()
+});
+if (process.env.NODE_ENV !== "production") TemporalAdapterContext.displayName = "TemporalAdapterContext";
+export function useTemporalAdapter() {
+  const context = React.useContext(TemporalAdapterContext);
+  if (context === undefined) {
+    throw new Error(process.env.NODE_ENV !== "production" ? 'Base UI: TemporalAdapterContext is missing. Temporal components must be place within <TemporalAdapterProvider />' : _formatErrorMessage(93));
+  }
+  return context.adapter;
+}

package/esm/temporal-adapter-provider/TemporalAdapterProvider.d.ts

@@ -0,0 +1,15 @@
+import * as React from 'react';
+import { TemporalAdapter } from "../types/temporal/index.js";
+/**
+ * Defines the date library adapter for Base UI temporal components.
+ */
+export declare const TemporalAdapterProvider: React.FC<TemporalAdapterProvider.Props>;
+export declare namespace TemporalAdapterProvider {
+  interface Props {
+    children?: React.ReactNode;
+    /**
+     * The date library adapter.
+     */
+    adapter: TemporalAdapter;
+  }
+}

package/esm/temporal-adapter-provider/TemporalAdapterProvider.js

@@ -0,0 +1,23 @@
+'use client';
+
+import * as React from 'react';
+import { TemporalAdapterContext } from "./TemporalAdapterContext.js";
+
+/**
+ * Defines the date library adapter for Base UI temporal components.
+ */
+import { jsx as _jsx } from "react/jsx-runtime";
+export const TemporalAdapterProvider = function DateAdapterProvider(props) {
+  const {
+    children,
+    adapter
+  } = props;
+  const contextValue = React.useMemo(() => ({
+    adapter
+  }), [adapter]);
+  return /*#__PURE__*/_jsx(TemporalAdapterContext.Provider, {
+    value: contextValue,
+    children: children
+  });
+};
+if (process.env.NODE_ENV !== "production") TemporalAdapterProvider.displayName = "TemporalAdapterProvider";

package/esm/temporal-adapter-provider/index.d.ts

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

package/esm/temporal-adapter-provider/index.js

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

package/esm/toast/action/ToastAction.d.ts

@@ -13,7 +13,7 @@ export interface ToastActionState {
    */
   type: string | undefined;
 }
-export interface ToastActionProps extends NativeButtonProps, BaseUIComponentProps<'button', ToastAction.State> {}
+export interface ToastActionProps extends NativeButtonProps, BaseUIComponentProps<'button', ToastActionState> {}
 export declare namespace ToastAction {
   type State = ToastActionState;
   type Props = ToastActionProps;

package/esm/toast/action/ToastAction.js

@@ -15,6 +15,7 @@ export const ToastAction = /*#__PURE__*/React.forwardRef(function ToastAction(co
   const {
     render,
     className,
+    style,
     disabled,
     nativeButton = true,
     ...elementProps

package/esm/toast/arrow/ToastArrow.d.ts

@@ -9,11 +9,20 @@ import type { Side, Align } from "../../utils/useAnchorPositioning.js";
  */
 export declare const ToastArrow: React.ForwardRefExoticComponent<Omit<ToastArrowProps, "ref"> & React.RefAttributes<HTMLDivElement>>;
 export interface ToastArrowState {
+  /**
+   * The side of the anchor the component is placed on.
+   */
   side: Side;
+  /**
+   * The alignment of the component relative to the anchor.
+   */
   align: Align;
+  /**
+   * Whether the arrow cannot be centered on the anchor.
+   */
   uncentered: boolean;
 }
-export interface ToastArrowProps extends BaseUIComponentProps<'div', ToastArrow.State> {}
+export interface ToastArrowProps extends BaseUIComponentProps<'div', ToastArrowState> {}
 export declare namespace ToastArrow {
   type State = ToastArrowState;
   type Props = ToastArrowProps;

package/esm/toast/arrow/ToastArrow.js

@@ -14,6 +14,7 @@ export const ToastArrow = /*#__PURE__*/React.forwardRef(function ToastArrow(comp
   const {
     className,
     render,
+    style,
     ...elementProps
   } = componentProps;
   const {

package/esm/toast/close/ToastClose.d.ts

@@ -13,7 +13,7 @@ export interface ToastCloseState {
    */
   type: string | undefined;
 }
-export interface ToastCloseProps extends NativeButtonProps, BaseUIComponentProps<'button', ToastClose.State> {}
+export interface ToastCloseProps extends NativeButtonProps, BaseUIComponentProps<'button', ToastCloseState> {}
 export declare namespace ToastClose {
   type State = ToastCloseState;
   type Props = ToastCloseProps;

package/esm/toast/close/ToastClose.js

@@ -16,6 +16,7 @@ export const ToastClose = /*#__PURE__*/React.forwardRef(function ToastClose(comp
   const {
     render,
     className,
+    style,
     disabled,
     nativeButton = true,
     ...elementProps

package/esm/toast/content/ToastContent.d.ts

@@ -17,7 +17,7 @@ export interface ToastContentState {
    */
   behind: boolean;
 }
-export interface ToastContentProps extends BaseUIComponentProps<'div', ToastContent.State> {}
+export interface ToastContentProps extends BaseUIComponentProps<'div', ToastContentState> {}
 export declare namespace ToastContent {
   type State = ToastContentState;
   type Props = ToastContentProps;

package/esm/toast/content/ToastContent.js

@@ -15,6 +15,7 @@ export const ToastContent = /*#__PURE__*/React.forwardRef(function ToastContent(
   const {
     render,
     className,
+    style,
     ...elementProps
   } = componentProps;
   const {

package/esm/toast/createToastManager.d.ts

@@ -6,7 +6,7 @@ export declare function createToastManager<Data extends object = any>(): ToastMa
 export interface ToastManager<Data extends object = any> {
   ' subscribe': (listener: (data: ToastManagerEvent) => void) => () => void;
   add: <T extends Data = Data>(options: ToastManagerAddOptions<T>) => string;
-  close: (id: string) => void;
+  close: (id?: string) => void;
   update: <T extends Data = Data>(id: string, updates: ToastManagerUpdateOptions<T>) => void;
   promise: <Value, T extends Data = Data>(promiseValue: Promise<Value>, options: ToastManagerPromiseOptions<Value, T>) => Promise<Value>;
 }

package/esm/toast/description/ToastDescription.d.ts

@@ -14,7 +14,7 @@ export interface ToastDescriptionState {
    */
   type: string | undefined;
 }
-export interface ToastDescriptionProps extends BaseUIComponentProps<'p', ToastDescription.State> {}
+export interface ToastDescriptionProps extends BaseUIComponentProps<'p', ToastDescriptionState> {}
 export declare namespace ToastDescription {
   type State = ToastDescriptionState;
   type Props = ToastDescriptionProps;

package/esm/toast/description/ToastDescription.js

@@ -17,6 +17,7 @@ export const ToastDescription = /*#__PURE__*/React.forwardRef(function ToastDesc
   const {
     render,
     className,
+    style,
     id: idProp,
     children: childrenProp,
     ...elementProps

package/esm/toast/portal/ToastPortal.d.ts

@@ -7,10 +7,9 @@ import { FloatingPortalLite } from "../../utils/FloatingPortalLite.js";
  * Documentation: [Base UI Toast](https://base-ui.com/react/components/toast)
  */
 export declare const ToastPortal: import("react").ForwardRefExoticComponent<Omit<FloatingPortalLite.Props<any>, "ref"> & import("react").RefAttributes<HTMLDivElement>>;
+export interface ToastPortalState {}
+export interface ToastPortalProps extends FloatingPortalLite.Props<ToastPortalState> {}
 export declare namespace ToastPortal {
-  interface State {}
-}
-export interface ToastPortalProps extends FloatingPortalLite.Props<ToastPortal.State> {}
-export declare namespace ToastPortal {
+  type State = ToastPortalState;
   type Props = ToastPortalProps;
 }

package/esm/toast/positioner/ToastPositioner.d.ts

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { useAnchorPositioning, type Side, type Align } from "../../utils/useAnchorPositioning.js";
+import { type Side, type Align, type UseAnchorPositioningSharedParameters } from "../../utils/useAnchorPositioning.js";
 import type { BaseUIComponentProps } from "../../utils/types.js";
 import type { ToastObject } from "../useToastManager.js";
 /**
@@ -10,15 +10,24 @@ import type { ToastObject } from "../useToastManager.js";
  */
 export declare const ToastPositioner: React.ForwardRefExoticComponent<Omit<ToastPositionerProps, "ref"> & React.RefAttributes<HTMLDivElement>>;
 export interface ToastPositionerState {
+  /**
+   * The side of the anchor the component is placed on.
+   */
   side: Side;
+  /**
+   * The alignment of the component relative to the anchor.
+   */
   align: Align;
+  /**
+   * Whether the anchor element is hidden.
+   */
   anchorHidden: boolean;
 }
-export interface ToastPositionerProps extends BaseUIComponentProps<'div', ToastPositioner.State>, Omit<useAnchorPositioning.SharedParameters, 'side' | 'anchor'> {
+export interface ToastPositionerProps extends BaseUIComponentProps<'div', ToastPositionerState>, Omit<UseAnchorPositioningSharedParameters, 'side' | 'anchor'> {
   /**
    * An element to position the toast against.
    */
-  anchor?: (Element | null) | undefined;
+  anchor?: Element | null | undefined;
   /**
    * Which side of the anchor element to align the toast against.
    * May automatically change to avoid collisions.

package/esm/toast/positioner/ToastPositioner.js

@@ -3,15 +3,13 @@
 import * as React from 'react';
 import { isElement } from '@floating-ui/utils/dom';
 import { useAnchorPositioning } from "../../utils/useAnchorPositioning.js";
-import { popupStateMapping } from "../../utils/popupStateMapping.js";
-import { useRenderElement } from "../../utils/useRenderElement.js";
 import { EMPTY_OBJECT, POPUP_COLLISION_AVOIDANCE } from "../../utils/constants.js";
-import { getDisabledMountTransitionStyles } from "../../utils/getDisabledMountTransitionStyles.js";
 import { ToastPositionerContext } from "./ToastPositionerContext.js";
 import { useFloatingRootContext } from "../../floating-ui-react/index.js";
 import { NOOP } from "../../utils/noop.js";
 import { ToastRootCssVars } from "../root/ToastRootCssVars.js";
 import { useToastProviderContext } from "../provider/ToastProviderContext.js";
+import { usePositioner } from "../../utils/usePositioner.js";
 
 /**
  * Positions the toast against the anchor.
@@ -42,6 +40,7 @@ export const ToastPositioner = /*#__PURE__*/React.forwardRef(function ToastPosit
     sticky = positionerProps.sticky ?? false,
     disableAnchorTracking = positionerProps.disableAnchorTracking ?? false,
     collisionAvoidance = positionerProps.collisionAvoidance ?? POPUP_COLLISION_AVOIDANCE,
+    style,
     ...elementProps
   } = props;
   const [positionerElement, setPositionerElement] = React.useState(null);
@@ -73,36 +72,22 @@ export const ToastPositioner = /*#__PURE__*/React.forwardRef(function ToastPosit
     keepMounted: true,
     collisionAvoidance
   });
-  const defaultProps = React.useMemo(() => {
-    const hiddenStyles = {};
-    return {
-      role: 'presentation',
-      style: {
-        ...positioning.positionerStyles,
-        ...hiddenStyles,
-        [ToastRootCssVars.index]: toast.transitionStatus === 'ending' ? domIndex : visibleIndex
-      }
-    };
-  }, [positioning.positionerStyles, toast.transitionStatus, domIndex, visibleIndex]);
   const state = React.useMemo(() => ({
     side: positioning.side,
     align: positioning.align,
     anchorHidden: positioning.anchorHidden
   }), [positioning.side, positioning.align, positioning.anchorHidden]);
-  const contextValue = React.useMemo(() => ({
-    ...state,
-    arrowRef: positioning.arrowRef,
-    arrowStyles: positioning.arrowStyles,
-    arrowUncentered: positioning.arrowUncentered
-  }), [state, positioning.arrowRef, positioning.arrowStyles, positioning.arrowUncentered]);
-  const element = useRenderElement('div', componentProps, {
-    state,
-    props: [defaultProps, getDisabledMountTransitionStyles(toast.transitionStatus), elementProps],
-    ref: [forwardedRef, setPositionerElement],
-    stateAttributesMapping: popupStateMapping
+  const element = usePositioner(componentProps, state, {
+    styles: {
+      ...positioning.positionerStyles,
+      [ToastRootCssVars.index]: toast.transitionStatus === 'ending' ? domIndex : visibleIndex
+    },
+    transitionStatus: toast.transitionStatus,
+    props: elementProps,
+    refs: [forwardedRef, setPositionerElement]
   });
   return /*#__PURE__*/_jsx(ToastPositionerContext.Provider, {
-    value: contextValue,
+    value: positioning,
     children: element
   });
 });

package/esm/toast/positioner/ToastPositionerContext.d.ts

@@ -1,11 +1,5 @@
 import * as React from 'react';
-import type { Side, Align } from "../../utils/useAnchorPositioning.js";
-export interface ToastPositionerContext {
-  side: Side;
-  align: Align;
-  arrowRef: React.RefObject<Element | null>;
-  arrowUncentered: boolean;
-  arrowStyles: React.CSSProperties;
-}
+import type { UseAnchorPositioningReturnValue } from "../../utils/useAnchorPositioning.js";
+export type ToastPositionerContext = Pick<UseAnchorPositioningReturnValue, 'side' | 'align' | 'arrowRef' | 'arrowUncentered' | 'arrowStyles'>;
 export declare const ToastPositionerContext: React.Context<ToastPositionerContext | undefined>;
 export declare function useToastPositionerContext(): ToastPositionerContext;