@linkurious/ogma-annotations-react 1.1.23 → 1.1.24

package/dist/types/index.d.ts

@@ -15,38 +15,94 @@ declare type AnnotationAction = {
 
 declare type AnnotationActionType = "add" | "remove" | "update";
 
+/**
+ * Creates a React context for managing annotations with type safety.
+ *
+ * @type {Context<IAnnotationsContext>} A typed context for annotation-related
+ * state and operations
+ */
 export declare const AnnotationsContext: Context<IAnnotationsContext>;
 
+/**
+ * Provides a context provider for managing annotations in a graph visualization.
+ *
+ * This component handles the state and interactions for creating, selecting,
+ * and styling annotations, including arrow and text annotations.
+ *
+ * @param {Props} props - The component props containing child elements
+ * @returns {ReactElement} A context provider with annotation management capabilities
+ */
 export declare const AnnotationsContextProvider: ({ children }: Props) => JSX_2.Element;
 
 export declare const BLACK = "#333333";
 
+/**
+ * Creates a React context for managing annotations with optional type safety.
+ *
+ * @returns {Context<IAnnotationsContext | null>} A context for annotation-related state and operations that can be null
+ */
 export declare function createAnnotationsContext(): Context<IAnnotationsContext | null>;
 
+/**
+ * Default arrow style for annotations.
+ * @type {ArrowStyles}
+ */
 export declare const defaultArrowStyle: ArrowStyles;
 
+/**
+ * List of default colors for annotations.
+ * @type {string[]}
+ */
 export declare const defaultColors: string[];
 
+/**
+ * Default text style for annotations.
+ * @type {TextStyle}
+ */
 export declare const defaultTextStyle: TextStyle;
 
+/**
+ * List of available fonts for annotations.
+ */
 export declare const fonts: string[];
 
 export declare const fontSizes: number[];
 
-declare interface IAnnotationsContext {
+/**
+ * Defines the context interface for managing annotations in a React application.
+ *
+ * @interface
+ * @description Provides state and methods for handling annotation collections,
+ * current annotation selection, styling, and editor control.
+ */
+export declare interface IAnnotationsContext {
+    /** Current annotations in the application. */
     annotations: AnnotationCollection;
+    /** Updates the annotations in the application. */
     updateAnnotations: React.Dispatch<AnnotationAction>;
+    /** The currently selected annotation in the application. */
     currentAnnotation: AnnotationFeature | null;
+    /** Sets the currently selected annotation in the application. */
     setCurrentAnnotation: (annotation: AnnotationFeature | null) => void;
+    /** The current arrow style for annotations. */
     arrowStyle: ArrowStyles;
+    /** The current width factor for arrow annotations. */
     arrowWidthFactor: number;
+    /** Sets the width factor for arrow annotations. */
     setArrowWidthFactor: (arrowWidthFactor: number) => void;
+    /** Sets the current arrow style for annotations. */
     setArrowStyle: (arrowStyle: ArrowStyles) => void;
+    /** The current text style for annotations. */
     textStyle: TextStyle;
+    /** The current size factor for text annotations in regards to node sizes. */
     textSizeFactor: number;
+    /** Sets the size factor for text annotations. */
     setTextSizeFactor: (textSizeFactor: number) => void;
+    /** Sets the current text style for annotations. */
     setTextStyle: (textStyle: TextStyle) => void;
+    /** The annotations editor for managing annotations. See {@link AnnotationsEditor} */
     editor: Control;
+    /** Sets the current annotations editor for managing annotations. */
     setEditor: (editor: Control) => void;
 }
 
@@ -60,10 +116,19 @@ declare interface Props {
     children: ReactElement;
 }
 
+/**
+ * Default relative padding for text annotations.
+ */
 export declare const RELATIVE_PADDING = 0.25;
 
 export declare const TRANSPARENT = "none";
 
+/**
+ * Retrieves the current annotations context for accessing and managing annotations.
+ *
+ * @returns {IAnnotationsContext} The current annotations context with methods and
+ * state for annotation management
+ */
 export declare const useAnnotationsContext: () => IAnnotationsContext;
 
 export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linkurious/ogma-annotations-react",
-  "version": "1.1.23",
+  "version": "1.1.24",
   "description": "A react component to add ogma annotations with  react",
   "type": "module",
   "main": "dist/index.mjs",
@@ -34,7 +34,8 @@
     "postdocs:build": "bash scripts/postdocs.sh",
     "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
     "lint:ci": "eslint -f checkstyle -o reports/checkstyle.xml --ext ts,tsx src",
-    "test:unit": ""
+    "test:unit": "vitest run",
+    "test": "npm run test:unit"
   },
   "publishConfig": {
     "access": "public"
@@ -51,12 +52,13 @@
   "license": "Apache-2.0",
   "peerDependencies": {
     "@linkurious/ogma": ">=4.5.6 || ^5.0.0",
-    "@linkurious/ogma-annotations": "^1.1.23",
+    "@linkurious/ogma-annotations": "^1.1.24",
     "@linkurious/ogma-react": ">=5",
     "react": ">=17"
   },
   "devDependencies": {
     "@linkurious/eslint-config-ogma": "^1.0.14",
+    "@testing-library/react": "16.2.0",
     "@types/react": "18.3.1",
     "@types/react-dom": "18.3.1",
     "@vitejs/plugin-react": "4.3.4",
@@ -67,7 +69,7 @@
     "react": "18.3.1",
     "react-dom": "18.3.1",
     "typescript": "5.3.3",
-    "vite": "6.2.0",
+    "vite": "6.2.2",
     "vite-plugin-dts": "4.5.1",
     "vite-plugin-lib-inject-css": "1.3.0",
     "vitest": "3.0.7"