chore(autoFocus): rename to autoPanOnNodeFocus

This commit is contained in:
moklick
2025-06-05 19:37:14 +02:00
parent c44f0c6156
commit 19cd285458
14 changed files with 41 additions and 42 deletions
+6 -6
View File
@@ -8,7 +8,6 @@ import {
ReactFlowProvider, ReactFlowProvider,
Node, Node,
Edge, Edge,
OnNodeDrag,
AriaLabelConfig, AriaLabelConfig,
Panel, Panel,
} from '@xyflow/react'; } from '@xyflow/react';
@@ -73,12 +72,13 @@ const ariaLabelConfig: Partial<AriaLabelConfig> = {
}; };
const A11y = () => { const A11y = () => {
const [isFocusPannable, setEnablePanOnFocus] = useState(true); const [autoPanOnNodeFocus, setAutoPanOnNodeFocus] = useState(true);
return ( return (
<ReactFlow <ReactFlow
defaultNodes={initialNodes} defaultNodes={initialNodes}
defaultEdges={initialEdges} defaultEdges={initialEdges}
enablePanOnFocus={isFocusPannable} autoPanOnNodeFocus={autoPanOnNodeFocus}
selectNodesOnDrag={false} selectNodesOnDrag={false}
elevateEdgesOnSelect elevateEdgesOnSelect
elevateNodesOnSelect={false} elevateNodesOnSelect={false}
@@ -94,11 +94,11 @@ const A11y = () => {
<input <input
id="focusPannable" id="focusPannable"
type="checkbox" type="checkbox"
checked={isFocusPannable} checked={autoPanOnNodeFocus}
onChange={(event) => setEnablePanOnFocus(event.target.checked)} onChange={(event) => setAutoPanOnNodeFocus(event.target.checked)}
className="xy-theme__checkbox" className="xy-theme__checkbox"
/> />
enablePanOnFocus autoPanOnNodeFocus
</label> </label>
</div> </div>
</Panel> </Panel>
@@ -19,13 +19,19 @@
{ id: 'A-C', source: 'A', target: 'C' }, { id: 'A-C', source: 'A', target: 'C' },
{ id: 'A-D', source: 'A', target: 'D' } { id: 'A-D', source: 'A', target: 'D' }
]); ]);
let isFocusPannable = $state(true); let autoPanOnNodeFocus = $state(true);
const ariaLabelConfig = $state( const ariaLabelConfig = $state({
{
'node.a11yDescription.default': 'Svelte Custom Node Desc.', 'node.a11yDescription.default': 'Svelte Custom Node Desc.',
'node.a11yDescription.keyboardDisabled': 'Svelte Custom Keyboard Desc.', 'node.a11yDescription.keyboardDisabled': 'Svelte Custom Keyboard Desc.',
'node.a11yDescription.ariaLiveMessage': ({ direction, x, y }: { direction: string; x: number; y: number }) => 'node.a11yDescription.ariaLiveMessage': ({
`Custom Moved selected node ${direction}. New position, x: ${x}, y: ${y}`, direction,
x,
y
}: {
direction: string;
x: number;
y: number;
}) => `Custom Moved selected node ${direction}. New position, x: ${x}, y: ${y}`,
'edge.a11yDescription.default': 'Svelte Custom Edge Desc.', 'edge.a11yDescription.default': 'Svelte Custom Edge Desc.',
'controls.ariaLabel': 'Svelte Custom Control Aria Label', 'controls.ariaLabel': 'Svelte Custom Control Aria Label',
'controls.zoomIn.ariaLabel': 'Svelte Custom Zoom in', 'controls.zoomIn.ariaLabel': 'Svelte Custom Zoom in',
@@ -33,30 +39,24 @@
// 'controls.fitView.ariaLabel': 'Svelte Custom Fit View', // 'controls.fitView.ariaLabel': 'Svelte Custom Fit View',
'controls.interactive.ariaLabel': 'Svelte Custom Toggle Interactivity', 'controls.interactive.ariaLabel': 'Svelte Custom Toggle Interactivity',
'minimap.ariaLabel': 'Svelte Custom Minimap' 'minimap.ariaLabel': 'Svelte Custom Minimap'
} });
);
</script> </script>
<SvelteFlow <SvelteFlow bind:nodes bind:edges {autoPanOnNodeFocus} {ariaLabelConfig}>
bind:nodes
bind:edges
enablePanOnFocus={isFocusPannable}
ariaLabelConfig={ariaLabelConfig}
>
<Controls /> <Controls />
<Background /> <Background />
<MiniMap /> <MiniMap />
<Panel class="panel top-right"> <Panel class="panel top-right">
<div> <div>
<label for="focusPannable"> <label for="focusPannable">
Enable Pan on Focus Enable Pan on Focus
<input <input
id="focusPannable" id="focusPannable"
type="checkbox" type="checkbox"
bind:checked={isFocusPannable} bind:checked={autoPanOnNodeFocus}
class="svelte-flow__zoomonscroll" class="svelte-flow__zoomonscroll"
/> />
</label> </label>
</div> </div>
</Panel> </Panel>
</SvelteFlow> </SvelteFlow>
@@ -29,7 +29,7 @@ export function NodeWrapper<NodeType extends Node>({
onContextMenu, onContextMenu,
onDoubleClick, onDoubleClick,
nodesDraggable, nodesDraggable,
enablePanOnFocus, autoPanOnNodeFocus,
elementsSelectable, elementsSelectable,
nodesConnectable, nodesConnectable,
nodesFocusable, nodesFocusable,
@@ -162,7 +162,7 @@ export function NodeWrapper<NodeType extends Node>({
}; };
const onFocus = () => { const onFocus = () => {
if (disableKeyboardA11y || !enablePanOnFocus || !nodeRef.current?.matches(':focus-visible')) { if (disableKeyboardA11y || !autoPanOnNodeFocus || !nodeRef.current?.matches(':focus-visible')) {
return; return;
} }
@@ -23,7 +23,7 @@ const reactFlowFieldsToTrack = [
'onClickConnectStart', 'onClickConnectStart',
'onClickConnectEnd', 'onClickConnectEnd',
'nodesDraggable', 'nodesDraggable',
'enablePanOnFocus', 'autoPanOnNodeFocus',
'nodesConnectable', 'nodesConnectable',
'nodesFocusable', 'nodesFocusable',
'edgesFocusable', 'edgesFocusable',
@@ -29,7 +29,7 @@ export type NodeRendererProps<NodeType extends Node> = Pick<
const selector = (s: ReactFlowState) => ({ const selector = (s: ReactFlowState) => ({
nodesDraggable: s.nodesDraggable, nodesDraggable: s.nodesDraggable,
enablePanOnFocus: s.enablePanOnFocus, autoPanOnNodeFocus: s.autoPanOnNodeFocus,
nodesConnectable: s.nodesConnectable, nodesConnectable: s.nodesConnectable,
nodesFocusable: s.nodesFocusable, nodesFocusable: s.nodesFocusable,
elementsSelectable: s.elementsSelectable, elementsSelectable: s.elementsSelectable,
@@ -37,10 +37,8 @@ const selector = (s: ReactFlowState) => ({
}); });
function NodeRendererComponent<NodeType extends Node>(props: NodeRendererProps<NodeType>) { function NodeRendererComponent<NodeType extends Node>(props: NodeRendererProps<NodeType>) {
const { nodesDraggable, nodesConnectable, nodesFocusable, elementsSelectable, enablePanOnFocus, onError } = useStore( const { nodesDraggable, nodesConnectable, nodesFocusable, elementsSelectable, autoPanOnNodeFocus, onError } =
selector, useStore(selector, shallow);
shallow
);
const nodeIds = useVisibleNodeIds(props.onlyRenderVisibleElements); const nodeIds = useVisibleNodeIds(props.onlyRenderVisibleElements);
const resizeObserver = useResizeObserver(); const resizeObserver = useResizeObserver();
@@ -90,7 +88,7 @@ function NodeRendererComponent<NodeType extends Node>(props: NodeRendererProps<N
disableKeyboardA11y={props.disableKeyboardA11y} disableKeyboardA11y={props.disableKeyboardA11y}
resizeObserver={resizeObserver} resizeObserver={resizeObserver}
nodesDraggable={nodesDraggable} nodesDraggable={nodesDraggable}
enablePanOnFocus={enablePanOnFocus} autoPanOnNodeFocus={autoPanOnNodeFocus}
nodesConnectable={nodesConnectable} nodesConnectable={nodesConnectable}
nodesFocusable={nodesFocusable} nodesFocusable={nodesFocusable}
elementsSelectable={elementsSelectable} elementsSelectable={elementsSelectable}
@@ -77,7 +77,7 @@ function ReactFlow<NodeType extends Node = Node, EdgeType extends Edge = Edge>(
onlyRenderVisibleElements = false, onlyRenderVisibleElements = false,
selectNodesOnDrag, selectNodesOnDrag,
nodesDraggable, nodesDraggable,
enablePanOnFocus, autoPanOnNodeFocus,
nodesConnectable, nodesConnectable,
nodesFocusable, nodesFocusable,
nodeOrigin = defaultNodeOrigin, nodeOrigin = defaultNodeOrigin,
@@ -262,7 +262,7 @@ function ReactFlow<NodeType extends Node = Node, EdgeType extends Edge = Edge>(
onClickConnectStart={onClickConnectStart} onClickConnectStart={onClickConnectStart}
onClickConnectEnd={onClickConnectEnd} onClickConnectEnd={onClickConnectEnd}
nodesDraggable={nodesDraggable} nodesDraggable={nodesDraggable}
enablePanOnFocus={enablePanOnFocus} autoPanOnNodeFocus={autoPanOnNodeFocus}
nodesConnectable={nodesConnectable} nodesConnectable={nodesConnectable}
nodesFocusable={nodesFocusable} nodesFocusable={nodesFocusable}
edgesFocusable={edgesFocusable} edgesFocusable={edgesFocusable}
+2 -1
View File
@@ -112,7 +112,6 @@ const getInitialState = ({
snapToGrid: false, snapToGrid: false,
nodesDraggable: true, nodesDraggable: true,
enablePanOnFocus: false,
nodesConnectable: true, nodesConnectable: true,
nodesFocusable: true, nodesFocusable: true,
edgesFocusable: true, edgesFocusable: true,
@@ -135,7 +134,9 @@ const getInitialState = ({
ariaLiveMessage: '', ariaLiveMessage: '',
autoPanOnConnect: true, autoPanOnConnect: true,
autoPanOnNodeDrag: true, autoPanOnNodeDrag: true,
autoPanOnNodeFocus: true,
autoPanSpeed: 15, autoPanSpeed: 15,
connectionRadius: 20, connectionRadius: 20,
onError: devWarn, onError: devWarn,
isValidConnection: undefined, isValidConnection: undefined,
+1 -1
View File
@@ -387,7 +387,7 @@ export interface ReactFlowProps<NodeType extends Node = Node, EdgeType extends E
* When `true`, the viewport will pan when a node is focused. * When `true`, the viewport will pan when a node is focused.
* @default false * @default false
*/ */
enablePanOnFocus?: boolean; autoPanOnNodeFocus?: boolean;
/** /**
* Controls whether all nodes should be connectable or not. Individual nodes can override this * Controls whether all nodes should be connectable or not. Individual nodes can override this
* setting by setting their `connectable` prop. * setting by setting their `connectable` prop.
+1 -1
View File
@@ -48,7 +48,7 @@ export type NodeWrapperProps<NodeType extends Node> = {
nodesConnectable: boolean; nodesConnectable: boolean;
elementsSelectable: boolean; elementsSelectable: boolean;
nodesDraggable: boolean; nodesDraggable: boolean;
enablePanOnFocus: boolean; autoPanOnNodeFocus: boolean;
nodesFocusable: boolean; nodesFocusable: boolean;
onClick?: NodeMouseHandler<NodeType>; onClick?: NodeMouseHandler<NodeType>;
onDoubleClick?: NodeMouseHandler<NodeType>; onDoubleClick?: NodeMouseHandler<NodeType>;
+1 -1
View File
@@ -89,7 +89,7 @@ export type ReactFlowStore<NodeType extends Node = Node, EdgeType extends Edge =
snapGrid: SnapGrid; snapGrid: SnapGrid;
nodesDraggable: boolean; nodesDraggable: boolean;
enablePanOnFocus: boolean; autoPanOnNodeFocus: boolean;
nodesConnectable: boolean; nodesConnectable: boolean;
nodesFocusable: boolean; nodesFocusable: boolean;
edgesFocusable: boolean; edgesFocusable: boolean;
@@ -202,7 +202,7 @@
const onFocus = () => { const onFocus = () => {
if ( if (
store.disableKeyboardA11y || store.disableKeyboardA11y ||
!store.enablePanOnFocus || !store.autoPanOnNodeFocus ||
!nodeRef?.matches(':focus-visible') !nodeRef?.matches(':focus-visible')
) { ) {
return; return;
@@ -84,7 +84,7 @@
elevateNodesOnSelect, elevateNodesOnSelect,
elevateEdgesOnSelect, elevateEdgesOnSelect,
nodesDraggable, nodesDraggable,
enablePanOnFocus, autoPanOnNodeFocus,
nodesConnectable, nodesConnectable,
elementsSelectable, elementsSelectable,
nodesFocusable, nodesFocusable,
@@ -236,7 +236,7 @@ export type SvelteFlowProps<
* When `true`, the viewport will pan when a node is focused. * When `true`, the viewport will pan when a node is focused.
* @default false * @default false
*/ */
enablePanOnFocus?: boolean; autoPanOnNodeFocus?: boolean;
/** /**
* Controls if all nodes should be connectable to each other * Controls if all nodes should be connectable to each other
* @default true * @default true
@@ -247,7 +247,6 @@ export function getInitialStore<NodeType extends Node = Node, EdgeType extends E
}); });
nodesDraggable: boolean = $derived(signals.props.nodesDraggable ?? true); nodesDraggable: boolean = $derived(signals.props.nodesDraggable ?? true);
enablePanOnFocus: boolean = $derived(signals.props.enablePanOnFocus ?? true);
nodesConnectable: boolean = $derived(signals.props.nodesConnectable ?? true); nodesConnectable: boolean = $derived(signals.props.nodesConnectable ?? true);
elementsSelectable: boolean = $derived(signals.props.elementsSelectable ?? true); elementsSelectable: boolean = $derived(signals.props.elementsSelectable ?? true);
nodesFocusable: boolean = $derived(signals.props.nodesFocusable ?? true); nodesFocusable: boolean = $derived(signals.props.nodesFocusable ?? true);
@@ -267,6 +266,7 @@ export function getInitialStore<NodeType extends Node = Node, EdgeType extends E
nodeDragThreshold: number = $derived(signals.props.nodeDragThreshold ?? 1); nodeDragThreshold: number = $derived(signals.props.nodeDragThreshold ?? 1);
autoPanOnNodeDrag: boolean = $derived(signals.props.autoPanOnNodeDrag ?? true); autoPanOnNodeDrag: boolean = $derived(signals.props.autoPanOnNodeDrag ?? true);
autoPanOnConnect: boolean = $derived(signals.props.autoPanOnConnect ?? true); autoPanOnConnect: boolean = $derived(signals.props.autoPanOnConnect ?? true);
autoPanOnNodeFocus: boolean = $derived(signals.props.autoPanOnNodeFocus ?? true);
fitViewQueued: boolean = signals.props.fitView ?? false; fitViewQueued: boolean = signals.props.fitView ?? false;
fitViewOptions: FitViewOptions | undefined = signals.props.fitViewOptions; fitViewOptions: FitViewOptions | undefined = signals.props.fitViewOptions;