link (The Emacs Widget Library)

8.1.3 The link Widget

Syntax:

type ::= (link [keyword argument]... [ value ])

A widget to represent an embedded link. Its super is the item widget.

The value, if present, is used to initialize the :value property. The value should be a string, which will be inserted in the buffer.

Example:

(widget-create 'link
 :button-prefix ""
 :button-suffix ""
 :tag "Mail yourself"
 :action #'(lambda (widget &optional _event)
 (compose-mail-other-window (widget-value widget)))
 user-mail-address)

By default, it has the following properties:

:button-prefix

The value of widget-link-prefix.

:button-suffix

The value of widget-link-suffix.

:keymap

A custom keymap for the link widget, so that it can respond to mouse clicks.

:follow-link

This property allows the link to respect the value of mouse-1-click-follows-link. See Clickable Text in the Emacs Lisp Reference Manual.

:format

Buttonizes the link, to make it clickable.

If you override this property, you should make sure to provide the ‘%[’ and ‘%]’ escape sequences, so that the link is clickable.

By default the link will be shown in brackets.