mirror of https://github.com/ANL-CEEESA/RELOG.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
32 lines
852 B
32 lines
852 B
import type { Viewport } from '@xyflow/system';
|
|
/**
|
|
* The `useViewport` hook is a convenient way to read the current state of the
|
|
* {@link Viewport} in a component. Components that use this hook
|
|
* will re-render **whenever the viewport changes**.
|
|
*
|
|
* @public
|
|
* @returns The current viewport.
|
|
*
|
|
* @example
|
|
*
|
|
*```jsx
|
|
*import { useViewport } from '@xyflow/react';
|
|
*
|
|
*export default function ViewportDisplay() {
|
|
* const { x, y, zoom } = useViewport();
|
|
*
|
|
* return (
|
|
* <div>
|
|
* <p>
|
|
* The viewport is currently at ({x}, {y}) and zoomed to {zoom}.
|
|
* </p>
|
|
* </div>
|
|
* );
|
|
*}
|
|
*```
|
|
*
|
|
* @remarks This hook can only be used in a component that is a child of a
|
|
*{@link ReactFlowProvider} or a {@link ReactFlow} component.
|
|
*/
|
|
export declare function useViewport(): Viewport;
|
|
//# sourceMappingURL=useViewport.d.ts.map
|