Skip to content

useOlTranslateEventListener

useOlTranslateEventListener(translate, type, listener): Translate | TranslateMiddleClass | null

Defined in: src/use-ol-translate-event-listener.tsx:38

Hook to attach an event listener to an OpenLayers Translate or TranslateMiddle interaction. Automatically handles cleanup when the component unmounts or dependencies change.

The OpenLayers Translate or TranslateMiddle interaction instance (null-safe)

Translate | TranslateMiddleClass | null

TranslateEventType

The type of translate event to listen for (e.g., ‘translatestart’, ‘translateend’)

TranslateListener

The callback function to execute when the event fires

Translate | TranslateMiddleClass | null

The translate interaction instance

const translate = useOlTranslate()
useOlTranslateEventListener(translate, 'translateend', (evt) => {
console.log('Translation complete', evt.features)
})