react-smart-copy 1.3.0 → 1.4.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.
- package/README.md +48 -13
- package/dist/capture.cjs.map +1 -1
- package/dist/capture.js.map +1 -1
- package/dist/core.cjs +47 -11
- package/dist/core.cjs.map +1 -1
- package/dist/core.d.cts +115 -85
- package/dist/core.d.ts +115 -85
- package/dist/core.js +47 -12
- package/dist/core.js.map +1 -1
- package/dist/index.cjs +129 -19
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +147 -90
- package/dist/index.d.ts +147 -90
- package/dist/index.js +129 -20
- package/dist/index.js.map +1 -1
- package/package.json +4 -4
package/dist/index.js
CHANGED
|
@@ -102,9 +102,19 @@ const PASTE_DESCRIPTIONS = {
|
|
|
102
102
|
function describeCopyError(error) {
|
|
103
103
|
return COPY_DESCRIPTIONS[error.type];
|
|
104
104
|
}
|
|
105
|
-
/**
|
|
106
|
-
|
|
107
|
-
|
|
105
|
+
/** Drops can only fail in these ways; the rest of the paste wording would mention the clipboard. */
|
|
106
|
+
const DROP_DESCRIPTIONS = {
|
|
107
|
+
"invalid-payload": "The dropped content couldn't be read.",
|
|
108
|
+
"no-content": "Nothing that was dropped can be used here.",
|
|
109
|
+
"too-large": "The dropped content is too large.",
|
|
110
|
+
unknown: "Couldn't read the dropped content. Try again."
|
|
111
|
+
};
|
|
112
|
+
/**
|
|
113
|
+
* Default English, user-facing sentence for a paste error. Pass the error
|
|
114
|
+
* state's `source` to word drag-and-drop failures as drops. Replace for i18n.
|
|
115
|
+
*/
|
|
116
|
+
function describePasteError(error, source) {
|
|
117
|
+
return (source === "drop" ? DROP_DESCRIPTIONS[error.type] : void 0) ?? PASTE_DESCRIPTIONS[error.type];
|
|
108
118
|
}
|
|
109
119
|
//#endregion
|
|
110
120
|
//#region src/core/payload.ts
|
|
@@ -691,6 +701,27 @@ function enforcePasteLimits(entries, options) {
|
|
|
691
701
|
for (const entry of entries) budget.charge(sizeOf(entry.data));
|
|
692
702
|
}
|
|
693
703
|
/**
|
|
704
|
+
* Whether a drag in progress could drop anything `accept`s. Uses only what
|
|
705
|
+
* browsers expose before the drop (item kinds and types, never the data).
|
|
706
|
+
* A file whose type is not known yet (some browsers hide it while dragging)
|
|
707
|
+
* counts as a maybe: the drop itself is checked against `accept`.
|
|
708
|
+
*/
|
|
709
|
+
function canAcceptDrag(data, options) {
|
|
710
|
+
const items = data.items ?? Array.from(data.types, (type) => type === "Files" ? {
|
|
711
|
+
kind: "file",
|
|
712
|
+
type: ""
|
|
713
|
+
} : {
|
|
714
|
+
kind: "string",
|
|
715
|
+
type
|
|
716
|
+
});
|
|
717
|
+
return Array.from(items).some(({ kind, type: raw }) => {
|
|
718
|
+
const file = kind === "file";
|
|
719
|
+
const type = normalizeMimeType(raw);
|
|
720
|
+
if (type === null) return file;
|
|
721
|
+
return (file || isTextualMimeType(type)) && isAccepted(type, options);
|
|
722
|
+
});
|
|
723
|
+
}
|
|
724
|
+
/**
|
|
694
725
|
* Synchronously copies the accepted parts of a paste event's `DataTransfer`.
|
|
695
726
|
* It must run during the event: browsers empty the object afterwards.
|
|
696
727
|
*/
|
|
@@ -788,7 +819,7 @@ async function finalizePaste(entries, source, options) {
|
|
|
788
819
|
data
|
|
789
820
|
});
|
|
790
821
|
}
|
|
791
|
-
if (items.length === 0) throw copyFailure("no-content", "The
|
|
822
|
+
if (items.length === 0) throw copyFailure("no-content", "The content holds nothing that matches `accept`.");
|
|
792
823
|
return {
|
|
793
824
|
source,
|
|
794
825
|
items,
|
|
@@ -980,10 +1011,11 @@ function createPasteMachine(options = {}) {
|
|
|
980
1011
|
}
|
|
981
1012
|
return readClipboard(state.retryCount + 1);
|
|
982
1013
|
};
|
|
983
|
-
|
|
984
|
-
|
|
985
|
-
if (!data) return Promise.resolve(IGNORED_NO_CONTENT);
|
|
1014
|
+
/** Shared by paste and drop events: their `DataTransfer` has the same shape and lifetime. */
|
|
1015
|
+
const transfer = (data, event, source) => {
|
|
986
1016
|
const current = read();
|
|
1017
|
+
if (source === "drop" && current.preventDefault !== false) event.preventDefault();
|
|
1018
|
+
if (!data) return Promise.resolve(IGNORED_NO_CONTENT);
|
|
987
1019
|
let resolved;
|
|
988
1020
|
try {
|
|
989
1021
|
resolved = resolvePasteReadOptions(current);
|
|
@@ -992,7 +1024,7 @@ function createPasteMachine(options = {}) {
|
|
|
992
1024
|
++generation;
|
|
993
1025
|
const superseded = operations.abort();
|
|
994
1026
|
clearResetTimer();
|
|
995
|
-
settleError(error,
|
|
1027
|
+
settleError(error, source, 0);
|
|
996
1028
|
if (superseded) invoke(current.onCancel, "superseded");
|
|
997
1029
|
return Promise.resolve({
|
|
998
1030
|
status: "error",
|
|
@@ -1001,12 +1033,14 @@ function createPasteMachine(options = {}) {
|
|
|
1001
1033
|
}
|
|
1002
1034
|
const entries = snapshotDataTransfer(data, resolved);
|
|
1003
1035
|
if (entries.length === 0) return Promise.resolve(IGNORED_NO_CONTENT);
|
|
1004
|
-
if (current.preventDefault !== false) event.preventDefault();
|
|
1036
|
+
if (source === "event" && current.preventDefault !== false) event.preventDefault();
|
|
1005
1037
|
return run(() => {
|
|
1006
1038
|
enforcePasteLimits(entries, resolved);
|
|
1007
|
-
return finalizePaste(entries,
|
|
1008
|
-
},
|
|
1039
|
+
return finalizePaste(entries, source, resolved);
|
|
1040
|
+
}, source, 0);
|
|
1009
1041
|
};
|
|
1042
|
+
const pasteEvent = (event) => transfer(event.clipboardData, event, "event");
|
|
1043
|
+
const dropEvent = (event) => transfer(event.dataTransfer, event, "drop");
|
|
1010
1044
|
const reset = () => {
|
|
1011
1045
|
++generation;
|
|
1012
1046
|
const cancelled = operations.abort();
|
|
@@ -1036,6 +1070,7 @@ function createPasteMachine(options = {}) {
|
|
|
1036
1070
|
},
|
|
1037
1071
|
paste,
|
|
1038
1072
|
pasteEvent,
|
|
1073
|
+
dropEvent,
|
|
1039
1074
|
retry,
|
|
1040
1075
|
reset,
|
|
1041
1076
|
connect
|
|
@@ -1500,10 +1535,21 @@ const CopyField = {
|
|
|
1500
1535
|
//#endregion
|
|
1501
1536
|
//#region src/react/usePaste.ts
|
|
1502
1537
|
const getServerSnapshot = () => PASTE_IDLE_STATE;
|
|
1538
|
+
const DRAG_END_EVENTS = ["drop", "dragend"];
|
|
1539
|
+
/** A text field or editable region nested inside the drop target, which should keep its native drop. */
|
|
1540
|
+
const isNestedEditable = (event) => {
|
|
1541
|
+
const { target, currentTarget } = event;
|
|
1542
|
+
if (target === currentTarget || !(target instanceof HTMLElement)) return false;
|
|
1543
|
+
if (target.tagName === "INPUT" || target.tagName === "TEXTAREA") return true;
|
|
1544
|
+
return target.isContentEditable && !(currentTarget instanceof HTMLElement && currentTarget.isContentEditable);
|
|
1545
|
+
};
|
|
1546
|
+
/** The drop effect the drag source allows, preferring copy: an effect it disallows cancels the drop. */
|
|
1547
|
+
const dropEffectFor = (allowed) => /^(all|uninitialized|copy)/.test(allowed) ? "copy" : /move/i.test(allowed) ? "move" : allowed === "link" ? "link" : "none";
|
|
1503
1548
|
/**
|
|
1504
1549
|
* Paste state machine bound to a component. Supports a "Paste" button
|
|
1505
|
-
* (`paste()`, may prompt for permission)
|
|
1506
|
-
*
|
|
1550
|
+
* (`paste()`, may prompt for permission), keyboard paste (`targetProps` or
|
|
1551
|
+
* `listenOnDocument`, no prompt) and drag-and-drop (`dropTargetProps`).
|
|
1552
|
+
* Options may change on every render.
|
|
1507
1553
|
*
|
|
1508
1554
|
* Everything in the result is untrusted user input.
|
|
1509
1555
|
*/
|
|
@@ -1530,6 +1576,48 @@ function usePaste(options = {}) {
|
|
|
1530
1576
|
const targetProps = useMemo(() => ({ onPaste: (event) => {
|
|
1531
1577
|
machine.pasteEvent(event);
|
|
1532
1578
|
} }), [machine]);
|
|
1579
|
+
const [isDragOver, setIsDragOver] = useState(false);
|
|
1580
|
+
const dragDepth = useRef(0);
|
|
1581
|
+
const [endDrag] = useState(() => () => {
|
|
1582
|
+
dragDepth.current = 0;
|
|
1583
|
+
setIsDragOver(false);
|
|
1584
|
+
});
|
|
1585
|
+
const dropTargetProps = useMemo(() => {
|
|
1586
|
+
const accepts = (data) => {
|
|
1587
|
+
try {
|
|
1588
|
+
return canAcceptDrag(data, resolvePasteReadOptions(optionsRef.current));
|
|
1589
|
+
} catch {
|
|
1590
|
+
return true;
|
|
1591
|
+
}
|
|
1592
|
+
};
|
|
1593
|
+
return {
|
|
1594
|
+
onDragEnter: (event) => {
|
|
1595
|
+
dragDepth.current += 1;
|
|
1596
|
+
if (accepts(event.dataTransfer)) setIsDragOver(true);
|
|
1597
|
+
},
|
|
1598
|
+
onDragOver: (event) => {
|
|
1599
|
+
if (isNestedEditable(event)) return;
|
|
1600
|
+
event.preventDefault();
|
|
1601
|
+
event.dataTransfer.dropEffect = accepts(event.dataTransfer) ? dropEffectFor(event.dataTransfer.effectAllowed) : "none";
|
|
1602
|
+
},
|
|
1603
|
+
onDragLeave: (event) => {
|
|
1604
|
+
const next = event.relatedTarget;
|
|
1605
|
+
dragDepth.current -= 1;
|
|
1606
|
+
if (dragDepth.current <= 0 || next instanceof Node && !event.currentTarget.contains(next)) endDrag();
|
|
1607
|
+
},
|
|
1608
|
+
onDrop: (event) => {
|
|
1609
|
+
endDrag();
|
|
1610
|
+
if (!isNestedEditable(event)) machine.dropEvent(event);
|
|
1611
|
+
}
|
|
1612
|
+
};
|
|
1613
|
+
}, [machine, endDrag]);
|
|
1614
|
+
useEffect(() => {
|
|
1615
|
+
if (!isDragOver) return void 0;
|
|
1616
|
+
for (const type of DRAG_END_EVENTS) window.addEventListener(type, endDrag, true);
|
|
1617
|
+
return () => {
|
|
1618
|
+
for (const type of DRAG_END_EVENTS) window.removeEventListener(type, endDrag, true);
|
|
1619
|
+
};
|
|
1620
|
+
}, [isDragOver, endDrag]);
|
|
1533
1621
|
return useMemo(() => ({
|
|
1534
1622
|
state,
|
|
1535
1623
|
status: state.status,
|
|
@@ -1538,14 +1626,19 @@ function usePaste(options = {}) {
|
|
|
1538
1626
|
canRetry,
|
|
1539
1627
|
paste: machine.paste,
|
|
1540
1628
|
pasteEvent: machine.pasteEvent,
|
|
1629
|
+
dropEvent: machine.dropEvent,
|
|
1541
1630
|
retry: machine.retry,
|
|
1542
1631
|
reset: machine.reset,
|
|
1543
|
-
targetProps
|
|
1632
|
+
targetProps,
|
|
1633
|
+
dropTargetProps,
|
|
1634
|
+
isDragOver
|
|
1544
1635
|
}), [
|
|
1545
1636
|
state,
|
|
1546
1637
|
canRetry,
|
|
1547
1638
|
machine,
|
|
1548
|
-
targetProps
|
|
1639
|
+
targetProps,
|
|
1640
|
+
dropTargetProps,
|
|
1641
|
+
isDragOver
|
|
1549
1642
|
]);
|
|
1550
1643
|
}
|
|
1551
1644
|
//#endregion
|
|
@@ -1601,6 +1694,7 @@ function usePasteDisplayStatus(status, options = {}) {
|
|
|
1601
1694
|
//#region src/react/PasteField.tsx
|
|
1602
1695
|
const defaultPasteFieldMessages = {
|
|
1603
1696
|
pasted: "Pasted from clipboard",
|
|
1697
|
+
dropped: "Dropped content added",
|
|
1604
1698
|
error: describePasteError,
|
|
1605
1699
|
triggerLabel: (label) => `Paste ${label}`,
|
|
1606
1700
|
zoneLabel: (label) => `Paste area for ${label}`
|
|
@@ -1624,6 +1718,7 @@ const Root = /* @__PURE__ */ forwardRef(function PasteFieldRoot({ label, pasteOp
|
|
|
1624
1718
|
const zoneId = `${baseId}-zone`;
|
|
1625
1719
|
const messages = useMemo(() => ({
|
|
1626
1720
|
...defaultPasteFieldMessages,
|
|
1721
|
+
...messageOverrides?.pasted === void 0 ? {} : { dropped: messageOverrides.pasted },
|
|
1627
1722
|
...messageOverrides
|
|
1628
1723
|
}), [messageOverrides]);
|
|
1629
1724
|
const { paste: machinePaste } = pasteState;
|
|
@@ -1652,7 +1747,11 @@ const Root = /* @__PURE__ */ forwardRef(function PasteFieldRoot({ label, pasteOp
|
|
|
1652
1747
|
doPaste
|
|
1653
1748
|
]);
|
|
1654
1749
|
const { state } = pasteState;
|
|
1655
|
-
|
|
1750
|
+
let announcement = "";
|
|
1751
|
+
if (state.status === "read") {
|
|
1752
|
+
const message = (state.result.source === "drop" ? messages.dropped : void 0) ?? messages.pasted;
|
|
1753
|
+
announcement = typeof message === "function" ? message(state.result) : message;
|
|
1754
|
+
} else if (state.status === "error") announcement = messages.error(state.error, state.source);
|
|
1656
1755
|
return /* @__PURE__ */ jsx(PasteFieldContext.Provider, {
|
|
1657
1756
|
value: context,
|
|
1658
1757
|
children: /* @__PURE__ */ jsxs("div", {
|
|
@@ -1701,15 +1800,23 @@ const Status = /* @__PURE__ */ forwardRef(function PasteFieldStatus({ children,
|
|
|
1701
1800
|
});
|
|
1702
1801
|
/**
|
|
1703
1802
|
* A focusable paste target. Accepts keyboard paste (Ctrl/⌘+V) without a
|
|
1704
|
-
* permission prompt and
|
|
1803
|
+
* permission prompt and, unless `droppable={false}`, drag-and-drop. Renders
|
|
1804
|
+
* `data-zone` and `data-drag-over` for styling.
|
|
1705
1805
|
*
|
|
1706
1806
|
* Accessible name: `aria-label` prop, else `messages.zoneLabel(label)`
|
|
1707
1807
|
* ("Paste area for Notes"). Pass `aria-labelledby` explicitly to name it from
|
|
1708
1808
|
* another element instead.
|
|
1709
1809
|
*/
|
|
1710
|
-
const Zone = /* @__PURE__ */ forwardRef(function PasteFieldZone({ children, focusable = true, onPaste, "aria-label": ariaLabel, tabIndex, ...rest }, ref) {
|
|
1810
|
+
const Zone = /* @__PURE__ */ forwardRef(function PasteFieldZone({ children, focusable = true, droppable = true, onPaste, onDragEnter, onDragOver, onDragLeave, onDrop, "aria-label": ariaLabel, tabIndex, ...rest }, ref) {
|
|
1711
1811
|
const field = usePasteField();
|
|
1712
|
-
const { targetProps } = field;
|
|
1812
|
+
const { targetProps, dropTargetProps } = field;
|
|
1813
|
+
const drop = {
|
|
1814
|
+
onDragEnter,
|
|
1815
|
+
onDragOver,
|
|
1816
|
+
onDragLeave,
|
|
1817
|
+
onDrop
|
|
1818
|
+
};
|
|
1819
|
+
if (droppable) for (const key of Object.keys(dropTargetProps)) drop[key] = composeEventHandlers(drop[key], dropTargetProps[key]);
|
|
1713
1820
|
const safeAriaLabel = (ariaLabel ?? field.messages.zoneLabel(field.label)) || defaultPasteFieldMessages.zoneLabel(field.label);
|
|
1714
1821
|
return /* @__PURE__ */ jsx("div", {
|
|
1715
1822
|
"aria-keyshortcuts": "Control+V Meta+V",
|
|
@@ -1721,8 +1828,10 @@ const Zone = /* @__PURE__ */ forwardRef(function PasteFieldZone({ children, focu
|
|
|
1721
1828
|
"data-zone": "",
|
|
1722
1829
|
"data-state": field.status,
|
|
1723
1830
|
"data-display-state": field.displayStatus,
|
|
1831
|
+
"data-drag-over": droppable && field.isDragOver ? "" : void 0,
|
|
1724
1832
|
tabIndex: tabIndex ?? (focusable ? 0 : void 0),
|
|
1725
1833
|
onPaste: composeEventHandlers(onPaste, targetProps.onPaste),
|
|
1834
|
+
...drop,
|
|
1726
1835
|
children
|
|
1727
1836
|
});
|
|
1728
1837
|
});
|
|
@@ -1846,6 +1955,6 @@ const PasteField = {
|
|
|
1846
1955
|
})
|
|
1847
1956
|
};
|
|
1848
1957
|
//#endregion
|
|
1849
|
-
export { CopyFailure, CopyField, CopyGroup, DEFAULT_MAX_RETRIES, DEFAULT_MIN_PENDING_MS, DEFAULT_PASTE_ACCEPT, DEFAULT_PASTE_MAX_BYTES, DEFAULT_PASTE_MAX_ITEMS, DEFAULT_PASTE_MIN_PENDING_MS, DEFAULT_PASTE_PENDING_DELAY_MS, DEFAULT_PENDING_DELAY_MS, DEFAULT_RESET_AFTER_MS, IDLE_STATE, IMAGE_MIME_TYPE, LiveRegion, PASTE_IDLE_STATE, PasteField, SVG_MIME_TYPE, canRetryPasteState, canRetryState, copyFailure, createBrowserClipboardAdapter, createBrowserPasteAdapter, createCopyCoordinator, createCopyError, createCopyMachine, createPasteMachine, defaultCopyFieldMessages, defaultPasteFieldMessages, describeCopyError, describePasteError, isBlob, isCopyFailure, isRetryableError, isTextualMimeType, matchesMimePattern, normalizeMimeType, normalizePayload, resolveMaxRetries, resolvePasteReadOptions, serializeJson, sniffImageBytes, sniffImageType, toCopyError, useCopy, useCopyField, useCopyGroup, useDisplayStatus, usePaste, usePasteDisplayStatus, usePasteField, useRevealOnInteraction, validatePayload, visuallyHiddenStyle };
|
|
1958
|
+
export { CopyFailure, CopyField, CopyGroup, DEFAULT_MAX_RETRIES, DEFAULT_MIN_PENDING_MS, DEFAULT_PASTE_ACCEPT, DEFAULT_PASTE_MAX_BYTES, DEFAULT_PASTE_MAX_ITEMS, DEFAULT_PASTE_MIN_PENDING_MS, DEFAULT_PASTE_PENDING_DELAY_MS, DEFAULT_PENDING_DELAY_MS, DEFAULT_RESET_AFTER_MS, IDLE_STATE, IMAGE_MIME_TYPE, LiveRegion, PASTE_IDLE_STATE, PasteField, SVG_MIME_TYPE, canAcceptDrag, canRetryPasteState, canRetryState, copyFailure, createBrowserClipboardAdapter, createBrowserPasteAdapter, createCopyCoordinator, createCopyError, createCopyMachine, createPasteMachine, defaultCopyFieldMessages, defaultPasteFieldMessages, describeCopyError, describePasteError, isBlob, isCopyFailure, isRetryableError, isTextualMimeType, matchesMimePattern, normalizeMimeType, normalizePayload, resolveMaxRetries, resolvePasteReadOptions, serializeJson, sniffImageBytes, sniffImageType, toCopyError, useCopy, useCopyField, useCopyGroup, useDisplayStatus, usePaste, usePasteDisplayStatus, usePasteField, useRevealOnInteraction, validatePayload, visuallyHiddenStyle };
|
|
1850
1959
|
|
|
1851
1960
|
//# sourceMappingURL=index.js.map
|