Version: 0.1.10.1.30.2.00.3.00.3.10.4.00.5.00.6.00.7.00.8.00.8.10.8.20.9.00.10.00.11.00.11.10.12.00.12.10.12.20.12.30.12.40.13.00.13.10.14.00.14.10.15.00.15.10.15.20.15.30.15.40.15.50.16.00.16.10.16.20.16.30.16.40.17.0-00.17.0-10.17.10.17.20.18.00.18.20.18.30.18.40.19.1-alpha.00.19.11.0.0-alpha.01.0.0-alpha.11.0.0-alpha.21.0.0-alpha.31.0.0-alpha.41.0.0-alpha.51.0.0-alpha.61.0.0-alpha.71.0.0-alpha.81.0.0-alpha.91.0.0-alpha.101.0.0-alpha.111.0.0-alpha.121.0.0-alpha.131.0.0-rc.01.0.0-rc.11.0.01.0.11.0.21.0.31.0.41.0.51.1.0-alpha.01.1.0-alpha.11.1.0-alpha.21.1.0-rc.01.1.01.1.11.1.21.1.31.2.0-alpha.01.2.0-alpha.11.2.0-alpha.21.2.0-alpha.31.2.0-rc.01.2.01.2.11.2.21.2.31.2.41.2.51.2.61.2.71.2.81.2.91.2.101.2.112.0.0-alpha.02.0.0-alpha.12.0.0-alpha.22.0.0-alpha.32.0.0-alpha.42.0.0-beta.02.0.0-beta.12.0.0-beta.22.0.0-beta.32.0.0-rc.02.0.0-rc.12.0.0-rc.22.0.02.0.12.0.22.0.32.1.0-a.02.1.0-beta.02.1.0-rc.02.1.02.1.12.2.0-alpha.02.2.0-alpha.22.2.0-rc.02.2.0-rc.12.2.02.2.12.2.22.2.32.2.42.2.52.2.62.2.72.3.0-alpha.02.3.0-alpha.12.3.0-alpha.22.3.0-rc.02.3.02.3.13.0.0-alpha.03.0.0-alpha.13.0.0-alpha.23.0.0-alpha.33.0.0-alpha.43.0.0-alpha.53.0.0-alpha.63.0.0-alpha.73.0.0-alpha.83.0.0-alpha.93.0.0-alpha.103.0.0-alpha.113.0.0-alpha.123.0.0-alpha.133.0.0-alpha.143.0.0-beta.03.0.0-beta.13.0.0-beta.23.0.0-beta.33.0.0-beta.43.0.0-beta.53.0.0-beta.63.0.0-beta.73.0.0-beta.83.0.0-rc.03.0.0-rc.13.0.0-rc.23.0.0-rc.33.0.0-rc.43.0.0-rc.53.0.0-rc.63.0.0-rc.73.0.0-rc.83.0.0-rc.93.0.0-rc.103.0.0-rc.113.0.0-rc.123.0.0-rc.133.0.0-rc.143.0.0-rc.153.0.03.0.13.0.23.0.33.0.43.0.53.0.63.0.73.0.83.0.93.0.103.1.0-alpha.03.1.0-alpha.13.1.0-alpha.23.1.0-alpha.33.1.0-alpha.43.1.0-alpha.53.1.0-alpha.63.1.0-alpha.73.1.0-alpha.83.1.0-alpha.93.1.0-alpha.103.1.0-alpha.113.1.0-alpha.123.1.0-alpha.133.1.0-beta.03.1.0-beta.13.1.0-beta.23.1.0-rc.03.1.0-rc.13.1.0-rc.23.1.03.1.13.1.23.1.33.1.43.1.53.1.63.1.73.1.83.1.93.1.103.1.113.1.123.1.133.1.153.1.163.1.173.1.183.2.0-alpha.03.2.0-alpha.13.2.0-beta.03.2.0-rc.03.2.03.2.13.2.23.2.33.2.43.2.53.2.63.2.73.2.83.2.93.3.0-alpha.03.3.0-alpha.13.3.0-alpha.23.3.0-alpha.33.3.0-alpha.43.3.0-alpha.53.3.0-alpha.63.3.0-alpha.73.3.0-alpha.83.3.0-alpha.93.3.0-alpha.103.3.0-alpha.113.3.0-alpha.123.3.0-alpha.133.3.0-alpha.143.3.0-alpha.153.3.0-alpha.163.3.0-alpha.173.3.0-alpha.183.3.0-beta.03.3.0-rc.03.3.03.3.13.3.23.3.33.3.43.4.0-alpha.03.4.0-beta.03.4.0-rc.03.4.03.4.13.4.23.4.33.4.43.4.53.4.63.4.73.4.83.5.0-alpha.03.5.0-beta.03.5.0-rc.03.5.03.5.13.5.23.5.33.6.0-alpha.03.6.0-alpha.13.6.0-alpha.23.6.0-alpha.33.6.0-alpha.43.6.0-alpha.53.6.0-beta.03.6.0-rc.03.6.0-rc.13.6.03.6.13.6.23.6.33.6.43.6.53.6.63.6.74.0.0-alpha.14.0.0-alpha.24.0.0-alpha.34.0.0-alpha.44.0.0-alpha.54.0.0-alpha.64.0.0-alpha.74.0.0-alpha.84.0.0-alpha.94.0.0-alpha.104.0.0-alpha.114.0.0-alpha.124.0.0-alpha.134.0.0-alpha.144.0.0-alpha.154.0.0-alpha.164.0.0-alpha.174.0.0-alpha.184.0.0-alpha.194.0.0-alpha.204.0.0-alpha.214.0.0-alpha.224.0.0-beta.04.0.0-beta.14.0.0-beta.24.0.0-rc.04.0.0-rc.14.0.04.1.14.1.24.1.34.1.44.1.54.1.64.1.74.1.84.1.94.1.104.1.114.1.124.1.134.2.0-alpha.14.2.0-alpha.24.2.0-alpha.34.2.0-alpha.44.2.0-beta.04.2.0-beta.14.2.0-beta.24.2.0-rc.04.2.0-rc.14.2.04.2.14.2.24.2.34.2.44.2.54.2.64.3.0-alpha.04.3.0-alpha.14.3.0-alpha.24.3.0-beta.04.3.0-beta.14.3.0-beta.24.3.0-beta.3
/**
* A namespace for `HoverBox` members.
*/
export declare namespace HoverBox {
* Options for setting the geometry of a hovering node and its anchor node.
interface IOptions {
* The referent anchor rectangle to which the hover box is bound.
*
* #### Notes
* In an editor context, this value will typically be the cursor's
* coordinate position, which can be retrieved via calling the
* `getCoordinateForPosition` method.
anchor: ClientRect;
* The node that hosts the anchor.
* The visibility of the anchor rectangle within this host node is the
* heuristic that determines whether the hover box ought to be visible.
host: HTMLElement;
* The maximum height of a hover box.
* This value is only used if a CSS max-height attribute is not set for the
* hover box. It is a fallback value.
maxHeight: number;
* The minimum height of a hover box.
minHeight: number;
* The hover box node.
node: HTMLElement;
* Optional pixel offset values added to where the hover box should render.
* This option is useful for passing in values that may pertain to CSS
* borders or padding in cases where the text inside the hover box may need
* to align with the text of the referent editor.
* Because the hover box calculation may render a box either above or below
* the cursor, the `vertical` offset accepts `above` and `below` values for
* the different render modes.
offset?: {
horizontal?: number;
vertical?: {
above?: number;
below?: number;
};
* If space is available both above and below the anchor, denote which
* location is privileged. Use forceBelow and forceAbove to mandate where
* hover box should render relative to anchor.
* The default value is `'below'`.
privilege?: 'above' | 'below' | 'forceAbove' | 'forceBelow';
* If the style of the node has already been computed, it can be passed into
* the hover box for geometry calculation.
style?: CSSStyleDeclaration;
}
* Set the visible dimensions of a hovering box anchored to an editor cursor.
* @param options - The hover box geometry calculation options.
function setGeometry(options: IOptions): void;