@simoncomputing/mui-bueno-v2 0.18.10 → 0.18.11

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/CHANGELOG.md CHANGED
@@ -11,6 +11,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
11
11
  - Minor increment --> singlular/minor changes. Minimal breaking changes.
12
12
  - Patch increment --> singlular/minor changes. Zero breaking changes.
13
13
 
14
+ ## [0.18.11] - 2025-09-26
15
+
16
+ ### Added
17
+
18
+ - `CitationField`
19
+ - Added helper text for Classification field
20
+
21
+ - `CitationField`, `CitationManger`, `SelectableCitationManager`
22
+ - Added `canOpenPublicUrls` prop to enable launch url button to display for public source URLs
23
+
24
+ - `CitationManger`, `SelectableCitationManager`
25
+ - Added tooltips to actions (Edit, Delete, Download, Open URL)
26
+ - Improved performance of Delete popper by reducing unnecessary re-renders
27
+
28
+ - `RadioGroup`
29
+ - Added `helperText` prop
30
+
31
+ ### Changed
32
+
33
+ - `Radio`/`Checkbox`
34
+ - Renamed `sublabel` to `helperText`
35
+
14
36
  ## [0.18.10] - 2025-09-25
15
37
 
16
38
  ### Added
@@ -154,7 +154,7 @@ export interface AutocompleteOption<T> {
154
154
  * Can be string OR:
155
155
  * {
156
156
  * label: string; // UI label
157
- * sublabel?: string; // Smaller text that appears below UI label. Supplemental/help text.
157
+ * helperText?: string; // Smaller text that appears below UI label. Supplemental/help text.
158
158
  * withTextField?: string; // Displays textfield for additional information needed from user (ex. "Other" checkbox). At mininmum, make sure to pass in `name` property.
159
159
  * }
160
160
  */
@@ -162,7 +162,7 @@ export type CheckboxOption =
162
162
  | string
163
163
  | {
164
164
  label: string;
165
- sublabel?: string;
165
+ helperText?: string;
166
166
  textField?: TextFieldProps;
167
167
  };
168
168
 
@@ -8,20 +8,19 @@ type BaseCheckboxProps = BaseInputProps & {
8
8
  */
9
9
  label?: string;
10
10
  /**
11
- * Optional, additional label that appears below `label` and provides additional
12
- * context, if necessary.
11
+ * Helpful text that appears below `label` and provides additional context (optional)
13
12
  */
14
- sublabel?: string;
13
+ helperText?: string;
15
14
  /**
16
15
  * Where the label is placed in relation to the box.
17
16
  * @default 'end'
18
17
  */
19
18
  labelPlacement?: 'start' | 'end' | 'top' | 'bottom';
20
19
  /**
21
- * Vertical alignment of the label with respect to the checkbox. This is mainly for longer labels, or checkboxes with sublabels.
20
+ * Vertical alignment of the label with respect to the checkbox. This is mainly for longer labels, or checkboxes with helperText.
22
21
  * Only applied when `labelPlacement` is 'start' or 'end'.
23
22
  *
24
- * Center: Verticaly aligns the checkbox with the center of the label (& sublabel)
23
+ * Center: Verticaly aligns the checkbox with the center of the label (& helperText)
25
24
  *
26
25
  * Top: Vertically aligns the checkbox with the first line of the label
27
26
  *
@@ -36,10 +36,10 @@ export type CheckboxGroupProps = BaseInputProps & {
36
36
  */
37
37
  labelPlacement?: 'top' | 'start' | 'bottom' | 'end';
38
38
  /**
39
- * Vertical alignment of the label with respect to the checkboxes. This is mainly for longer labels, or checkboxes with sublabels.
39
+ * Vertical alignment of the label with respect to the checkboxes. This is mainly for longer labels, or checkboxes with helperText.
40
40
  * Only applied when `labelPlacement` is 'start' or 'end'.
41
41
  *
42
- * Center: Verticaly aligns the checkbox with the center of the label (& sublabel)
42
+ * Center: Verticaly aligns the checkbox with the center of the label (& helperText)
43
43
  *
44
44
  * Top: Vertically aligns the checkbox with the first line of the label
45
45
  *
@@ -84,6 +84,10 @@ export type CitationFieldProps = BaseInputProps & {
84
84
  * NOTE: This feature is a prototype and is not fully implemented.
85
85
  */
86
86
  notApplicableName?: string;
87
+ /**
88
+ * When true, users have the option to open public urls
89
+ */
90
+ canOpenPublicUrls?: boolean;
87
91
  };
88
92
  /**
89
93
  * Rich Text field -- uses MUI Tip Tap
@@ -62,6 +62,10 @@ export interface BaseCitationManagerProps {
62
62
  * Additional actions to be displayed for each row. Will be inserted in between Download (if applicable) and Edit button.
63
63
  */
64
64
  addlActions?: (citation: Citation) => ReactNode;
65
+ /**
66
+ * When true, users have the option to open public urls
67
+ */
68
+ canOpenPublicUrls?: boolean;
65
69
  }
66
70
  export declare enum CitationManagerState {
67
71
  CITATIONS_TABLE = "Insert Citation/Attachment(s)",
@@ -77,5 +81,5 @@ export declare enum CitationManagerState {
77
81
  *
78
82
  * For in-line citations, see CitationField instead.
79
83
  */
80
- export declare function BaseCitationManager({ getCitationsPaginated, onCreateCitation, onUpdateCitation, onDeleteCitation, getCitationById, onDownloadAttachment, onSelectCitations, onCancel, initialSelectedIds, onContentChange, onError, renderAsSelectablePopup, addlActions, }: BaseCitationManagerProps): import("react/jsx-runtime").JSX.Element;
84
+ export declare function BaseCitationManager({ getCitationsPaginated, onCreateCitation, onUpdateCitation, onDeleteCitation, getCitationById, onDownloadAttachment, onSelectCitations, onCancel, initialSelectedIds, onContentChange, onError, renderAsSelectablePopup, addlActions, canOpenPublicUrls, }: BaseCitationManagerProps): import("react/jsx-runtime").JSX.Element;
81
85
  export default BaseCitationManager;
@@ -24,4 +24,4 @@ export type CitationBubbleMenuProps = Partial<Except<ControlledBubbleMenuProps,
24
24
  * update, which will happen if it's a child of the component using
25
25
  * `useEditor`).
26
26
  */
27
- export default function CitationBubbleMenuTipTap({ getCitationsPaginated, onCreateCitation, onUpdateCitation, onDeleteCitation, getCitationById, onDownloadAttachment, ...controlledBubbleMenuProps }: CitationBubbleMenuProps): import("react/jsx-runtime").JSX.Element | null;
27
+ export default function CitationBubbleMenuTipTap({ getCitationsPaginated, onCreateCitation, onUpdateCitation, onDeleteCitation, getCitationById, onDownloadAttachment, canOpenPublicUrls, ...controlledBubbleMenuProps }: CitationBubbleMenuProps): import("react/jsx-runtime").JSX.Element | null;
@@ -43,6 +43,10 @@ export type CitationTableProps = {
43
43
  * When true, edit citation icon buttons will display for each row.
44
44
  */
45
45
  canEdit?: boolean;
46
+ /**
47
+ * When true, users can open public urls
48
+ */
49
+ canOpenPublicUrls?: boolean;
46
50
  /**
47
51
  * Additional actions to be displayed for each row. Will be inserted in between Download (if applicable) and Edit button.
48
52
  */
@@ -0,0 +1,12 @@
1
+ import { Citation } from '../../../../../../../@types';
2
+ type Props = {
3
+ citation: Citation | null;
4
+ anchorEl: HTMLElement | null;
5
+ onDeleteCitation?: (id: number) => Promise<void>;
6
+ onClose: () => void;
7
+ };
8
+ /**
9
+ * Popper to ask the user to confirm if they want to delete the citation.
10
+ */
11
+ declare const DeleteCitationPopper: (props: Props) => import("react/jsx-runtime").JSX.Element | undefined;
12
+ export default DeleteCitationPopper;
@@ -0,0 +1,11 @@
1
+ import { Citation } from '../../../../../../../@types';
2
+ type Props = {
3
+ citation: Citation | null;
4
+ anchorEl: HTMLElement | null;
5
+ onClose: () => void;
6
+ };
7
+ /**
8
+ * Popper to ask the user to confirm if they want to navigate to the citation's URL.
9
+ */
10
+ declare const LaunchLinkPopper: (props: Props) => import("react/jsx-runtime").JSX.Element;
11
+ export default LaunchLinkPopper;
@@ -15,7 +15,7 @@ type BaseRadioProps<T> = {
15
15
  * Optional, additional label that appears below `label` and provides additional
16
16
  * context, if necessary.
17
17
  */
18
- sublabel?: string;
18
+ helperText?: string;
19
19
  };
20
20
  /**
21
21
  * *Interface used exclusively for creating radio buttons within RadioGroup*
@@ -64,10 +64,10 @@ type BaseRadioGroupProps<T> = BaseInputProps & {
64
64
  */
65
65
  labelPlacement?: 'top' | 'start' | 'bottom' | 'end';
66
66
  /**
67
- * Vertical alignment of the label with respect to the radio buttons. This is mainly for longer labels, or radio buttons with sublabels.
67
+ * Vertical alignment of the label with respect to the radio buttons. This is mainly for longer labels, or radio buttons with helperText.
68
68
  * Only applied when `labelPlacement` is 'start' or 'end'.
69
69
  *
70
- * Center: Verticaly aligns the radio button with the center of the label (& sublabel)
70
+ * Center: Verticaly aligns the radio button with the center of the label (& helperText)
71
71
  *
72
72
  * Top: Vertically aligns the radio button with the first line of the label
73
73
  *
@@ -104,6 +104,11 @@ type BaseRadioGroupProps<T> = BaseInputProps & {
104
104
  * Used to customize the label when the static label option is selected or the field is readOnly.
105
105
  */
106
106
  staticLabelProps?: TypographyProps;
107
+ /**
108
+ * Used to show more information to help the user understand the RadioGroup label.
109
+ * NOTE: Radios have their own `helperText` for more fine-grained details about specific options.
110
+ */
111
+ helperText?: string;
107
112
  };
108
113
  export type RadioGroupProps<T> = BaseRadioGroupProps<T> & Omit<MuiRadioGroupProps, 'onChange' | 'name'>;
109
114
  /**