@muraldevkit/ui-toolkit 4.74.1 → 4.76.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.
Files changed (52) hide show
  1. package/dist/cjs/components/file-upload/MrlFileUpload/MrlFileUpload.js +404 -0
  2. package/dist/cjs/components/file-upload/MrlFileUpload/MrlFileUpload.js.map +1 -0
  3. package/dist/cjs/components/file-upload/MrlFileUpload/MrlFileUpload.module.scss.js +8 -0
  4. package/dist/cjs/components/file-upload/MrlFileUpload/MrlFileUpload.module.scss.js.map +1 -0
  5. package/dist/cjs/components/file-upload/constants.js +48 -0
  6. package/dist/cjs/components/file-upload/constants.js.map +1 -0
  7. package/dist/cjs/components/file-upload/helpers.js +67 -0
  8. package/dist/cjs/components/file-upload/helpers.js.map +1 -0
  9. package/dist/cjs/components/link/MrlLink/MrlLink.js.map +1 -1
  10. package/dist/cjs/components/pagination/MrlPaginationButton/MrlPaginationButton.js.map +1 -1
  11. package/dist/cjs/components/table/MrlSmartTable/MrlSmartTable.js.map +1 -1
  12. package/dist/cjs/index.js +37 -31
  13. package/dist/cjs/index.js.map +1 -1
  14. package/dist/cjs/version.js +1 -1
  15. package/dist/cjs/version.js.map +1 -1
  16. package/dist/components/file-upload/MrlFileUpload/MrlFileUpload.d.ts +154 -0
  17. package/dist/components/file-upload/MrlFileUpload/index.d.ts +1 -0
  18. package/dist/components/file-upload/constants.d.ts +35 -0
  19. package/dist/components/file-upload/helpers.d.ts +35 -0
  20. package/dist/components/file-upload/index.d.ts +2 -0
  21. package/dist/components/index.d.ts +1 -0
  22. package/dist/components/link/MrlLink/MrlLink.d.ts +7 -1
  23. package/dist/components/pagination/MrlPaginationButton/MrlPaginationButton.d.ts +12 -1
  24. package/dist/components/table/MrlSmartTable/MrlSmartTable.d.ts +41 -0
  25. package/dist/esm/components/file-upload/MrlFileUpload/MrlFileUpload.js +379 -0
  26. package/dist/esm/components/file-upload/MrlFileUpload/MrlFileUpload.js.map +1 -0
  27. package/dist/esm/components/file-upload/MrlFileUpload/MrlFileUpload.module.scss.js +4 -0
  28. package/dist/esm/components/file-upload/MrlFileUpload/MrlFileUpload.module.scss.js.map +1 -0
  29. package/dist/esm/components/file-upload/constants.js +44 -0
  30. package/dist/esm/components/file-upload/constants.js.map +1 -0
  31. package/dist/esm/components/file-upload/helpers.js +62 -0
  32. package/dist/esm/components/file-upload/helpers.js.map +1 -0
  33. package/dist/esm/components/link/MrlLink/MrlLink.js.map +1 -1
  34. package/dist/esm/components/pagination/MrlPaginationButton/MrlPaginationButton.js.map +1 -1
  35. package/dist/esm/components/table/MrlSmartTable/MrlSmartTable.js.map +1 -1
  36. package/dist/esm/index.js +2 -0
  37. package/dist/esm/index.js.map +1 -1
  38. package/dist/esm/version.js +1 -1
  39. package/dist/esm/version.js.map +1 -1
  40. package/dist/styles/MrlFileUpload/module.scss +136 -0
  41. package/dist/styles/file-upload/variables.scss +13 -0
  42. package/dist/styles.css +1 -0
  43. package/dist/types/components/file-upload/MrlFileUpload/MrlFileUpload.d.ts +154 -0
  44. package/dist/types/components/file-upload/MrlFileUpload/index.d.ts +1 -0
  45. package/dist/types/components/file-upload/constants.d.ts +35 -0
  46. package/dist/types/components/file-upload/helpers.d.ts +35 -0
  47. package/dist/types/components/file-upload/index.d.ts +2 -0
  48. package/dist/types/components/index.d.ts +1 -0
  49. package/dist/types/components/link/MrlLink/MrlLink.d.ts +7 -1
  50. package/dist/types/components/pagination/MrlPaginationButton/MrlPaginationButton.d.ts +12 -1
  51. package/dist/types/components/table/MrlSmartTable/MrlSmartTable.d.ts +41 -0
  52. package/package.json +1 -1
@@ -0,0 +1,154 @@
1
+ import * as React from 'react';
2
+ import { ProgressRange } from '../../loader/constants';
3
+ import { DataQa } from '../../../utils/dataQa';
4
+ import { MrlFileUploadState } from '../constants';
5
+ /**
6
+ * The resting half of the state contract: anything but a reported failure.
7
+ */
8
+ type MrlFileUploadRestingProps = {
9
+ /**
10
+ * Message for a failure the consumer is not currently reporting — kept across
11
+ * a retry, for instance. Rendered only in the error state.
12
+ */
13
+ errorMessage?: string;
14
+ /**
15
+ * The visual state of the zone, owned by the consumer. The component tracks
16
+ * drag state and local validation itself, but never starts, advances or
17
+ * completes an upload — pass 'uploading' with a `percent`, then 'complete'.
18
+ * Reporting 'error' requires an `errorMessage`, so it lives in the other half
19
+ * of this union.
20
+ *
21
+ * 'disabled' blocks all interaction: drag, drop and click handlers return
22
+ * early rather than relying on `pointer-events` alone. Because it is a value
23
+ * of this union rather than a separate flag, it replaces the lifecycle state
24
+ * rather than composing with it — a zone cannot be disabled *and* report
25
+ * progress at the same time.
26
+ */
27
+ state?: Exclude<MrlFileUploadState, 'error'>;
28
+ };
29
+ /**
30
+ * The failure half: reporting an error means saying what went wrong.
31
+ */
32
+ type MrlFileUploadErrorProps = {
33
+ /**
34
+ * Why the upload failed. Required alongside `state="error"`: the failure has
35
+ * to reach people who cannot see the border colour.
36
+ *
37
+ * A retry that fails with the identical message is announced only once — a
38
+ * live region re-set to the text it already holds says nothing, and the
39
+ * component cannot tell a retry from a re-render. Pass through a non-error
40
+ * state between attempts (back to 'idle', or 'uploading' while the retry is
41
+ * in flight) so the second failure is a genuine change.
42
+ */
43
+ errorMessage: string;
44
+ /**
45
+ * Reports a failed upload. A local validation failure supplies its own
46
+ * message and takes precedence over `errorMessage`.
47
+ */
48
+ state: 'error';
49
+ };
50
+ /**
51
+ * The zone's state and, when it reports a failure, the message that explains it.
52
+ *
53
+ * The two are a union rather than two independent props so that `state="error"`
54
+ * without an `errorMessage` does not compile. An errored zone with no text is
55
+ * signalled by border colour alone, which reaches neither assistive technology
56
+ * nor anyone who cannot distinguish the error hue. A consumer holding the state
57
+ * in a variable typed as the whole union has to narrow it before rendering —
58
+ * that is the point, not an accident.
59
+ */
60
+ export type MrlFileUploadStateProps = MrlFileUploadRestingProps | MrlFileUploadErrorProps;
61
+ export type MrlFileUploadProps = {
62
+ /**
63
+ * Accepted file types, in the same format as the native `accept` attribute
64
+ * (e.g. '.gif,.jpg,.jpeg,.png' or 'image/*'). Also enforced on drop, which
65
+ * the native attribute does not cover.
66
+ */
67
+ accept?: string;
68
+ /**
69
+ * Name of the file being uploaded, shown in the progress and completed copy
70
+ * and announced to assistive technology. Falls back to the name of the file
71
+ * the user last selected.
72
+ */
73
+ fileName?: string;
74
+ /**
75
+ * Headline inside the drop zone.
76
+ */
77
+ heading?: string;
78
+ /**
79
+ * Supporting line describing what is accepted.
80
+ */
81
+ helperText?: string;
82
+ /**
83
+ * Field label rendered above the drop zone, and the zone's accessible name.
84
+ */
85
+ label?: string;
86
+ /**
87
+ * Maximum accepted file size in bytes. Omit for no limit.
88
+ */
89
+ maxSizeBytes?: number;
90
+ /**
91
+ * Fired when the user cancels an upload in progress. The consumer owns the
92
+ * abort — the component only returns itself to its resting state.
93
+ */
94
+ onCancel?: () => void;
95
+ /**
96
+ * Fired when a file fails local validation, with the message shown to the
97
+ * user. Transport failures are reported by the consumer through
98
+ * `state="error"` instead.
99
+ */
100
+ onError?: (message: string, file: File) => void;
101
+ /**
102
+ * Fired when a file passes validation and is ready to upload. The consumer
103
+ * performs the upload and drives `state` and `percent` from its result.
104
+ */
105
+ onFilesSelected?: (file: File) => void;
106
+ /**
107
+ * Fired when the user removes a completed upload.
108
+ */
109
+ onRemove?: () => void;
110
+ /**
111
+ * Upload progress, 0–100. Only read while `state` is 'uploading'.
112
+ */
113
+ percent?: ProgressRange;
114
+ /**
115
+ * Shows `helperText` inside the drop zone.
116
+ */
117
+ showHelperText?: boolean;
118
+ /**
119
+ * Repeats `helperText` as an inline message below the drop zone. Off by
120
+ * default — with `showHelperText` on, enabling both prints the same sentence
121
+ * twice. A validation or upload error always renders below the zone
122
+ * regardless of this flag.
123
+ */
124
+ showInlineAlert?: boolean;
125
+ /**
126
+ * Additional validation, run after the built-in `accept` and `maxSizeBytes`
127
+ * checks and only if those pass. Return a message to reject the file — it is
128
+ * shown and reported exactly like a built-in failure — or `null` to accept it.
129
+ */
130
+ validate?: (file: File) => string | null;
131
+ /**
132
+ * Enables interaction tracking for this upload control. Provide a stable,
133
+ * non-PII id (e.g. 'workspace-logo-upload'). When omitted, the component
134
+ * emits no analytics.
135
+ *
136
+ * Note: file names, sizes and types are never emitted — only the fact of a
137
+ * selection and whether it was accepted.
138
+ */
139
+ eventId?: string;
140
+ } & MrlFileUploadStateProps & Omit<React.ComponentPropsWithoutRef<'div'>, 'onError'> & DataQa;
141
+ /**
142
+ * A drag-and-drop file upload zone with a keyboard-accessible browse button.
143
+ *
144
+ * The component owns presentation, drag tracking and local validation
145
+ * (`accept`, `maxSizeBytes`); the consumer owns the upload itself and drives
146
+ * `state` and `percent`. Drag and drop is pointer-only by nature, so the
147
+ * button inside the zone is the equivalent path for everyone else and is the
148
+ * affordance exposed to the accessibility tree.
149
+ *
150
+ * @param props - The component props.
151
+ * @returns The MrlFileUpload component.
152
+ */
153
+ export declare function MrlFileUpload(props: MrlFileUploadProps): React.ReactElement;
154
+ export {};
@@ -0,0 +1 @@
1
+ export { MrlFileUpload, type MrlFileUploadProps } from './MrlFileUpload';
@@ -0,0 +1,35 @@
1
+ export declare const allowedFileUploadValues: {
2
+ states: readonly ["idle", "uploading", "complete", "error", "disabled"];
3
+ };
4
+ /**
5
+ * The visual state of the drop zone, owned by the consumer.
6
+ *
7
+ * `dragging` is deliberately absent — a drag is transient pointer state the
8
+ * component tracks internally, not a state a consumer can meaningfully set.
9
+ */
10
+ export type MrlFileUploadState = (typeof allowedFileUploadValues.states)[number];
11
+ export interface FileUploadDefaults {
12
+ accept: string;
13
+ heading: string;
14
+ showHelperText: boolean;
15
+ showInlineAlert: boolean;
16
+ state: MrlFileUploadState;
17
+ }
18
+ /**
19
+ * Default values for props on the MrlFileUpload component;
20
+ * shared between the component and Storybook.
21
+ *
22
+ * `helperText` is absent on purpose: with no value from the consumer it is
23
+ * derived from the constraints actually enforced, so the copy cannot drift from
24
+ * what `accept` and `maxSizeBytes` reject.
25
+ */
26
+ export declare const fileUploadDefaults: FileUploadDefaults;
27
+ /**
28
+ * Shown when a consumer reports `state="error"` without an `errorMessage`.
29
+ *
30
+ * The types make that combination impossible, but a JavaScript consumer can
31
+ * still reach it — and an errored zone with no text is signalled by border
32
+ * colour alone, which reaches neither assistive technology nor anyone who
33
+ * cannot distinguish the error hue.
34
+ */
35
+ export declare const DEFAULT_ERROR_MESSAGE = "Upload failed";
@@ -0,0 +1,35 @@
1
+ /**
2
+ * Matches a file against an `accept` string (extensions and/or MIME types).
3
+ *
4
+ * The native `accept` attribute only filters the file picker; a dropped file
5
+ * bypasses it entirely, so the same rules have to be applied in code.
6
+ *
7
+ * @param file - the file to test
8
+ * @param accept - native `accept` syntax, e.g. '.png,image/*'
9
+ * @returns whether the file matches the accept rules
10
+ */
11
+ export declare function isAccepted(file: File, accept: string): boolean;
12
+ /**
13
+ * Formats a byte count for display in a validation message.
14
+ *
15
+ * @param bytes - the size in bytes
16
+ * @returns a short human-readable size, e.g. '2.5 MB'
17
+ */
18
+ export declare function formatBytes(bytes: number): string;
19
+ /**
20
+ * Lists the file types an `accept` string permits, for display.
21
+ *
22
+ * @param accept - native `accept` syntax, e.g. '.png,image/*'
23
+ * @returns a comma-separated list, or an empty string if nothing is restricted
24
+ */
25
+ export declare function formatAcceptList(accept: string): string;
26
+ /**
27
+ * Describes the constraints the component actually enforces, for use as helper
28
+ * text. Deriving the sentence from `accept` and `maxSizeBytes` is what keeps it
29
+ * from contradicting what validation rejects.
30
+ *
31
+ * @param accept - native `accept` syntax, e.g. '.png,image/*'
32
+ * @param maxSizeBytes - the size limit in bytes, if there is one
33
+ * @returns a sentence describing what may be uploaded, or an empty string
34
+ */
35
+ export declare function describeConstraints(accept: string, maxSizeBytes?: number): string;
@@ -0,0 +1,2 @@
1
+ export * from './MrlFileUpload';
2
+ export * from './constants';
@@ -32,3 +32,4 @@ export * from './rovingTabindex';
32
32
  export * from './toolbar';
33
33
  export * from './filter';
34
34
  export * from './breadcrumb';
35
+ export * from './file-upload';
@@ -6,7 +6,13 @@ export interface MrlLinkProptypes extends React.ComponentProps<'a'> {
6
6
  text: string;
7
7
  /** Specifies where to redirect the linked document */
8
8
  href: string;
9
- /** Specifies how to open the linked document */
9
+ /**
10
+ * Specifies how to open the linked document.
11
+ *
12
+ * Link with external icon: when `target="_blank"` (taking the user to a new
13
+ * browser window), the component shows an external icon after the text and
14
+ * sets `rel="noopener noreferrer"`.
15
+ */
10
16
  target?: LinkTargetType;
11
17
  /**
12
18
  * Color scheme to use based on the link's container background
@@ -7,7 +7,18 @@ interface MrlPaginationButtonProps {
7
7
  /** Additional class to add to the container element */
8
8
  className?: string;
9
9
  disabled?: boolean;
10
- /** The type of pagination item */
10
+ /**
11
+ * The type of pagination item.
12
+ *
13
+ * Known quirk: `kind` doesn't match the rendered aria-label. The `kind` prop is
14
+ * `'first' | 'previous' | 'next' | 'last'`, but the rendered aria-labels are
15
+ * "Beginning", "Previous", "Next", "End" (unless `text` overrides them).
16
+ * Matters for tests and for users reading the announcement:
17
+ * - `first` → `Beginning`
18
+ * - `previous` → `Previous`
19
+ * - `next` → `Next`
20
+ * - `last` → `End`
21
+ */
11
22
  kind: PaginationButtonType;
12
23
  /**
13
24
  * Click event for the button.
@@ -78,6 +78,11 @@ export interface MrlSmartTableColumn {
78
78
  id: MrlTableColumnId;
79
79
  /**
80
80
  * The display name of the column.
81
+ *
82
+ * Header columns wrap by default: `<th>` defaults to wrapping. Apply
83
+ * `white-space: nowrap` on `.MrlTableColumn` to force one-line titles (the
84
+ * column will then grow to at least its title width). Body cells
85
+ * (`.MrlTableCell`) should be left alone so long content can wrap.
81
86
  */
82
87
  name: string;
83
88
  /**
@@ -93,6 +98,26 @@ export interface MrlSmartTableColumn {
93
98
  /**
94
99
  * A component used to override rendering for each row cell. The
95
100
  * component is expected to render a MrlTableCell.
101
+ *
102
+ * `renderCell` must return `<MrlTableCell>`, not raw content: the default
103
+ * renderer wraps for you; overrides don't. Returning raw JSX produces a
104
+ * validateDOMNesting console warning (a hydration mismatch if server-rendered) and breaks
105
+ * sticky/scroll-shadow styling.
106
+ *
107
+ * @example
108
+ * // ❌ wrong — content rendered directly into the row
109
+ * renderCell: ({ item }) => <RowActions item={item} />
110
+ *
111
+ * // ✅ right — wrap in MrlTableCell and forward the sticky/shadow props
112
+ * renderCell: ({ item, column, hasScrollShadowLeft, hasScrollShadowRight }) => (
113
+ * <MrlTableCell
114
+ * sticky={column.sticky}
115
+ * hasScrollShadowLeft={hasScrollShadowLeft}
116
+ * hasScrollShadowRight={hasScrollShadowRight}
117
+ * >
118
+ * <RowActions item={item} />
119
+ * </MrlTableCell>
120
+ * )
96
121
  */
97
122
  renderCell?: (props: MrlSmartCellRendererProps) => JSX.Element;
98
123
  /**
@@ -119,6 +144,19 @@ export interface MrlSmartTableColumn {
119
144
  * the sticky effect will only work on the first or last column.
120
145
  * Set to 'left' for the first column and 'right' for the last column
121
146
  *
147
+ * Sticky-left column is offset by 44px when there's no selection column:
148
+ * the CSS uses `left: var(--mrl-table-selection-width)` (default `2.75rem` / 44px),
149
+ * assuming a row-selection column exists. Without `selectionOptions`, the
150
+ * sticky-left column pins 44px right of its natural position and overlaps
151
+ * the next column at scroll=0. Two fixes:
152
+ * - Add `selectionOptions` (then the real selection column fills that 44px slot).
153
+ * - Or override the variable for tables without selection:
154
+ * ```scss
155
+ * .my-table-wrapper .MrlTable {
156
+ * --mrl-table-selection-width: 0;
157
+ * }
158
+ * ```
159
+ *
122
160
  * @example The container of the table will need overflow:scroll/auto
123
161
  * and the width will need to be constrained in order for
124
162
  * the columns to be 'sticky'
@@ -170,6 +208,9 @@ export interface MrlSmartTableProps extends Partial<Pick<MrlTableProps, 'aria-la
170
208
  items: MrlTableItem[];
171
209
  /**
172
210
  * When provided, enables and controls table selection.
211
+ *
212
+ * Without it, a `sticky: 'left'` column is still offset by the 44px selection
213
+ * slot (`--mrl-table-selection-width`); see `MrlSmartTableColumn.sticky` for the override.
173
214
  */
174
215
  selectionOptions?: MrlSmartTableSelectionOptions;
175
216
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@muraldevkit/ui-toolkit",
3
- "version": "4.74.1",
3
+ "version": "4.76.0",
4
4
  "description": "Mural's UI Toolkit",
5
5
  "main": "./dist/cjs/index.js",
6
6
  "module": "./dist/esm/index.js",