vccs 0.0.1 → 0.2.0

package/dist/utils/scale/getNiceTickValues.d.ts

@@ -0,0 +1,61 @@
+import { default as Decimal } from 'decimal.js-light';
+/**
+ * Calculate a interval of a minimum value and a maximum value
+ *
+ * @param  {number} min       The minimum value
+ * @param  {number} max       The maximum value
+ * @return {Array} An interval
+ */
+export declare function getValidInterval([min, max]: [number, number]): number[];
+/**
+ * Calculate the step which is easy to understand between ticks, like 10, 20, 25
+ *
+ * @param  {Decimal} roughStep        The rough step calculated by dividing the
+ * difference by the tickCount
+ * @param  {boolean} allowDecimals    Allow the ticks to be decimals or not
+ * @param  {Integer} correctionFactor A correction factor
+ * @return {Decimal} The step which is easy to understand between two ticks
+ */
+export declare function getFormatStep(roughStep: Decimal, allowDecimals: boolean, correctionFactor: number): Decimal;
+/**
+ * calculate the ticks when the minimum value equals to the maximum value
+ *
+ * @param  value         The minimum value which is also the maximum value
+ * @param  tickCount     The count of ticks
+ * @param  allowDecimals Allow the ticks to be decimals or not
+ * @return array of ticks
+ */
+export declare function getTickOfSingleValue(value: number, tickCount: number, allowDecimals: boolean): Array<number>;
+/**
+ * Calculate the step
+ *
+ * @param  {number}  min              The minimum value of an interval
+ * @param  {number}  max              The maximum value of an interval
+ * @param  {Integer} tickCount        The count of ticks
+ * @param  {boolean} allowDecimals    Allow the ticks to be decimals or not
+ * @param  {number}  correctionFactor A correction factor
+ * @return {object}  The step, minimum value of ticks, maximum value of ticks
+ */
+export declare function calculateStep(min: number, max: number, tickCount: number, allowDecimals: boolean, correctionFactor?: number): any;
+/**
+ * Calculate the ticks of an interval, the count of ticks will be guaranteed
+ *
+ * @param  {number}  min, max      min: The minimum value, max: The maximum value
+ * @param  {Integer} tickCount     The count of ticks
+ * @param  {boolean} allowDecimals Allow the ticks to be decimals or not
+ * @return {Array}   ticks
+ */
+declare function getNiceTickValuesFn([min, max]: [number, number], tickCount?: number, allowDecimals?: boolean): any[];
+/**
+ * Calculate the ticks of an interval, the count of ticks won't be guraranteed,
+ * but the domain will be guaranteed
+ *
+ * @param  {number}  min, max      min: The minimum value, max: The maximum value
+ * @param  {Integer} tickCount     The count of ticks
+ * @param  {boolean} allowDecimals Allow the ticks to be decimals or not
+ * @return {Array}   ticks
+ */
+declare function getTickValuesFixedDomainFn([min, max]: readonly [number, number], tickCount: number, allowDecimals?: boolean): any[];
+export declare const getNiceTickValues: typeof getNiceTickValuesFn;
+export declare const getTickValuesFixedDomain: typeof getTickValuesFixedDomainFn;
+export {};

package/dist/utils/scale/utils/arithmetic.d.ts

@@ -0,0 +1,50 @@
+import { default as Decimal } from 'decimal.js-light';
+/**
+ * 获取数值的位数
+ * 其中绝对值属于区间[0.1, 1)， 得到的值为0
+ * 绝对值属于区间[0.01, 0.1)，得到的位数为 -1
+ * 绝对值属于区间[0.001, 0.01)，得到的位数为 -2
+ *
+ * @param  {number} value 数值
+ * @return {Integer} 位数
+ */
+declare function getDigitCount(value: number): any;
+/**
+ * 按照固定的步长获取[start, end)这个区间的数据
+ * 并且需要处理js计算精度的问题
+ *
+ * @param  {Decimal} start 起点
+ * @param  {Decimal} end   终点，不包含该值
+ * @param  {Decimal} step  步长
+ * @return {Array}         若干数值
+ */
+declare function rangeStep(start: Decimal, end: Decimal, step: Decimal): any[];
+/**
+ * 对数值进行线性插值
+ *
+ * @param  {number} a  定义域的极点
+ * @param  {number} b  定义域的极点
+ * @param  {number} t  [0, 1]内的某个值
+ * @return {number}    定义域内的某个值
+ */
+declare const interpolateNumber: (...args: any[]) => any;
+/**
+ * 线性插值的逆运算
+ *
+ * @param  {number} a 定义域的极点
+ * @param  {number} b 定义域的极点
+ * @param  {number} x 可以认为是插值后的一个输出值
+ * @return {number}   当x在 a ~ b这个范围内时，返回值属于[0, 1]
+ */
+declare const uninterpolateNumber: (...args: any[]) => any;
+/**
+ * 线性插值的逆运算，并且有截断的操作
+ *
+ * @param  {number} a 定义域的极点
+ * @param  {number} b 定义域的极点
+ * @param  {number} x 可以认为是插值后的一个输出值
+ * @return {number}   当x在 a ~ b这个区间内时，返回值属于[0, 1]，
+ * 当x不在 a ~ b这个区间时，会截断到 a ~ b 这个区间
+ */
+declare const uninterpolateTruncation: (...args: any[]) => any;
+export { rangeStep, getDigitCount, interpolateNumber, uninterpolateNumber, uninterpolateTruncation };

package/dist/utils/scale/utils/utils.d.ts

@@ -0,0 +1,9 @@
+export declare const PLACE_HOLDER: {
+    '@@functional/placeholder': boolean;
+};
+export declare const curry: (fn: (...args: any[]) => any) => (...args: any[]) => any;
+export declare function range(begin: number, end: number): any[];
+export declare const map: (...args: any[]) => any;
+export declare function compose(...args: any[]): (...composeArgs: any[]) => any;
+export declare function reverse<T extends any[] | string>(arr: T): T;
+export declare function memoize<F>(fn: F): F;

package/dist/utils/style.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Converts a style value to a string with 'px' if it's a number
+ * @param value The style value to convert
+ * @returns The converted style value
+ */
+export declare function toPx(value: string | number | undefined): string | undefined;
+/**
+ * Converts style object values to use 'px' for numeric height/width values
+ * @param style The style object to convert
+ * @returns A new style object with converted values
+ */
+export declare function normalizeStyle(style?: Record<string, any>): Record<string, any>;

package/dist/utils/tick.d.ts

@@ -0,0 +1,19 @@
+import { CartesianViewBoxRequired } from '../cartesian/type';
+import { Size } from '../types';
+import { CartesianTickItem } from '../types/tick';
+export declare function getNumberIntervalTicks(ticks: ReadonlyArray<CartesianTickItem>, interval: number): ReadonlyArray<CartesianTickItem> | undefined;
+/**
+ * Given an array and a number N, return a new array which contains every nTh
+ * element of the input array. For n below 1, an empty array is returned.
+ * If isValid is provided, all candidates must suffice the condition, else undefined is returned.
+ * @param {T[]} array An input array.
+ * @param {integer} n A number
+ * @param {Function} isValid A function to evaluate a candidate form the array
+ * @returns {T[]} The result array of the same type as the input array.
+ */
+export declare function getEveryNthWithCondition<Type>(array: ReadonlyArray<Type>, n: number, isValid?: (candidate: Type) => boolean): ReadonlyArray<Type> | undefined;
+export declare function getAngledTickWidth(contentSize: Size, unitSize: Size, angle: number): number;
+export declare function getTickBoundaries(viewBox: CartesianViewBoxRequired, sign: number, sizeKey: string): {
+    start: number;
+    end: number;
+};

package/dist/utils/tooltip/translate.d.ts

@@ -0,0 +1,47 @@
+import { CSSProperties } from 'vue';
+import { AllowInDimension, Coordinate } from '../../types';
+import { CartesianViewBox } from '../../cartesian/type';
+export type Dimension2D = 'x' | 'y';
+export declare function getTooltipCSSClassName({ coordinate, translateX, translateY, }: {
+    translateX: number | undefined;
+    translateY: number | undefined;
+    coordinate: Partial<Coordinate> | undefined;
+}): (string | {
+    "v-charts-tooltip-wrapper-right": boolean;
+    "v-charts-tooltip-wrapper-left": boolean;
+    "v-charts-tooltip-wrapper-bottom": boolean;
+    "v-charts-tooltip-wrapper-top": boolean;
+})[];
+export declare function getTooltipTranslateXY({ allowEscapeViewBox, coordinate, key, offsetTopLeft, position, reverseDirection, tooltipDimension, viewBox, viewBoxDimension, }: {
+    allowEscapeViewBox: AllowInDimension;
+    coordinate: Coordinate;
+    key: Dimension2D;
+    offsetTopLeft: number;
+    position: Partial<Coordinate>;
+    reverseDirection: AllowInDimension;
+    tooltipDimension: number;
+    viewBox: CartesianViewBox;
+    viewBoxDimension: number | undefined;
+}): number;
+export declare function getTransformStyle({ translateX, translateY, useTranslate3d, }: {
+    useTranslate3d: boolean;
+    translateX: number;
+    translateY: number;
+}): CSSProperties;
+export declare function getTooltipTranslate({ allowEscapeViewBox, coordinate, offsetTopLeft, position, reverseDirection, tooltipBox, useTranslate3d, viewBox, }: {
+    allowEscapeViewBox: AllowInDimension;
+    coordinate: Coordinate | undefined;
+    offsetTopLeft: number;
+    position: Partial<Coordinate>;
+    reverseDirection: AllowInDimension;
+    tooltipBox: {
+        width: number;
+        height: number;
+    };
+    useTranslate3d: boolean;
+    viewBox: CartesianViewBox;
+}): {
+    cssProperties: CSSProperties;
+    cssClasses: any[];
+    transform: CSSProperties | undefined;
+};

package/dist/utils/types.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This object defines the offset of the chart area and width and height and brush and ... it's a bit too much information all in one.
+ * We use it internally but let's not expose it to the outside world.
+ * If you are looking for this information, instead import `ChartOffset` or `PlotArea` from `recharts`.
+ */
+export type ChartOffsetInternal = {
+    top: number;
+    bottom: number;
+    left: number;
+    right: number;
+    width: number;
+    height: number;
+    brushBottom: number;
+};

package/dist/utils/validate.d.ts

@@ -0,0 +1,25 @@
+import { LayoutType } from '../types';
+import { AxisType } from '../types/axis';
+export declare function isNan(value: any): boolean;
+export declare function isNumber(value: unknown): value is number;
+/**
+ * validate the width and height props of a chart element
+ * @param  {object} el A chart element
+ * @return {boolean}   true If the props width and height are number, and greater than 0
+ */
+export declare function validateWidthHeight({ width, height }: {
+    width?: number;
+    height?: number;
+}): boolean;
+export declare function isWellBehavedNumber(n: unknown): n is number;
+export declare function isPercent(value: string | number): value is `${number}%`;
+export declare function isCategoricalAxis(layout: LayoutType, axisType: AxisType): boolean;
+export declare function isVisible(sign: number, tickPosition: number, getSize: () => number, start: number, end: number): boolean;
+export declare const isSsr: boolean;
+/**
+ * Checks if the value is null or undefined
+ * @param {any} value The value to check
+ * @returns {boolean} true if the value is null or undefined
+ */
+export declare function isNullish(value: unknown): boolean;
+export declare const isNumOrStr: (value: unknown) => value is number | string;

package/package.json

@@ -1,45 +1,62 @@
 {
   "name": "vccs",
-  "version": "0.0.1",
-  "description": "vue lib",
-  "author": "",
-  "license": "ISC",
+  "type": "module",
+  "version": "0.2.0",
+  "description": "Composable charting components for Vue 3 — an unofficial port of Recharts",
+  "author": "rick-hup",
+  "license": "MIT",
+  "homepage": "https://github.com/rick-hup/vuecharts#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rick-hup/vuecharts"
+  },
+  "bugs": {
+    "url": "https://github.com/rick-hup/vuecharts/issues"
+  },
   "keywords": [
     "charts",
-    "vue"
+    "vue",
+    "vue3",
+    "recharts",
+    "composable",
+    "typescript",
+    "svg",
+    "data-visualization",
+    "charting"
   ],
   "sideEffects": false,
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/es/index.mjs",
-      "require": "./dist/cjs/index.js"
+      "import": "./dist/es/index.mjs"
     }
   },
-  "main": "./dist/cjs/index.js",
   "module": "./dist/es/index.mjs",
   "types": "./dist/index.d.ts",
   "files": [
     "./LICENSE",
+    "./README.md",
     "./dist"
   ],
   "typings": "./dist/index.d.ts",
   "peerDependencies": {
+    "motion-v": ">=2.0.0",
     "vue": ">=3.0.0"
   },
   "dependencies": {
     "@reduxjs/toolkit": "^2.8.2",
     "@reduxjs/vue-redux": "^1.0.1",
     "@vueuse/core": "^13.1.0",
+    "decimal.js-light": "^2.5.1",
+    "es-toolkit": "^1.39.3",
     "eventemitter3": "^5.0.1",
     "immer": "^10.1.1",
     "lodash-es": "^4.17.21",
-    "pinia": "^3.0.2",
     "victory-vendor": "^37.3.6"
   },
   "devDependencies": {
     "@types/lodash-es": "^4.17.12",
-    "@vitejs/plugin-vue-jsx": "^3.1.0",
+    "@vitejs/plugin-vue-jsx": "^5.0.0",
     "@vue/babel-plugin-jsx": "^1.1.1",
     "@vue/runtime-core": "^3.5.13",
     "vue": "^3.5.13"