vccs 0.6.0 → 1.0.0-beta.2

package/dist/state/tooltipSlice.d.ts

@@ -1,204 +0,0 @@
-import { AxisId } from './cartesianAxisSlice';
-import { ChartCoordinate, Coordinate, DataKey, NameType, Payload, TooltipTrigger, ValueType } from '../types';
-/**
- * One Tooltip can display multiple TooltipPayloadEntries at a time.
- */
-export type TooltipPayloadEntry = Payload<ValueType, NameType>;
-/**
- * So what happens is that the tooltip payload is decided based on the available data, and the dataKey.
- * The dataKey can either be defined on the graphical element (like Line, or Bar)
- * or on the tooltip itself.
- *
- * The data can be defined in the chart element, or in the graphical item.
- *
- * So this type is all the settings, other than the data + dataKey complications.
- */
-export type TooltipEntrySettings = Omit<TooltipPayloadEntry, 'payload' | 'value'> & {
-    nameKey: DataKey<any> | undefined;
-};
-/**
- * This is what Tooltip renders.
- */
-export type TooltipPayload = ReadonlyArray<TooltipPayloadEntry>;
-/**
- * null means no active index
- * string means: whichever index from the chart data it is.
- * Different charts have different requirements on data shapes,
- * and are also responsible for providing a function that will accept this index
- * and return data.
- */
-export type TooltipIndex = string | null;
-/**
- * Different items have different data shapes so the state has no opinion on what the data shape should be;
- * the only requirement is that the chart also provides a searcher function
- * that accepts the data, and a key, and returns whatever the payload in Tooltip should be.
- */
-export type TooltipPayloadSearcher<T = any, R = T> = (data: T, index: TooltipIndex, computedData?: unknown, nameKey?: DataKey<any>) => R | undefined;
-export type TooltipPayloadConfiguration = {
-    settings: TooltipEntrySettings;
-    /**
-     * This is the data that the item has provided, all of it mixed together.
-     * Later as user is interacting with the chart, a redux selector will use this
-     * data + activeIndex, pass it to the TooltipPayloadSearcher, and render the result in a Tooltip.
-     */
-    dataDefinedOnItem: unknown;
-    /**
-     * Opportunity for the graphical item to define its own Tooltip coordinates
-     * instead of relying on the axes.
-     *
-     * If undefined, then Recharts will use mouse interaction coordinates, or the axis coordinates,
-     * with some defaults (like, top/left of the chart).
-     */
-    positions: Record<NonNullable<TooltipIndex>, Coordinate> | ReadonlyArray<Coordinate> | undefined;
-};
-export type ActiveTooltipProps = {
-    activeIndex: TooltipIndex;
-    activeCoordinate: ChartCoordinate | undefined;
-};
-/**
- * So this informs the "tooltip event type". Tooltip event type can be either "axis" or "item"
- * and it is used for two things:
- * 1. Sets the active area
- * 2. Sets the background and cursor highlights
- *
- * Some charts only allow to have one type of tooltip event type, some allow both.
- * Those charts that allow both will have one default, and the "shared" prop will be used to switch between them.
- * Undefined means "use the chart default".
- *
- * Charts that only allow one tooltip event type, will ignore the shared prop.
- */
-export type SharedTooltipSettings = boolean | undefined;
-export type TooltipSettingsState = {
-    shared: SharedTooltipSettings;
-    trigger: TooltipTrigger;
-    axisId: AxisId;
-    /**
-     * The `active` prop, despite its name, does not mean "always active".
-     * It means "active after user interaction has ended".
-     * By default, the tooltip is only active while the user is hovering over the chart.
-     * With `active=true`, the tooltip will remain visible after mouse leave event.
-     *
-     * If you want to see the "active before user interaction" settings, see `defaultIndex`.
-     *
-     * Undefined means "depends on user interactions".
-     */
-    active: boolean | undefined;
-    /**
-     * If you want to set the tooltip to be active before user interaction, you can set this property.
-     */
-    defaultIndex: TooltipIndex | undefined;
-};
-/**
- * A generic state for user interaction with the chart.
- * User interaction can come through multiple channels: mouse events, keyboard events, or hardcoded in props, or synchronised from other charts.
- *
- * Each of the interaction states is represented as TooltipInteractionState,
- * and then the selectors and Tooltip will decide which of the interaction states to use.
- */
-export type TooltipInteractionState = {
-    /**
-     * If user interaction is in progress or not.
-     * Why is this its own property? Why is this not computed from the index?
-     * Certainly if index !== -1 then the tooltip is active, right?
-     * Well not so fast. Recharts allows Tooltips can be set to `active=true`
-     * which means the tooltip remains displayed after the user stops interacting.
-     * - This implies that we cannot set index to <empty value> after interaction ends,
-     *   because the chart must remember the last position just in case the `active` prop on Tooltip is set to true.
-     */
-    active: boolean;
-    /**
-     * This is the current data index that is set for the chart.
-     * This can come from mouse events, keyboard events, or hardcoded in props
-     * in property `defaultIndex` on Tooltip.
-     */
-    index: TooltipIndex;
-    /**
-     * DataKey filter.
-     *
-     * In case of multiple graphical items, this is the dataKey that is set for the item.
-     * Very useful for `Tooltip.shared=false`, where activeIndex can display multiple values,
-     * but we only want to display one of them.
-     *
-     * If we want to interact with all the graphical items, then this is undefined.
-     * This is the case for eventTooltipType === 'axis' for example.
-     */
-    dataKey: DataKey<any> | undefined;
-    /**
-     * The Coordinate where user last interacted with the chart. This needs saved so we can continue to render the tooltip at that point.
-     * This is undefined on several occasions:
-     * - before the user started interacting with the chart,
-     * - when the chart is controlled programmatically through `defaultIndex` prop
-     * - when the chart is controlled using keyboard interactions
-     */
-    coordinate: Coordinate | undefined;
-};
-export type TooltipSyncState = TooltipInteractionState & {
-    /**
-     * Tooltip synchronization is a feature that allows multiple charts to share the same interaction state.
-     * This comes with one specialty - the syncMethod. `syncMethod=value` allows the user to synchronise charts
-     * based on the active label (which is rendered as the title of the Tooltip).
-     * To allow that, we need the label to be stored in the sync state.
-     */
-    label: string | undefined;
-};
-export declare const noInteraction: TooltipInteractionState;
-/**
- * The tooltip interaction state stores:
- *
- * - Which graphical item is user interacting with at the moment,
- * - which axis (or, which part of chart background) is user interacting with at the moment
- * - The data that individual graphical items wish to be displayed in case the tooltip gets activated
- */
-export type TooltipState = {
-    /**
-     * This is the state of interactions with individual graphical items.
-     */
-    itemInteraction: {
-        click: TooltipInteractionState;
-        /**
-         * Why is hover activation separate from click activation? Because they are independent:
-         * If a click is set, then mouseLeave should not clear it.
-         * - the opposite is technically true too - but it's difficult to click on things without also hovering.
-         */
-        hover: TooltipInteractionState;
-    };
-    /**
-     * This is the state of interaction with the bar background - which will get mapped
-     * to the axis index.
-     *
-     * Axis interaction is independent of item interaction so the state must also be independent.
-     */
-    axisInteraction: {
-        click: TooltipInteractionState;
-        hover: TooltipInteractionState;
-    };
-    keyboardInteraction: TooltipInteractionState;
-    /**
-     * This part of the state is the information coming from other charts.
-     * If there are two charts with the same syncId, events from one chart will be transferred
-     * to other charts. So this is what the other charts are reporting.
-     */
-    syncInteraction: TooltipSyncState;
-    /**
-     * One graphical item will have one configuration;
-     * hovering over multiple of them (for example with tooltipEventType===axis)
-     * may render multiple tooltip payloads.
-     */
-    tooltipItemPayloads: ReadonlyArray<TooltipPayloadConfiguration>;
-    /**
-     * Tooltip props or other settings that need redux access.
-     * This assumes that there is always only one Tooltip. In case we want to start supporting multiple Tooltips,
-     * we have to change this to an array - and update all the places reading this state too.
-     */
-    settings: TooltipSettingsState;
-};
-export declare const initialState: TooltipState;
-export type TooltipActionPayload = {
-    activeIndex: TooltipIndex;
-    activeDataKey: DataKey<any> | undefined;
-    activeCoordinate?: ChartCoordinate | undefined;
-};
-export declare const addTooltipEntrySettings: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<TooltipPayloadConfiguration, "tooltip/addTooltipEntrySettings">, removeTooltipEntrySettings: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<TooltipPayloadConfiguration, "tooltip/removeTooltipEntrySettings">, setTooltipSettingsState: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<TooltipSettingsState, "tooltip/setTooltipSettingsState">, setActiveMouseOverItemIndex: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<TooltipActionPayload, "tooltip/setActiveMouseOverItemIndex">, mouseLeaveItem: import('@reduxjs/toolkit').ActionCreatorWithoutPayload<"tooltip/mouseLeaveItem">, mouseLeaveChart: import('@reduxjs/toolkit').ActionCreatorWithoutPayload<"tooltip/mouseLeaveChart">, setActiveClickItemIndex: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<TooltipActionPayload, "tooltip/setActiveClickItemIndex">, setMouseOverAxisIndex: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<TooltipActionPayload, "tooltip/setMouseOverAxisIndex">, setMouseClickAxisIndex: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<TooltipActionPayload, "tooltip/setMouseClickAxisIndex">, setSyncInteraction: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<TooltipSyncState, "tooltip/setSyncInteraction">, setKeyboardInteraction: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<TooltipActionPayload & {
-    active: boolean;
-}, "tooltip/setKeyboardInteraction">;
-export declare const tooltipReducer: import('@reduxjs/toolkit').Reducer<TooltipState>;

package/dist/state/touchEventsMiddleware.d.ts

@@ -1,2 +0,0 @@
-export declare const touchEventAction: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<TouchEvent, string>;
-export declare const touchEventMiddleware: import('@reduxjs/toolkit').ListenerMiddlewareInstance<unknown, import('@reduxjs/toolkit').ThunkDispatch<unknown, unknown, import('@reduxjs/toolkit').UnknownAction>, unknown>;

package/dist/state/utils/useReportScale.d.ts

@@ -1 +0,0 @@
-export declare function useReportScale(): import('vue').Ref<HTMLElement, HTMLElement>;

package/dist/synchronisation/syncSelectors.d.ts

@@ -1,3 +0,0 @@
-import { RechartsRootState } from '../state/store';
-import { TooltipSyncState } from '../state/tooltipSlice';
-export declare function selectSynchronisedTooltipState(state: RechartsRootState): TooltipSyncState;

package/dist/synchronisation/useChartSynchronisation.d.ts

@@ -1,11 +0,0 @@
-import { Ref } from 'vue';
-import { ChartCoordinate, TooltipEventType, TooltipIndex, TooltipTrigger } from '../types';
-export declare function useTooltipChartSynchronisation({ tooltipEventType, trigger, activeCoordinate, activeLabel, activeIndex, isTooltipActive, }: {
-    tooltipEventType: Ref<TooltipEventType | undefined>;
-    trigger: TooltipTrigger;
-    activeCoordinate: Ref<ChartCoordinate | undefined>;
-    activeLabel: Ref<string | number | undefined>;
-    activeIndex: Ref<TooltipIndex | undefined>;
-    isTooltipActive: Ref<boolean>;
-}): void;
-export declare function useBrushChartSynchronisation(): void;

package/dist/types/offset.d.ts

@@ -1,8 +0,0 @@
-export type OffsetVertical = {
-    top: number;
-    bottom: number;
-};
-export type OffsetHorizontal = {
-    left: number;
-    right: number;
-};

package/dist/utils/Global.d.ts

@@ -1,9 +0,0 @@
-export type GlobalConfigKeys = 'isSsr';
-export interface GlobalConfig {
-    isSsr?: boolean;
-}
-export declare const Global: {
-    isSsr: boolean;
-    get(key: GlobalConfigKeys): boolean;
-    set(key: GlobalConfigKeys | GlobalConfig, value?: any): void;
-};

package/dist/utils/context.d.ts

@@ -1,8 +0,0 @@
-/**
- * @param providerComponentName - The name(s) of the component(s) providing the context.
- *
- * There are situations where context can come from multiple components. In such cases, you might need to give an array of component names to provide your context, instead of just a single string.
- *
- * @param contextName The description for injection key symbol.
- */
-export declare function createContext<ContextValue>(providerComponentName: string | string[], contextName?: string): readonly [<T extends ContextValue | null | undefined = ContextValue>(fallback?: T) => T extends null ? ContextValue | null : ContextValue, (contextValue: ContextValue) => ContextValue];

package/dist/utils/createContext.d.ts

@@ -1,8 +0,0 @@
-/**
- * @param providerComponentName - The name(s) of the component(s) providing the context.
- *
- * There are situations where context can come from multiple components. In such cases, you might need to give an array of component names to provide your context, instead of just a single string.
- *
- * @param contextName The description for injection key symbol.
- */
-export declare function createContext<ContextValue>(contextName?: string): readonly [<T extends ContextValue | null | undefined = ContextValue>(fallback?: T) => T extends null ? ContextValue | null : ContextValue, (contextValue: ContextValue) => ContextValue];

package/dist/utils/legend.d.ts

@@ -1,3 +0,0 @@
-import { LegendSettings } from '../state/legendSlice';
-import { ChartOffset, Size } from '../types';
-export declare function appendOffsetOfLegend(offset: ChartOffset, legendSettings: LegendSettings, legendSize: Size): ChartOffset;

package/dist/utils/props.d.ts

@@ -1,15 +0,0 @@
-import { ComponentObjectPropsOptions } from 'vue';
-/**
- * 将 defaultProps 的属性值作为 props 的 default 属性
- * @param props - Vue 组件的 props 定义对象
- * @param defaultProps - 默认值对象
- * @returns 新的 Vue 组件 props 对象
- */
-export declare function applyDefaultProps<T extends ComponentObjectPropsOptions>(props: T, defaultProps: Partial<Record<keyof T, any>>): T;
-/**
- * 创建带有默认值的 props 对象
- * @param baseProps - 基础 props 定义
- * @param defaultProps - 默认值配置
- * @returns 合并后的 props 对象
- */
-export declare function createPropsWithDefaults<T extends ComponentObjectPropsOptions>(baseProps: T, defaultProps: Partial<Record<keyof T, any>>): T;

package/dist/utils/resolveDefaultProps.d.ts

@@ -1,52 +0,0 @@
-/**
- * This function mimics the behavior of the `defaultProps` static property in React.
- * Functional components do not have a defaultProps property, so this function is useful to resolve default props.
- *
- * The common recommendation is to use ES6 destructuring with default values in the function signature,
- * but you need to be careful there and make sure you destructure all the individual properties
- * and not the whole object. See the test file for example.
- *
- * And because destructuring all properties one by one is a faff, and it's easy to miss one property,
- * this function exists.
- *
- * @param realProps - the props object passed to the component by the user
- * @param defaultProps - the default props object defined in the component by Recharts
- * @returns - the props object with all the default props resolved. All `undefined` values are replaced with the default value.
- */
-export declare function resolveDefaultProps<T, D extends Partial<T>>(realProps: T, defaultProps: D & DisallowExtraKeys<T, D>): RequiresDefaultProps<T, D>;
-/**
- * Helper type to extract the keys of T that are required.
- * It iterates through each key K in T. If Pick<T, K> cannot be assigned an empty object {},
- * it means K is required, so we keep K; otherwise, we discard it (never).
- * [keyof T] at the end creates a union of the kept keys.
- */
-export type RequiredKeys<T> = {
-    [K in keyof T]-?: object extends Pick<T, K> ? never : K;
-}[keyof T];
-/**
- * Helper type to extract the keys of T that are optional.
- * It iterates through each key K in T. If Pick<T, K> can be assigned an empty object {},
- * it means K is optional (or potentially missing), so we keep K; otherwise, we discard it (never).
- * [keyof T] at the end creates a union of the kept keys.
- */
-export type OptionalKeys<T> = {
-    [K in keyof T]-?: object extends Pick<T, K> ? K : never;
-}[keyof T];
-/**
- * Helper type to ensure keys of D exist in T.
- * For each key K in D, if K is also a key of T, keep the type D[K].
- * If K is NOT a key of T, map it to type `never`.
- * An object cannot have a property of type `never`, effectively disallowing extra keys.
- */
-export type DisallowExtraKeys<T, D> = {
-    [K in keyof D]: K extends keyof T ? D[K] : never;
-};
-/**
- * This type will take a source type `T` and a default type `D` and will return a new type
- * where all properties that are optional in `T` but required in `D` are made required in the result.
- * Properties that are required in `T` and optional in `D` will remain required.
- * Properties that are optional in both `T` and `D` will remain optional.
- *
- * This is useful for creating a type that represents the resolved props of a component with default props.
- */
-export type RequiresDefaultProps<T, D extends Partial<T>> = Pick<T, RequiredKeys<T>> & Required<Pick<T, Extract<OptionalKeys<T>, RequiredKeys<D>>>> & Pick<T, Exclude<OptionalKeys<T>, keyof D>>;