@muraldevkit/ui-toolkit 4.42.0 → 4.44.0

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.
@@ -23,7 +23,6 @@ declare const avatarValues: {
23
23
  export declare const defaultAvatarValues: avatarDefaults;
24
24
  /**
25
25
  * Renders an avatar component
26
- *
27
26
  * @param {MrlAvatarPropTypes} props the props for your MrlAvatar
28
27
  * @returns {React.ReactElement} an avatar containing the props you pass
29
28
  */
@@ -12,13 +12,11 @@ type UseIsEditableReturn = {
12
12
  * isEditable controls if the input field can be interacted with directly.
13
13
  *
14
14
  * This leaves open the possibility for a field to be editable even if someone has not explicitly decided to edit it.
15
- *
16
- *
17
- *
18
- * @param {Function | undefined} param.changeHandler - optional set handler
19
- * @param {boolean | undefined} param.initialValue - the text input initial value
20
- * @param {InputStates | undefined} param.state - the text input state
21
- * @param {boolean | undefined} param.value - optional control value
15
+ * @param param - useIsEditable options
16
+ * @param param.changeHandler - optional set handler
17
+ * @param param.initialValue - the text input initial value
18
+ * @param param.state - the text input state
19
+ * @param param.value - optional control value
22
20
  * @returns the isEditable, isEditing state and handler
23
21
  */
24
22
  export declare function useIsEditable({ changeHandler, initialValue, state, value }: {
@@ -27,7 +27,6 @@ interface MrlEditableTextInputProps extends React.InputHTMLAttributes<HTMLInputE
27
27
  setIsEditable?: (isEditableUpdate: boolean) => void;
28
28
  /**
29
29
  * Show icon on hover, if true the icon will be hidden and show on hover and focus
30
- *
31
30
  * @default false
32
31
  */
33
32
  showIconOnHover?: boolean;
@@ -37,7 +37,6 @@ interface MrlEditableTextareaProps extends React.TextareaHTMLAttributes<HTMLText
37
37
  }
38
38
  /**
39
39
  * Allows the user to input plain text in a multi-line format
40
- *
41
40
  * @param {MrlEditableTextareaProps} props - the component props
42
41
  * @returns a textarea element
43
42
  */
@@ -105,6 +105,15 @@ export interface MrlSmartTableColumn {
105
105
  * @default sortAlphabeticallyAsCoercedStrings
106
106
  */
107
107
  sortBy?: (aValue: unknown, bValue: unknown) => number;
108
+ /**
109
+ * A sort comparator function for the column that receives the entire
110
+ * row context. Will override the `sortBy` function (if provided).
111
+ *
112
+ * @param aValue
113
+ * @param bValue
114
+ * @returns number
115
+ */
116
+ sortByRowContext?: (aValue: unknown, bValue: unknown) => number;
108
117
  /**
109
118
  * Whether the column is sticky
110
119
  * the sticky effect will only work on the first or last column.
@@ -24,6 +24,11 @@ export declare const SAMPLE_ITEMS: {
24
24
  name: string;
25
25
  type: string;
26
26
  }[];
27
+ export declare const SAMPLE_ITEMS_FOR_ROW_CONTEXT_SORTING: {
28
+ dateModified: string;
29
+ id: string;
30
+ name: string;
31
+ }[];
27
32
  export declare const SAMPLE_ITEMS_WITH_NON_SELECTABLE_ITEM: ({
28
33
  dateModified: string;
29
34
  id: string;