victory-core 37.0.2 → 37.1.0

package/es/index.d.ts

@@ -9,8 +9,9 @@ export * from "./victory-clip-container/victory-clip-container";
 export * from "./victory-theme/types";
 export * from "./victory-theme/victory-theme";
 export * from "./victory-portal/portal";
-export * from "./victory-portal/portal-context";
 export * from "./victory-portal/victory-portal";
+export * from "./victory-portal/portal-context";
+export * from "./victory-portal/portal-outlet";
 export * from "./victory-primitives";
 export { Border as Box } from "./victory-primitives";
 export type { BorderProps as BoxProps } from "./victory-primitives";

package/es/index.js

@@ -9,8 +9,9 @@ export * from "./victory-clip-container/victory-clip-container";
 export * from "./victory-theme/types";
 export * from "./victory-theme/victory-theme";
 export * from "./victory-portal/portal";
-export * from "./victory-portal/portal-context";
 export * from "./victory-portal/victory-portal";
+export * from "./victory-portal/portal-context";
+export * from "./victory-portal/portal-outlet";
 export * from "./victory-primitives";
 export { Border as Box } from "./victory-primitives";
 export * from "./victory-util";

package/es/types/prop-types.d.ts

@@ -126,5 +126,6 @@ export declare type CoordinatesPropType = {
     x: number;
     y: number;
 };
+export declare type VictoryEventHandler = (event?: any, targetProps?: any, eventKey?: any, context?: any) => void;
 export {};
 //# sourceMappingURL=prop-types.d.ts.map

package/es/victory-container/victory-container.d.ts

@@ -14,9 +14,6 @@ export interface VictoryContainerProps {
     height?: number;
     name?: string;
     origin?: OriginType;
-    ouiaId?: number | string;
-    ouiaSafe?: boolean;
-    ouiaType?: string;
     polar?: boolean;
     portalComponent?: React.ReactElement;
     portalZIndex?: number;
@@ -32,38 +29,35 @@ export interface VictoryContainerProps {
     theme?: VictoryThemeDefinition;
     title?: string;
     width?: number;
+    ouiaId?: number | string;
+    ouiaSafe?: boolean;
+    ouiaType?: string;
 }
-export declare class VictoryContainer<TProps extends VictoryContainerProps> extends React.Component<TProps> {
-    static displayName: string;
-    static role: string;
-    static defaultProps: {
-        className: string;
-        portalComponent: JSX.Element;
-        portalZIndex: number;
-        responsive: boolean;
-        role: string;
+export declare function useVictoryContainer<TProps extends VictoryContainerProps>(initialProps: TProps): {
+    className: string;
+    portalComponent: JSX.Element;
+    portalZIndex: number;
+    responsive: boolean;
+    role: string;
+} & TProps & {
+    titleId: string;
+    descId: string;
+    dimensions: {
+        width: string;
+        height: string;
+    } | {
+        width: number | undefined;
+        height: number | undefined;
     };
-    static contextType: React.Context<{
-        transitionTimer: import("..").Timer;
-        animationTimer: import("..").Timer;
-    }>;
-    private containerId;
-    private portalRef;
-    private containerRef;
-    private shouldHandleWheel;
-    constructor(props: TProps);
-    savePortalRef: (portal: any) => any;
-    portalUpdate: (key: any, el: any) => void;
-    portalRegister: () => number;
-    portalDeregister: (key: any) => void;
-    saveContainerRef: (container: HTMLElement) => HTMLElement;
-    handleWheel: (e: any) => any;
-    componentDidMount(): void;
-    componentWillUnmount(): void;
-    getIdForElement(elementName: any): string;
-    getChildren(props: any): any;
-    getOUIAProps(props: any): any;
-    renderContainer(props: any, svgProps: any, style: any): JSX.Element;
-    render(): JSX.Element;
-}
+    viewBox: string | undefined;
+    preserveAspectRatio: string | undefined;
+    ariaLabelledBy: string | undefined;
+    ariaDescribedBy: string | undefined;
+    userProps: Record<string, string>;
+    localContainerRef: React.RefObject<HTMLDivElement>;
+};
+export declare const VictoryContainer: {
+    (initialProps: VictoryContainerProps): JSX.Element;
+    role: string;
+};
 //# sourceMappingURL=victory-container.d.ts.map

package/es/victory-container/victory-container.js

@@ -1,179 +1,151 @@
-import _isObject from "lodash/isObject";
 import _uniqueId from "lodash/uniqueId";
-import _defaults from "lodash/defaults";
 function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
-import React from "react";
+import React, { useRef } from "react";
 import { Portal } from "../victory-portal/portal";
-import { PortalContext } from "../victory-portal/portal-context";
-import TimerContext from "../victory-util/timer-context";
-import * as Helpers from "../victory-util/helpers";
 import * as UserProps from "../victory-util/user-props";
-export class VictoryContainer extends React.Component {
-  static displayName = "VictoryContainer";
-  static role = "container";
-  static defaultProps = {
-    className: "VictoryContainer",
-    portalComponent: /*#__PURE__*/React.createElement(Portal, null),
-    portalZIndex: 99,
-    responsive: true,
-    role: "img"
+import { mergeRefs } from "../victory-util";
+import { PortalOutlet } from "../victory-portal/portal-outlet";
+import { PortalProvider } from "../victory-portal/portal-context";
+const defaultProps = {
+  className: "VictoryContainer",
+  portalComponent: /*#__PURE__*/React.createElement(Portal, null),
+  portalZIndex: 99,
+  responsive: true,
+  role: "img"
+};
+export function useVictoryContainer(initialProps) {
+  const props = {
+    ...defaultProps,
+    ...initialProps
   };
-  static contextType = TimerContext;
+  const {
+    title,
+    desc,
+    width,
+    height,
+    responsive
+  } = props;
+  const localContainerRef = useRef(null);
 
-  // @ts-expect-error Ref will be initialized on mount
-
-  // @ts-expect-error Ref will be initialized on mount
-
-  constructor(props) {
-    super(props);
-    this.containerId = !_isObject(props) || props.containerId === undefined ? _uniqueId("victory-container-") : props.containerId;
-    this.shouldHandleWheel = !!(props && props.events && props.events.onWheel);
-  }
-  savePortalRef = portal => {
-    this.portalRef = portal;
-    return portal;
+  // Generated ID stored in ref because it needs to persist across renders
+  const generatedId = useRef(_uniqueId("victory-container-"));
+  const containerId = props.containerId ?? generatedId.current;
+  const getIdForElement = elName => `${containerId}-${elName}`;
+  const userProps = UserProps.getSafeUserProps(props);
+  const dimensions = responsive ? {
+    width: "100%",
+    height: "100%"
+  } : {
+    width,
+    height
   };
-  portalUpdate = (key, el) => this.portalRef.portalUpdate(key, el);
-  portalRegister = () => this.portalRef.portalRegister();
-  portalDeregister = key => this.portalRef.portalDeregister(key);
-  saveContainerRef = container => {
-    if (Helpers.isFunction(this.props.containerRef)) {
-      this.props.containerRef(container);
-    }
-    this.containerRef = container;
-    return container;
+  const viewBox = responsive ? `0 0 ${width} ${height}` : undefined;
+  const preserveAspectRatio = responsive ? props.preserveAspectRatio : undefined;
+  const ariaLabelledBy = [title && getIdForElement("title"), props["aria-labelledby"]].filter(Boolean).join(" ") || undefined;
+  const ariaDescribedBy = [desc && getIdForElement("desc"), props["aria-describedby"]].filter(Boolean).join(" ") || undefined;
+  const titleId = getIdForElement("title");
+  const descId = getIdForElement("desc");
+  return {
+    ...props,
+    titleId,
+    descId,
+    dimensions,
+    viewBox,
+    preserveAspectRatio,
+    ariaLabelledBy,
+    ariaDescribedBy,
+    userProps,
+    localContainerRef
   };
-  handleWheel = e => e.preventDefault();
-  componentDidMount() {
-    if (this.shouldHandleWheel && this.containerRef) {
-      this.containerRef.addEventListener("wheel", this.handleWheel);
-    }
-  }
-  componentWillUnmount() {
-    if (this.shouldHandleWheel && this.containerRef) {
-      this.containerRef.removeEventListener("wheel", this.handleWheel);
-    }
-  }
-  getIdForElement(elementName) {
-    return `${this.containerId}-${elementName}`;
-  }
-
-  // overridden in custom containers
-  getChildren(props) {
-    return props.children;
-  }
-
-  // Get props defined by the Open UI Automation (OUIA) 1.0-RC spec
-  // See https://ouia.readthedocs.io/en/latest/README.html#ouia-component
-  getOUIAProps(props) {
-    const {
-      ouiaId,
-      ouiaSafe,
-      ouiaType
-    } = props;
-    return {
-      ...(ouiaId && {
-        "data-ouia-component-id": ouiaId
-      }),
-      ...(ouiaType && {
-        "data-ouia-component-type": ouiaType
-      }),
-      ...(ouiaSafe !== undefined && {
-        "data-ouia-safe": ouiaSafe
-      })
+}
+export const VictoryContainer = initialProps => {
+  const {
+    role,
+    title,
+    desc,
+    children,
+    className,
+    portalZIndex,
+    portalComponent,
+    width,
+    height,
+    style,
+    tabIndex,
+    responsive,
+    events,
+    ouiaId,
+    ouiaSafe,
+    ouiaType,
+    dimensions,
+    ariaDescribedBy,
+    ariaLabelledBy,
+    viewBox,
+    preserveAspectRatio,
+    userProps,
+    titleId,
+    descId,
+    containerRef,
+    localContainerRef
+  } = useVictoryContainer(initialProps);
+  React.useEffect(() => {
+    if (!events?.onWheel) return;
+    const handleWheel = e => e.preventDefault();
+    const container = localContainerRef?.current;
+    container?.addEventListener("wheel", handleWheel);
+    return () => {
+      container?.removeEventListener("wheel", handleWheel);
     };
-  }
-  renderContainer(props, svgProps, style) {
-    const {
-      title,
-      desc,
-      portalComponent,
-      className,
-      width,
-      height,
-      portalZIndex,
-      responsive
-    } = props;
-    const children = this.getChildren(props);
-    const dimensions = responsive ? {
-      width: "100%",
-      height: "100%"
-    } : {
-      width,
-      height
-    };
-    const divStyle = Object.assign({
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, []);
+  return /*#__PURE__*/React.createElement("div", {
+    className: className,
+    style: {
+      ...style,
+      width: responsive ? style?.width : dimensions.width,
+      height: responsive ? style?.height : dimensions.height,
       pointerEvents: "none",
       touchAction: "none",
       position: "relative"
-    }, dimensions);
-    const portalDivStyle = Object.assign({
+    },
+    "data-ouia-component-id": ouiaId,
+    "data-ouia-component-type": ouiaType,
+    "data-ouia-safe": ouiaSafe,
+    ref: mergeRefs([localContainerRef, containerRef])
+  }, /*#__PURE__*/React.createElement(PortalProvider, null, /*#__PURE__*/React.createElement("svg", _extends({
+    width: width,
+    height: height,
+    tabIndex: tabIndex,
+    role: role,
+    "aria-labelledby": ariaLabelledBy,
+    "aria-describedby": ariaDescribedBy,
+    viewBox: viewBox,
+    preserveAspectRatio: preserveAspectRatio,
+    style: {
+      ...dimensions,
+      pointerEvents: "all"
+    }
+  }, userProps, events), title ? /*#__PURE__*/React.createElement("title", {
+    id: titleId
+  }, title) : null, desc ? /*#__PURE__*/React.createElement("desc", {
+    id: descId
+  }, desc) : null, children), /*#__PURE__*/React.createElement("div", {
+    style: {
+      ...dimensions,
       zIndex: portalZIndex,
       position: "absolute",
       top: 0,
       left: 0
-    }, dimensions);
-    const svgStyle = Object.assign({
-      pointerEvents: "all"
-    }, dimensions);
-    const portalSvgStyle = Object.assign({
+    }
+  }, /*#__PURE__*/React.createElement(PortalOutlet, {
+    as: portalComponent,
+    width: width,
+    height: height,
+    viewBox: viewBox,
+    preserveAspectRatio: preserveAspectRatio,
+    style: {
+      ...dimensions,
       overflow: "visible"
-    }, dimensions);
-    const portalProps = {
-      width,
-      height,
-      viewBox: svgProps.viewBox,
-      preserveAspectRatio: svgProps.preserveAspectRatio,
-      style: portalSvgStyle
-    };
-    return /*#__PURE__*/React.createElement(PortalContext.Provider, {
-      value: {
-        portalUpdate: this.portalUpdate,
-        portalRegister: this.portalRegister,
-        portalDeregister: this.portalDeregister
-      }
-    }, /*#__PURE__*/React.createElement("div", _extends({
-      style: _defaults({}, style, divStyle),
-      className: className,
-      ref: this.saveContainerRef
-    }, this.getOUIAProps(props)), /*#__PURE__*/React.createElement("svg", _extends({}, svgProps, {
-      style: svgStyle
-    }), title ? /*#__PURE__*/React.createElement("title", {
-      id: this.getIdForElement("title")
-    }, title) : null, desc ? /*#__PURE__*/React.createElement("desc", {
-      id: this.getIdForElement("desc")
-    }, desc) : null, children), /*#__PURE__*/React.createElement("div", {
-      style: portalDivStyle
-    }, /*#__PURE__*/React.cloneElement(portalComponent, {
-      ...portalProps,
-      ref: this.savePortalRef
-    }))));
-  }
-  render() {
-    const {
-      width,
-      height,
-      responsive,
-      events,
-      title,
-      desc,
-      tabIndex,
-      preserveAspectRatio,
-      role
-    } = this.props;
-    const style = responsive ? this.props.style : Helpers.omit(this.props.style, ["height", "width"]);
-    const userProps = UserProps.getSafeUserProps(this.props);
-    const svgProps = Object.assign({
-      width,
-      height,
-      tabIndex,
-      role,
-      "aria-labelledby": [title && this.getIdForElement("title"), this.props["aria-labelledby"]].filter(Boolean).join(" ") || undefined,
-      "aria-describedby": [desc && this.getIdForElement("desc"), this.props["aria-describedby"]].filter(Boolean).join(" ") || undefined,
-      viewBox: responsive ? `0 0 ${width} ${height}` : undefined,
-      preserveAspectRatio: responsive ? preserveAspectRatio : undefined,
-      ...userProps
-    }, events);
-    return this.renderContainer(this.props, svgProps, style);
-  }
-}
+    }
+  }))));
+};
+VictoryContainer.role = "container";

package/es/victory-portal/portal-context.d.ts

@@ -1,12 +1,13 @@
 import React from "react";
 export interface PortalContextValue {
-    portalRegister(): number;
-    portalUpdate(key: number, element: React.ReactElement): void;
-    portalDeregister(key: number): void;
+    addChild: (id: string, node: React.ReactElement) => void;
+    removeChild: (id: string) => void;
+    children: Map<string, React.ReactElement>;
 }
-/**
- * The React context object consumers may use to access the context of the
- * portal.
- */
-export declare const PortalContext: React.Context<PortalContextValue>;
+export declare const PortalContext: React.Context<PortalContextValue | undefined>;
+export declare const usePortalContext: () => PortalContextValue | undefined;
+export interface PortalProviderProps {
+    children?: React.ReactNode;
+}
+export declare const PortalProvider: ({ children }: PortalProviderProps) => JSX.Element;
 //# sourceMappingURL=portal-context.d.ts.map

package/es/victory-portal/portal-context.js

@@ -1,7 +1,35 @@
 import React from "react";
-/**
- * The React context object consumers may use to access the context of the
- * portal.
- */
-export const PortalContext = /*#__PURE__*/React.createContext({});
-PortalContext.displayName = "PortalContext";
+export const PortalContext = /*#__PURE__*/React.createContext(undefined);
+PortalContext.displayName = "PortalContext";
+export const usePortalContext = () => {
+  const context = React.useContext(PortalContext);
+  return context;
+};
+export const PortalProvider = _ref => {
+  let {
+    children
+  } = _ref;
+  const [portalChildren, setPortalChildren] = React.useState(new Map());
+  const addChild = React.useCallback((id, element) => {
+    setPortalChildren(prevChildren => {
+      const nextChildren = new Map(prevChildren);
+      nextChildren.set(id, element);
+      return nextChildren;
+    });
+  }, [setPortalChildren]);
+  const removeChild = React.useCallback(id => {
+    setPortalChildren(prevChildren => {
+      const nextChildren = new Map(prevChildren);
+      nextChildren.delete(id);
+      return nextChildren;
+    });
+  }, [setPortalChildren]);
+  const contextValue = React.useMemo(() => ({
+    addChild,
+    removeChild,
+    children: portalChildren
+  }), [addChild, removeChild, portalChildren]);
+  return /*#__PURE__*/React.createElement(PortalContext.Provider, {
+    value: contextValue
+  }, children);
+};

package/es/victory-portal/portal-outlet.d.ts

@@ -0,0 +1,12 @@
+import React from "react";
+export interface PortalOutletProps {
+    as: React.ReactElement;
+    width?: number;
+    height?: number;
+    viewBox?: string;
+    preserveAspectRatio?: string;
+    style?: React.CSSProperties;
+    children?: (children: React.ReactElement[]) => React.ReactNode | undefined;
+}
+export declare const PortalOutlet: ({ as: portalComponent, ...props }: PortalOutletProps) => React.ReactElement<any, string | React.JSXElementConstructor<any>> | null;
+//# sourceMappingURL=portal-outlet.d.ts.map

package/es/victory-portal/portal-outlet.js

@@ -0,0 +1,14 @@
+import React from "react";
+import { usePortalContext } from "./portal-context";
+export const PortalOutlet = _ref => {
+  let {
+    as: portalComponent,
+    ...props
+  } = _ref;
+  const portalContext = usePortalContext();
+  if (!portalContext) {
+    return null;
+  }
+  const children = Array.from(portalContext.children.values());
+  return /*#__PURE__*/React.cloneElement(portalComponent, props, children);
+};

package/es/victory-portal/portal.d.ts

@@ -1,5 +1,4 @@
 import React from "react";
-import { PortalContextValue } from "./portal-context";
 export interface PortalProps {
     className?: string;
     height?: number;
@@ -7,15 +6,5 @@ export interface PortalProps {
     viewBox?: string;
     width?: number;
 }
-export declare class Portal extends React.Component<PortalProps> implements PortalContextValue {
-    static displayName: string;
-    private readonly map;
-    private index;
-    constructor(props: PortalProps);
-    portalRegister: () => number;
-    portalUpdate: (key: number, element: React.ReactElement) => void;
-    portalDeregister: (key: number) => void;
-    getChildren(): React.ReactElement<any, string | React.JSXElementConstructor<any>>[];
-    render(): JSX.Element;
-}
+export declare const Portal: React.ForwardRefExoticComponent<PortalProps & React.RefAttributes<SVGSVGElement>>;
 //# sourceMappingURL=portal.d.ts.map

package/es/victory-portal/portal.js

@@ -1,33 +1,7 @@
+function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
 import React from "react";
-export class Portal extends React.Component {
-  static displayName = "Portal";
-  constructor(props) {
-    super(props);
-    this.map = {};
-    this.index = 1;
-  }
-  portalRegister = () => {
-    return ++this.index;
-  };
-  portalUpdate = (key, element) => {
-    this.map[key] = element;
-    this.forceUpdate();
-  };
-  portalDeregister = key => {
-    delete this.map[key];
-    this.forceUpdate();
-  };
-  getChildren() {
-    return Object.keys(this.map).map(key => {
-      const el = this.map[key];
-      return el ? /*#__PURE__*/React.cloneElement(el, {
-        key
-      }) : el;
-    });
-  }
-
-  // Overridden in victory-core-native
-  render() {
-    return /*#__PURE__*/React.createElement("svg", this.props, this.getChildren());
-  }
-}
+export const Portal = /*#__PURE__*/React.forwardRef((props, ref) => {
+  return /*#__PURE__*/React.createElement("svg", _extends({
+    ref: ref
+  }, props));
+});

package/es/victory-portal/victory-portal.d.ts

@@ -1,27 +1,10 @@
 import React from "react";
-import { PortalContext } from "./portal-context";
 export interface VictoryPortalProps {
-    children?: React.ReactElement;
+    children: React.ReactElement;
     groupComponent?: React.ReactElement;
 }
-export interface VictoryPortal {
-    context: React.ContextType<typeof PortalContext>;
-}
-export declare class VictoryPortal extends React.Component<VictoryPortalProps> {
-    static displayName: string;
-    static role: string;
-    static defaultProps: {
-        groupComponent: JSX.Element;
-    };
-    static contextType: React.Context<import("./portal-context").PortalContextValue>;
-    private checkedContext;
-    private portalKey;
-    renderInPlace: boolean;
-    element: React.ReactElement;
-    componentDidMount(): void;
-    componentDidUpdate(): void;
-    componentWillUnmount(): void;
-    renderPortal(child: React.ReactElement): React.ReactElement<any, string | React.JSXElementConstructor<any>> | null;
-    render(): React.ReactElement<any, string | React.JSXElementConstructor<any>> | null;
-}
+export declare const VictoryPortal: {
+    (initialProps: VictoryPortalProps): any;
+    role: string;
+};
 //# sourceMappingURL=victory-portal.d.ts.map