Lowdefy
  • Introduction
  • Tutorial
    • Getting started
    • Creating a page
    • Adding blocks
    • Interactive pages
    • Requests
    • Deploy to Netlify
    • Next steps
  • How To
    • Generate CSVs
    • Generate PDFs
  • Concepts
    • Overview
    • The CLI
    • Lowdefy App Schema
    • Context and State
    • Blocks
    • Layout
    • Connections and Requests
    • Events and Actions
    • Operators
    • Secrets
    • Lists
    • Hosting Files
    • Custom Code
    • Custom Blocks
  • Deployment
    • AWS Lambda
    • Docker
    • Netlify
    • Node.js
  • User Authentication
    • Introduction
    • OpenID Connect
    • Login and Logout
    • Protected pages
    • User object
    • Roles
  • Input Blocks
    • AutoComplete
    • ButtonSelector
    • CheckboxSelector
    • CheckboxSwitch
    • ChromeColorSelector
    • CircleColorSelector
    • ColorSelector
    • CompactColorSelector
    • DateRangeSelector
    • DateSelector
    • DateTimeSelector
    • GithubColorSelector
    • MonthSelector
    • MultipleSelector
    • NumberInput
    • Pagination
    • ParagraphInput
    • PasswordInput
    • RadioSelector
    • RatingSlider
    • S3UploadButton
    • Selector
    • SliderColorSelector
    • SwatchesColorSelector
    • Switch
    • TextArea
    • TextInput
    • TitleInput
    • TwitterColorSelector
    • WeekSelector
  • Display Blocks
    • Alert
    • Anchor
    • Avatar
    • Breadcrumb
    • Button
    • DangerousHtml
    • DangerousMarkdown
    • Descriptions
    • Divider
    • EChart
    • Html
    • Icon
    • Img
    • Markdown
    • MarkdownWithCode
    • Menu
    • Message
    • MobileMenu
    • Notification
    • Paragraph
    • Progress
    • Statistic
    • Title
  • Container Blocks
    • Affix
    • Badge
    • Box
    • Card
    • Collapse
    • Comment
    • ConfirmModal
    • Drawer
    • Label
    • Modal
    • Result
    • Span
    • Spin
    • Tabs
    • Tooltip
  • Context Blocks
    • Context
    • PageHCF
    • PageHCSF
    • PageHeaderMenu
    • PageHSCF
    • PageSHCF
    • PageSiderMenu
  • List Blocks
    • ControlledList
    • List
  • Connections
    • Amazon Redshift
    • Amazon S3
    • Axios HTTP
    • Elasticsearch
    • Google Sheets
    • Knex
    • MariaDB
    • MongoDB
    • Microsoft SQL Server
    • MySQL
    • PostgreSQL
    • SendGrid Email
    • SQLite
    • Stripe
  • Actions
    • CallMethod
    • JsAction
    • Link
    • Login
    • Logout
    • Message
    • Notification
    • Request
    • Reset
    • ResetValidation
    • ScrollTo
    • SetGlobal
    • SetState
    • Throw
    • Validate
    • Wait
  • Operators
    • _actions
    • _and
    • _args
    • _array
    • _base64
    • _change_case
    • _date
    • _diff
    • _divide
    • _eq
    • _event
    • _format
    • _function
    • _get
    • _global
    • _gt
    • _gte
    • _hash
    • _if
    • _if_none
    • _index
    • _input
    • _js
    • _json
    • _list_contexts
    • _location
    • _log
    • _lt
    • _lte
    • _math
    • _media
    • _menu
    • _mql
    • _ne
    • _not
    • _number
    • _nunjucks
    • _object
    • _operator
    • _or
    • _product
    • _random
    • _ref
    • _regex
    • _request
    • _secret
    • _state
    • _string
    • _subtract
    • _sum
    • _switch
    • _type
    • _uri
    • _url_query
    • _user
    • _uuid
    • _var
    • _yaml
  • Lowdefy Versions
    • v3.23.3
    • v3.22.0
    • v3.21.2
    • v3.20.4
    • v3.19.0
    • v3.18.1
    • v3.17.2
    • v3.16.5
    • v3.15.0
    • v3.14.1
    • v3.13.0
    • v3.12.6
v3.23.3/display/Menu/

Menu

A menu block used to display page links.

Block
  • Home
  • Pages
Block Setup
id: block_id
type: Menu
properties:
  selectedKeys: []
  defaultOpenKeys: []
  links:
    - id: home
      type: MenuLink
      pageId: home
      properties:
        icon: HomeOutlined
        title: Home
        danger: false
      links: []
      style: null
    - id: pages
      type: MenuGroup
      properties:
        title: Pages
        icon: LayoutOutlined
        danger: false
      links:
        - id: page1
          type: MenuLink
          pageId: page1
          properties:
            title: Page 1
            danger: false
          style: null
        - id: more_pages
          type: MenuGroup
          links:
            - id: page3
              type: MenuLink
              pageId: page3
          pageId: null
          properties:
            danger: false
            title: null
          style: null
      pageId: null
      style: null

Settings
properties:
-------
Menu background color.
defaultOpenKeys:
No Items

Render submenu into DOM before it becomes visible.
links:
  • false
    Menu item id.
    links:
    No Items

    Page to link to.
    properties:
    Apply danger style to menu item.
    Menu item title.
    Menu item type.
  • false
    Menu item id.
    links:
    • false
      Menu item id.
      Page to link to.
      properties:
      Apply danger style to menu item.
      Menu item title.
      Menu item type.
    • false
      Menu item id.
      Page to link to.
      properties:
      Apply danger style to menu item.
      Menu item title.
      Menu item type.

    Page to link to.
    properties:
    Apply danger style to menu item.
    Menu item title.
    Menu item type.

App menu id used to get menu links.
Type of menu to render.
-------
Menu primary selected color.
selectedKeys:
No Items

Delay time to hide submenu when mouse leaves (in seconds).
Delay time to show submenu when mouse enters (in seconds).
Color theme of menu.
layout:
style:
events:
required:
visible:
Menu JSON Schema Definition
type: object
properties:
  events:
    additionalProperties: false
    properties:
      onClick:
        description: Trigger action when menu item is clicked.
        type: array
      onSelect:
        description: Trigger action when menu item is selected.
        type: array
      onToggleMenuGroup:
        description: Trigger action when mobile menu group is opened.
        type: array
    type: object
  properties:
    additionalProperties: false
    properties:
      backgroundColor:
        description: Menu background color.
        type: string
      defaultOpenKeys:
        description: Array with the keys of default opened sub menus.
        items:
          description: A menu item 'id' which should be open by default.
          type: string
        type: array
      forceSubMenuRender:
        default: false
        description: Render submenu into DOM before it becomes visible.
        type: boolean
      links:
        items:
          properties:
            id:
              description: Menu item id.
              type: string
            links:
              items:
                properties:
                  id:
                    description: Menu item id.
                    type: string
                  pageId:
                    description: Page to link to.
                    type: string
                  properties:
                    description: properties from menu item.
                    links:
                      items:
                        properties:
                          id:
                            description: Menu item id.
                            type: string
                          pageId:
                            description: Page to link to.
                            type: string
                          properties:
                            description: properties from menu item.
                            properties:
                              danger:
                                default: false
                                description: Apply danger style to menu item.
                                type: boolean
                              title:
                                description: Menu item title.
                                type: string
                            type: object
                          style:
                            description: Css style to applied to sub-link.
                            type: object
                          type:
                            default: MenuLink
                            description: Menu item type.
                            enum:
                              - MenuLink
                            type: string
                        required:
                          - id
                          - type
                        type: object
                      type: array
                    properties:
                      danger:
                        default: false
                        description: Apply danger style to menu item.
                        type: boolean
                      title:
                        description: Menu item title.
                        type: string
                    type: object
                  style:
                    description: Css style to applied to sub-link.
                    type: object
                  type:
                    default: MenuLink
                    description: Menu item type.
                    enum:
                      - MenuLink
                      - MenuGroup
                    type: string
                required:
                  - id
                  - type
                type: object
              type: array
            pageId:
              description: Page to link to.
              type: string
            properties:
              description: properties from menu item.
              properties:
                danger:
                  default: false
                  description: Apply danger style to menu item.
                  type: boolean
                icon:
                  description: >-
                    Name of an Ant Design Icon or properties of an Icon block to
                    customize icon on menu item.
                  type:
                    - string
                    - object
                title:
                  description: Menu item title.
                  type: string
              type: object
            style:
              description: Css style to applied to link.
              type: object
            type:
              default: MenuLink
              description: Menu item type.
              enum:
                - MenuLink
                - MenuGroup
              type: string
          required:
            - id
            - type
          type: object
        type: array
      menuId:
        description: App menu id used to get menu links.
        type: string
      mode:
        default: vertical
        description: Type of menu to render.
        enum:
          - vertical
          - horizontal
          - inline
        type: string
      selectedColor:
        description: Menu primary selected color.
        type: string
      selectedKeys:
        description: Array with the keys of currently selected menu items.
        items:
          description: A menu item 'id' to be displayed as selected.
          type: string
        type: array
      subMenuCloseDelay:
        description: Delay time to hide submenu when mouse leaves (in seconds).
        type: number
      subMenuOpenDelay:
        description: Delay time to show submenu when mouse enters (in seconds).
        type: number
      theme:
        default: dark
        description: Color theme of menu.
        enum:
          - dark
          - light
        type: string
    type: object
  

Was this helpful?

😭
😟
😊
😀
Edit this page on Github

Build internal tools with YAML.

hello@lowdefy.com

Subscribe to our newsletter

Receive the latest Lowdefy updates in your inbox.
Why Lowdefy
Quick Start Tutorial
Deploy to Netlify
How Lowdefy Works
Github Repository
Version Changelog
Apache-2.0 License
© 2021 Lowdefy, Inc. - Give. Easy. Value.