Skip to main content
CYPEX Documentation
    Support
    v2.0.0 Latest stable release View changelog ->
    1. CYPEX — PostgreSQL Application Platform
    2. /
    3. Element Dictionary
    4. /
    5. Various
    6. /
    7. Internal Link Button
    Various Referencegenerated

    Internal Link Button

    Display a Link Button

    Technical id
    default_internal_link_button
    Default size
    1 × 1 cells
    Translation keys
    label

    A styleable navigation layout link or button component designed strictly for routing internally between local workspace page templates.

    When to use

    • Navigating users cleanly between different pages or routing dashboards inside the current application workspace environment.
    • Providing simple routing triggers (e.g., standard ‘Back to List’ cancel paths or detail page redirects) without triggering secondary transactional database operations.

    Examples

    • A ‘Cancel’ secondary action button nested within a form layout that returns the user safely to the main dashboard directory.
    • A compact icon-only navigation shortcut placed inside a data grid header routing users straight to a detailed analytics overview tab.

    Avoid

    • Navigating to third-party web portals or external addresses outside the current platform domain, use the external_link_field instead.
    • Configuring complex multi-step mutation procedures or API transactions directly on this element, use default_call_button or action_button instead.
    • Allocating visual footprints taller than 1 grid row unit high, which breaks visual layout conventions.

    Use instead

    • External Link Field — The navigation route points toward a domain address outside the local application framework ecosystem.
    • Action Button — The page transition workflow requires running side-effects first (such as committing changes or refreshing queries) prior to performing the route shift.

    Editor properties

    Configure these in the Application Designer property panel. Group headings mirror the editor where possible. Data Source is where the element gets its rows or field binding (a view/query, a connector operation, or a parent form field). References appear only for view-backed sources and map foreign-key ID columns to readable labels from another view.

    Referring Page
    Page IDrequiredTextInside `linkTo`
    Target page id in the application menu.
    Default: none
    ParamsrequiredKey-value mapInside `linkTo`
    Query parameters passed to the target page.
    Default: {}
    Display
    IconoptionalText
    Configuration for icon.
    Default: none
    ColoroptionalOne of: primary, secondary, success, error, warning, info, default, lighter, disabled, white, black (or not set)
    Sets the visual design theme tint via static selector maps or dynamic expression variable text boxes.
    Choices
    • primary — Theme default branding blue color (#007bff).
    • secondary — Muted branding slate gray color (#6c757d).
    • success — Standard transactional green color (#28a745).
    • error — Severe action warning red color (#dc3545).
    • warning — Cautionary yellow color (#ffc107).
    • info — Informing teal/light blue color (#17a2b8).
    • default — Dark charcoal text color (#343a40).
    • lighter
    • disabled — Non-interactive gray color (#adb5bd).
    • white — Plain white color (#ffffff).
    • black — Plain black color (#000000).
    Default: none
    SizeoptionalOne of: small, medium, large
    Defines the geometric structural dimensions footprints assigned to the button block frame.
    Choices
    • small
    • medium
    • large
    Default: none
    VariantoptionalOne of: outlined, contained
    Configures container paint styles across background frameworks.
    Choices
    • outlined
    • contained
    Default: none
    Is IconoptionalYes / no
    Configuration for is Icon.
    Default: false
    DisabledoptionalCustom expression (yes/no)
    When true, the control cannot be edited.
    Example false
    Default: buildCustomExpressionValue("false")
    Full WidthoptionalYes / no
    A layout switch forcing the element bounding footprint box to stretch fully across its allocated cell lane width. Highly recommended to center alignment states cleanly.
    Default: none
    Styling
    ColoroptionalOne of: primary, secondary, success, error, warning, info, default, lighter, disabled, white, black (or not set)
    Sets the visual design theme tint via static selector maps or dynamic expression variable text boxes.
    Choices
    • primary — Theme default branding blue color (#007bff).
    • secondary — Muted branding slate gray color (#6c757d).
    • success — Standard transactional green color (#28a745).
    • error — Severe action warning red color (#dc3545).
    • warning — Cautionary yellow color (#ffc107).
    • info — Informing teal/light blue color (#17a2b8).
    • default — Dark charcoal text color (#343a40).
    • lighter
    • disabled — Non-interactive gray color (#adb5bd).
    • white — Plain white color (#ffffff).
    • black — Plain black color (#000000).
    Default: none
    SizeoptionalOne of: small, medium, large
    Defines the geometric structural dimensions footprints assigned to the button block frame.
    Choices
    • small
    • medium
    • large
    Default: none
    VariantoptionalOne of: outlined, contained
    Configures container paint styles across background frameworks.
    Choices
    • outlined
    • contained
    Default: none
    Is IconoptionalYes / no
    Configuration for is Icon.
    Default: false
    Full WidthoptionalYes / no
    A layout switch forcing the element bounding footprint box to stretch fully across its allocated cell lane width. Highly recommended to center alignment states cleanly.
    Default: none

    Sizing

    • Minimum size: 1 × 1 grid cells (width × height).
    • Default size when dropped on a page: 1 × 1.

    Translatable labels

    • label — The text string generated visible centered over the body layout frame of the internal navigation control button.

    Accessibility

    Fires direct spatial route changes using standard native hyperlink anchors or keyboard triggers. Automatically supplies alternate screen tags when toggled to icon-only display modes.

    • Fires the router path mutation hook immediately when focused and clicking Spacebar or Enter keys.

    Where you can place it

    Drag this element into one of these containers:

     1
 2
 3
 4
 5
 6
 7
 8
 9
10

    {
  "config": {
    "linkTo": {
      "pageId": "overview",
      "params": {
        "exampleKey": "@@expression:'value'"
      }
    }
  }
}

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

    {
  "config": {
    "linkTo": {
      "pageId": "overview",
      "params": {
        "exampleKey": "@@expression:'value'"
      }
    },
    "color": "primary",
    "size": "small",
    "icon": "icon",
    "fullWidth": false,
    "disabled": "@@expression:true",
    "variant": "outlined",
    "isIcon": false
  }
}