For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign in
DocsAPI ReferenceChangelog
DocsAPI ReferenceChangelog
  • Get started
    • Quickstart
    • Concepts
  • Guides
    • Environments
  • Reference
        • Checkbox
        • Code
        • Color
        • Combobox
        • Group
        • Image
        • Font
        • Link
        • List
        • Number
        • Rich Text
        • Select
        • Slot
        • Style
        • Text Area
        • Text Input
      • Makeswift API Handler
    • Product docs
    • Blog
    • Support
Sign in
LogoLogo
On this page
  • Params
  • Prop type
  • Example
Reference@makeswift/runtimeControls

Link

Was this page helpful?
Previous

Font

Next

List

Built with

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

Params

label
stringDefaults to 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.

1type LinkValue = {
2 href: string;
3 target?: "_blank" | "_self";
4};

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.

1import { Link } from "@makeswift/runtime/controls";
2
3import { runtime } from "../../../../../makeswift/runtime";
4
5import { Button } from "./Button";
6
7runtime.registerComponent(Button, {
8 type: "button",
9 label: "Button",
10 props: {
11 link: Link(),
12 },
13});

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