@ckeditor/ckeditor5-react/dist/lifecycle/useLifeCycleSemaphoreSyncRef.d.ts

Official React component for CKEditor 5 – the best browser-based rich text editor.

/**
 * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
 * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
 */
import { type RefObject } from 'react';
import type { LifeCycleElementSemaphore, LifeCycleAfterMountCallback } from './LifeCycleElementSemaphore.js';
/**
 * When using the `useState` approach, a new instance of the semaphore must be set based on the previous
 * one within the `setState` callback, as shown in this example:
 *
 * 		setState( prevSemaphore => ... )
 *
 * The issue arises from the uncertainty of whether React has batched and cancelled some `setState` calls.
 * This means that setting the state with a semaphore three times might result in the collapsing of these three calls into a single one.
 *
 * Although this may not seem like a significant issue in theory, it can lead to a multitude of minor issues in practice that may
 * generate race conditions. This is because semaphores handle batching independently.
 *
 * A solution involving refs is safer in terms of preserving object references. In other words, `semaphoreRef.current` is guaranteed to
 * always point to the most recent instance of the semaphore.
 */
export declare const useLifeCycleSemaphoreSyncRef: <R extends object>() => LifeCycleSemaphoreSyncRefResult<R>;
export type LifeCycleSemaphoreSyncRefResult<R> = RefObject<LifeCycleElementSemaphore<R>> & {
    revision: number;
    unsafeSetValue: (value: R) => void;
    runAfterMount: (callback: LifeCycleAfterMountCallback<R>) => void;
    release: (rerender?: boolean) => void;
    replace: (newSemaphore: () => LifeCycleElementSemaphore<R>) => void;
    createAttributeRef: <K extends keyof R>(key: K) => RefObject<R[K]>;
};