@mesh.ai/rabbit 0.0.54 → 0.0.55

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -917,7 +917,9 @@ declare interface MenuSubTriggerProps extends MenuItemImplProps {
917
917
  declare type MenuSubTriggerProps_2 = Radix.ComponentPropsWithoutRef<typeof MenuPrimitive.SubTrigger>;
918
918
 
919
919
  declare interface MetricBy {
920
+ /** The symbol of the metric we are measuring ex- % for percentage , $ for currency */
920
921
  symbol: string;
922
+ /** The position of the metric's symbol corresponding to the value */
921
923
  isPrefix: boolean;
922
924
  }
923
925
 
@@ -1093,31 +1095,47 @@ declare type PrimitiveSvgProps = Radix.ComponentPropsWithoutRef<typeof Primitive
1093
1095
  export declare function ProgressBar({ progressInPercentage, status }: ProgressBarProps): JSX_2.Element;
1094
1096
 
1095
1097
  declare interface ProgressBarProps {
1098
+ /** The progress of the OKR in percentage */
1096
1099
  progressInPercentage?: number;
1100
+ /** The current status of OKR ex- ON_TRACK */
1097
1101
  status?: StatusNames;
1098
1102
  }
1099
1103
 
1100
1104
  export declare function ProgressInfo({ status, startValue, targetValue, achievedValue, metricName, measureBy, }: ProgressInfoProps): JSX_2.Element;
1101
1105
 
1102
1106
  declare interface ProgressInfoProps {
1107
+ /** The current status of OKR ex- ON_TRACK */
1103
1108
  status?: StatusNames;
1109
+ /** The starting value for OKR */
1104
1110
  startValue: number;
1111
+ /** The target value for OKR */
1105
1112
  targetValue: number;
1113
+ /** The current achieved value for OKR */
1106
1114
  achievedValue: number;
1115
+ /** The name of the metric we are measuring ex- number of people hired this quarter */
1107
1116
  metricName: string;
1117
+ /** The type of the metric we are measuring ex- percentage , currency or count */
1108
1118
  measureBy: MetricBy;
1109
1119
  }
1110
1120
 
1111
1121
  export declare function ProgressSlider({ startValue, targetValue, achievedValue, isReadOnly, status, onChangeEnd, onChange, onThumbClick, }: ProgressSliderProps): JSX_2.Element;
1112
1122
 
1113
1123
  declare interface ProgressSliderProps {
1124
+ /** The current status of OKR ex- ON_TRACK */
1114
1125
  status: StatusNames;
1126
+ /** The function to receive changing progress value of the OKR */
1115
1127
  onChange: (val: number) => unknown;
1128
+ /** The function to receive the changed progress value of the OKR once the user has stopped moving the slider */
1116
1129
  onChangeEnd: (val: number) => unknown;
1130
+ /** The function which triggers when user clicks on the circular slider above the progress bar */
1117
1131
  onThumbClick: () => unknown;
1132
+ /** The starting value for OKR */
1118
1133
  startValue: number;
1134
+ /** The target value for OKR */
1119
1135
  targetValue: number;
1136
+ /** The current achieved value for OKR */
1120
1137
  achievedValue: number;
1138
+ /** The flag to disable/enable the progress slider */
1121
1139
  isReadOnly: boolean;
1122
1140
  }
1123
1141
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@mesh.ai/rabbit",
3
3
  "private": false,
4
- "version": "0.0.54",
4
+ "version": "0.0.55",
5
5
  "packageManager": "pnpm@8.6.0",
6
6
  "main": "./dist/@mesh.ai/rabbit.umd.js",
7
7
  "module": "./dist/@mesh.ai/rabbit.es.js ",