@devtron-labs/devtron-fe-common-lib 1.0.9-beta-2 → 1.0.9-beta-4

package/dist/Shared/Components/DiffViewer/DiffViewer.component.d.ts

@@ -1,3 +1,41 @@
 import { DiffViewerProps } from './types';
+/**
+ * Component for showing diff between two string or object.
+ *
+ * Note: Pass down the object as stringified for optimized performance.
+ *
+ * @example Usage
+ *
+ * ```tsx
+ * <DiffViewer
+ *   oldValue={oldValue}
+ *   newValue={newValue}
+ * />
+ * ```
+ *
+ * @example With left/right title for lhs/rhs
+ *
+ * ```tsx
+ * <DiffViewer
+ *   oldValue={oldValue}
+ *   newValue={newValue}
+ *   leftTitle="Title for LHS"
+ *   rightTitle={
+ *     <span>Title for RHS</span>
+ *   }
+ * />
+ * ```
+ *
+ * @example With custom message for folded code
+ * Note: the entire section would be clickable
+ *
+ * ```tsx
+ * <DiffViewer
+ *   oldValue={oldValue}
+ *   newValue={newValue}
+ *   codeFoldMessageRenderer={(totalFoldedLines, leftStartLineNumber, rightStartLineNumber) => <span>Custom text</span>}
+ * />
+ * ```
+ */
 declare const DiffViewer: ({ oldValue, newValue, leftTitle, rightTitle, ...props }: DiffViewerProps) => JSX.Element;
 export default DiffViewer;