{ "features": { "spectrumThemes": 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": "Sandbox", "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": 400, "height": 200 }, "styles": ["padding", "size", "background", "border", "shadow"], "settings": [ { "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": "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" }, { "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" }, { "type": "boolean", "label": "Wrap", "key": "wrap", "showInBar": true, "barIcon": "ModernGridView", "barTitle": "Wrap" }, { "type": "event", "label": "On click", "key": "onClick" } ] }, "section": { "name": "Section", "description": "Add a section to your application", "icon": "ColumnTwoB", "hasChildren": true, "illegalChildren": ["section"], "showEmptyState": false, "size": { "width": 400, "height": 100 }, "settings": [ { "type": "section", "label": "Type", "key": "type", "defaultValue": "mainSidebar" } ] }, "screenslot": { "name": "Screenslot", "icon": "WebPage", "description": "Contains your app screens", "static": true }, "buttongroup": { "name": "Button group", "icon": "Button", "hasChildren": false, "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": "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" }, { "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" }, { "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" }, { "type": "boolean", "label": "Wrap", "key": "wrap", "showInBar": true, "barIcon": "ModernGridView", "barTitle": "Wrap" } ] } ] }, "button": { "name": "Button", "description": "A basic html button that is ready for styling", "icon": "Button", "editable": true, "size": { "width": 105, "height": 32 }, "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": "Separator", "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": "JourneyData", "illegalChildren": ["section"], "hasChildren": true, "size": { "width": 400, "height": 100 }, "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": "TaskList", "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": "ViewColumn", "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", "description": "A component for displaying paragraph text.", "icon": "TextParagraph", "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", "icon": "TextBold", "description": "A component for displaying heading text", "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", "icon": "Label", "size": { "width": 100, "height": 25 }, "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": "Images", "hasChildren": true, "styles": ["size"], "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 }, "settings": [ { "type": "icon", "label": "Icon", "key": "icon", "required": true }, { "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": "ViewRow", "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": "Card", "size": { "width": 260, "height": 143 }, "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 }, "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": "GraphBarVertical", "size": { "width": 600, "height": 400 }, "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": "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": "GraphTrend", "size": { "width": 600, "height": 400 }, "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": "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": "GraphAreaStacked", "size": { "width": 600, "height": 400 }, "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": "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 }, { "type": "boolean", "label": "Stacked", "key": "stacked", "defaultValue": true }, { "type": "boolean", "label": "Gradient", "key": "gradient", "defaultValue": false } ] }, "pie": { "documentationLink": "https://docs.budibase.com/docs/pie-donut-chart", "name": "Pie Chart", "description": "Pie chart", "icon": "GraphPie", "size": { "width": 600, "height": 400 }, "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": "field", "label": "Data column", "key": "valueColumn", "dependsOn": "dataProvider", "explanation": { "typeSupport": { "preset": "numberLike" } }, "required": true }, { "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": "Data labels", "key": "dataLabels", "defaultValue": false }, { "type": "boolean", "label": "Animate", "key": "animate", "defaultValue": true }, { "type": "boolean", "label": "Legend", "key": "legend", "defaultValue": false } ] }, "donut": { "documentationLink": "https://docs.budibase.com/docs/pie-donut-chart", "name": "Donut Chart", "description": "Donut chart", "icon": "GraphDonut", "size": { "width": 600, "height": 400 }, "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": "field", "label": "Data columns", "key": "valueColumn", "dependsOn": "dataProvider", "explanation": { "typeSupport": { "preset": "numberLike" } }, "required": true }, { "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": "Data labels", "key": "dataLabels", "defaultValue": false }, { "type": "boolean", "label": "Animate", "key": "animate", "defaultValue": true }, { "type": "boolean", "label": "Legend", "key": "legend", "defaultValue": false } ] }, "candlestick": { "documentationLink": "https://docs.budibase.com/docs/candlestick-chart", "name": "Candlestick Chart", "description": "Candlestick chart", "icon": "GraphBarVerticalStacked", "size": { "width": 600, "height": 400 }, "settings": [ { "type": "text", "label": "Title", "key": "title" }, { "type": "dataProvider", "label": "Provider", "key": "dataProvider", "required": true }, { "type": "field", "label": "Date column", "key": "dateColumn", "dependsOn": "dataProvider", "explanation": { "typeSupport": { "preset": "datetimeLike" } }, "required": true }, { "type": "field", "label": "Open column", "key": "openColumn", "dependsOn": "dataProvider", "explanation": { "typeSupport": { "preset": "numberLike" } }, "required": true }, { "type": "field", "label": "Close column", "key": "closeColumn", "dependsOn": "dataProvider", "explanation": { "typeSupport": { "preset": "numberLike" } }, "required": true }, { "type": "field", "label": "High column", "key": "highColumn", "dependsOn": "dataProvider", "explanation": { "typeSupport": { "preset": "numberLike" } }, "required": true }, { "type": "field", "label": "Low column", "key": "lowColumn", "dependsOn": "dataProvider", "explanation": { "typeSupport": { "preset": "numberLike" } }, "required": true }, { "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": "boolean", "label": "Animate", "key": "animate", "defaultValue": true } ] }, "histogram": { "documentationLink": "https://docs.budibase.com/docs/histogram-chart", "name": "Histogram Chart", "description": "Histogram chart", "icon": "Histogram", "size": { "width": 600, "height": 400 }, "settings": [ { "type": "text", "label": "Title", "key": "title" }, { "type": "dataProvider", "label": "Provider", "key": "dataProvider", "required": true }, { "type": "field", "label": "Data column", "key": "valueColumn", "dependsOn": "dataProvider", "explanation": { "typeSupport": { "preset": "numberLike" } }, "required": true }, { "type": "text", "label": "Y axis label", "key": "yAxisLabel", "defaultValue": "Frequency" }, { "type": "text", "label": "X axis label", "key": "xAxisLabel" }, { "type": "number", "label": "Bucket count", "key": "bucketCount", "defaultValue": 10, "min": 2 }, { "type": "boolean", "label": "Data labels", "key": "dataLabels", "defaultValue": false }, { "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": "Animate", "key": "animate", "defaultValue": true }, { "type": "boolean", "label": "Horizontal", "key": "horizontal", "defaultValue": false } ] }, "form": { "name": "Form", "icon": "Form", "hasChildren": true, "illegalChildren": ["section", "form", "formblock"], "actions": [ "ValidateForm", "ClearForm", "ChangeFormStep", "UpdateFieldValue", "ScrollTo" ], "styles": ["size"], "size": { "width": 400, "height": 400 }, "settings": [ { "type": "select", "label": "Type", "key": "actionType", "options": ["Create", "Update"], "defaultValue": "Create" }, { "type": "schema", "label": "Schema", "key": "dataSource", "defaultValue": { "name": "Custom", "label": "Custom" } }, { "type": "select", "label": "Size", "key": "size", "options": [ { "label": "Medium", "value": "spectrum--medium" }, { "label": "Large", "value": "spectrum--large" } ], "defaultValue": "spectrum--medium" }, { "type": "boolean", "label": "Disabled", "key": "disabled", "defaultValue": false }, { "type": "boolean", "label": "Read only", "key": "readonly", "defaultValue": false, "dependsOn": { "setting": "disabled", "value": true, "invert": true } }, { "type": "text", "label": "Initial form step", "key": "initialFormStep", "defaultValue": 1 } ], "context": [ { "type": "static", "values": [ { "label": "Value", "key": "__value", "type": "object" }, { "label": "Valid", "key": "__valid", "type": "boolean" }, { "label": "Current Step", "key": "__currentStep", "type": "number" }, { "label": "Current Step Valid", "key": "__currentStepValid", "type": "boolean" } ] }, { "type": "form" } ] }, "formstep": { "name": "Form Step", "icon": "AssetsAdded", "hasChildren": true, "requiredAncestors": ["form"], "illegalChildren": ["section", "form", "formstep", "formblock"], "styles": ["size"], "size": { "width": 400, "height": 400 }, "settings": [ { "type": "number", "label": "Step", "key": "step", "defaultValue": 1, "min": 1 } ] }, "fieldgroup": { "name": "Field Group", "icon": "Group", "requiredAncestors": ["form"], "illegalChildren": ["section"], "styles": ["size"], "hasChildren": true, "size": { "width": 400, "height": 400 }, "settings": [ { "type": "select", "label": "Labels", "key": "labelPosition", "defaultValue": "above", "options": [ { "label": "Left", "value": "left" }, { "label": "Above", "value": "above" } ] }, { "type": "section", "label": "Type", "key": "type", "defaultValue": "oneColumn", "dependsOn": { "setting": "labelPosition", "value": "above" } } ] }, "labelfield": { "name": "Text Field", "icon": "Text", "editable": true, "size": { "width": 400, "height": 32 }, "settings": [ { "type": "plainText", "label": "Label", "key": "label" }, { "type": "number", "label": "Initial width", "key": "width", "placeholder": "Auto", "min": 80, "max": 9999 }, { "type": "cellConditions", "label": "Conditions", "key": "conditions" } ] }, "stringfield": { "name": "Text Field", "icon": "Text", "styles": ["size"], "requiredAncestors": ["form"], "editable": true, "size": { "width": 400, "height": 32 }, "settings": [ { "type": "field/string", "label": "Field", "key": "field", "required": true }, { "type": "text", "label": "Label", "key": "label" }, { "type": "text", "label": "Placeholder", "key": "placeholder" }, { "type": "text", "label": "Default value", "key": "defaultValue", "supportsConditions": false }, { "type": "text", "label": "Help text", "key": "helpText" }, { "type": "event", "label": "On change", "key": "onChange", "context": [ { "label": "Field Value", "key": "value" } ] }, { "type": "boolean", "label": "Disabled", "key": "disabled", "defaultValue": false }, { "type": "boolean", "label": "Read only", "key": "readonly", "defaultValue": false, "dependsOn": { "setting": "disabled", "value": true, "invert": true } }, { "type": "validation/string", "label": "Validation", "key": "validation" }, { "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" } ] }, { "type": "select", "label": "Layout", "key": "span", "defaultValue": 6, "hidden": true, "showInBar": true, "barStyle": "buttons", "options": [ { "label": "1 column", "value": 6, "barIcon": "Stop", "barTitle": "1 column" }, { "label": "2 columns", "value": 3, "barIcon": "ColumnTwoA", "barTitle": "2 columns" }, { "label": "3 columns", "value": 2, "barIcon": "ViewColumn", "barTitle": "3 columns" } ] } ] }, "numberfield": { "name": "Number Field", "icon": "123", "styles": ["size"], "requiredAncestors": ["form"], "editable": true, "size": { "width": 400, "height": 50 }, "settings": [ { "type": "field/number", "label": "Field", "key": "field", "required": true }, { "type": "text", "label": "Label", "key": "label" }, { "type": "text", "label": "Placeholder", "key": "placeholder" }, { "type": "text", "label": "Default value", "key": "defaultValue", "supportsConditions": false }, { "type": "text", "label": "Help text", "key": "helpText" }, { "type": "event", "label": "On change", "key": "onChange", "context": [ { "label": "Field Value", "key": "value" } ] }, { "type": "boolean", "label": "Disabled", "key": "disabled", "defaultValue": false }, { "type": "boolean", "label": "Read only", "key": "readonly", "defaultValue": false, "dependsOn": { "setting": "disabled", "value": true, "invert": true } }, { "type": "validation/number", "label": "Validation", "key": "validation" }, { "type": "select", "label": "Layout", "key": "span", "defaultValue": 6, "hidden": true, "showInBar": true, "barStyle": "buttons", "options": [ { "label": "1 column", "value": 6, "barIcon": "Stop", "barTitle": "1 column" }, { "label": "2 columns", "value": 3, "barIcon": "ColumnTwoA", "barTitle": "2 columns" }, { "label": "3 columns", "value": 2, "barIcon": "ViewColumn", "barTitle": "3 columns" } ] } ] }, "bigintfield": { "name": "BigInt Field", "icon": "TagBold", "styles": ["size"], "requiredAncestors": ["form"], "editable": true, "size": { "width": 400, "height": 50 }, "settings": [ { "type": "field/bigint", "label": "Field", "key": "field", "required": true }, { "type": "text", "label": "Label", "key": "label" }, { "type": "text", "label": "Placeholder", "key": "placeholder" }, { "type": "text", "label": "Default value", "key": "defaultValue", "supportsConditions": false }, { "type": "text", "label": "Help text", "key": "helpText" }, { "type": "event", "label": "On change", "key": "onChange", "context": [ { "label": "Field Value", "key": "value" } ] }, { "type": "boolean", "label": "Disabled", "key": "disabled", "defaultValue": false }, { "type": "select", "label": "Layout", "key": "span", "defaultValue": 6, "hidden": true, "showInBar": true, "barStyle": "buttons", "options": [ { "label": "1 column", "value": 6, "barIcon": "Stop", "barTitle": "1 column" }, { "label": "2 columns", "value": 3, "barIcon": "ColumnTwoA", "barTitle": "2 columns" }, { "label": "3 columns", "value": 2, "barIcon": "ViewColumn", "barTitle": "3 columns" } ] } ] }, "passwordfield": { "name": "Password Field", "icon": "LockClosed", "styles": ["size"], "requiredAncestors": ["form"], "editable": true, "size": { "width": 400, "height": 50 }, "settings": [ { "type": "field/string", "label": "Field", "key": "field", "required": true }, { "type": "text", "label": "Label", "key": "label" }, { "type": "text", "label": "Placeholder", "key": "placeholder" }, { "type": "text", "label": "Default value", "key": "defaultValue", "supportsConditions": false }, { "type": "event", "label": "On change", "key": "onChange", "context": [ { "label": "Field Value", "key": "value" } ] }, { "type": "boolean", "label": "Disabled", "key": "disabled", "defaultValue": false }, { "type": "validation/string", "label": "Validation", "key": "validation" }, { "type": "select", "label": "Layout", "key": "span", "defaultValue": 6, "hidden": true, "showInBar": true, "barStyle": "buttons", "options": [ { "label": "1 column", "value": 6, "barIcon": "Stop", "barTitle": "1 column" }, { "label": "2 columns", "value": 3, "barIcon": "ColumnTwoA", "barTitle": "2 columns" }, { "label": "3 columns", "value": 2, "barIcon": "ViewColumn", "barTitle": "3 columns" } ] } ] }, "optionsfield": { "name": "Options Picker", "icon": "Menu", "styles": ["size"], "requiredAncestors": ["form"], "editable": true, "size": { "width": 400, "height": 50 }, "settings": [ { "type": "field/options", "label": "Field", "key": "field", "required": true }, { "type": "text", "label": "Label", "key": "label" }, { "type": "text", "label": "Placeholder", "key": "placeholder", "placeholder": "Choose an option" }, { "type": "event", "label": "On change", "key": "onChange", "context": [ { "label": "Field Value", "key": "value" } ] }, { "type": "select", "label": "Type", "key": "optionsType", "defaultValue": "select", "placeholder": "Pick an options type", "options": [ { "label": "Select", "value": "select" }, { "label": "Radio buttons", "value": "radio" } ] }, { "type": "select", "label": "Direction", "key": "direction", "defaultValue": "vertical", "options": [ { "label": "Horizontal", "value": "horizontal" }, { "label": "Vertical", "value": "vertical" } ], "dependsOn": { "setting": "optionsType", "value": "radio" } }, { "type": "text", "label": "Default value", "key": "defaultValue", "supportsConditions": false }, { "type": "text", "label": "Help text", "key": "helpText" }, { "type": "boolean", "label": "Autocomplete", "key": "autocomplete", "defaultValue": false, "dependsOn": { "setting": "optionsType", "value": "select" } }, { "type": "boolean", "label": "Alphabetical", "key": "sort", "defaultValue": true }, { "type": "boolean", "label": "Disabled", "key": "disabled", "defaultValue": false }, { "type": "boolean", "label": "Read only", "key": "readonly", "defaultValue": false, "dependsOn": { "setting": "disabled", "value": true, "invert": true } }, { "type": "select", "label": "Options source", "key": "optionsSource", "defaultValue": "schema", "placeholder": "Pick an options source", "options": [ { "label": "Schema", "value": "schema" }, { "label": "Data provider", "value": "provider" }, { "label": "Custom", "value": "custom" } ] }, { "type": "dataProvider", "label": "Options provider", "key": "dataProvider", "required": true, "dependsOn": { "setting": "optionsSource", "value": "provider" } }, { "type": "field", "label": "Label column", "key": "labelColumn", "dependsOn": { "setting": "optionsSource", "value": "provider" } }, { "type": "field", "label": "Value column", "key": "valueColumn", "dependsOn": { "setting": "optionsSource", "value": "provider" } }, { "type": "options", "label": "Custom options", "key": "customOptions", "dependsOn": { "setting": "optionsSource", "value": "custom" } }, { "type": "validation/string", "label": "Validation", "key": "validation" }, { "type": "select", "label": "Layout", "key": "span", "defaultValue": 6, "hidden": true, "showInBar": true, "barStyle": "buttons", "options": [ { "label": "1 column", "value": 6, "barIcon": "Stop", "barTitle": "1 column" }, { "label": "2 columns", "value": 3, "barIcon": "ColumnTwoA", "barTitle": "2 columns" }, { "label": "3 columns", "value": 2, "barIcon": "ViewColumn", "barTitle": "3 columns" } ] } ] }, "multifieldselect": { "name": "Multi-select Picker", "icon": "ViewList", "styles": ["size"], "requiredAncestors": ["form"], "editable": true, "size": { "width": 400, "height": 50 }, "settings": [ { "type": "field/array", "label": "Field", "key": "field", "required": true }, { "type": "text", "label": "Label", "key": "label" }, { "type": "text", "label": "Placeholder", "key": "placeholder", "placeholder": "Choose an option" }, { "type": "text", "label": "Default value", "key": "defaultValue", "supportsConditions": false }, { "type": "text", "label": "Help text", "key": "helpText" }, { "type": "event", "label": "On change", "key": "onChange", "context": [ { "label": "Field Value", "key": "value" } ] }, { "type": "boolean", "label": "Autocomplete", "key": "autocomplete", "defaultValue": false, "dependsOn": { "setting": "optionsType", "value": "select" } }, { "type": "boolean", "label": "Disabled", "key": "disabled", "defaultValue": false }, { "type": "boolean", "label": "Read only", "key": "readonly", "defaultValue": false, "dependsOn": { "setting": "disabled", "value": true, "invert": true } }, { "type": "select", "label": "Type", "key": "optionsType", "defaultValue": "select", "placeholder": "Pick an options type", "options": [ { "label": "Select", "value": "select" }, { "label": "Checkboxes", "value": "checkbox" } ] }, { "type": "select", "label": "Direction", "key": "direction", "defaultValue": "vertical", "options": [ { "label": "Horizontal", "value": "horizontal" }, { "label": "Vertical", "value": "vertical" } ], "dependsOn": { "setting": "optionsType", "value": "checkbox" } }, { "type": "select", "label": "Options source", "key": "optionsSource", "defaultValue": "schema", "placeholder": "Pick an options source", "options": [ { "label": "Schema", "value": "schema" }, { "label": "Data provider", "value": "provider" }, { "label": "Custom", "value": "custom" } ] }, { "type": "dataProvider", "label": "Options provider", "key": "dataProvider", "required": true, "dependsOn": { "setting": "optionsSource", "value": "provider" } }, { "type": "field", "label": "Label column", "key": "labelColumn", "dependsOn": { "setting": "optionsSource", "value": "provider" } }, { "type": "field", "label": "Value column", "key": "valueColumn", "dependsOn": { "setting": "optionsSource", "value": "provider" } }, { "type": "options", "label": "Custom options", "key": "customOptions", "dependsOn": { "setting": "optionsSource", "value": "custom" } }, { "type": "validation/array", "label": "Validation", "key": "validation" }, { "type": "select", "label": "Layout", "key": "span", "defaultValue": 6, "hidden": true, "showInBar": true, "barStyle": "buttons", "options": [ { "label": "1 column", "value": 6, "barIcon": "Stop", "barTitle": "1 column" }, { "label": "2 columns", "value": 3, "barIcon": "ColumnTwoA", "barTitle": "2 columns" }, { "label": "3 columns", "value": 2, "barIcon": "ViewColumn", "barTitle": "3 columns" } ] } ] }, "booleanfield": { "name": "Checkbox", "icon": "SelectBox", "editable": true, "requiredAncestors": ["form"], "size": { "width": 20, "height": 20 }, "settings": [ { "type": "field/boolean", "label": "Field", "key": "field", "required": true }, { "type": "text", "label": "Label", "key": "label" }, { "type": "text", "label": "Text", "key": "text" }, { "type": "select", "label": "Size", "key": "size", "options": [ { "label": "Small", "value": "S" }, { "label": "Medium", "value": "M" }, { "label": "Large", "value": "L" }, { "label": "Extra large", "value": "XL" } ], "defaultValue": "M" }, { "type": "text", "label": "Default value", "key": "defaultValue", "supportsConditions": false }, { "type": "text", "label": "Help text", "key": "helpText" }, { "type": "event", "label": "On change", "key": "onChange", "context": [ { "label": "Field Value", "key": "value" } ] }, { "type": "boolean", "label": "Disabled", "key": "disabled", "defaultValue": false }, { "type": "boolean", "label": "Read only", "key": "readonly", "defaultValue": false, "dependsOn": { "setting": "disabled", "value": true, "invert": true } }, { "type": "validation/boolean", "label": "Validation", "key": "validation" }, { "type": "select", "label": "Layout", "key": "span", "defaultValue": 6, "hidden": true, "showInBar": true, "barStyle": "buttons", "options": [ { "label": "1 column", "value": 6, "barIcon": "Stop", "barTitle": "1 column" }, { "label": "2 columns", "value": 3, "barIcon": "ColumnTwoA", "barTitle": "2 columns" }, { "label": "3 columns", "value": 2, "barIcon": "ViewColumn", "barTitle": "3 columns" } ] } ] }, "longformfield": { "name": "Long Form Field", "icon": "TextAlignLeft", "styles": ["size"], "requiredAncestors": ["form"], "editable": true, "size": { "width": 400, "height": 150 }, "settings": [ { "type": "field/longform", "label": "Field", "key": "field", "required": true }, { "type": "text", "label": "Label", "key": "label" }, { "type": "text", "label": "Placeholder", "key": "placeholder", "placeholder": "Type something..." }, { "type": "text", "label": "Default value", "key": "defaultValue", "supportsConditions": false }, { "type": "text", "label": "Help text", "key": "helpText" }, { "type": "event", "label": "On change", "key": "onChange", "context": [ { "label": "Field Value", "key": "value" } ] }, { "type": "select", "label": "Formatting", "key": "format", "placeholder": null, "options": [ { "label": "Auto", "value": "auto" }, { "label": "Plain text", "value": "plain" }, { "label": "Rich text (markdown)", "value": "rich" } ], "defaultValue": "auto" }, { "type": "boolean", "label": "Disabled", "key": "disabled", "defaultValue": false }, { "type": "boolean", "label": "Read only", "key": "readonly", "defaultValue": false, "dependsOn": { "setting": "disabled", "value": true, "invert": true } }, { "type": "validation/string", "label": "Validation", "key": "validation" }, { "type": "select", "label": "Layout", "key": "span", "defaultValue": 6, "hidden": true, "showInBar": true, "barStyle": "buttons", "options": [ { "label": "1 column", "value": 6, "barIcon": "Stop", "barTitle": "1 column" }, { "label": "2 columns", "value": 3, "barIcon": "ColumnTwoA", "barTitle": "2 columns" }, { "label": "3 columns", "value": 2, "barIcon": "ViewColumn", "barTitle": "3 columns" } ] } ] }, "datetimefield": { "name": "Date Picker", "icon": "Date", "styles": ["size"], "requiredAncestors": ["form"], "editable": true, "size": { "width": 400, "height": 50 }, "settings": [ { "type": "field/datetime", "label": "Field", "key": "field", "required": true }, { "type": "text", "label": "Label", "key": "label" }, { "type": "text", "label": "Placeholder", "key": "placeholder" }, { "type": "boolean", "label": "Show time", "key": "enableTime", "defaultValue": true }, { "type": "boolean", "label": "Time only", "key": "timeOnly", "defaultValue": false }, { "type": "boolean", "label": "Ignore time zones", "key": "ignoreTimezones", "defaultValue": false }, { "type": "text", "label": "Default value", "key": "defaultValue", "supportsConditions": false }, { "type": "text", "label": "Help text", "key": "helpText" }, { "type": "event", "label": "On change", "key": "onChange", "context": [ { "label": "Field Value", "key": "value" } ] }, { "type": "boolean", "label": "Disabled", "key": "disabled", "defaultValue": false }, { "type": "boolean", "label": "Read only", "key": "readonly", "defaultValue": false, "dependsOn": { "setting": "disabled", "value": true, "invert": true } }, { "type": "validation/datetime", "label": "Validation", "key": "validation" }, { "type": "select", "label": "Layout", "key": "span", "defaultValue": 6, "hidden": true, "showInBar": true, "barStyle": "buttons", "options": [ { "label": "1 column", "value": 6, "barIcon": "Stop", "barTitle": "1 column" }, { "label": "2 columns", "value": 3, "barIcon": "ColumnTwoA", "barTitle": "2 columns" }, { "label": "3 columns", "value": 2, "barIcon": "ViewColumn", "barTitle": "3 columns" } ] } ] }, "codescanner": { "name": "Barcode/QR Scanner", "icon": "Camera", "styles": ["size"], "size": { "width": 400, "height": 50 }, "settings": [ { "type": "field/barcodeqr", "label": "Field", "key": "field", "required": true }, { "type": "text", "label": "Label", "key": "label" }, { "type": "text", "label": "Button text", "key": "scanButtonText" }, { "type": "text", "label": "Default value", "key": "defaultValue", "supportsConditions": false }, { "type": "text", "label": "Help text", "key": "helpText" }, { "type": "boolean", "label": "Disabled", "key": "disabled", "defaultValue": false }, { "type": "boolean", "label": "Manual entry", "key": "allowManualEntry", "defaultValue": false }, { "type": "boolean", "label": "Auto confirm", "key": "autoConfirm", "defaultValue": false }, { "type": "boolean", "label": "Play sound on scan", "key": "beepOnScan", "defaultValue": false }, { "type": "select", "label": "Sound pitch", "key": "beepFrequency", "dependsOn": "beepOnScan", "defaultValue": 2637, "options": [ { "label": "Low", "value": 2096 }, { "label": "Regular", "value": 2637 }, { "label": "High", "value": 3136 }, { "label": "Custom", "value": "custom" } ] }, { "type": "number", "label": "Sound frequency (Hz)", "key": "customFrequency", "defaultValue": 1046, "min": 20, "max": 8000, "dependsOn": { "setting": "beepFrequency", "value": "custom" } }, { "type": "select", "label": "Preferred camera", "key": "preferredCamera", "defaultValue": "environment", "options": [ { "label": "Front", "value": "user" }, { "label": "Back", "value": "environment" } ] }, { "type": "event", "label": "On change", "key": "onChange", "context": [ { "label": "Field Value", "key": "value" } ] }, { "type": "validation/string", "label": "Validation", "key": "validation" }, { "type": "select", "label": "Layout", "key": "span", "defaultValue": 6, "hidden": true, "showInBar": true, "barStyle": "buttons", "options": [ { "label": "1 column", "value": 6, "barIcon": "Stop", "barTitle": "1 column" }, { "label": "2 columns", "value": 3, "barIcon": "ColumnTwoA", "barTitle": "2 columns" }, { "label": "3 columns", "value": 2, "barIcon": "ViewColumn", "barTitle": "3 columns" } ] } ] }, "signaturesinglefield": { "name": "Signature", "icon": "AnnotatePen", "styles": ["size"], "size": { "width": 400, "height": 50 }, "settings": [ { "type": "field/signature_single", "label": "Field", "key": "field", "required": true }, { "type": "text", "label": "Label", "key": "label" }, { "type": "text", "label": "Help text", "key": "helpText" }, { "type": "boolean", "label": "Disabled", "key": "disabled", "defaultValue": false }, { "type": "event", "label": "On change", "key": "onChange", "context": [ { "label": "Field Value", "key": "value" } ] }, { "type": "validation/signature_single", "label": "Validation", "key": "validation" } ] }, "embeddedmap": { "name": "Embedded Map", "icon": "Location", "styles": ["size"], "draggable": false, "size": { "width": 400, "height": 320 }, "settings": [ { "type": "dataProvider", "label": "Provider", "key": "dataProvider" }, { "type": "field", "label": "Latitude key", "key": "latitudeKey", "dependsOn": "dataProvider" }, { "type": "field", "label": "Longitude key", "key": "longitudeKey", "dependsOn": "dataProvider" }, { "type": "field", "label": "Title key", "key": "titleKey", "dependsOn": "dataProvider" }, { "type": "event", "label": "On click marker", "key": "onClickMarker", "context": [ { "label": "Clicked marker", "key": "marker" } ] }, { "type": "boolean", "label": "Enable adding", "key": "creationEnabled", "defaultValue": false }, { "type": "event", "label": "On create marker", "key": "onCreateMarker", "dependsOn": "creationEnabled", "context": [ { "label": "New marker latitude", "key": "lat" }, { "label": "New marker longitude", "key": "lng" } ] }, { "type": "boolean", "label": "Enable fullscreen", "key": "fullScreenEnabled", "defaultValue": true }, { "type": "boolean", "label": "Enable location", "key": "locationEnabled", "defaultValue": true }, { "type": "boolean", "label": "Enable zoom", "key": "zoomEnabled", "defaultValue": true }, { "type": "text", "label": "Tile URL", "key": "tileURL", "defaultValue": "https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png" }, { "type": "text", "label": "Default location", "key": "defaultLocation", "placeholder": "51.5072,-0.1276" }, { "type": "number", "label": "Default zoom (0-100)", "key": "zoomLevel", "placeholder": 50, "max": 100, "min": 0 }, { "type": "text", "label": "Map attribution", "key": "mapAttribution", "defaultValue": "OpenStreetMap contributors" } ] }, "attachmentfield": { "name": "Attachment List", "icon": "DocumentFragmentGroup", "styles": ["size"], "requiredAncestors": ["form"], "editable": true, "size": { "width": 400, "height": 200 }, "settings": [ { "type": "field/attachment", "label": "Field", "key": "field", "required": true }, { "type": "text", "label": "Label", "key": "label" }, { "type": "text", "label": "Help text", "key": "helpText" }, { "type": "text", "label": "Extensions", "key": "extensions" }, { "type": "number", "label": "Max attachments", "key": "maximum", "min": 1 }, { "type": "event", "label": "On change", "key": "onChange", "context": [ { "label": "Field Value", "key": "value" } ] }, { "type": "boolean", "label": "Compact", "key": "compact", "defaultValue": false }, { "type": "boolean", "label": "Read only", "key": "disabled", "defaultValue": false }, { "type": "validation/attachment", "label": "Validation", "key": "validation" }, { "type": "select", "label": "Layout", "key": "span", "defaultValue": 6, "hidden": true, "showInBar": true, "barStyle": "buttons", "options": [ { "label": "1 column", "value": 6, "barIcon": "Stop", "barTitle": "1 column" }, { "label": "2 columns", "value": 3, "barIcon": "ColumnTwoA", "barTitle": "2 columns" }, { "label": "3 columns", "value": 2, "barIcon": "ViewColumn", "barTitle": "3 columns" } ] } ] }, "attachmentsinglefield": { "name": "Single Attachment", "icon": "DocumentFragment", "styles": ["size"], "requiredAncestors": ["form"], "editable": true, "size": { "width": 400, "height": 200 }, "settings": [ { "type": "field/attachment_single", "label": "Field", "key": "field", "required": true }, { "type": "text", "label": "Label", "key": "label" }, { "type": "text", "label": "Help text", "key": "helpText" }, { "type": "text", "label": "Extensions", "key": "extensions" }, { "type": "event", "label": "On change", "key": "onChange", "context": [ { "label": "Field Value", "key": "value" } ] }, { "type": "boolean", "label": "Compact", "key": "compact", "defaultValue": false }, { "type": "boolean", "label": "Read only", "key": "disabled", "defaultValue": false }, { "type": "validation/attachment_single", "label": "Validation", "key": "validation" }, { "type": "select", "label": "Layout", "key": "span", "defaultValue": 6, "hidden": true, "showInBar": true, "barStyle": "buttons", "options": [ { "label": "1 column", "value": 6, "barIcon": "Stop", "barTitle": "1 column" }, { "label": "2 columns", "value": 3, "barIcon": "ColumnTwoA", "barTitle": "2 columns" }, { "label": "3 columns", "value": 2, "barIcon": "ViewColumn", "barTitle": "3 columns" } ] } ] }, "relationshipfield": { "name": "Relationship Picker", "icon": "TaskList", "styles": ["size"], "requiredAncestors": ["form"], "editable": true, "size": { "width": 400, "height": 50 }, "settings": [ { "type": "field/link", "label": "Field", "key": "field", "required": true }, { "type": "text", "label": "Label", "key": "label" }, { "type": "text", "label": "Placeholder", "key": "placeholder" }, { "type": "text", "label": "Default value", "key": "defaultValue", "supportsConditions": false }, { "type": "text", "label": "Help text", "key": "helpText" }, { "type": "event", "label": "On change", "key": "onChange", "context": [ { "label": "Field Value", "key": "value" } ] }, { "type": "validation/link", "label": "Validation", "key": "validation" }, { "type": "filter/relationship", "label": "Filtering", "key": "filter" }, { "type": "boolean", "label": "Search", "key": "autocomplete", "defaultValue": true }, { "type": "boolean", "label": "Disabled", "key": "disabled", "defaultValue": false }, { "type": "boolean", "label": "Read only", "key": "readonly", "defaultValue": false, "dependsOn": { "setting": "disabled", "value": true, "invert": true } }, { "type": "select", "label": "Layout", "key": "span", "defaultValue": 6, "hidden": true, "showInBar": true, "barStyle": "buttons", "options": [ { "label": "1 column", "value": 6, "barIcon": "Stop", "barTitle": "1 column" }, { "label": "2 columns", "value": 3, "barIcon": "ColumnTwoA", "barTitle": "2 columns" }, { "label": "3 columns", "value": 2, "barIcon": "ViewColumn", "barTitle": "3 columns" } ] } ] }, "jsonfield": { "name": "JSON Field", "icon": "Brackets", "styles": ["size"], "editable": true, "requiredAncestors": ["form"], "size": { "width": 400, "height": 100 }, "settings": [ { "type": "field/json", "label": "Field", "key": "field", "required": true }, { "type": "text", "label": "Label", "key": "label" }, { "type": "text", "label": "Placeholder", "key": "placeholder" }, { "type": "text", "label": "Default value", "key": "defaultValue", "supportsConditions": false }, { "type": "text", "label": "Help text", "key": "helpText" }, { "type": "event", "label": "On change", "key": "onChange", "context": [ { "label": "Field Value", "key": "value" } ] }, { "type": "boolean", "label": "Disabled", "key": "disabled", "defaultValue": false }, { "type": "boolean", "label": "Read only", "key": "readonly", "defaultValue": false, "dependsOn": { "setting": "disabled", "value": true, "invert": true } }, { "type": "select", "label": "Layout", "key": "span", "defaultValue": 6, "hidden": true, "showInBar": true, "barStyle": "buttons", "options": [ { "label": "1 column", "value": 6, "barIcon": "Stop", "barTitle": "1 column" }, { "label": "2 columns", "value": 3, "barIcon": "ColumnTwoA", "barTitle": "2 columns" }, { "label": "3 columns", "value": 2, "barIcon": "ViewColumn", "barTitle": "3 columns" } ] } ] }, "s3upload": { "name": "S3 File Upload", "icon": "UploadToCloud", "styles": ["size"], "editable": true, "size": { "width": 400, "height": 200 }, "settings": [ { "type": "field/s3", "label": "Field", "key": "field", "required": true }, { "type": "text", "label": "Label", "key": "label" }, { "type": "dataSource/s3", "label": "S3 datasource", "key": "datasourceId", "info": "This component can't be used with S3 datasources that use custom endpoints" }, { "type": "text", "label": "Bucket", "key": "bucket" }, { "type": "text", "label": "File name", "key": "key" }, { "type": "event", "label": "On change", "key": "onChange", "context": [ { "label": "Field Value", "key": "value" } ] }, { "type": "boolean", "label": "Disabled", "key": "disabled", "defaultValue": false }, { "type": "validation/attachment", "label": "Validation", "key": "validation" } ] }, "dataprovider": { "name": "Data Provider", "icon": "Data", "illegalChildren": ["section"], "hasChildren": true, "actions": ["RefreshDatasource"], "size": { "width": 400, "height": 100 }, "settings": [ { "type": "dataSource", "label": "Data", "key": "dataSource", "required": true }, { "type": "select", "label": "Auto-refresh", "key": "autoRefresh", "license": "premium", "placeholder": "Never", "options": [ { "label": "10 seconds", "value": 10 }, { "label": "30 seconds", "value": 30 }, { "label": "1 minute", "value": 60 }, { "label": "5 minutes", "value": 300 }, { "label": "10 minutes", "value": 600 } ] }, { "type": "filter", "label": "Filtering", "key": "filter" }, { "type": "field/sortable", "label": "Sort column", "key": "sortColumn", "placeholder": "None" }, { "type": "select", "label": "Sort order", "key": "sortOrder", "options": ["Ascending", "Descending"], "defaultValue": "Ascending" }, { "type": "number", "label": "Limit", "key": "limit", "defaultValue": 50 }, { "type": "boolean", "label": "Paginate", "key": "paginate", "defaultValue": true, "info": "Pagination is only available for data stored in tables" } ], "context": { "type": "static", "values": [ { "label": "Rows", "key": "rows", "type": "array" }, { "label": "Extra Info", "key": "info", "type": "string" }, { "label": "Rows Length", "key": "rowsLength", "type": "number" }, { "label": "Schema", "key": "schema", "type": "object" }, { "label": "Page Number", "key": "pageNumber", "type": "number" } ] } }, "table": { "deprecated": true, "name": "Table", "icon": "Table", "illegalChildren": ["section"], "hasChildren": true, "showEmptyState": false, "actions": ["ClearRowSelection"], "size": { "width": 600, "height": 400 }, "settings": [ { "type": "dataProvider", "label": "Data provider", "key": "dataProvider", "required": true }, { "type": "columns", "label": "Columns", "key": "columns", "dependsOn": "dataProvider", "nested": true }, { "type": "select", "label": "Size", "key": "size", "defaultValue": "spectrum--medium", "options": [ { "label": "Medium", "value": "spectrum--medium" }, { "label": "Large", "value": "spectrum--large" } ] }, { "type": "number", "label": "Row count", "key": "rowCount", "defaultValue": 8 }, { "type": "boolean", "label": "Quiet", "key": "quiet" }, { "type": "boolean", "label": "Compact", "key": "compact" }, { "type": "boolean", "label": "Row selection", "key": "allowSelectRows", "defaultValue": false, "info": "Row selection is only compatible with internal or SQL tables" }, { "type": "text", "label": "Empty text", "key": "noRowsMessage", "defaultValue": "No rows found" }, { "section": true, "name": "On Row Click", "settings": [ { "type": "event", "key": "onClick", "context": [ { "label": "Clicked row", "key": "row" } ] } ] } ], "context": [ { "type": "schema", "scope": "local" }, { "type": "static", "values": [ { "label": "Selected Rows", "key": "selectedRows", "type": "array" } ] } ] }, "daterangepicker": { "name": "Date Range", "icon": "Calendar", "styles": ["size"], "hasChildren": false, "size": { "width": 200, "height": 50 }, "settings": [ { "type": "dataProvider", "label": "Provider", "key": "dataProvider", "required": true, "info": "Your data provider will be automatically filtered to the given date range." }, { "type": "field", "label": "Date field", "key": "field", "required": true }, { "type": "select", "label": "Default range", "key": "defaultValue", "options": [ "Last 1 day", "Last 7 days", "Last 30 days", "Last 3 months", "Last 6 months", "Last 1 year" ], "defaultValue": "Last 30 days" } ] }, "spectrumcard": { "name": "Card", "icon": "PersonalizationField", "styles": ["size"], "size": { "width": 300, "height": 120 }, "settings": [ { "type": "text", "key": "title", "label": "Title", "defaultValue": "Title" }, { "type": "text", "key": "subtitle", "label": "Subtitle", "defaultValue": "Subtitle" }, { "type": "text", "key": "description", "label": "Description", "defaultValue": "Description" }, { "type": "text", "key": "imageURL", "label": "Image URL" }, { "type": "url", "key": "linkURL", "label": "Link URL" }, { "type": "boolean", "key": "linkPeek", "label": "Open in modal" }, { "type": "boolean", "key": "horizontal", "label": "Horizontal" }, { "type": "boolean", "label": "Show button", "key": "showButton" }, { "type": "text", "key": "buttonText", "label": "Button text", "dependsOn": "showButton" }, { "type": "event", "label": "Click action", "key": "buttonOnClick" } ] }, "dynamicfilter": { "name": "Dynamic Filter", "icon": "Filter", "size": { "width": 100, "height": 35 }, "settings": [ { "type": "dataProvider", "label": "Provider", "key": "dataProvider", "required": true }, { "type": "columns/basic", "label": "Allowed filter columns", "key": "allowedFields", "dependsOn": "dataProvider" }, { "type": "select", "label": "Button 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" } ] }, "chartblock": { "documentationLink": "https://docs.budibase.com/docs/chart", "block": true, "name": "Chart Block", "icon": "GraphPie", "hasChildren": false, "settings": [ { "type": "select", "label": "Chart type", "key": "chartType", "required": true, "options": [ { "label": "Pie", "value": "pie" }, { "label": "Bar", "value": "bar" }, { "label": "Histogram", "value": "histogram" }, { "label": "Line", "value": "line" }, { "label": "Donut", "value": "donut" }, { "label": "Candlestick", "value": "candlestick" }, { "label": "Area", "value": "area" } ] }, { "type": "dataSource", "label": "Data", "key": "dataSource", "required": true }, { "type": "select", "label": "Auto-refresh", "key": "autoRefresh", "license": "premium", "placeholder": "Never", "options": [ { "label": "10 seconds", "value": 10 }, { "label": "30 seconds", "value": 30 }, { "label": "1 minute", "value": 60 }, { "label": "5 minutes", "value": 300 }, { "label": "10 minutes", "value": 600 } ] }, { "type": "text", "label": "Title", "key": "chartTitle" }, { "type": "filter", "label": "Filtering", "key": "filter", "nested": true }, { "type": "field", "label": "Sort column", "key": "sortColumn" }, { "type": "select", "label": "Sort order", "key": "sortOrder", "options": ["Ascending", "Descending"], "defaultValue": "Ascending" }, { "type": "number", "label": "Limit", "key": "limit", "defaultValue": 50 }, { "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": "Data labels", "key": "dataLabels", "defaultValue": false }, { "type": "boolean", "label": "Legend", "key": "legend", "defaultValue": true }, { "type": "boolean", "label": "Animate", "key": "animate", "defaultValue": false }, { "section": true, "name": "Pie Chart", "icon": "GraphPie", "dependsOn": { "setting": "chartType", "value": "pie" }, "settings": [ { "type": "field", "label": "Label column", "key": "labelColumn", "dependsOn": "dataSource", "explanation": { "typeSupport": { "preset": "stringLike" } }, "required": true }, { "type": "field", "label": "Data column", "key": "valueColumn", "dependsOn": "dataSource", "explanation": { "typeSupport": { "preset": "numberLike" } }, "required": true } ] }, { "section": true, "name": "Donut Chart", "icon": "GraphDonut", "dependsOn": { "setting": "chartType", "value": "donut" }, "settings": [ { "type": "field", "label": "Label column", "key": "labelColumn", "dependsOn": "dataSource", "explanation": { "typeSupport": { "preset": "stringLike" } }, "required": true }, { "type": "field", "label": "Data column", "key": "valueColumn", "dependsOn": "dataSource", "explanation": { "typeSupport": { "preset": "numberLike" } }, "required": true } ] }, { "section": true, "name": "Bar Chart", "icon": "GraphBarVertical", "dependsOn": { "setting": "chartType", "value": "bar" }, "settings": [ { "type": "field", "label": "Label column", "key": "labelColumn", "dependsOn": "dataSource", "explanation": { "typeSupport": { "preset": "stringLike" } }, "required": true }, { "type": "multifield", "label": "Data columns", "key": "valueColumns", "dependsOn": "dataSource", "explanation": { "typeSupport": { "preset": "numberLike" } }, "required": true }, { "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": "boolean", "label": "Stacked", "key": "stacked", "defaultValue": false }, { "type": "boolean", "label": "Horizontal", "key": "horizontal", "defaultValue": false } ] }, { "section": true, "name": "Histogram Chart", "icon": "Histogram", "dependsOn": { "setting": "chartType", "value": "histogram" }, "settings": [ { "type": "field", "label": "Value column", "key": "valueColumn", "dependsOn": "dataSource", "explanation": { "typeSupport": { "preset": "numberLike" } }, "required": true }, { "type": "text", "label": "Y axis label", "key": "yAxisLabel" }, { "type": "text", "label": "X axis label", "key": "xAxisLabel" }, { "type": "boolean", "label": "Horizontal", "key": "horizontal", "defaultValue": false }, { "type": "number", "label": "Bucket count", "key": "bucketCount", "defaultValue": 10, "min": 2 } ] }, { "section": true, "name": "Line Chart", "icon": "GraphTrend", "dependsOn": { "setting": "chartType", "value": "line" }, "settings": [ { "type": "field", "label": "Label column", "key": "labelColumn", "dependsOn": "dataSource", "explanation": { "typeSupport": { "preset": "stringLike" } }, "required": true }, { "type": "multifield", "label": "Data columns", "key": "valueColumns", "dependsOn": "dataSource", "explanation": { "typeSupport": { "preset": "numberLike" } }, "required": true }, { "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": "select", "label": "Curve", "key": "curve", "options": ["Smooth", "Straight", "Stepline"], "defaultValue": "Smooth" } ] }, { "section": true, "name": "Area Chart", "icon": "GraphAreaStacked", "dependsOn": { "setting": "chartType", "value": "area" }, "settings": [ { "type": "field", "label": "Label columns", "key": "labelColumn", "dependsOn": "dataSource", "explanation": { "typeSupport": { "preset": "stringLike" } }, "required": true }, { "type": "multifield", "label": "Data columns", "key": "valueColumns", "dependsOn": "dataSource", "explanation": { "typeSupport": { "preset": "numberLike" } }, "required": true }, { "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": "select", "label": "Curve", "key": "curve", "options": ["Smooth", "Straight", "Stepline"], "defaultValue": "Smooth" }, { "type": "boolean", "label": "Stacked", "key": "stacked", "defaultValue": true }, { "type": "boolean", "label": "Gradient", "key": "gradient", "defaultValue": false } ] }, { "section": true, "name": "Candlestick Chart", "icon": "GraphBarVerticalStacked", "dependsOn": { "setting": "chartType", "value": "candlestick" }, "settings": [ { "type": "field", "label": "Date column", "key": "dateColumn", "dependsOn": "dataSource", "explanation": { "typeSupport": { "preset": "datetimeLike" } }, "required": true }, { "type": "field", "label": "Open column", "key": "openColumn", "dependsOn": "dataSource", "explanation": { "typeSupport": { "preset": "numberLike" } }, "required": true }, { "type": "field", "label": "Close column", "key": "closeColumn", "dependsOn": "dataSource", "explanation": { "typeSupport": { "preset": "numberLike" } }, "required": true }, { "type": "field", "label": "High column", "key": "highColumn", "dependsOn": "dataSource", "explanation": { "typeSupport": { "preset": "numberLike" } }, "required": true }, { "type": "field", "label": "Low column", "key": "lowColumn", "dependsOn": "dataSource", "explanation": { "typeSupport": { "preset": "numberLike" } }, "required": true }, { "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" } ] } ] }, "tableblock": { "deprecated": true, "block": true, "name": "Table Block", "icon": "Table", "styles": ["size"], "size": { "width": 600, "height": 400 }, "settings": [ { "type": "text", "label": "Title", "key": "title" }, { "section": true, "name": "Table", "settings": [ { "type": "dataSource", "label": "Data", "key": "dataSource", "required": true }, { "type": "select", "label": "Auto-refresh", "key": "autoRefresh", "license": "premium", "placeholder": "Never", "options": [ { "label": "10 seconds", "value": 10 }, { "label": "30 seconds", "value": 30 }, { "label": "1 minute", "value": 60 }, { "label": "5 minutes", "value": 300 }, { "label": "10 minutes", "value": 600 } ] }, { "type": "columns", "label": "Columns", "key": "tableColumns", "dependsOn": "dataSource", "placeholder": "All columns", "nested": true }, { "type": "field/sortable", "label": "Sort by", "key": "sortColumn", "placeholder": "Default" }, { "type": "select", "label": "Sort order", "key": "sortOrder", "options": ["Ascending", "Descending"], "defaultValue": "Ascending", "dependsOn": "sortColumn" }, { "type": "select", "label": "Size", "key": "size", "defaultValue": "spectrum--medium", "options": [ { "label": "Medium", "value": "spectrum--medium" }, { "label": "Large", "value": "spectrum--large" } ] }, { "type": "number", "label": "Scroll limit", "key": "rowCount", "defaultValue": 8 }, { "type": "boolean", "label": "Paginate", "key": "paginate", "defaultValue": true }, { "type": "boolean", "label": "Quiet", "key": "quiet" }, { "type": "boolean", "label": "Compact", "key": "compact" }, { "type": "boolean", "label": "Row selection", "key": "allowSelectRows", "info": "Row selection is only compatible with internal or SQL tables" }, { "type": "filter", "label": "Filtering", "key": "filter", "nested": true }, { "type": "text", "label": "Empty text", "key": "noRowsMessage", "defaultValue": "No rows found" }, { "type": "searchfield", "label": "Search fields", "key": "searchColumns", "placeholder": "Choose search fields", "info": "Only the first 5 fields will be used" } ] }, { "section": true, "name": "On row click", "settings": [ { "label": "Behaviour", "labelHidden": true, "type": "radio", "key": "clickBehaviour", "sendEvents": true, "defaultValue": "actions", "info": "Details side panel is only compatible with internal or SQL tables", "options": [ { "label": "Run actions", "value": "actions" }, { "label": "Show details side panel", "value": "details" } ] }, { "label": "Actions", "labelHidden": true, "type": "event", "key": "onClick", "nested": true, "dependsOn": { "setting": "clickBehaviour", "value": "actions" }, "context": [ { "label": "Clicked row", "key": "row" } ] }, { "label": "", "type": "fieldConfiguration", "key": "sidePanelFields", "nested": true, "dependsOn": { "setting": "clickBehaviour", "value": "details" }, "resetOn": "dataSource" }, { "label": "Save button", "type": "text", "key": "sidePanelSaveLabel", "defaultValue": "Save", "nested": true, "dependsOn": { "setting": "clickBehaviour", "value": "details" } }, { "label": "Delete button", "type": "text", "key": "sidePanelDeleteLabel", "defaultValue": "Delete", "nested": true, "dependsOn": { "setting": "clickBehaviour", "value": "details" } }, { "type": "boolean", "label": "Hide notifications", "key": "notificationOverride", "defaultValue": false, "dependsOn": { "setting": "clickBehaviour", "value": "details" } } ] }, { "section": true, "name": "Button", "settings": [ { "type": "boolean", "key": "showTitleButton", "label": "Show button", "defaultValue": false }, { "type": "text", "key": "titleButtonText", "label": "Text", "defaultValue": "Create row", "dependsOn": "showTitleButton" }, { "type": "radio", "key": "titleButtonClickBehaviour", "label": "Behaviour", "dependsOn": "showTitleButton", "defaultValue": "actions", "info": "New row side panel is only compatible with internal or SQL tables", "options": [ { "label": "Run actions", "value": "actions" }, { "label": "Show new row side panel", "value": "new" } ] }, { "type": "event", "label": "On click", "key": "onClickTitleButton", "nested": true, "dependsOn": { "setting": "titleButtonClickBehaviour", "value": "actions" } } ] } ], "context": [ { "type": "static", "suffix": "provider", "values": [ { "label": "Rows", "key": "rows", "type": "array" }, { "label": "Extra Info", "key": "info", "type": "string" }, { "label": "Rows Length", "key": "rowsLength", "type": "number" }, { "label": "Schema", "key": "schema", "type": "object" }, { "label": "Page Number", "key": "pageNumber", "type": "number" } ] }, { "type": "static", "suffix": "table", "values": [ { "label": "Selected Rows", "key": "selectedRows", "type": "array" } ] } ] }, "cardsblock": { "block": true, "name": "Cards Block", "icon": "PersonalizationField", "styles": ["size"], "size": { "width": 600, "height": 400 }, "settings": [ { "type": "text", "label": "Title", "key": "title" }, { "type": "dataSource", "label": "Data", "key": "dataSource", "required": true }, { "type": "select", "label": "Auto-refresh", "key": "autoRefresh", "license": "premium", "placeholder": "Never", "options": [ { "label": "10 seconds", "value": 10 }, { "label": "30 seconds", "value": 30 }, { "label": "1 minute", "value": 60 }, { "label": "5 minutes", "value": 300 }, { "label": "10 minutes", "value": 600 } ] }, { "type": "searchfield", "label": "Search columns", "key": "searchColumns", "placeholder": "Choose search columns", "info": "Max 5 columns will be used" }, { "type": "filter", "label": "Filtering", "key": "filter", "nested": true }, { "type": "field/sortable", "label": "Sort column", "key": "sortColumn", "placeholder": "None" }, { "type": "select", "label": "Sort order", "key": "sortOrder", "options": ["Ascending", "Descending"], "defaultValue": "Descending" }, { "type": "number", "label": "Limit", "key": "limit", "defaultValue": 8 }, { "type": "boolean", "label": "Paginate", "key": "paginate" }, { "type": "text", "label": "Empty text", "key": "noRowsMessage", "defaultValue": "No rows found" }, { "section": true, "name": "Cards", "settings": [ { "type": "text", "key": "cardTitle", "label": "Title", "nested": true, "resetOn": "dataSource" }, { "type": "text", "key": "cardSubtitle", "label": "Subtitle", "nested": true, "resetOn": "dataSource" }, { "type": "text", "key": "cardDescription", "label": "Description", "nested": true, "resetOn": "dataSource" }, { "type": "text", "key": "cardImageURL", "label": "Image URL", "nested": true, "resetOn": "dataSource" }, { "type": "boolean", "key": "linkCardTitle", "label": "Link card title" }, { "type": "boolean", "key": "cardPeek", "label": "Open in modal" }, { "type": "url", "label": "Link screen", "key": "cardURL", "nested": true }, { "type": "boolean", "key": "cardHorizontal", "label": "Horizontal" }, { "type": "boolean", "label": "Add button", "key": "showCardButton" }, { "type": "text", "key": "cardButtonText", "label": "Button text", "nested": true, "dependsOn": "showCardButton" }, { "type": "event", "label": "Click action", "key": "cardButtonOnClick", "nested": true } ] }, { "section": true, "name": "Title button", "settings": [ { "type": "boolean", "key": "showTitleButton", "label": "Show button" }, { "type": "boolean", "label": "Open in modal", "key": "titleButtonPeek" }, { "type": "text", "key": "titleButtonText", "label": "Button text" }, { "type": "url", "label": "Button link", "key": "titleButtonURL" } ] }, { "section": true, "name": "Advanced", "settings": [ { "type": "field", "label": "ID column", "key": "linkColumn", "placeholder": "Default" } ] } ], "context": { "type": "schema", "suffix": "repeater", "scope": "local" } }, "repeaterblock": { "block": true, "name": "Repeater Block", "icon": "ViewList", "illegalChildren": ["section", "rowexplorer"], "hasChildren": true, "size": { "width": 400, "height": 100 }, "settings": [ { "type": "dataSource", "label": "Data", "key": "dataSource", "required": true }, { "type": "select", "label": "Auto-refresh", "key": "autoRefresh", "license": "premium", "placeholder": "Never", "options": [ { "label": "10 seconds", "value": 10 }, { "label": "30 seconds", "value": 30 }, { "label": "1 minute", "value": 60 }, { "label": "5 minutes", "value": 300 }, { "label": "10 minutes", "value": 600 } ] }, { "type": "filter", "label": "Filtering", "key": "filter", "nested": true }, { "type": "field/sortable", "label": "Sort column", "key": "sortColumn", "placeholder": "None" }, { "type": "select", "label": "Sort order", "key": "sortOrder", "options": ["Ascending", "Descending"], "defaultValue": "Descending" }, { "type": "number", "label": "Limit", "key": "limit", "defaultValue": 10 }, { "type": "boolean", "label": "Paginate", "key": "paginate" }, { "section": true, "name": "Layout settings", "settings": [ { "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": "static", "suffix": "provider", "values": [ { "label": "Rows", "key": "rows", "type": "array" }, { "label": "Extra Info", "key": "info", "type": "string" }, { "label": "Rows Length", "key": "rowsLength", "type": "number" }, { "label": "Schema", "key": "schema", "type": "object" }, { "label": "Page Number", "key": "pageNumber", "type": "number" } ] }, { "type": "static", "suffix": "repeater", "values": [ { "label": "Row Index", "key": "index", "type": "number" } ] }, { "type": "schema", "suffix": "repeater", "scope": "local" } ] }, "markdownviewer": { "name": "Markdown Viewer", "icon": "Preview", "styles": ["size"], "size": { "width": 400, "height": 100 }, "settings": [ { "type": "text", "label": "Markdown", "key": "value", "required": true } ] }, "multistepformblock": { "name": "Multi-step Form Block", "icon": "AssetsAdded", "block": true, "hasChildren": false, "ejectable": false, "size": { "width": 400, "height": 400 }, "styles": ["size"], "settings": [ { "type": "table", "label": "Data", "key": "dataSource" }, { "type": "radio", "label": "Type", "key": "actionType", "options": ["Create", "Update", "View"], "defaultValue": "Create" }, { "section": true, "dependsOn": { "setting": "actionType", "value": "Create", "invert": true }, "name": "Row ID", "info": "How to pass a row ID using bindings", "settings": [ { "type": "text", "label": "Row ID", "key": "rowId", "nested": true }, { "type": "text", "label": "No rows found", "key": "noRowsMessage", "defaultValue": "We couldn't find a row to display", "nested": true } ] }, { "section": true, "name": "Details", "settings": [ { "type": "stepConfiguration", "key": "steps", "nested": true, "labelHidden": true, "resetOn": ["dataSource", "actionType"], "defaultValue": [{}] } ] }, { "tag": "style", "type": "select", "label": "Button position", "key": "buttonPosition", "options": [ { "label": "Bottom", "value": "bottom" }, { "label": "Top", "value": "top" } ], "defaultValue": "bottom" }, { "tag": "style", "type": "select", "label": "Size", "key": "size", "options": [ { "label": "Medium", "value": "spectrum--medium" }, { "label": "Large", "value": "spectrum--large" } ], "defaultValue": "spectrum--medium" } ], "actions": [ { "type": "ValidateForm", "suffix": "form" }, { "type": "ClearForm", "suffix": "form" }, { "type": "UpdateFieldValue", "suffix": "form" }, { "type": "ScrollTo", "suffix": "form" }, { "type": "ChangeFormStep", "suffix": "form" } ], "context": [ { "type": "form", "suffix": "form" }, { "type": "schema", "suffix": "repeater" }, { "type": "static", "suffix": "form", "values": [ { "label": "Value", "key": "__value", "type": "object" }, { "label": "Valid", "key": "__valid", "type": "boolean" }, { "label": "Current Step", "key": "__currentStep", "type": "number" }, { "label": "Current Step Valid", "key": "__currentStepValid", "type": "boolean" } ] } ] }, "multistepformblockstep": { "name": "Multi-step Form Block Step", "settings": [ { "type": "formStepControls", "label": "Steps", "key": "steps" }, { "type": "text", "label": "Title", "key": "title", "nested": true }, { "type": "text", "label": "Description", "key": "desc", "nested": true }, { "type": "fieldConfiguration", "key": "fields", "nested": true }, { "type": "buttonConfiguration", "label": "Buttons", "key": "buttons", "wide": true, "nested": true } ] }, "formblock": { "name": "Form Block", "icon": "Form", "styles": ["size"], "block": true, "info": "Form blocks are only compatible with internal or SQL tables", "size": { "width": 400, "height": 400 }, "settings": [ { "type": "table", "label": "Data", "key": "dataSource" }, { "type": "radio", "label": "Type", "key": "actionType", "options": ["Create", "Update", "View"], "defaultValue": "Create" }, { "section": true, "dependsOn": { "setting": "actionType", "value": "Create", "invert": true }, "name": "Row ID", "info": "How to pass a row ID using bindings", "settings": [ { "type": "text", "label": "Row ID", "key": "rowId", "nested": true }, { "type": "text", "label": "No rows found", "key": "noRowsMessage", "defaultValue": "We couldn't find a row to display", "nested": true } ] }, { "section": true, "name": "Details", "settings": [ { "type": "text", "label": "Title", "key": "title", "nested": true }, { "type": "text", "label": "Description", "key": "description", "nested": true }, { "type": "fieldConfiguration", "key": "fields", "nested": true, "resetOn": "dataSource", "selectAllFields": true }, { "type": "boolean", "label": "Disabled", "key": "disabled", "defaultValue": false } ] }, { "tag": "style", "type": "select", "label": "Button position", "key": "buttonPosition", "options": [ { "label": "Bottom", "value": "bottom" }, { "label": "Top", "value": "top" } ], "defaultValue": "bottom" }, { "section": true, "name": "Buttons", "settings": [ { "type": "buttonConfiguration", "key": "buttons", "nested": true, "resetOn": ["actionType", "dataSource"] } ] }, { "tag": "style", "type": "select", "label": "Size", "key": "size", "options": [ { "label": "Medium", "value": "spectrum--medium" }, { "label": "Large", "value": "spectrum--large" } ], "defaultValue": "spectrum--medium" } ], "actions": [ { "type": "ValidateForm", "suffix": "form" }, { "type": "ClearForm", "suffix": "form" }, { "type": "UpdateFieldValue", "suffix": "form" }, { "type": "ScrollTo", "suffix": "form" } ], "context": [ { "type": "form", "suffix": "form" }, { "type": "schema", "suffix": "repeater" } ] }, "sidepanel": { "name": "Side Panel", "icon": "RailRight", "hasChildren": true, "illegalChildren": ["section", "sidepanel", "modal"], "showEmptyState": false, "draggable": false, "info": "Side panels are hidden by default. They will only be revealed when triggered by the 'Open Side Panel' action.", "settings": [ { "type": "boolean", "key": "ignoreClicksOutside", "label": "Ignore clicks outside", "defaultValue": false }, { "type": "event", "key": "onClose", "label": "On close" } ] }, "modal": { "name": "Modal", "icon": "MBox", "hasChildren": true, "illegalChildren": ["section", "modal", "sidepanel"], "showEmptyState": false, "draggable": false, "info": "Modals are hidden by default. They will only be revealed when triggered by the 'Open Modal' action.", "settings": [ { "type": "boolean", "key": "ignoreClicksOutside", "label": "Ignore clicks outside", "defaultValue": false }, { "type": "event", "key": "onClose", "label": "On close" }, { "type": "select", "label": "Size", "key": "size", "defaultValue": "small", "options": [ { "label": "Small", "value": "small" }, { "label": "Medium", "value": "medium" }, { "label": "Large", "value": "large" }, { "label": "Fullscreen", "value": "fullscreen" } ] } ] }, "rowexplorer": { "block": true, "name": "Row Explorer Block", "icon": "PersonalizationField", "size": { "width": 600, "height": 400 }, "settings": [ { "type": "table", "label": "Data", "key": "dataSource", "required": true }, { "type": "select", "label": "Auto-refresh", "key": "autoRefresh", "license": "premium", "placeholder": "Never", "options": [ { "label": "10 seconds", "value": 10 }, { "label": "30 seconds", "value": 30 }, { "label": "1 minute", "value": 60 }, { "label": "5 minutes", "value": 300 }, { "label": "10 minutes", "value": 600 } ] }, { "type": "text", "label": "Height", "key": "height", "defaultValue": "426px" }, { "type": "text", "label": "Empty text", "key": "noRowsMessage", "defaultValue": "No data" }, { "section": true, "name": "Cards", "settings": [ { "type": "field", "label": "Search field", "key": "cardSearchField", "nested": true }, { "type": "text", "key": "cardTitle", "label": "Title", "nested": true, "defaultValue": "Title" }, { "type": "text", "key": "cardSubtitle", "label": "Subtitle", "nested": true, "defaultValue": "Subtitle" }, { "type": "text", "key": "cardDescription", "label": "Description", "nested": true, "defaultValue": "Description" }, { "type": "text", "key": "cardImageURL", "label": "Image URL", "nested": true } ] }, { "section": true, "name": "Details", "settings": [ { "type": "text", "key": "detailTitle", "label": "Title" }, { "type": "multifield", "label": "Fields", "key": "detailFields", "nested": true, "selectAllFields": true } ] } ], "context": { "type": "schema", "suffix": "repeater", "scope": "local" } }, "grid": { "name": "Grid", "icon": "ViewGrid", "hasChildren": true, "settings": [ { "type": "number", "key": "cols", "label": "Columns" }, { "type": "number", "key": "rows", "label": "Rows" } ] }, "gridblock": { "name": "Table", "icon": "Table", "styles": ["size"], "size": { "width": 600, "height": 400 }, "settings": [ { "type": "dataSource", "label": "Data", "key": "table", "required": true }, { "type": "filter", "label": "Filtering", "key": "initialFilter", "dependsOn": { "setting": "table.type", "value": "custom", "invert": true } }, { "type": "field/sortable", "label": "Sort column", "key": "initialSortColumn", "placeholder": "Default", "dependsOn": { "setting": "table.type", "value": "custom", "invert": true } }, { "type": "select", "label": "Sort order", "key": "initialSortOrder", "options": ["Ascending", "Descending"], "defaultValue": "Ascending", "dependsOn": "initialSortColumn" }, { "type": "select", "label": "Row height", "key": "fixedRowHeight", "placeholder": "Default", "options": [ { "label": "Small", "value": 36 }, { "label": "Medium", "value": 64 }, { "label": "Large", "value": 92 } ] }, { "type": "event", "label": "On row click", "key": "onRowClick", "context": [ { "label": "Clicked row", "key": "row" } ] }, { "type": "boolean", "label": "Add rows", "key": "allowAddRows", "defaultValue": true, "dependsOn": { "setting": "table.type", "value": ["table", "viewV2"] } }, { "type": "boolean", "label": "Edit rows", "key": "allowEditRows", "defaultValue": true, "dependsOn": { "setting": "table.type", "value": ["table", "viewV2"] } }, { "type": "boolean", "label": "Delete rows", "key": "allowDeleteRows", "defaultValue": true, "dependsOn": { "setting": "table.type", "value": ["table", "viewV2"] } }, { "type": "boolean", "label": "High contrast", "key": "stripeRows", "defaultValue": false }, { "type": "boolean", "label": "Quiet", "key": "quiet", "defaultValue": false }, { "section": true, "name": "Columns", "settings": [ { "type": "columns/grid", "key": "columns", "nested": true, "resetOn": "table" } ] }, { "section": true, "name": "Buttons", "settings": [ { "type": "buttonConfiguration", "key": "buttons", "nested": true, "max": 3, "context": [ { "label": "Clicked row", "key": "row" } ] } ] } ], "context": [ { "type": "schema", "scope": "local" }, { "type": "static", "values": [ { "label": "Selected rows", "key": "selectedRows", "type": "array" } ] } ], "actions": ["RefreshDatasource"] }, "bbreferencefield": { "devComment": "As bb reference is only used for user subtype for now, we are using user for icon and labels", "name": "User List Field", "icon": "UserGroup", "styles": ["size"], "requiredAncestors": ["form"], "editable": true, "size": { "width": 400, "height": 50 }, "settings": [ { "type": "field/bb_reference", "label": "Field", "key": "field", "required": true }, { "type": "text", "label": "Label", "key": "label" }, { "type": "text", "label": "Placeholder", "key": "placeholder" }, { "type": "text", "label": "Default value", "key": "defaultValue" }, { "type": "text", "label": "Help text", "key": "helpText" }, { "type": "event", "label": "On change", "key": "onChange", "context": [ { "label": "Field Value", "key": "value" } ] }, { "type": "validation/link", "label": "Validation", "key": "validation" }, { "type": "boolean", "label": "Search", "key": "autocomplete", "defaultValue": true }, { "type": "boolean", "label": "Disabled", "key": "disabled", "defaultValue": false }, { "type": "boolean", "label": "Read only", "key": "readonly", "defaultValue": false, "dependsOn": { "setting": "disabled", "value": true, "invert": true } }, { "type": "select", "label": "Layout", "key": "span", "defaultValue": 6, "hidden": true, "showInBar": true, "barStyle": "buttons", "options": [ { "label": "1 column", "value": 6, "barIcon": "Stop", "barTitle": "1 column" }, { "label": "2 columns", "value": 3, "barIcon": "ColumnTwoA", "barTitle": "2 columns" }, { "label": "3 columns", "value": 2, "barIcon": "ViewColumn", "barTitle": "3 columns" } ] } ] }, "bbreferencesinglefield": { "devComment": "As bb reference is only used for user subtype for now, we are using user for icon and labels", "name": "User Field", "icon": "User", "styles": ["size"], "requiredAncestors": ["form"], "editable": true, "size": { "width": 400, "height": 50 }, "settings": [ { "type": "field/bb_reference_single", "label": "Field", "key": "field", "required": true }, { "type": "text", "label": "Label", "key": "label" }, { "type": "text", "label": "Placeholder", "key": "placeholder" }, { "type": "text", "label": "Default value", "key": "defaultValue" }, { "type": "text", "label": "Help text", "key": "helpText" }, { "type": "event", "label": "On change", "key": "onChange", "context": [ { "label": "Field Value", "key": "value" } ] }, { "type": "validation/link", "label": "Validation", "key": "validation" }, { "type": "boolean", "label": "Search", "key": "autocomplete", "defaultValue": true }, { "type": "boolean", "label": "Disabled", "key": "disabled", "defaultValue": false }, { "type": "boolean", "label": "Read only", "key": "readonly", "defaultValue": false, "dependsOn": { "setting": "disabled", "value": true, "invert": true } }, { "type": "select", "label": "Layout", "key": "span", "defaultValue": 6, "hidden": true, "showInBar": true, "barStyle": "buttons", "options": [ { "label": "1 column", "value": 6, "barIcon": "Stop", "barTitle": "1 column" }, { "label": "2 columns", "value": 3, "barIcon": "ColumnTwoA", "barTitle": "2 columns" }, { "label": "3 columns", "value": 2, "barIcon": "ViewColumn", "barTitle": "3 columns" } ] } ] } }