@budibase/server
Version:
Budibase Web Server
2,231 lines (2,230 loc) • 196 kB
JSON
{
"features": {
"spectrumThemes": true,
"unifiedTheme": true,
"intelligentLoading": true,
"deviceAwareness": true,
"state": true,
"customThemes": true,
"devicePreview": true,
"messagePassing": true,
"rowSelection": true,
"continueIfAction": true,
"showNotificationAction": true,
"sidePanel": true,
"modal": true,
"skeletonLoader": true
},
"typeSupportPresets": {
"numberLike": {
"supported": ["number", "boolean"],
"partialSupport": [
{
"type": "longform",
"message": "stringAsNumber"
},
{
"type": "string",
"message": "stringAsNumber"
},
{
"type": "bigint",
"message": "stringAsNumber"
},
{
"type": "options",
"message": "stringAsNumber"
},
{
"type": "formula",
"message": "stringAsNumber"
},
{
"type": "datetime",
"message": "dateAsNumber"
}
],
"unsupported": [
{
"type": "json",
"message": "jsonPrimitivesOnly"
}
]
},
"stringLike": {
"supported": [
"string",
"number",
"bigint",
"options",
"longform",
"boolean",
"datetime"
],
"unsupported": [
{
"type": "json",
"message": "jsonPrimitivesOnly"
}
]
},
"datetimeLike": {
"supported": ["datetime"],
"partialSupport": [
{
"type": "longform",
"message": "stringAsDate"
},
{
"type": "string",
"message": "stringAsDate"
},
{
"type": "options",
"message": "stringAsDate"
},
{
"type": "formula",
"message": "stringAsDate"
},
{
"type": "bigint",
"message": "stringAsDate"
},
{
"type": "number",
"message": "numberAsDate"
}
],
"unsupported": [
{
"type": "json",
"message": "jsonPrimitivesOnly"
}
]
}
},
"layout": {
"name": "Layout",
"description": "This component is specific only to layouts",
"icon": "columns",
"hasChildren": true,
"styles": ["padding", "background"],
"settings": [
{
"type": "text",
"label": "Logo URL",
"key": "logoUrl"
},
{
"type": "text",
"label": "Title",
"key": "title"
},
{
"type": "select",
"label": "Navigation",
"key": "navigation",
"options": ["Top", "Left", "None"],
"defaultValue": "Top"
},
{
"type": "select",
"label": "Width",
"key": "width",
"options": ["Small", "Medium", "Large", "Max"],
"defaultValue": "Large"
},
{
"type": "navigation",
"label": "Links",
"key": "links"
},
{
"type": "boolean",
"label": "Hide title",
"key": "hideTitle",
"defaultValue": false
},
{
"type": "boolean",
"label": "Hide logo",
"key": "hideLogo",
"defaultValue": false
},
{
"type": "boolean",
"label": "Sticky header",
"key": "sticky",
"defaultValue": false
}
]
},
"container": {
"name": "Container",
"description": "This component contains things within itself",
"icon": "selection",
"hasChildren": true,
"size": {
"width": 500,
"height": 200
},
"grid": {
"hAlign": "stretch",
"vAlign": "stretch"
},
"styles": ["padding", "size", "background", "border", "shadow"],
"settings": [
{
"type": "select",
"label": "Layout",
"key": "layout",
"showInBar": true,
"placeholder": false,
"options": [
{
"label": "Flex",
"value": "flex"
},
{
"label": "Grid",
"value": "grid"
}
],
"defaultValue": "grid"
},
{
"type": "select",
"label": "Direction",
"key": "direction",
"showInBar": true,
"barStyle": "buttons",
"options": [
{
"label": "Column",
"value": "column",
"barIcon": "rows-plus-bottom",
"barTitle": "Column layout"
},
{
"label": "Row",
"value": "row",
"barIcon": "columns-plus-right",
"barTitle": "Row layout"
}
],
"defaultValue": "column",
"dependsOn": {
"setting": "layout",
"value": "grid",
"invert": true
}
},
{
"type": "select",
"label": "Horiz. align",
"key": "hAlign",
"showInBar": true,
"barStyle": "buttons",
"options": [
{
"label": "Left",
"value": "left",
"barIcon": "AlignLeft",
"barTitle": "Align left"
},
{
"label": "Center",
"value": "center",
"barIcon": "AlignCenter",
"barTitle": "Align center"
},
{
"label": "Right",
"value": "right",
"barIcon": "AlignRight",
"barTitle": "Align right"
},
{
"label": "Stretch",
"value": "stretch",
"barIcon": "MoveLeftRight",
"barTitle": "Align stretched horizontally"
}
],
"defaultValue": "stretch",
"dependsOn": {
"setting": "layout",
"value": "grid",
"invert": true
}
},
{
"type": "select",
"label": "Vert. align",
"key": "vAlign",
"showInBar": true,
"barStyle": "buttons",
"options": [
{
"label": "Top",
"value": "top",
"barIcon": "AlignTop",
"barTitle": "Align top"
},
{
"label": "Middle",
"value": "middle",
"barIcon": "AlignMiddle",
"barTitle": "Align middle"
},
{
"label": "Bottom",
"value": "bottom",
"barIcon": "AlignBottom",
"barTitle": "Align bottom"
},
{
"label": "Stretch",
"value": "stretch",
"barIcon": "MoveUpDown",
"barTitle": "Align stretched vertically"
}
],
"defaultValue": "top",
"dependsOn": {
"setting": "layout",
"value": "grid",
"invert": true
}
},
{
"type": "select",
"label": "Size",
"key": "size",
"showInBar": true,
"barStyle": "buttons",
"options": [
{
"label": "Shrink",
"value": "shrink",
"barIcon": "Minimize",
"barTitle": "Shrink container"
},
{
"label": "Grow",
"value": "grow",
"barIcon": "Maximize",
"barTitle": "Grow container"
}
],
"defaultValue": "shrink",
"dependsOn": {
"setting": "layout",
"value": "grid",
"invert": true
}
},
{
"type": "select",
"label": "Gap",
"key": "gap",
"showInBar": true,
"barStyle": "picker",
"options": [
{
"label": "None",
"value": "N"
},
{
"label": "Small",
"value": "S"
},
{
"label": "Medium",
"value": "M"
},
{
"label": "Large",
"value": "L"
}
],
"defaultValue": "M",
"dependsOn": {
"setting": "layout",
"value": "grid",
"invert": true
}
},
{
"type": "boolean",
"label": "Wrap",
"key": "wrap",
"showInBar": true,
"barIcon": "ModernGridView",
"barTitle": "Wrap",
"dependsOn": {
"setting": "layout",
"value": "grid",
"invert": true
}
},
{
"type": "event",
"label": "On click",
"key": "onClick"
}
]
},
"section": {
"name": "Section",
"description": "Add a section to your application",
"icon": "columns",
"hasChildren": true,
"illegalChildren": ["section"],
"showEmptyState": false,
"size": {
"width": 600,
"height": 200
},
"grid": {
"hAlign": "stretch",
"vAlign": "stretch"
},
"settings": [
{
"type": "section",
"label": "Type",
"key": "type",
"defaultValue": "mainSidebar"
}
]
},
"screenslot": {
"name": "Screenslot",
"icon": "browser",
"description": "Contains your app screens",
"static": true
},
"buttongroup": {
"name": "Button group",
"icon": "circles-three-plus",
"hasChildren": false,
"size": {
"width": 200,
"height": 60
},
"grid": {
"hAlign": "stretch",
"vAlign": "stretch"
},
"settings": [
{
"section": true,
"name": "Buttons",
"settings": [
{
"type": "buttonConfiguration",
"key": "buttons",
"nested": true,
"defaultValue": [
{
"type": "cta",
"text": "Button 1"
},
{
"type": "primary",
"text": "Button 2"
}
]
}
]
},
{
"section": true,
"name": "Layout",
"settings": [
{
"type": "boolean",
"label": "Collapse",
"key": "collapsed"
},
{
"type": "text",
"label": "Collapsed text",
"key": "collapsedText",
"dependsOn": "collapsed",
"placeholder": "Action"
},
{
"type": "select",
"label": "Direction",
"key": "direction",
"showInBar": true,
"barStyle": "buttons",
"options": [
{
"label": "Column",
"value": "column",
"barIcon": "TableSelectColumn",
"barTitle": "Column layout"
},
{
"label": "Row",
"value": "row",
"barIcon": "TableSelectRow",
"barTitle": "Row layout"
}
],
"defaultValue": "row",
"dependsOn": {
"setting": "collapsed",
"invert": true
}
},
{
"type": "select",
"label": "Horiz. align",
"key": "hAlign",
"showInBar": true,
"barStyle": "buttons",
"options": [
{
"label": "Left",
"value": "left",
"barIcon": "AlignLeft",
"barTitle": "Align left"
},
{
"label": "Center",
"value": "center",
"barIcon": "AlignCenter",
"barTitle": "Align center"
},
{
"label": "Right",
"value": "right",
"barIcon": "AlignRight",
"barTitle": "Align right"
},
{
"label": "Stretch",
"value": "stretch",
"barIcon": "MoveLeftRight",
"barTitle": "Align stretched horizontally"
}
],
"defaultValue": "left"
},
{
"type": "select",
"label": "Vert. align",
"key": "vAlign",
"showInBar": true,
"barStyle": "buttons",
"options": [
{
"label": "Top",
"value": "top",
"barIcon": "AlignTop",
"barTitle": "Align top"
},
{
"label": "Middle",
"value": "middle",
"barIcon": "AlignMiddle",
"barTitle": "Align middle"
},
{
"label": "Bottom",
"value": "bottom",
"barIcon": "AlignBottom",
"barTitle": "Align bottom"
},
{
"label": "Stretch",
"value": "stretch",
"barIcon": "MoveUpDown",
"barTitle": "Align stretched vertically"
}
],
"defaultValue": "top"
},
{
"type": "select",
"label": "Size",
"key": "size",
"showInBar": true,
"barStyle": "buttons",
"options": [
{
"label": "Shrink",
"value": "shrink",
"barIcon": "Minimize",
"barTitle": "Shrink container"
},
{
"label": "Grow",
"value": "grow",
"barIcon": "Maximize",
"barTitle": "Grow container"
}
],
"defaultValue": "shrink",
"dependsOn": {
"setting": "collapsed",
"invert": true
}
},
{
"type": "select",
"label": "Gap",
"key": "gap",
"showInBar": true,
"barStyle": "picker",
"options": [
{
"label": "None",
"value": "N"
},
{
"label": "Small",
"value": "S"
},
{
"label": "Medium",
"value": "M"
},
{
"label": "Large",
"value": "L"
}
],
"defaultValue": "M",
"dependsOn": {
"setting": "collapsed",
"invert": true
}
},
{
"type": "boolean",
"label": "Wrap",
"key": "wrap",
"showInBar": true,
"barIcon": "ModernGridView",
"barTitle": "Wrap",
"dependsOn": {
"setting": "collapsed",
"invert": true
}
}
]
}
]
},
"button": {
"name": "Button",
"description": "This component is a button",
"icon": "circle",
"editable": true,
"size": {
"width": 120,
"height": 32
},
"grid": {
"hAlign": "center",
"vAlign": "center"
},
"styles": ["margin", "background", "font"],
"settings": [
{
"type": "text",
"label": "Text",
"key": "text",
"defaultValue": "New Button"
},
{
"type": "select",
"showInBar": true,
"label": "Variant",
"key": "type",
"options": [
{
"label": "Action",
"value": "cta"
},
{
"label": "Primary",
"value": "primary"
},
{
"label": "Secondary",
"value": "secondary"
},
{
"label": "Warning",
"value": "warning"
},
{
"label": "Over background",
"value": "overBackground"
}
],
"defaultValue": "cta"
},
{
"type": "select",
"label": "Size",
"showInBar": true,
"key": "size",
"options": [
{
"label": "Small",
"value": "S"
},
{
"label": "Medium",
"value": "M"
},
{
"label": "Large",
"value": "L"
},
{
"label": "Extra large",
"value": "XL"
}
],
"defaultValue": "M"
},
{
"type": "boolean",
"label": "Quiet",
"key": "quiet",
"showInBar": true,
"barIcon": "VisibilityOff",
"barTitle": "Quiet variant",
"barSeparator": false
},
{
"type": "boolean",
"label": "Disabled",
"showInBar": true,
"barIcon": "NoEdit",
"barTitle": "Disable button",
"key": "disabled"
},
{
"type": "icon",
"label": "Icon",
"key": "icon"
},
{
"type": "select",
"label": "Gap",
"key": "gap",
"showInBar": true,
"barStyle": "picker",
"dependsOn": "icon",
"options": [
{
"label": "None",
"value": "N"
},
{
"label": "Small",
"value": "S"
},
{
"label": "Medium",
"value": "M"
},
{
"label": "Large",
"value": "L"
}
],
"defaultValue": "M"
},
{
"type": "event",
"label": "On click",
"key": "onClick"
}
]
},
"divider": {
"name": "Divider",
"description": "A basic divider",
"icon": "line-segments",
"illegalChildren": ["section"],
"size": {
"width": 400,
"height": 10
},
"settings": [
{
"type": "select",
"label": "Size",
"key": "size",
"options": [
{
"label": "Small",
"value": "S"
},
{
"label": "Medium",
"value": "M"
},
{
"label": "Large",
"value": "L"
}
],
"defaultValue": "M"
},
{
"type": "boolean",
"label": "Vertical",
"key": "vertical"
}
]
},
"repeater": {
"name": "Repeater",
"description": "A configurable data list that attaches to your backend tables.",
"icon": "list-dashes",
"illegalChildren": ["section"],
"hasChildren": true,
"size": {
"width": 500,
"height": 200
},
"grid": {
"hAlign": "stretch",
"vAlign": "stretch"
},
"settings": [
{
"type": "dataProvider",
"label": "Provider",
"key": "dataProvider",
"required": true
},
{
"type": "text",
"label": "Empty text",
"key": "noRowsMessage",
"defaultValue": "No rows found"
},
{
"type": "select",
"label": "Direction",
"key": "direction",
"showInBar": true,
"barStyle": "buttons",
"options": [
{
"label": "Column",
"value": "column",
"barIcon": "TableSelectColumn",
"barTitle": "Column layout"
},
{
"label": "Row",
"value": "row",
"barIcon": "TableSelectRow",
"barTitle": "Row layout"
}
],
"defaultValue": "column"
},
{
"type": "select",
"label": "Horiz. align",
"key": "hAlign",
"showInBar": true,
"barStyle": "buttons",
"options": [
{
"label": "Left",
"value": "left",
"barIcon": "AlignLeft",
"barTitle": "Align left"
},
{
"label": "Center",
"value": "center",
"barIcon": "AlignCenter",
"barTitle": "Align center"
},
{
"label": "Right",
"value": "right",
"barIcon": "AlignRight",
"barTitle": "Align right"
},
{
"label": "Stretch",
"value": "stretch",
"barIcon": "MoveLeftRight",
"barTitle": "Align stretched horizontally"
}
],
"defaultValue": "stretch"
},
{
"type": "select",
"label": "Vert. align",
"key": "vAlign",
"showInBar": true,
"barStyle": "buttons",
"options": [
{
"label": "Top",
"value": "top",
"barIcon": "AlignTop",
"barTitle": "Align top"
},
{
"label": "Middle",
"value": "middle",
"barIcon": "AlignMiddle",
"barTitle": "Align middle"
},
{
"label": "Bottom",
"value": "bottom",
"barIcon": "AlignBottom",
"barTitle": "Align bottom"
},
{
"label": "Stretch",
"value": "stretch",
"barIcon": "MoveUpDown",
"barTitle": "Align stretched vertically"
}
],
"defaultValue": "top"
},
{
"type": "select",
"label": "Gap",
"key": "gap",
"showInBar": true,
"barStyle": "picker",
"options": [
{
"label": "None",
"value": "N"
},
{
"label": "Small",
"value": "S"
},
{
"label": "Medium",
"value": "M"
},
{
"label": "Large",
"value": "L"
}
],
"defaultValue": "M"
}
],
"context": [
{
"type": "schema",
"scope": "local"
},
{
"type": "static",
"scope": "local",
"values": [
{
"label": "Row index",
"key": "index",
"type": "number"
}
]
}
]
},
"stackedlist": {
"deprecated": true,
"name": "Stacked List",
"icon": "list-checks",
"description": "A basic card component that can contain content and actions.",
"illegalChildren": ["section"],
"settings": [
{
"type": "text",
"label": "Image",
"key": "imageUrl"
},
{
"type": "text",
"label": "Heading",
"key": "heading"
},
{
"type": "text",
"label": "Subheading",
"key": "subheading"
},
{
"type": "text",
"label": "Link URL",
"key": "destinationUrl",
"placeholder": "/screen"
}
]
},
"card": {
"deprecated": true,
"name": "Vertical Card",
"description": "A basic card component that can contain content and actions.",
"icon": "cards",
"illegalChildren": ["section"],
"settings": [
{
"type": "text",
"label": "Image",
"key": "imageUrl"
},
{
"type": "text",
"label": "Heading",
"key": "heading"
},
{
"type": "text",
"label": "Description",
"key": "description"
},
{
"type": "text",
"label": "Link text",
"key": "linkText"
},
{
"type": "text",
"label": "Link URL",
"key": "linkUrl",
"placeholder": "/screen"
},
{
"type": "color",
"label": "Link color",
"key": "linkColor",
"defaultValue": "#000"
},
{
"type": "color",
"label": "Hover color",
"key": "linkHoverColor",
"defaultValue": "#222"
},
{
"type": "select",
"label": "Image height",
"key": "imageHeight",
"options": ["auto", "12rem", "16rem", "20rem", "24rem"],
"defaultValue": "auto"
},
{
"type": "select",
"label": "Card width",
"key": "cardWidth",
"options": ["16rem", "20rem", "24rem"],
"defaultValue": "20rem"
}
]
},
"text": {
"name": "Paragraph",
"deprecated": true,
"description": "A component for displaying paragraph text.",
"icon": "text-t",
"illegalChildren": ["section"],
"editable": true,
"size": {
"width": 400,
"height": 24
},
"settings": [
{
"type": "text",
"label": "Text",
"key": "text"
},
{
"type": "select",
"label": "Size",
"key": "size",
"defaultValue": "M",
"showInBar": true,
"barStyle": "picker",
"options": [
{
"label": "Extra small",
"value": "XS"
},
{
"label": "Small",
"value": "S"
},
{
"label": "Medium",
"value": "M"
},
{
"label": "Large",
"value": "L"
},
{
"label": "Extra large",
"value": "XL"
},
{
"label": "2XL",
"value": "XXL"
},
{
"label": "3XL",
"value": "XXXL"
}
]
},
{
"type": "color",
"label": "Color",
"key": "color",
"showInBar": true,
"barSeparator": false
},
{
"type": "boolean",
"label": "Bold",
"key": "bold",
"showInBar": true,
"barIcon": "TagBold",
"barTitle": "Bold text",
"barSeparator": false
},
{
"type": "boolean",
"label": "Italic",
"key": "italic",
"showInBar": true,
"barIcon": "TagItalic",
"barTitle": "Italic text",
"barSeparator": false
},
{
"type": "boolean",
"label": "Underline",
"key": "underline",
"showInBar": true,
"barIcon": "TagUnderline",
"barTitle": "Underline text"
},
{
"type": "select",
"label": "Alignment",
"key": "align",
"defaultValue": "left",
"showInBar": true,
"barStyle": "buttons",
"options": [
{
"label": "Left",
"value": "left",
"barIcon": "TextAlignLeft",
"barTitle": "Align left"
},
{
"label": "Center",
"value": "center",
"barIcon": "TextAlignCenter",
"barTitle": "Align center"
},
{
"label": "Right",
"value": "right",
"barIcon": "TextAlignRight",
"barTitle": "Align right"
},
{
"label": "Justify",
"value": "justify",
"barIcon": "TextAlignJustify",
"barTitle": "Justify text"
}
]
}
]
},
"heading": {
"name": "Headline",
"deprecated": true,
"description": "A component for displaying heading text",
"icon": "text-b",
"illegalChildren": ["section"],
"editable": true,
"size": {
"width": 400,
"height": 32
},
"settings": [
{
"type": "text",
"key": "text",
"label": "Text"
},
{
"type": "select",
"label": "Size",
"key": "size",
"defaultValue": "M",
"showInBar": true,
"barStyle": "picker",
"options": [
{
"label": "Extra small",
"value": "XS"
},
{
"label": "Small",
"value": "S"
},
{
"label": "Medium",
"value": "M"
},
{
"label": "Large",
"value": "L"
},
{
"label": "Extra large",
"value": "XL"
},
{
"label": "2XL",
"value": "XXL"
},
{
"label": "3XL",
"value": "XXXL"
}
]
},
{
"type": "color",
"label": "Color",
"key": "color",
"showInBar": true,
"barSeparator": false
},
{
"type": "boolean",
"label": "Bold",
"key": "bold",
"showInBar": true,
"barIcon": "TagBold",
"barTitle": "Bold text",
"barSeparator": false
},
{
"type": "boolean",
"label": "Italic",
"key": "italic",
"showInBar": true,
"barIcon": "TagItalic",
"barTitle": "Italic text",
"barSeparator": false
},
{
"type": "boolean",
"label": "Underline",
"key": "underline",
"showInBar": true,
"barIcon": "TagUnderline",
"barTitle": "Underline text"
},
{
"type": "select",
"label": "Alignment",
"key": "align",
"defaultValue": "left",
"showInBar": true,
"barStyle": "buttons",
"options": [
{
"label": "Left",
"value": "left",
"barIcon": "TextAlignLeft",
"barTitle": "Align left"
},
{
"label": "Center",
"value": "center",
"barIcon": "TextAlignCenter",
"barTitle": "Align center"
},
{
"label": "Right",
"value": "right",
"barIcon": "TextAlignRight",
"barTitle": "Align right"
},
{
"label": "Justify",
"value": "justify",
"barIcon": "TextAlignJustify",
"barTitle": "Justify text"
}
]
}
]
},
"tag": {
"name": "Tag",
"description": "This component is a tag",
"icon": "tag",
"size": {
"width": 100,
"height": 25
},
"grid": {
"hAlign": "center",
"vAlign": "center"
},
"settings": [
{
"type": "text",
"label": "Text",
"key": "text"
},
{
"type": "select",
"label": "Size",
"key": "size",
"defaultValue": "M",
"showInBar": true,
"barStyle": "picker",
"options": [
{
"label": "Small",
"value": "S"
},
{
"label": "Medium",
"value": "M"
},
{
"label": "Large",
"value": "L"
}
]
},
{
"type": "color",
"label": "Color",
"key": "color",
"showInBar": true
},
{
"type": "color",
"label": "Text Color",
"key": "textColor",
"showInBar": true
},
{
"type": "boolean",
"label": "Allow delete",
"key": "closable"
},
{
"type": "event",
"label": "On click delete",
"key": "onClick",
"dependsOn": "closable"
}
]
},
"image": {
"name": "Image",
"description": "A basic component for displaying images",
"icon": "image",
"styles": ["size"],
"size": {
"width": 400,
"height": 300
},
"settings": [
{
"type": "text",
"label": "URL",
"key": "url",
"required": true
}
]
},
"backgroundimage": {
"name": "Background Image",
"description": "A background image",
"icon": "image-square",
"hasChildren": true,
"styles": ["size"],
"showEmptyState": false,
"size": {
"width": 400,
"height": 300
},
"settings": [
{
"type": "text",
"label": "URL",
"key": "url",
"required": true
},
{
"type": "select",
"label": "Position",
"key": "position",
"defaultValue": "center center",
"options": [
{
"label": "Center top",
"value": "center top"
},
{
"label": "Center",
"value": "center center"
},
{
"label": "Center bottom",
"value": "center bottom"
},
{
"label": "Left top",
"value": "left top"
},
{
"label": "Left center",
"value": "left center"
},
{
"label": "Left bottom",
"value": "left bottom"
},
{
"label": "Right top",
"value": "right top"
},
{
"label": "Right center",
"value": "right center"
},
{
"label": "Right bottom",
"value": "right bottom"
}
]
}
]
},
"icon": {
"name": "Icon",
"description": "A basic component for displaying icons",
"icon": "shapes",
"size": {
"width": 25,
"height": 25
},
"grid": {
"hAlign": "center",
"vAlign": "center"
},
"settings": [
{
"type": "icon",
"label": "Icon",
"key": "icon",
"required": true,
"defaultValue": "ri-star-fill"
},
{
"type": "select",
"label": "Size",
"key": "size",
"defaultValue": "ri-1x",
"options": [
{
"value": "ri-xxs",
"label": "XXS"
},
{
"value": "ri-xs",
"label": "XS"
},
{
"value": "ri-sm",
"label": "Small"
},
{
"value": "ri-1x",
"label": "Medium"
},
{
"value": "ri-lg",
"label": "Large"
},
{
"value": "ri-xl",
"label": "XL"
},
{
"value": "ri-2x",
"label": "2XL"
},
{
"value": "ri-3x",
"label": "3XL"
},
{
"value": "ri-4x",
"label": "4XL"
},
{
"value": "ri-5x",
"label": "5XL"
},
{
"value": "ri-6x",
"label": "6XL"
},
{
"value": "ri-7x",
"label": "7XL"
},
{
"value": "ri-8x",
"label": "8XL"
},
{
"value": "ri-9x",
"label": "9XL"
},
{
"value": "ri-10x",
"label": "10XL"
}
]
},
{
"type": "color",
"label": "Color",
"key": "color"
},
{
"type": "event",
"label": "On click",
"key": "onClick"
}
]
},
"navigation": {
"deprecated": true,
"name": "Nav Bar",
"description": "A component for handling the navigation within your app.",
"icon": "BreadcrumbNavigation",
"illegalChildren": ["section"],
"hasChildren": true,
"settings": [
{
"type": "text",
"label": "Logo URL",
"key": "logoUrl"
},
{
"type": "boolean",
"label": "Hide logo",
"key": "hideLogo",
"defaultValue": false
}
]
},
"link": {
"name": "Link",
"description": "A basic link component for internal and external links",
"icon": "link",
"editable": true,
"size": {
"width": 200,
"height": 30
},
"settings": [
{
"type": "text",
"label": "Text",
"key": "text"
},
{
"type": "url",
"label": "URL",
"key": "url",
"placeholder": "/screen"
},
{
"type": "boolean",
"label": "New tab",
"key": "openInNewTab"
},
{
"type": "select",
"label": "Size",
"key": "size",
"defaultValue": "M",
"showInBar": true,
"barStyle": "picker",
"options": [
{
"label": "Small",
"value": "S"
},
{
"label": "Medium",
"value": "M"
},
{
"label": "Large",
"value": "L"
}
]
},
{
"type": "color",
"label": "Color",
"key": "color",
"showInBar": true,
"barSeparator": false
},
{
"type": "boolean",
"label": "Bold",
"key": "bold",
"showInBar": true,
"barIcon": "TagBold",
"barTitle": "Bold text",
"barSeparator": false
},
{
"type": "boolean",
"label": "Italic",
"key": "italic",
"showInBar": true,
"barIcon": "TagItalic",
"barTitle": "Italic text",
"barSeparator": false
},
{
"type": "boolean",
"label": "Underline",
"key": "underline",
"showInBar": true,
"barIcon": "TagUnderline",
"barTitle": "Underline text"
},
{
"type": "select",
"label": "Alignment",
"key": "align",
"defaultValue": "left",
"showInBar": true,
"barStyle": "buttons",
"options": [
{
"label": "Left",
"value": "left",
"barIcon": "TextAlignLeft",
"barTitle": "Align left"
},
{
"label": "Center",
"value": "center",
"barIcon": "TextAlignCenter",
"barTitle": "Align center"
},
{
"label": "Right",
"value": "right",
"barIcon": "TextAlignRight",
"barTitle": "Align right"
},
{
"label": "Justify",
"value": "justify",
"barIcon": "TextAlignJustify",
"barTitle": "Justify text"
}
]
}
]
},
"cardhorizontal": {
"deprecated": true,
"name": "Horizontal Card",
"description": "A basic card component that can contain content and actions.",
"icon": "cards",
"settings": [
{
"type": "text",
"label": "Image",
"key": "imageUrl"
},
{
"type": "text",
"label": "Heading",
"key": "heading"
},
{
"type": "text",
"label": "Description",
"key": "description"
},
{
"type": "text",
"label": "Subtext",
"key": "subtext"
},
{
"type": "text",
"label": "Link text",
"key": "linkText"
},
{
"type": "text",
"label": "Link URL",
"key": "linkUrl",
"placeholder": "/screen"
},
{
"type": "color",
"label": "Link color",
"key": "linkColor",
"defaultValue": "#000"
},
{
"type": "color",
"label": "Hover color",
"key": "linkHoverColor",
"defaultValue": "#222"
},
{
"type": "select",
"label": "Card width",
"key": "cardWidth",
"options": [
"24rem",
"28rem",
"32rem",
"40rem",
"48rem",
"60rem",
"100%"
],
"defaultValue": "32rem"
},
{
"type": "select",
"label": "Image width",
"key": "imageWidth",
"options": ["auto", "8rem", "12rem", "16rem"],
"defaultValue": "8rem"
},
{
"type": "select",
"label": "Image height",
"key": "imageHeight",
"options": ["auto", "8rem", "12rem", "16rem", "auto"],
"defaultValue": "auto"
}
]
},
"cardstat": {
"name": "Stat Card",
"description": "A card component for displaying numbers.",
"icon": "cards",
"size": {
"width": 260,
"height": 143
},
"grid": {
"hAlign": "center",
"vAlign": "center"
},
"settings": [
{
"type": "text",
"label": "Title",
"key": "title",
"placeholder": "Total Revenue",
"defaultValue": "Title"
},
{
"type": "text",
"label": "Value",
"key": "value",
"placeholder": "$1,981,983",
"defaultValue": "Value"
},
{
"type": "text",
"label": "Label",
"key": "label",
"placeholder": "Stripe",
"defaultValue": "Label"
}
]
},
"embed": {
"name": "Embed",
"icon": "code",
"description": "Embed content from 3rd party sources",
"styles": ["size"],
"size": {
"width": 400,
"height": 100
},
"grid": {
"hAlign": "stretch",
"vAlign": "stretch"
},
"settings": [
{
"type": "text",
"label": "Embed",
"key": "embed",
"required": true
}
]
},
"bar": {
"documentationLink": "https://docs.budibase.com/docs/bar-chart",
"name": "Bar Chart",
"description": "Bar chart",
"icon": "chart-bar",
"size": {
"width": 600,
"height": 420
},
"grid": {
"hAlign": "stretch",
"vAlign": "center"
},
"settings": [
{
"type": "text",
"label": "Title",
"key": "title"
},
{
"type": "dataProvider",
"label": "Provider",
"key": "dataProvider",
"required": true
},
{
"type": "field",
"label": "Label column",
"key": "labelColumn",
"dependsOn": "dataProvider",
"explanation": {
"typeSupport": {
"preset": "stringLike"
}
},
"required": true
},
{
"type": "multifield",
"label": "Data columns",
"key": "valueColumns",
"dependsOn": "dataProvider",
"explanation": {
"typeSupport": {
"preset": "numberLike"
}
},
"required": true
},
{
"type": "event",
"label": "On click bar",
"key": "onClick",
"context": [
{
"label": "Clicked bar",
"key": "bar"
}
]
},
{
"type": "select",
"label": "Format",
"key": "yAxisUnits",
"options": ["Default", "Thousands", "Millions"],
"defaultValue": "Default"
},
{
"type": "text",
"label": "Y axis label",
"key": "yAxisLabel"
},
{
"type": "text",
"label": "X axis label",
"key": "xAxisLabel"
},
{
"type": "text",
"label": "Width",
"key": "width"
},
{
"type": "text",
"label": "Height",
"key": "height",
"defaultValue": "400"
},
{
"type": "select",
"label": "Colors",
"key": "palette",
"defaultValue": "Palette 1",
"options": [
"Custom",
"Palette 1",
"Palette 2",
"Palette 3",
"Palette 4",
"Palette 5",
"Palette 6",
"Palette 7",
"Palette 8",
"Palette 9",
"Palette 10"
]
},
{
"type": "color",
"label": "C1",
"key": "c1",
"dependsOn": {
"setting": "palette",
"value": "Custom"
}
},
{
"type": "color",
"label": "C2",
"key": "c2",
"dependsOn": {
"setting": "palette",
"value": "Custom"
}
},
{
"type": "color",
"label": "C3",
"key": "c3",
"dependsOn": {
"setting": "palette",
"value": "Custom"
}
},
{
"type": "color",
"label": "C4",
"key": "c4",
"dependsOn": {
"setting": "palette",
"value": "Custom"
}
},
{
"type": "color",
"label": "C5",
"key": "c5",
"dependsOn": {
"setting": "palette",
"value": "Custom"
}
},
{
"type": "boolean",
"label": "Stacked",
"key": "stacked",
"defaultValue": false
},
{
"type": "boolean",
"label": "Horizontal",
"key": "horizontal",
"defaultValue": false
},
{
"type": "boolean",
"label": "Data labels",
"key": "dataLabels",
"defaultValue": false
},
{
"type": "boolean",
"label": "Animate",
"key": "animate",
"defaultValue": true
},
{
"type": "boolean",
"label": "Legend",
"key": "legend",
"defaultValue": false
}
]
},
"line": {
"documentationLink": "https://docs.budibase.com/docs/line-chart",
"name": "Line Chart",
"description": "Line chart",
"icon": "chart-line",
"size": {
"width": 600,
"height": 420
},
"grid": {
"hAlign": "stretch",
"vAlign": "center"
},
"settings": [
{
"type": "text",
"label": "Title",
"key": "title"
},
{
"type": "dataProvider",
"label": "Provider",
"key": "dataProvider",
"required": true
},
{
"type": "field",
"label": "Label column",
"key": "labelColumn",
"dependsOn": "dataProvider",
"explanation": {
"typeSupport": {
"preset": "stringLike"
}
},
"required": true
},
{
"type": "multifield",
"label": "Data columns",
"key": "valueColumns",
"dependsOn": "dataProvider",
"explanation": {
"typeSupport": {
"preset": "numberLike"
}
},
"required": true
},
{
"type": "event",
"label": "On click marker",
"key": "onClick",
"context": [
{
"label": "Clicked marker",
"key": "marker"
}
]
},
{
"type": "select",
"label": "Format",
"key": "yAxisUnits",
"options": ["Default", "Thousands", "Millions"],
"defaultValue": "Default"
},
{
"type": "text",
"label": "Y axis label",
"key": "yAxisLabel"
},
{
"type": "text",
"label": "X axis label",
"key": "xAxisLabel"
},
{
"type": "text",
"label": "Width",
"key": "width"
},
{
"type": "text",
"label": "Height",
"key": "height",
"defaultValue": "400"
},
{
"type": "select",
"label": "Colors",
"key": "palette",
"defaultValue": "Palette 1",
"options": [
"Custom",
"Palette 1",
"Palette 2",
"Palette 3",
"Palette 4",
"Palette 5",
"Palette 6",
"Palette 7",
"Palette 8",
"Palette 9",
"Palette 10"
]
},
{
"type": "color",
"label": "C1",
"key": "c1",
"dependsOn": {
"setting": "palette",
"value": "Custom"
}
},
{
"type": "color",
"label": "C2",
"key": "c2",
"dependsOn": {
"setting": "palette",
"value": "Custom"
}
},
{
"type": "color",
"label": "C3",
"key": "c3",
"dependsOn": {
"setting": "palette",
"value": "Custom"
}
},
{
"type": "color",
"label": "C4",
"key": "c4",
"dependsOn": {
"setting": "palette",
"value": "Custom"
}
},
{
"type": "color",
"label": "C5",
"key": "c5",
"dependsOn": {
"setting": "palette",
"value": "Custom"
}
},
{
"type": "select",
"label": "Curve",
"key": "curve",
"options": ["Smooth", "Straight", "Stepline"],
"defaultValue": "Smooth"
},
{
"type": "boolean",
"label": "Data labels",
"key": "dataLabels",
"defaultValue": false
},
{
"type": "boolean",
"label": "Animate",
"key": "animate",
"defaultValue": true
},
{
"type": "boolean",
"label": "Legend",
"key": "legend",
"defaultValue": false
}
]
},
"area": {
"documentationLink": "https://docs.budibase.com/docs/area-chart",
"name": "Area Chart",
"description": "Line chart",
"icon": "chart-line-up",
"size": {
"width": 600,
"height": 420
},
"grid": {
"hAlign": "stretch",
"vAlign": "center"
},
"settings": [
{
"type": "text",
"label": "Title",
"key": "title"
},
{
"type": "dataProvider",
"label": "Provider",
"key": "dataProvider",
"required": true
},
{
"type": "field",
"label": "Label column",
"key": "labelColumn",
"dependsOn": "dataProvider",
"explanation": {
"typeSupport": {
"preset": "stringLike"
}
},
"required": true
},
{
"type": "multifield",
"label": "Data columns",
"key": "valueColumns",
"dependsOn": "dataProvider",
"explanation": {
"typeSupport": {
"preset": "numberLike"
}
},
"required": true
},
{
"type": "event",