@octanejs/recharts 0.1.41 → 0.1.42

package/src/component/DefaultTooltipContent.tsrx.d.ts

@@ -1,87 +0,0 @@
-/**
- * @fileOverview Default Tooltip Content
- */
-import * as React from 'octane';
-import { CSSProperties, ReactNode, SVGProps } from 'octane';
-import { DataKey } from '../util/types';
-export type TooltipType = 'none';
-export type ValueType = number | string | ReadonlyArray<number | string>;
-export type NameType = number | string;
-export type Formatter<TValue extends ValueType = ValueType, TName extends NameType = NameType> = (
-	value: TValue | undefined,
-	name: TName | undefined,
-	item: Payload<TValue, TName>,
-	index: number,
-	payload: ReadonlyArray<Payload<TValue, TName>>,
-) => [React.ReactNode, TName] | React.ReactNode;
-export interface Payload<
-	TValue extends ValueType = ValueType,
-	TName extends NameType = NameType,
-> extends Omit<SVGProps<SVGElement>, 'name'> {
-	type?: TooltipType;
-	color?: string;
-	formatter?: Formatter<TValue, TName>;
-	name?: TName;
-	value?: TValue;
-	unit?: ReactNode;
-	fill?: string;
-	dataKey?: DataKey<any>;
-	nameKey?: DataKey<any>;
-	payload?: any;
-	chartType?: string;
-	stroke?: string;
-	strokeDasharray?: string | number;
-	strokeWidth?: number | string;
-	className?: string;
-	hide?: boolean;
-	/**
-	 * The id of the graphical item that the data point belongs to
-	 */
-	graphicalItemId: string;
-}
-/**
- * @inline
- */
-export type TooltipItemSorter<
-	TValue extends ValueType = ValueType,
-	TName extends NameType = NameType,
-> = 'dataKey' | 'value' | 'name' | ((item: Payload<TValue, TName>) => number | string | undefined);
-export interface Props<TValue extends ValueType = ValueType, TName extends NameType = NameType> {
-	separator?: string;
-	wrapperClassName?: string;
-	labelClassName?: string;
-	formatter?: Formatter<TValue, TName>;
-	contentStyle?: CSSProperties;
-	itemStyle?: CSSProperties;
-	labelStyle?: CSSProperties;
-	labelFormatter?: (label: ReactNode, payload: ReadonlyArray<Payload<TValue, TName>>) => ReactNode;
-	label?: ReactNode;
-	payload?: ReadonlyArray<Payload<TValue, TName>>;
-	itemSorter?: TooltipItemSorter<TValue, TName>;
-	accessibilityLayer?: boolean;
-}
-export declare const defaultDefaultTooltipContentProps: {
-	readonly separator: ' : ';
-	readonly contentStyle: {
-		readonly margin: 0;
-		readonly padding: 10;
-		readonly backgroundColor: '#fff';
-		readonly border: '1px solid #ccc';
-		readonly whiteSpace: 'nowrap';
-	};
-	readonly itemStyle: {
-		readonly display: 'block';
-		readonly paddingTop: 4;
-		readonly paddingBottom: 4;
-		readonly color: '#000';
-	};
-	readonly labelStyle: {};
-	readonly accessibilityLayer: false;
-};
-/**
- * This component is by default rendered inside the {@link Tooltip} component. You would not use it directly.
- *
- * You can use this component to customize the content of the tooltip,
- * or you can provide your own completely independent content.
- */
-export declare const DefaultTooltipContent: (props: Props) => React.JSX.Element;

package/src/component/Label.tsrx.d.ts

@@ -1,12 +0,0 @@
-// Type declaration for the .tsrx component (resolved by relative path).
-export declare const defaultLabelProps: Record<string, unknown>;
-export declare const Label: {
-	(props: Record<string, unknown>): unknown;
-	displayName: string;
-};
-export declare function isLabelContentAFunction(content: unknown): boolean;
-export declare const CartesianLabelContextProvider: (props: Record<string, unknown>) => unknown;
-export declare const PolarLabelContextProvider: (props: Record<string, unknown>) => unknown;
-export declare function usePolarLabelContext(): unknown;
-export declare function CartesianLabelFromLabelProp(props: Record<string, unknown>): unknown;
-export declare function PolarLabelFromLabelProp(props: Record<string, unknown>): unknown;

package/src/component/LabelList.tsrx.d.ts

@@ -1,8 +0,0 @@
-// Type declaration for the .tsrx component (resolved by relative path).
-export declare const LabelList: {
-	(props: Record<string, unknown>): unknown;
-	displayName: string;
-};
-export declare const CartesianLabelListContextProvider: unknown;
-export declare const PolarLabelListContextProvider: unknown;
-export declare function LabelListFromLabelProp(props: Record<string, unknown>): unknown;

package/src/component/Legend.tsrx.d.ts

@@ -1,88 +0,0 @@
-import * as React from 'octane';
-import { CSSProperties } from 'octane';
-import {
-	ContentType,
-	LegendPayload,
-	Props as DefaultLegendContentProps,
-	VerticalAlignmentType,
-} from './DefaultLegendContent';
-import { UniqueOption } from '../util/payload/getUniqPayload';
-import { ElementOffset } from '../util/useElementOffset';
-export type LegendItemSorter = 'value' | 'dataKey' | ((item: LegendPayload) => number | string);
-export type Props = Omit<DefaultLegendContentProps, 'payload' | 'ref' | 'verticalAlign'> & {
-	/**
-	 * Renders the content of the legend.
-	 *
-	 * This should return HTML elements, not SVG elements.
-	 *
-	 * - If not set, the {@link DefaultLegendContent} component is used.
-	 * - If set to a React element, this element will be cloned and extra props will be passed in.
-	 * - If set to a function, the function will be called and should return HTML elements.
-	 *
-	 * @example <Legend content={CustomizedLegend} />
-	 * @example <Legend content={renderLegend} />
-	 */
-	content?: ContentType;
-	/**
-	 * CSS styles to be applied to the wrapper `div` element.
-	 */
-	wrapperStyle?: CSSProperties;
-	/**
-	 * Width of the legend.
-	 * Accept CSS style string values like `100%` or `fit-content`, or number values like `400`.
-	 */
-	width?: number | string;
-	/**
-	 * Height of the legend.
-	 * Accept CSS style string values like `100%` or `fit-content`, or number values like `400`.
-	 */
-	height?: number | string;
-	payloadUniqBy?: UniqueOption<LegendPayload>;
-	onBBoxUpdate?: (box: ElementOffset | null) => void;
-	/**
-	 * If portal is defined, then Legend will use this element as a target
-	 * for rendering using React Portal.
-	 *
-	 * If this is undefined then Legend renders inside the recharts-wrapper element.
-	 *
-	 * @see {@link https://react.dev/reference/react-dom/createPortal}
-	 */
-	portal?: HTMLElement | null;
-	/**
-	 * Sorts Legend items. Defaults to `value` which means it will sort alphabetically
-	 * by the label.
-	 *
-	 * If `null` is provided then the payload is not sorted. Be aware that without sort,
-	 * the order of items may change between renders!
-	 *
-	 * @defaultValue value
-	 */
-	itemSorter?: LegendItemSorter | null;
-	/**
-	 * The alignment of the whole Legend container:
-	 *
-	 * - `bottom`: shows the Legend below chart, and chart height reduces automatically to make space for it.
-	 * - `top`: shows the Legend above chart, and chart height reduces automatically.
-	 * - `middle`:  shows the Legend in the middle of chart, covering other content, and chart height remains unchanged.
-	 * The exact behavior changes depending on `align` prop.
-	 *
-	 * @defaultValue bottom
-	 */
-	verticalAlign?: VerticalAlignmentType;
-};
-export declare const legendDefaultProps: {
-	readonly align: 'center';
-	readonly iconSize: 14;
-	readonly inactiveColor: '#ccc';
-	readonly itemSorter: 'value';
-	readonly labelStyle: {};
-	readonly layout: 'horizontal';
-	readonly verticalAlign: 'bottom';
-};
-/**
- * @consumes CartesianChartContext
- * @consumes PolarChartContext
- */
-declare function LegendImpl(outsideProps: Props): React.ReactPortal | null;
-export declare const Legend: React.MemoExoticComponent<typeof LegendImpl>;
-export {};

package/src/component/ResponsiveContainer.tsrx.d.ts

@@ -1,81 +0,0 @@
-import * as React from 'octane';
-import { CSSProperties, ReactNode } from 'octane';
-import { Percent, Size } from '../util/types';
-export interface Props extends Omit<
-	React.HTMLAttributes<HTMLDivElement>,
-	'id' | 'className' | 'style' | 'onResize'
-> {
-	/**
-	 * width / height. If specified, the height will be calculated by width / aspect.
-	 */
-	aspect?: number;
-	/**
-	 * The width of chart container.
-	 * Can be a number or a percent string like "100%".
-	 * @default '100%'
-	 */
-	width?: Percent | number;
-	/**
-	 * The height of chart container.
-	 * Can be a number or a percent string like "100%".
-	 * @default '100%'
-	 */
-	height?: Percent | number;
-	/**
-	 * The minimum width of the container.
-	 * @default 0
-	 */
-	minWidth?: string | number;
-	/**
-	 * The minimum height of the container.
-	 */
-	minHeight?: string | number;
-	/**
-	 * The initial width and height of the container.
-	 * @default {"width":-1,"height":-1}
-	 */
-	initialDimension?: {
-		width: number;
-		height: number;
-	};
-	/** The maximum height of the container. It can be a number. */
-	maxHeight?: number;
-	/**
-	 * The content of the container.
-	 * It can contain multiple charts, and then they will all share the same dimensions.
-	 */
-	children: ReactNode;
-	/**
-	 * If specified a positive number, debounced function will be used to handle the resize event.
-	 * @default 0
-	 */
-	debounce?: number;
-	/**
-	 * Unique identifier of this component.
-	 * Used as an HTML attribute `id`.
-	 */
-	id?: string | number;
-	/** The HTML element's class name */
-	className?: string | number;
-	/** The style of the container. */
-	style?: CSSProperties;
-	/**
-	 * If specified provides a callback providing the updated chart width and height values.
-	 */
-	onResize?: (width: number, height: number) => void;
-}
-export declare const useResponsiveContainerContext: () => Size;
-/**
- * The `ResponsiveContainer` component is a container that adjusts its width and height based on the size of its parent element.
- * It is used to create responsive charts that adapt to different screen sizes.
- *
- * This component uses the {@link https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver ResizeObserver} API to monitor changes to the size of its parent element.
- * If you need to support older browsers that do not support this API, you may need to include a polyfill.
- *
- * @see {@link https://recharts.github.io/en-US/guide/sizes/ Chart size guide}
- *
- * @provides ResponsiveContainerContext
- */
-export declare const ResponsiveContainer: React.ForwardRefExoticComponent<
-	Props & React.RefAttributes<HTMLDivElement>
->;

package/src/component/Text.tsrx.d.ts

@@ -1,9 +0,0 @@
-// Type declaration for the .tsrx component (resolved by relative path).
-export declare const textDefaultProps: Record<string, unknown>;
-export declare const Text: {
-	(props: Record<string, unknown>): unknown;
-	displayName: string;
-};
-export declare function isValidTextAnchor(value: unknown): boolean;
-export declare function isRenderableText(val: unknown): boolean;
-export declare const getWordsByLines: (input: Record<string, unknown>) => unknown[];

package/src/component/Tooltip.tsrx.d.ts

@@ -1,246 +0,0 @@
-import * as React from 'octane';
-import { CSSProperties, ReactElement, ReactNode } from 'octane';
-import {
-	NameType,
-	Props as DefaultTooltipContentProps,
-	TooltipItemSorter,
-	ValueType,
-} from './DefaultTooltipContent';
-import { UniqueOption } from '../util/payload/getUniqPayload';
-import { AllowInDimension, AnimationDuration, EasingInput, Coordinate } from '../util/types';
-import { CursorDefinition } from './Cursor';
-import { TooltipTrigger } from '../chart/types';
-import { TooltipIndex, TooltipPayload, TooltipPayloadEntry } from '../state/tooltipSlice';
-import { AxisId } from '../state/cartesianAxisSlice';
-export type ContentType<TValue extends ValueType = ValueType, TName extends NameType = NameType> =
-	ReactElement | ((props: TooltipContentProps<TValue, TName>) => ReactNode);
-export type TooltipContentProps<
-	TValue extends ValueType = ValueType,
-	TName extends NameType = NameType,
-> = TooltipProps<TValue, TName> & {
-	label?: string | number;
-	payload: TooltipPayload;
-	coordinate: Coordinate | undefined;
-	active: boolean;
-	accessibilityLayer: boolean;
-	activeIndex: TooltipIndex | undefined;
-};
-type PropertiesReadFromContext =
-	'viewBox' | 'active' | 'payload' | 'coordinate' | 'label' | 'accessibilityLayer';
-export type TooltipProps<
-	TValue extends ValueType = ValueType,
-	TName extends NameType = NameType,
-> = Omit<DefaultTooltipContentProps<TValue, TName>, PropertiesReadFromContext> & {
-	/**
-	 * If true, then Tooltip is always displayed, once an activeIndex is set by mouse over, or programmatically.
-	 * If false, then Tooltip is never displayed.
-	 * If undefined, Recharts will control when the Tooltip displays. This includes mouse and keyboard controls.
-	 */
-	active?: boolean;
-	/**
-	 * This option allows the tooltip to extend beyond the viewBox of the chart itself.
-	 * @defaultValue {"x":false,"y":false}
-	 */
-	allowEscapeViewBox?: AllowInDimension;
-	/**
-	 * Specifies the duration of animation, the unit of this option is ms.
-	 * @defaultValue 400
-	 */
-	animationDuration?: AnimationDuration;
-	/**
-	 * The type of easing function.
-	 * @defaultValue ease
-	 */
-	animationEasing?: EasingInput;
-	/**
-	 * Tooltip always attaches itself to the "Tooltip" axis. Which axis is it? Depends on the layout:
-	 * - horizontal layout -> X axis
-	 * - vertical layout -> Y axis
-	 * - radial layout -> radial axis
-	 * - centric layout -> angle axis
-	 *
-	 * Tooltip will use the default axis for the layout, unless you specify an axisId.
-	 *
-	 * @defaultValue 0
-	 */
-	axisId?: AxisId;
-	/**
-	 * Renders the content of the tooltip.
-	 *
-	 * This should return HTML elements, not SVG elements.
-	 *
-	 * - If not set, the {@link DefaultTooltipContent} component is used.
-	 * - If set to a React element, this element will be cloned and extra props will be passed in.
-	 * - If set to a function, the function will be called and should return HTML elements.
-	 *
-	 * @see {@link https://recharts.github.io/en-US/examples/CustomContentOfTooltip/ Example with custom content}
-	 */
-	content?: ContentType<TValue, TName>;
-	/**
-	 * The style of tooltip content which is a dom element.
-	 * @defaultValue {}
-	 */
-	contentStyle?: CSSProperties;
-	/**
-	 * If set false, no cursor will be drawn when tooltip is active.
-	 * If set a object, the option is the configuration of cursor.
-	 * If set a React element, the option is the custom react element of drawing cursor.
-	 * @defaultValue true
-	 */
-	cursor?: CursorDefinition;
-	defaultIndex?: number | TooltipIndex;
-	/**
-	 * When an item of the payload has value null or undefined, this item won't be displayed.
-	 * @defaultValue true
-	 */
-	filterNull?: boolean;
-	/**
-	 * Function to customize the value in the tooltip.
-	 * If you return an array, the first entry will be the formatted "value", and the second entry will be the formatted "name"
-	 */
-	formatter?: (
-		value: TValue,
-		name: TName,
-		item: TooltipPayloadEntry,
-		index: number,
-		payload: TooltipPayload,
-	) => ReactNode | [ReactNode, ReactNode];
-	/**
-	 * If true, the tooltip will display information about hidden series.
-	 * Defaults to false.
-	 * Interacting with the hide property of Area, Bar, Line, Scatter.
-	 *
-	 * @defaultValue false
-	 */
-	includeHidden?: boolean | undefined;
-	/**
-	 * If set false, animation of tooltip will be disabled.
-	 * If set "auto", the animation will be disabled in SSR and will respect the user's prefers-reduced-motion system preference for accessibility.
-	 * @defaultValue auto
-	 */
-	isAnimationActive?: boolean | 'auto';
-	/**
-	 * Sorts tooltip items.
-	 * Defaults to 'name' which means it sorts alphabetically by graphical item `name` property.
-	 * @defaultValue name
-	 */
-	itemSorter?: TooltipItemSorter;
-	/**
-	 * The style of default tooltip content item which is a li element.
-	 * @defaultValue {}
-	 */
-	itemStyle?: CSSProperties;
-	/**
-	 * The formatter function of label in tooltip.
-	 */
-	labelFormatter?: (label: any, payload: TooltipPayload) => ReactNode;
-	/**
-	 * The style of default tooltip label which is a p element.
-	 * @defaultValue {}
-	 */
-	labelStyle?: CSSProperties;
-	/**
-	 * The offset size between the position of tooltip and the mouse cursor position.
-	 * When a number is provided, the same offset is applied to both x and y axes.
-	 *
-	 * When a Coordinate object is provided, you can specify different offsets for each axis (x and y as numbers)
-	 * @defaultValue 10
-	 */
-	offset?: number | Coordinate;
-	payloadUniqBy?: UniqueOption<TooltipPayloadEntry>;
-	/**
-	 * If portal is defined, then Tooltip will use this element as a target
-	 * for rendering using React Portal: https://react.dev/reference/react-dom/createPortal
-	 *
-	 * If this is undefined then Tooltip renders inside the recharts-wrapper element.
-	 */
-	portal?: HTMLElement | null;
-	/**
-	 * If this field is set, the tooltip will be displayed at the specified position
-	 * regardless of the mouse position.
-	 *
-	 * You can set a single field (x or y) and let the other field be calculated automatically based
-	 * on the mouse position.
-	 */
-	position?: Partial<Coordinate>;
-	/**
-	 * @defaultValue {"x":false,"y":false}
-	 */
-	reverseDirection?: AllowInDimension;
-	/**
-	 * The separator between name and value.
-	 * @defaultValue ' : '
-	 */
-	separator?: string;
-	/**
-	 * Defines whether the tooltip is reacting to the current data point,
-	 * or to all data points at the current axis coordinate.
-	 *
-	 * - `true`: tooltip will appear on top of all bars on an axis tick.
-	 * - `false`: tooltip will appear on individual bars.
-	 *
-	 * Different chart types allow different modes, and have different defaults.
-	 *
-	 * @see {@link https://github.com/recharts/recharts/wiki/Tooltip-event-type-and-shared-prop Tooltip event type and shared prop wiki page}
-	 */
-	shared?: boolean;
-	/**
-	 * If `hover` then the Tooltip shows on mouse enter and hides on mouse leave.
-	 *
-	 * If `click` then the Tooltip shows after clicking and stays active.
-	 *
-	 * @defaultValue hover
-	 */
-	trigger?: TooltipTrigger;
-	/**
-	 * @defaultValue false
-	 */
-	useTranslate3d?: boolean;
-	/**
-	 * CSS styles to be applied to the wrapper `div` element.
-	 */
-	wrapperStyle?: CSSProperties;
-};
-export declare const defaultTooltipProps: {
-	readonly allowEscapeViewBox: {
-		readonly x: false;
-		readonly y: false;
-	};
-	readonly animationDuration: 400;
-	readonly animationEasing: 'ease';
-	readonly axisId: 0;
-	readonly contentStyle: {};
-	readonly cursor: true;
-	readonly filterNull: true;
-	readonly includeHidden: false;
-	readonly isAnimationActive: 'auto';
-	readonly itemSorter: 'name';
-	readonly itemStyle: {};
-	readonly labelStyle: {};
-	readonly offset: 10;
-	readonly reverseDirection: {
-		readonly x: false;
-		readonly y: false;
-	};
-	readonly separator: ' : ';
-	readonly trigger: 'hover';
-	readonly useTranslate3d: false;
-	readonly wrapperStyle: {};
-};
-/**
- * The Tooltip component displays a floating box with data values when hovering over or clicking on chart elements.
- *
- * It can be configured to show information for individual data points or for all points at a specific axis coordinate.
- * The appearance and content of the tooltip can be customized via props.
- *
- * @see {@link https://github.com/recharts/recharts/wiki/Tooltip-event-type-and-shared-prop Tooltip event type and shared prop wiki page}
- * @see {@link https://recharts.github.io/en-US/guide/activeIndex/ Active index replacement when migrating from Recharts v2 to v3}
- *
- * @consumes CartesianChartContext
- * @consumes PolarChartContext
- * @consumes TooltipEntrySettings
- */
-export declare function Tooltip(
-	outsideProps: TooltipProps<ValueType, NameType>,
-): React.JSX.Element | null;
-export {};

package/src/container/Layer.tsrx.d.ts

@@ -1,6 +0,0 @@
-// Type declaration for the .tsrx component (resolved by relative path).
-export declare const Layer: (props: {
-	className?: unknown;
-	children?: unknown;
-	[key: string]: unknown;
-}) => unknown;

package/src/container/Surface.tsrx.d.ts

@@ -1,12 +0,0 @@
-// Type declaration for the .tsrx component (resolved by relative path).
-export declare const Surface: (props: {
-	width: number;
-	height: number;
-	viewBox?: { x?: number; y?: number; width?: number; height?: number };
-	className?: unknown;
-	style?: unknown;
-	title?: string;
-	desc?: string;
-	children?: unknown;
-	[key: string]: unknown;
-}) => unknown;

package/src/context/accessibilityContext.js

@@ -1,10 +0,0 @@
-// Vendored verbatim from recharts@3.9.2 es6/context/accessibilityContext.js (framework-agnostic).
-// Do not edit — update by re-vendoring when the recharts devDependency moves.
-import { useAppSelector } from '../state/hooks';
-export var useAccessibilityLayer = () => {
-	var _useAppSelector;
-	return (_useAppSelector = useAppSelector((state) => state.rootProps.accessibilityLayer)) !==
-		null && _useAppSelector !== void 0
-		? _useAppSelector
-		: true;
-};

package/src/context/tooltipContext.js

@@ -1,55 +0,0 @@
-// Vendored verbatim from recharts@3.9.2 es6/context/tooltipContext.js (framework-agnostic).
-// Do not edit — update by re-vendoring when the recharts devDependency moves.
-import { useAppDispatch } from '../state/hooks';
-import {
-	mouseLeaveItem,
-	setActiveClickItemIndex,
-	setActiveMouseOverItemIndex,
-} from '../state/tooltipSlice';
-
-/**
- * Some graphical items choose to provide more information to the tooltip
- * and some do not.
- */
-
-export var useMouseEnterItemDispatch = (onMouseEnterFromProps, dataKey, graphicalItemId) => {
-	var dispatch = useAppDispatch();
-	return (data, index) => (event) => {
-		onMouseEnterFromProps === null ||
-			onMouseEnterFromProps === void 0 ||
-			onMouseEnterFromProps(data, index, event);
-		dispatch(
-			setActiveMouseOverItemIndex({
-				activeIndex: String(index),
-				activeDataKey: dataKey,
-				activeCoordinate: data.tooltipPosition,
-				activeGraphicalItemId: graphicalItemId,
-			}),
-		);
-	};
-};
-export var useMouseLeaveItemDispatch = (onMouseLeaveFromProps) => {
-	var dispatch = useAppDispatch();
-	return (data, index) => (event) => {
-		onMouseLeaveFromProps === null ||
-			onMouseLeaveFromProps === void 0 ||
-			onMouseLeaveFromProps(data, index, event);
-		dispatch(mouseLeaveItem());
-	};
-};
-export var useMouseClickItemDispatch = (onMouseClickFromProps, dataKey, graphicalItemId) => {
-	var dispatch = useAppDispatch();
-	return (data, index) => (event) => {
-		onMouseClickFromProps === null ||
-			onMouseClickFromProps === void 0 ||
-			onMouseClickFromProps(data, index, event);
-		dispatch(
-			setActiveClickItemIndex({
-				activeIndex: String(index),
-				activeDataKey: dataKey,
-				activeCoordinate: data.tooltipPosition,
-				activeGraphicalItemId: graphicalItemId,
-			}),
-		);
-	};
-};