Files
coopgo/node_modules/slate/dist/interfaces/range.d.ts
sgauthier 6e64e138e2
All checks were successful
Publish To Prod / deploy_and_publish (push) Successful in 35s
planning
2024-10-14 09:15:30 +02:00

35 lines
1.4 KiB
TypeScript

import { ExtendedType, Operation, Path, Point, PointEntry } from '..';
import { RangeDirection } from './types';
/**
* `Range` objects are a set of points that refer to a specific span of a Slate
* document. They can define a span inside a single node or a can span across
* multiple nodes.
*/
export interface BaseRange {
anchor: Point;
focus: Point;
}
export declare type Range = ExtendedType<'Range', BaseRange>;
export interface RangeEdgesOptions {
reverse?: boolean;
}
export interface RangeTransformOptions {
affinity?: RangeDirection | null;
}
export interface RangeInterface {
edges: (range: Range, options?: RangeEdgesOptions) => [Point, Point];
end: (range: Range) => Point;
equals: (range: Range, another: Range) => boolean;
includes: (range: Range, target: Path | Point | Range) => boolean;
intersection: (range: Range, another: Range) => Range | null;
isBackward: (range: Range) => boolean;
isCollapsed: (range: Range) => boolean;
isExpanded: (range: Range) => boolean;
isForward: (range: Range) => boolean;
isRange: (value: any) => value is Range;
points: (range: Range) => Generator<PointEntry, void, undefined>;
start: (range: Range) => Point;
transform: (range: Range, op: Operation, options?: RangeTransformOptions) => Range | null;
}
export declare const Range: RangeInterface;
//# sourceMappingURL=range.d.ts.map