@paperbits/common/permalinks/hyperlinkModel.ts

Paperbits common components.

/**
 * Hyperlink model is used in editors to display an associated hyperlink.
 */
export class HyperlinkModel {
    /**
     * Example: "Page: Home"
     */
    public title?: string;

    /**
     * Example: _blank.
     */
    public target: string;

    /**
     * Example: "pages/43i4394u3kn34j3h4gujhhfe444"
     */
    public targetKey?: string;

    /**
     * Example: "http://external-resource"
     */
    public href: string;

    /**
     * Example: "http://external-resource#anchor"
     */
    public anchor: string;

    /**
     * @deprecated. Display name of the anchor (temporary field, should be calculated).
     */
    public anchorName: string;

    /**
     * Event that triggers the navigation, e.g. `click`.
     */
    public triggerEvent?: string;
}

export enum HyperlinkTarget {
    popup = "_popup",
    download = "_download"
}