s2maps-gpu/dist/plugins/react/S2Map.d.ts

S2 Maps GPU - An open source, high-performance, and GPU-accelerated map engine for rendering large-scale, interactive maps.

import { BuildType } from '../preload.js';
import React from 'react';
import type { MapOptions, S2Map } from 's2/index.js';
/**
 * Props for the S2Map React Component.
 * Props are:
 * - `build`: The build type for the S2Map instance. See {@link BuildType}.
 * - `mapOptions`: The options for the S2Map instance.
 * - `mapReady?`: A function to be called when the S2Map instance is ready. Optional
 * - `version?`: The version of the S2Map instance. Optional
 * - `children?`: Child elements to be rendered inside the S2Map instance. Optional
 */
export interface S2MapReactComponentProps {
    build: BuildType;
    mapOptions: MapOptions;
    mapReady?: (s2map: S2Map) => void;
    version?: string;
    children?: React.ReactNode;
    testing?: boolean;
}
/**
 * S2Map React Component
 * @param props - Props passed to the component
 * @returns - The S2Map React Component
 */
export declare const ReactS2MapGPU: React.FC<S2MapReactComponentProps>;