Skip to main content Skip to complementary content

Link property definition

Information noteSTABLE.

This API is reliable and breaking changes are unlikely.


The link definition property template can be used to add a custom property of link type. When defining a link property, the following fields can be used:


This field is optional for links. Can be either string, integer, number, array or boolean.

Information noteThe link effect is achieved by defining the component field to "link", see below.


Used for defining how the property is visualized in the property panel. Used to override the default component that comes with the type setting.

This field is mandatory for a link property and should always be "link".


Used for defining the label that is displayed on the link.


Used for defining the web address used in the link.

Information noteLinks are always opened in your default web browser when clicked.


Defining a custom button

Defining a custom property of link type can look like below.


Information noteCustomization of properties always start with items:.
define( [
function ( ) {

	return {
		definition : {
			type : "items",
			component : "accordion",
			items: {
				settings: {
					uses: "settings",
					items: {
						MyLink: {
							label:"My Link",
							component: "link",
		paint: function ($element) {
			//add your rendering code here
			$element.html( "props-link" );

} );

This is what it looks like in the property panel

An interface titled "link property" with the subtitle "Appearance". Under "Appearance" there are two hide and show buttons called "General" and "My Link". Underneat the expanded hide and show button "My Link", there is a link with the text "My link". It is underlined and blue, visibling showing that it is a clickable link.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!