Link

Adds a Link panel in the Makeswift builder to visually edit a LinkValue prop.

Params

label · string · default: "On click"

Text for the panel label in the Makeswift builder.

description · string

The description shown in the Panel of the Makeswift builder. This can be written in Markdown format. Added in v0.24.8.

Prop type

The Link control passes an object of type LinkValue to your component.

type LinkValue = {
  href: string;
  target?: "_blank" | "_self";
};

If no value is set in the builder, your component receives { href: '#' }.

Example

The following example adds an Link control to the link prop of a Button component.

Button.makeswift.ts

import { Link } from "@makeswift/runtime/controls";

import { runtime } from "@/makeswift/runtime";

import { Button } from "./Button";

runtime.registerComponent(Button, {
  type: "button",
  label: "Button",
  props: {
    link: Link(),
  },
});

.makeswift.ts is a naming convention for organizing Makeswift registration code. Learn more.