@simoncomputing/mui-bueno-v2 0.25.0 → 0.25.2

package/CHANGELOG.md

@@ -11,6 +11,34 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Minor increment --> singlular/minor changes. Minimal breaking changes.
 - Patch increment --> singlular/minor changes. Zero breaking changes.
 
+## [0.25.2] - 2026-02-05
+
+### Changed
+
+- `Diff`/`Readonly`
+    - Added `mode`/`diffMode` prop to allow modifying which diff tool to use (word, sentence or HTML based diff).
+
+- `TextField`, `Select`, `Autocomplete`, `RadioGroup`
+    - Diff will be sentence-based instead of word-based. For `TextField`, this is configurable but defaults to sentence-based.
+
+### Fixed
+
+- `Diff`
+    - Fixed missing `DiffProps` export
+
+## [0.25.1] - 2026-02-04
+
+### Fixed
+
+- `DiffProvider`/`useDiff` hook
+    - Added `getSnapshotValue` helper function to `useDiff` hook, which can be used to get desired field value from the `previousSnapshot`. Use this to obtain the before/snapshot value before passing it to `DiffTable` or `ReadOnly` component.
+    - Updated supported components (`TextField`, `TextArea`, `Select`, `Autocomplete`, `RadioGroup`, `CitationField`) to use `getSnapshotValue` internally. Previously, they were only working with non-nested formik names.
+
+### Removed
+
+- `useDiff` hook
+    - `previousSnapshot` is no longer exposed. Use `getSnapshotValue` to get the specific value directly.
+
 ## [0.25.0] - 2026-02-04
 
 ### Changed

package/dist/components/Form/Diff/Diff.d.ts

@@ -1,10 +1,21 @@
+export type DiffMode = 'word' | 'sentence' | 'html';
 export type DiffProps = {
     beforeTxt?: string;
     afterTxt?: string;
     /**
-     * Set to `true` for HTML
+     * word - use word-based diff
+     * sentence - use sentence-based diff
+     * html - use HTML-based diff
+     *
+     * @default sentence
      */
-    useHtmlDiff?: boolean;
+    mode?: DiffMode;
 };
+/**
+ * Displays diff between two strings.
+ *
+ * For use with form field components, use `ReadOnly` instead, since it already handles `Diff` internally.
+ * See any of the fields in this library (TextField, Select, etc.) for an example of how to use `ReadOnly`.
+ */
 export declare const Diff: (props: DiffProps) => import("react/jsx-runtime").JSX.Element;
 export default Diff;

package/dist/components/Form/Diff/DiffContext.d.ts

@@ -1,4 +1,17 @@
-type DiffContextType = {
+type DiffContextValue = {
+    /**
+     * Used by fields to determine whether to render as a read-only diff or not
+     */
+    showDiff: boolean;
+    /**
+     * Obtains the snapshot value from `previousSnapshot`.
+     *
+     * @param name - formik field name
+     * @returns value in previousSnapshot (ex. name='phone' could return "999-123-1234")
+     */
+    getSnapshotValue: (name: string) => any;
+};
+type DiffProviderProps = {
     showDiff?: boolean;
     previousSnapshot?: any;
     children: React.ReactNode;
@@ -9,9 +22,6 @@ type DiffContextType = {
  * @param showDiff - when true (default), enables text diff. Set to false to return form to normal.
  * @param previousSnapshot - previous snapshot. This should match the same stucture as your fields (i.e. formik initialValues)
  */
-export declare const DiffProvider: ({ showDiff, previousSnapshot, children }: DiffContextType) => import("react/jsx-runtime").JSX.Element;
-export declare const useDiff: () => {
-    showDiff: boolean;
-    previousSnapshot: null;
-};
+export declare const DiffProvider: ({ showDiff, previousSnapshot, children }: DiffProviderProps) => import("react/jsx-runtime").JSX.Element;
+export declare const useDiff: () => DiffContextValue;
 export {};

package/dist/components/Form/Inputs/TextField/TextField.d.ts

@@ -1,5 +1,6 @@
 import { TypographyProps, TextFieldProps as MuiTextFieldProps } from '@mui/material';
 import { BaseInputProps } from '../BaseInputProps';
+import { DiffMode } from '../../Diff/Diff';
 import * as React from 'react';
 type BaseTextFieldProps = BaseInputProps & {
     /**
@@ -47,6 +48,7 @@ type BaseTextFieldProps = BaseInputProps & {
      * By default, TextField will trim leading and trailing whitespace on blur. To disable this, set `noTrimOnBlur` to true.
      */
     noTrimOnBlur?: boolean;
+    diffMode?: DiffMode;
 };
 export type TextFieldProps = BaseTextFieldProps & Omit<MuiTextFieldProps, 'defaultValue' | 'error' | 'fullWidth' | 'select' | 'SelectProps' | 'value'>;
 /**

package/dist/components/Form/ReadOnly/ReadOnly.d.ts

@@ -1,5 +1,5 @@
 import { TypographyProps } from '@mui/material';
-import { DiffProps } from '../Diff/Diff';
+import { DiffMode, DiffProps } from '../Diff/Diff';
 import { ReactNode } from 'react';
 export type ReadOnlyProps = {
     label: string;
@@ -9,7 +9,7 @@ export type ReadOnlyProps = {
     staticLabelProps?: TypographyProps;
     showDiff?: boolean;
     diffSnapshot?: string;
-    useHtmlDiff?: boolean;
+    diffMode?: DiffMode;
 } & Omit<DiffProps, 'beforeTxt' | 'afterTxt'>;
 export declare const ReadOnly: (props: ReadOnlyProps) => import("react/jsx-runtime").JSX.Element;
 export default ReadOnly;