{ "datatypes": [ "Boolean", "Date", "DateTime", "Decimal", "Double", "Integer", "Long", "String", "Function", "Object", "List", "Map", "Set", "Boolean[]", "Date[]", "DateTime[]", "Decimal[]", "Double[]", "Integer[]", "Long[]", "String[]", "Object[]" ], "access":[ "public", "global", "private" ], "sizes": [ "xx-small", "x-small", "small", "medium", "large" ], "paddings": [ "horizontal-small", "horizontal-medium", "horizontal-large", "around-small", "around-medium", "around-large" ], "booleans": [ "true", "false" ], "variants": [ "circle", "square", "base", "neutral", "brand", "destructive", "inverse", "success", "bare", "container", "border", "border-filled", "bare-inverse", "border-inverse", "text", "narrow", "standard", "label-hidden", "label-inline", "label-stacked", "bottom-toolbar", "linear", "non-linear", "circular", "shaded", "default", "scoped", "vertical" ], "progressTypes": [ "base", "path" ], "recordModes": [ "VIEW", "EDIT" ], "feedDesigns": [ "BROWSE", "DEFAULT" ], "publisherContexts": [ "RECORD", "GLOBAL" ], "feedTypes": [ "Bookmarks", "Company", "DirectMessages", "Feeds", "Files", "Filter", "Groups", "Home", "Moderation", "Mute", "News", "PendingReview", "Record", "Streams", "To", "Topics", "UserProfile" ], "fullFeedTypes": [ "News", "Home", "Record", "To" ], "buttonTypes": [ "button", "reset", "submit" ], "severities":[ "message", "confirm", "info", "warning", "error" ], "inputTypes": [ "radio", "button" ], "densities": [ "compact", "comfy", "auto" ], "dynamicIcons": [ "ellie", "eq", "score", "strength", "trend", "waffle" ], "timeZoneNames": [ "short", "long" ], "nameFormats": [ "short", "medium", "long" ], "numberStyles": [ "decimal", "currency", "percent" ], "currencyDisplays": [ "symbol", "code", "name" ], "urlTargets": [ "_blank", "_parent", "_self", "_top" ], "sortValues": [ "asc", "desc" ], "positions": [ "left", "right", "top", "bottom", "auto", "center", "bottom-left", "bottom-center", "bottom-right", "space", "spread", "end", "stretch", "horizontal" ], "flexibilities":[ "auto", "shrink", "no-shrink", "grow", "no-grow", "no-flex" ], "components": { "lightning": { "input": [ "button", "buttonGroup", "buttonIcon", "buttonIconStateful", "buttonMenu", "buttonStateful", "checkboxGroup", "combobox", "input", "inputRichText", "menuItem", "radioGroup", "select", "tab", "textarea" ], "inputField": [ "inputAddress", "inputLocation", "inputName" ], "css": [ "accordion", "accordionSection", "avatar", "badge", "breadcrumb", "breadcrumbs", "button", "buttonGroup", "buttonIcon", "buttonIconStateful", "buttonMenu", "buttonStateful", "checkboxGroup", "carousel", "checkboxGroup", "clickToDial", "combobox", "datatable", "dynamicIcon", "fileUpload", "flow", "formattedAddress", "formattedDateTime", "formattedLocation", "formattedName", "formattedNumber", "formattedPhone", "formattedRichText", "formattedTime", "helptext", "icon", "input", "inputAddress", "inputLocation", "inputName", "inputRichText", "layout", "layoutItem", "map", "menuItem", "pill", "pillContainer", "progressBar", "progressIndicator", "radioGroup", "relativeDateTime", "select", "slider", "spinner", "tab", "tabset", "textarea", "tile", "tree", "treeGrid", "verticalNavigation", "verticalNavigationItem", "verticalNavigationItemBadge", "verticalNavigationItemIcon", "verticalNavigationOverflow", "verticalNavigationSection" ], "html": [ "accordion", "accordionSection", "avatar", "badge", "breadcrumb", "breadcrumbs", "button", "buttonGroup", "buttonIcon", "buttonIconStateful", "buttonMenu", "buttonStateful", "checkboxGroup", "carousel", "checkboxGroup", "clickToDial", "combobox", "datatable", "dynamicIcon", "fileUpload", "flow", "formattedAddress", "formattedDateTime", "formattedLocation", "formattedName", "formattedNumber", "formattedPhone", "formattedRichText", "formattedTime", "helptext", "icon", "input", "inputAddress", "inputLocation", "inputName", "inputRichText", "layout", "layoutItem", "map", "menuItem", "pill", "pillContainer", "progressBar", "progressIndicator", "radioGroup", "relativeDateTime", "select", "slider", "spinner", "tab", "tabset", "textarea", "tile", "tree", "treeGrid", "verticalNavigation", "verticalNavigationItem", "verticalNavigationItemBadge", "verticalNavigationItemIcon", "verticalNavigationOverflow", "verticalNavigationSection" ], "select": [ "combobox", "dualListbox", "input", "radioGroup", "select", "textarea" ] } }, "notRoot": { "lightning": [ "utilityItem", "hasPageReference", "availableForFlowScreens", "availableForChatterExtensionRenderer", "availableForFlowActions" ] }, "root": { "component": [ { "name": "body", "type": "component[]", "description": "The body of the component. In markup, this is everything in the body of the tag." } ], "css": [ { "name": "class", "type": "String", "access": "global", "required": false, "default": "", "description": "A CSS class for the outer element, in addition to the component's base classes." } ], "html": [ { "name": "title", "type": "String", "access": "global", "required": false, "default": "", "description": "Displays tooltip text when the mouse moves over the element." } ], "input": [ { "name": "onfocus", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the element receives focus." }, { "name": "onblur", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the element releases focus." }, { "name": "tabindex", "type": "Integer", "access": "global", "required": false, "default": "", "description": "Specifies the tab order of an element when the Tab key is used for navigating. The tabindex value can be set to 0 or -1. The default is 0, which means that the component is focusable and participates in sequential keyboard navigation. -1 means that the component is focusable but does not participate in keyboard navigation." }, { "name": "accesskey", "type": "String", "access": "global", "required": false, "default": "", "description": "Specifies a shortcut key to activate or focus an element." } ], "inputField": [ { "name": "onblur", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the input releases focus." }, { "name": "onchange", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the value changes." }, { "name": "onfocus", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the input receives focus." } ], "select": [ { "name": "name", "type": "String", "access": "global", "required": false, "default": "", "description": "Specifies the name of an input element." }, { "name": "value", "type": "Object", "access": "global", "required": false, "default": "", "description": "Specifies the value of an input element." }, { "name": "variant", "type": "String", "access": "global", "required": false, "default": "standard", "description": "The variant changes the appearance of an input field. Accepted variants include standard, label-inline, label-hidden, and label-stacked. This value defaults to standard, which displays the label above the field. Use label-hidden to hide the label but make it available to assistive technology. Use label-inline to horizontally align the label and input field. Use label-stacked to place the label above the input field." }, { "name": "disabled", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Specifies that an input element should be disabled. This value defaults to false." }, { "name": "readonly", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Specifies that an input field is read-only. This value defaults to false." }, { "name": "validity", "type": "Object", "access": "global", "required": false, "default": "", "description": "Represents the validity states that an element can be in, with respect to constraint validation." }, { "name": "onchange", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when a value attribute changes" } ] }, "aura": { "component": [ { "name": "access", "type": "String", "description": "Indicates whether the component can be used outside of its own namespace. Possible values are public (default), and global." }, { "name": "controller", "type": "String", "description": "The server-side controller class for the component in the format namespace.myController or myController if using the default namespace." }, { "name": "extends", "type": "Component", "description": "The component to be extended." }, { "name": "extensible", "type": "Boolean", "description": "Set to true if the component can be extended. The default is false." }, { "name": "implements", "type": "String", "description": "A comma-separated list of interfaces that the component implements." }, { "name": "isTemplate", "type": "Boolean", "description": "Set to true if the component is a template. The default is false. A template must have isTemplate=\"true\" set in its aura:component tag." }, { "name": "template", "type": "Component", "description": "The template for this component. A template bootstraps loading of the framework and app. The default template is aura:template. You can customize the template by creating your own component that extends the default template" } ], "if": [ { "name": "isTrue", "type": "Boolean", "description": "An expression that must be fulfilled in order to display the body." }, { "name": "else", "type": "component[]", "description": "The alternative to render when isTrue evaluates to false, and the body is not rendered. Should always be set using the aura:set tag." } ], "iteration": [ { "name": "items", "type": "List", "access": "global", "required": true, "default": "", "description": "The collection of data to iterate over" }, { "name": "var", "type": "String", "access": "global", "required": true, "default": "", "description": "The name of the variable to use for each item inside the iteration" }, { "name": "indexVar", "type": "String", "access": "global", "required": false, "default": "", "description": "The name of variable to use for the index of each item inside the iteration" }, { "name": "start", "type": "Integer", "access": "global", "required": false, "default": "", "description": "The index of the collection to start at (inclusive)" }, { "name": "end", "type": "Integer", "access": "global", "required": false, "default": "", "description": "The index of the collection to end at (exclusive)" }, { "name": "loaded", "type": "Boolean", "access": "global", "required": false, "default": "false", "description": "True if the iteration has finished loading the set of templates." }, { "name": "template", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "The template that is used to generate components. By default, this is set from the body markup on first load." } ], "renderIf": [ { "name": "isTrue", "type": "Boolean", "description": "An expression that must be fulfilled in order to display the body." }, { "name": "else", "type": "component[]", "description": "The alternative content to render when isTrue evaluates to false, and the body is not rendered. Set using the tag." } ], "template": [ { "name": "title", "type": "String", "access": "global", "required": false, "default": "Aura", "description": "The title of the template." }, { "name": "auraPreInitBlock", "type": "component[]", "access": "global", "required": false, "default": "", "description": "The block of content that is rendered before Aura initialization." }, { "name": "doctype", "type": "String", "access": "global", "required": false, "default": "", "description": "The DOCTYPE declaration for the template." }, { "name": "loadingText", "type": "String", "access": "global", "required": false, "default": "Loading", "description": "Loading text" }, { "name": "errorTitle", "type": "String", "access": "global", "required": false, "default": "Sorry to interrupt", "description": "Error title when an error has occured." }, { "name": "errorMessage", "type": "String", "access": "global", "required": false, "default": "CSS Error", "description": "Error loading text" }, { "name": "defaultBodyClass", "type": "String", "access": "global", "required": false, "default": "loading", "description": "Default body CSS styles." }, { "name": "bodyClass", "type": "String", "access": "global", "required": false, "default": "", "description": "Extra body CSS styles." } ], "text": [ { "name": "value", "type": "String", "access": "global", "required": false, "default": "", "description": "The String to be rendered." } ], "unescapedHtml": [ { "name": "value", "type": "String", "access": "global", "required": false, "default": "", "description": "The string that should be rendered as unescaped HTML." } ], "attribute":[ { "name": "access", "type": "String", "access": "global", "required": false, "default": "", "description": "Indicates whether the attribute can be used outside of its own namespace. Possible values are public (default), and global, and private." }, { "name": "name", "type": "String", "access": "global", "required": true, "default": "", "description": "Required. The name of the attribute. For example, if you set on a component called aura:newCmp, you can set this attribute when you instantiate the component; for example," }, { "name": "type", "type": "String", "access": "global", "required": false, "default": "", "description": "Required. The type of the attribute. For a list of basic types supported, see Basic Types. [https://developer.salesforce.com/docs/atlas.en-us.lightning.meta/lightning/ref_attr_types_basic.htm]" }, { "name": "default", "type": "String", "access": "global", "required": false, "default": "", "description": "The default value for the attribute, which can be overwritten as needed. When setting a default value, expressions using the $Label, $Locale, and $Browser global value providers are supported. Alternatively, to set a dynamic default, use an init event. See Invoking Actions on Component Initialization. [https://developer.salesforce.com/docs/atlas.en-us.lightning.meta/lightning/js_cb_init_handler.htm]" }, { "name": "required", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Determines if the attribute is required. The default is false." }, { "name": "description", "type": "String", "access": "global", "required": false, "default": "", "description": "A summary of the attribute and its usage." } ] }, "lightning": { "accordion": [ { "name": "activeSectionName", "type": "String", "access": "global", "required": false, "default": "", "description": "The activeSectionName changes the default expanded section. The first section in the accordion is expanded by default." }, { "name": "allowMultipleSectionsOpen", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "If true, all sections will be closed by default and the accordion will allow multiple sections open at a time." }, { "name": "onsectiontoggle", "type": "action", "access": "global", "required": false, "default": false, "description": "Action fired when the open sections change, it contains all open sections." } ], "accordionSection": [ { "name": "name", "type": "String", "access": "global", "required": false, "default": "", "description": "The unique section name to use with the activeSectionName attribute in the lightning:accordion component." }, { "name": "label", "type": "String", "access": "global", "required": false, "default": "", "description": "The text that displays as the title of the section." }, { "name": "actions", "type": "component[]", "access": "global", "required": false, "default": "", "description": "Enables a custom menu implementation. Actions are displayed to the right of the section title." } ], "avatar": [ { "name": "variant", "type": "String", "access": "global", "required": false, "default": "square", "description": "The variant changes the shape of the avatar. Valid values are empty, circle, and square. This value defaults to square." }, { "name": "size", "type": "String", "access": "global", "required": false, "default": "medium", "description": "The size of the avatar. Valid values are x-small, small, medium, and large. This value defaults to medium." }, { "name": "src", "type": "String", "access": "global", "required": true, "default": "", "description": "The URL for the image." }, { "name": "alternativeText", "type": "String", "access": "global", "required": true, "default": "", "description": "The alternative text used to describe the avatar, which is displayed as hover text on the image." }, { "name": "fallbackIconName", "type": "String", "access": "global", "required": false, "default": "", "description": "The Lightning Design System name of the icon used as a fallback when the image fails to load. The initials fallback relies on this for its background color. Names are written in the format 'standard:account' where 'standard' is the category, and 'account' is the specific icon to be displayed. Only icons from the standard and custom categories are allowed." }, { "name": "initials", "type": "String", "access": "global", "required": false, "default": "", "description": "If the record name contains two words, like first and last name, use the first capitalized letter of each. For records that only have a single word name, use the first two letters of that word using one capital and one lower case letter." } ], "badge": [ { "name": "label", "type": "String", "access": "global", "required": false, "default": "", "description": "The text that displays as the title of the section." } ], "breadcrumb": [ { "name": "label", "type": "String", "access": "global", "required": true, "default": "", "description": "The text label for the breadcrumb." }, { "name": "href", "type": "String", "access": "global", "required": false, "default": "", "description": "The URL of the page that the breadcrumb goes to." }, { "name": "onclick", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the breadcrumb is clicked." }, { "name": "name", "type": "String", "access": "global", "required": false, "default": "", "description": "The name for the breadcrumb component. This value is optional and can be used to identify the breadcrumb in a callback." } ], "breadcrumbs": [], "button": [ { "name": "name", "type": "String", "access": "global", "required": false, "default": "", "description": "The name for the button element. This value is optional and can be used to identify the button in a callback." }, { "name": "value", "type": "String", "access": "global", "required": false, "default": "", "description": "The value for the button element. This value is optional and can be used when submitting a form." }, { "name": "label", "type": "String", "access": "global", "required": false, "default": "", "description": "The text to be displayed inside the button" }, { "name": "variant", "type": "String", "access": "global", "required": false, "default": "neutral", "description": "The variant changes the appearance of the button. Accepted variants include base, neutral, brand, destructive, inverse and success. This value defaults to neutral." }, { "name": "iconName", "type": "String", "access": "global", "required": false, "default": "", "description": "The Lightning Design System name of the icon. Names are written in the format 'utility:down' where 'utility' is the category, and 'down' is the specific icon to be displayed." }, { "name": "iconPosition", "type": "String", "access": "global", "required": false, "default": "left", "description": "Describes the position of the icon with respect to body. Options include left and right. This value defaults to left" }, { "name": "disabled", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Specifies whether this button should be displayed in a disabled state. Disabled buttons can't be clicked. This value defaults to false." }, { "name": "onclick", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the button is clicked." }, { "name": "type", "type": "String", "access": "global", "required": false, "default": "button", "description": "Specifies the type of button. Valid values are button, reset, and submit. This value defaults to button" }, { "name": "ariaLabel", "type": "String", "access": "global", "required": false, "default": "", "description": "Label describing the button to assistive technologies." }, { "name": "ariaDescribedBy", "type": "String", "access": "global", "required": false, "default": "", "description": "A space-separated list of element IDs that provides descriptive labels for the button." }, { "name": "ariaControls", "type": "String", "access": "global", "required": false, "default": "", "description": "A space-separated list of element IDs that this button controls the contents or presence of." }, { "name": "ariaExpanded", "type": "String", "access": "global", "required": false, "default": "", "description": "Indicates whether an element the button controls is expanded or collapsed. Valid values are 'true' or 'false'." }, { "name": "ariaLive", "type": "String", "access": "global", "required": false, "default": "", "description": "Indicates that the button will be updated. Valid values are 'assertive', 'polite', or 'off'." }, { "name": "ariaAtomic", "type": "String", "access": "global", "required": false, "default": "", "description": "Indicates whether assistive technologies will present all, or only parts of, the changed region. Valid values are 'true' or 'false'." } ], "buttonGroup": [], "buttonIcon": [ { "name": "name", "type": "String", "access": "global", "required": false, "default": "", "description": "The name for the button element. This value is optional and can be used to identify the button in a callback." }, { "name": "value", "type": "String", "access": "global", "required": false, "default": "", "description": "The value for the button element. This value is optional and can be used when submitting a form." }, { "name": "iconName", "type": "String", "access": "global", "required": true, "default": "", "description": "The Lightning Design System name of the icon. Names are written in the format 'utility:down' where 'utility' is the category, and 'down' is the specific icon to be displayed. Only utility icons can be used in this component." }, { "name": "iconClass", "type": "String", "access": "global", "required": false, "default": "", "description": "The class to be applied to the contained icon element." }, { "name": "variant", "type": "String", "access": "global", "required": false, "default": "border", "description": "The variant changes the appearance of buttonIcon. Accepted variants include bare, container, brand, border, border-filled, bare-inverse, and border-inverse. This value defaults to border." }, { "name": "size", "type": "String", "access": "global", "required": false, "default": "medium", "description": "The size of the buttonIcon. For the bare variant, options include x-small, small, medium, and large. For non-bare variants, options include xx-small, x-small, small, and medium. This value defaults to medium." }, { "name": "disabled", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Specifies whether this button should be displayed in a disabled state. Disabled buttons can't be clicked. This value defaults to false." }, { "name": "alternativeText", "type": "String", "access": "global", "required": true, "default": "", "description": "The alternative text used to describe the icon. This text should describe what happens when you click the button, for example 'Upload File', not what the icon looks like, 'Paperclip'." }, { "name": "onclick", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the button is clicked." }, { "name": "type", "type": "String", "access": "global", "required": false, "default": "button", "description": "Specifies the type of button. Valid values are button, reset, and submit. This value defaults to button" }, { "name": "tooltip", "type": "String", "access": "global", "required": false, "default": "button", "description": "Text to display when the user mouses over or focuses on the button. The tooltip is auto-positioned relative to the button and screen space." }, { "name": "ariaLabel", "type": "String", "access": "global", "required": false, "default": "", "description": "Label describing the button to assistive technologies." }, { "name": "ariaDescribedBy", "type": "String", "access": "global", "required": false, "default": "", "description": "A space-separated list of element IDs that provides descriptive labels for the button." }, { "name": "ariaControls", "type": "String", "access": "global", "required": false, "default": "", "description": "A space-separated list of element IDs that this button controls the contents or presence of." }, { "name": "ariaExpanded", "type": "String", "access": "global", "required": false, "default": "", "description": "Indicates whether an element the button controls is expanded or collapsed. Valid values are 'true' or 'false'." }, { "name": "ariaLive", "type": "String", "access": "global", "required": false, "default": "", "description": "Indicates that the button will be updated. Valid values are 'assertive', 'polite', or 'off'." }, { "name": "ariaAtomic", "type": "String", "access": "global", "required": false, "default": "", "description": "Indicates whether assistive technologies will present all, or only parts of, the changed region. Valid values are 'true' or 'false'." } ], "buttonIconStateful": [ { "name": "name", "type": "String", "access": "global", "required": false, "default": "", "description": "The name for the button element. This value is optional and can be used to identify the button in a callback." }, { "name": "value", "type": "String", "access": "global", "required": false, "default": "", "description": "The value for the button element. This value is optional and can be used when submitting a form." }, { "name": "iconName", "type": "String", "access": "global", "required": true, "default": "", "description": "The Lightning Design System name of the icon. Names are written in the format 'utility:down' where 'utility' is the category, and 'down' is the specific icon to be displayed. Only utility icons can be used in this component." }, { "name": "size", "type": "String", "access": "global", "required": false, "default": "medium", "description": "The size of the buttonIcon. For the bare variant, options include x-small, small, medium, and large. For non-bare variants, options include xx-small, x-small, small, and medium. This value defaults to medium." }, { "name": "disabled", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Specifies whether this button should be displayed in a disabled state. Disabled buttons can't be clicked. This value defaults to false." }, { "name": "alternativeText", "type": "String", "access": "global", "required": true, "default": "", "description": "The alternative text used to describe the icon. This text should describe what happens when you click the button, for example 'Upload File', not what the icon looks like, 'Paperclip'." }, { "name": "onclick", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the button is clicked." }, { "name": "selected", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Specifies whether button is in selected state or not" } ], "buttonMenu": [ { "name": "label", "type": "String", "access": "global", "required": false, "default": "", "description": "Optional text to be shown on the button" }, { "name": "variant", "type": "String", "access": "global", "required": false, "default": "border", "description": "The variant changes the look of the button. Accepted variants include bare, container, border, border-filled, bare-inverse, and border-inverse. This value defaults to border." }, { "name": "onselect", "type": "action", "access": "global", "required": false, "default": "", "description": "Action fired when a menu item is selected. The 'detail.menuItem' property of the passed event is the selected menu item." }, { "name": "menuAlignment", "type": "String", "access": "global", "required": false, "default": "left", "description": "Determines the alignment of the menu relative to the button. Available options are: auto, left, center, right, bottom-left, bottom-center, bottom-right. The auto option aligns the dropdown menu based on available space. This value defaults to left." }, { "name": "iconName", "type": "String", "access": "global", "required": false, "default": "utility:down", "description": "The name of the icon to be used in the format 'utility:down'. This value defaults to utility:down. If an icon other than utility:down or utility:chevrondown is used, a utility:down icon is appended to the right of that icon." }, { "name": "iconSize", "type": "String", "access": "global", "required": false, "default": "medium", "description": "The size of the icon. Options include xx-small, x-small, medium, or large. This value defaults to medium." }, { "name": "disabled", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "If true, the menu is disabled. Disabling the menu prevents users from opening it. This value defaults to false." }, { "name": "visible", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "If true, the menu items are displayed. This value defaults to false." }, { "name": "alternativeText", "type": "String", "access": "global", "required": false, "default": "", "description": "The assistive text for the button." }, { "name": "name", "type": "String", "access": "global", "required": false, "default": "", "description": "The name for the button element. This value is optional and can be used to identify the button in a callback." }, { "name": "value", "type": "String", "access": "global", "required": false, "default": "", "description": "The value for the button element. This value is optional and can be used when submitting a form." }, { "name": "isLoading", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "If true, the menu is in a loading state and shows a spinner. This value defaults to false." }, { "name": "loadingStateAlternativeText", "type": "String", "access": "global", "required": false, "default": "", "description": "Message displayed while the menu is in the loading state." }, { "name": "isDraft", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "If true, the menu trigger shows a draft indicator. This value defaults to false." }, { "name": "draftAlternativeText", "type": "String", "access": "global", "required": false, "default": "", "description": "Describes the reason for showing the draft indicator. This is required when the isDraft attribute is true." }, { "name": "tooltip", "type": "String", "access": "global", "required": false, "default": "", "description": "Text to display when the user mouses over or focuses on the button. The tooltip is auto-positioned relative to the button and screen space." }, { "name": "onopen", "type": "action", "access": "global", "required": false, "default": "", "description": "Action fired when the menu is opened." } ], "buttonStateful": [ { "name": "state", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "The state of the button, which shows whether the button has been selected or not. The default state is false." }, { "name": "labelWhenOff", "type": "String", "access": "global", "required": true, "default": "", "description": "The text to be displayed inside the button when state is false." }, { "name": "labelWhenOn", "type": "String", "access": "global", "required": true, "default": "", "description": "The text to be displayed inside the button when state is true." }, { "name": "labelWhenHover", "type": "String", "access": "global", "required": false, "default": "", "description": "The text to be displayed inside the button when state is true and the button receives focus." }, { "name": "iconNameWhenOff", "type": "String", "access": "global", "required": false, "default": "", "description": "The name of the icon to be used in the format 'utility:add' when the state is false." }, { "name": "iconNameWhenOn", "type": "String", "access": "global", "required": false, "default": "", "description": "The name of the icon to be used in the format 'utility:check' when the state is true." }, { "name": "iconNameWhenHover", "type": "String", "access": "global", "required": false, "default": "", "description": "The name of the icon to be used in the format 'utility:close' when the state is true and the button receives focus." }, { "name": "variant", "type": "String", "access": "global", "required": false, "default": "neutral", "description": "The variant changes the appearance of the button. Accepted variants include brand, destructive, inverse, neutral, success, and text. This value defaults to neutral." }, { "name": "onclick", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the button is clicked" } ], "card": [ { "name": "iconName", "type": "String", "access": "global", "required": false, "default": "", "description": "The Lightning Design System name of the icon. Names are written in the format 'utility:down' where 'utility' is the category, and 'down' is the specific icon to be displayed. The icon is displayed in the header to the left of the title." }, { "name": "actions", "type": "component[]", "access": "global", "required": false, "default": "", "description": "Actions are components such as button or buttonIcon. Actions are displayed in the header." }, { "name": "variant", "type": "String", "access": "global", "required": false, "default": "base", "description": "The variant changes the appearance of the card. Accepted variants include base or narrow. This value defaults to base." }, { "name": "footer", "type": "Object", "access": "global", "required": false, "default": "", "description": "The footer can include text or another component" }, { "name": "title", "type": "Object", "access": "global", "required": true, "default": "", "description": "The title can include text or another component, and is displayed in the header." } ], "carousel": [ { "name": "scrollDuration", "type": "Integer", "access": "global", "required": false, "default": 5, "description": "The auto scroll duration. The default is 5 seconds, after that the next image is displayed." }, { "name": "disableAutoScroll", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Specifies whether auto scroll is disabled. The default value is false." }, { "name": "disableAutoRefresh", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Specifies whether the carousel should stop looping from the beginning after the last item is displayed. The default value is false." } ], "checkboxGroup": [ { "name": "name", "type": "String", "access": "global", "required": true, "default": "", "description": "The name of the checkbox group." }, { "name": "label", "type": "String", "access": "global", "required": true, "default": "", "description": "Text label for the checkbox group." }, { "name": "options", "type": "List", "access": "global", "required": true, "default": "", "description": "Array of label-value pairs for each checkbox." }, { "name": "value", "type": "String[]", "access": "global", "required": true, "default": "", "description": "The list of selected checkboxes. Each array entry contains the value of a selected checkbox. The value of each checkbox is set in the options attribute." }, { "name": "variant", "type": "String", "access": "global", "required": false, "default": "standard", "description": "The variant changes the appearance of the checkbox group. Accepted variants include standard, label-hidden, label-inline, and label-stacked. This value defaults to standard. Use label-hidden to hide the label but make it available to assistive technology. Use label-inline to horizontally align the label and checkbox group. Use label-stacked to place the label above the checkbox group." }, { "name": "messageWhenValueMissing", "type": "String", "access": "global", "required": false, "default": "", "description": "Optional message displayed when no checkbox is selected and the required attribute is set to true." }, { "name": "required", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Set to true if at least one checkbox must be selected. This value defaults to false." }, { "name": "disabled", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Set to true if the checkbox group is disabled. Checkbox selections can't be changed for a disabled checkbox group. This value defaults to false." }, { "name": "onchange", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when a checkbox value changes." } ], "clickToDial": [ { "name": "value", "type": "String", "access": "global", "required": true, "default": "", "description": "The phone number." }, { "name": "recordId", "type": "String", "access": "global", "required": false, "default": "", "description": "The Salesforce record Id that's associated with the phone number." }, { "name": "params", "type": "String", "access": "global", "required": false, "default": "", "description": "Comma-separated list of parameters to pass to the third-party phone system." } ], "combobox": [ { "name": "options", "type": "Object[]", "access": "global", "required": true, "default": "", "description": "A list of options that are available for selection. Each option has the following attributes: label and value." }, { "name": "label", "type": "String", "access": "global", "required": true, "default": "", "description": "Text label for the combobox." }, { "name": "placeholder", "type": "String", "access": "global", "required": false, "default": "Select an Option", "description": "Text that is displayed before an option is selected, to prompt the user to select an option. The default is \"Select an Option\"." }, { "name": "dropdownAlignment", "type": "String", "access": "global", "required": false, "default": "left", "description": "Specifies where the drop-down list is aligned with or anchored to the selection field. By default the list is aligned with the selection field at the top so the list opens down. Use bottom-left to make the selection field display at the bottom so the list opens above it. Use auto to let the component determine where to open the list based on space available." }, { "name": "messageWhenValueMissing", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message to be displayed when the value is missing and input is required." }, { "name": "fieldLevelHelp", "type": "String", "access": "global", "required": false, "default": "", "description": "Help text detailing the purpose and function of the combobox." }, { "name": "spinnerActive", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Displays a spinner to indicate activity in the dropdown list. This value defaults to false." } ], "container": [ { "name": "class", "type": "String", "access": "global", "required": true, "default": "", "description": "The CSS class for the iframe element." }, { "name": "src", "type": "String", "access": "global", "required": true, "default": "", "description": "The resource name, landing page and query params in url format. Navigation is supported only for the single page identified." }, { "name": "alternativeText", "type": "String", "access": "global", "required": false, "default": "", "description": "Used for alternative text in accessibility scenarios." }, { "name": "onmessage", "type": "action", "access": "global", "required": false, "default": "", "description": "The client-side controller action to run when a message is received from the contained content." }, { "name": "onerror", "type": "action", "access": "global", "required": false, "default": "", "description": "The client-side controller action to run when an error occurs when sending a message to the contained app." } ], "datatable": [ { "name": "columns", "type": "Object", "access": "global", "required": false, "default": "", "description": "Array of the columns object that's used to define the data types. Required properties include 'label', 'dataKey', and 'type'. The default type is 'text'." }, { "name": "data", "type": "Object", "access": "global", "required": false, "default": "", "description": "The array of data to be displayed." }, { "name": "keyField", "type": "String", "access": "global", "required": true, "default": "", "description": "Required for better performance. Associates each row with a unique ID." }, { "name": "hideCheckboxColumn", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Hides or displays the checkbox column for row selection. To hide the checkbox column, set hideCheckboxColumn to true. The default is false." }, { "name": "hideTableHeader", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Specifies whether the table header should be hidden." }, { "name": "resizeColumnDisabled", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Specifies whether column resizing is disabled. The default is false." }, { "name": "suppressBottomBar", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Specifies whether the inline edit Save/Cancel bottom bar should be hidden." }, { "name": "minColumnWidth", "type": "Integer", "access": "global", "required": false, "default": "", "description": "The minimum width for all columns. The default is 50px." }, { "name": "maxColumnWidth", "type": "Integer", "access": "global", "required": false, "default": "", "description": "The maximum width for all columns. The default is 1000px." }, { "name": "resizeStep", "type": "Integer", "access": "global", "required": false, "default": "", "description": "The width to resize the column when user press left or right arrow. The default is 10px." }, { "name": "sortedBy", "type": "String", "access": "global", "required": false, "default": "", "description": "The column fieldName that controls the sorting order. Sort the data using the onsort event handler." }, { "name": "sortedDirection", "type": "String", "access": "global", "required": false, "default": "", "description": "Specifies the sorting direction. Sort the data using the onsort event handler. Valid options include 'asc' and 'desc'." }, { "name": "defaultSortDirection", "type": "String", "access": "global", "required": false, "default": "", "description": "Specifies the default sorting direction on an unsorted column. Valid options include 'asc' and 'desc'. The default is 'asc' for sorting in ascending order." }, { "name": "showRowNumberColumn", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Shows or hides the row number column. Set to true to show the row number column. The default is false." }, { "name": "rowNumberOffset", "type": "Integer", "access": "global", "required": false, "default": "", "description": "Determines where to start counting the row number. The default is 0." }, { "name": "enableInfiniteLoading", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Enables or disables infinite loading. The default is false." }, { "name": "loadMoreOffset", "type": "Integer", "access": "global", "required": false, "default": "", "description": "Determines when to trigger infinite loading based on how many pixels the table's scroll position is from the bottom of the table. The default is 20." }, { "name": "isLoading", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Specifies whether more data is being loaded and displays a spinner if so. The default is false." }, { "name": "maxRowSelection", "type": "Integer", "access": "global", "required": false, "default": "", "description": "The maximum number of rows that can be selected. Checkboxes are used for selection by default, and radio buttons are used when maxRowSelection is 1." }, { "name": "selectedRows", "type": "List", "access": "global", "required": false, "default": "", "description": "Enables programmatic row selection with a list of keyField values." }, { "name": "errors", "type": "Object", "access": "global", "required": false, "default": "", "description": "Specifies an object containing information about cell level, row level, and table level errors. When it's set, error messages are displayed on the table accordingly." }, { "name": "draftValues", "type": "Object", "access": "global", "required": false, "default": "", "description": "The current values per row that are provided during inline edit." }, { "name": "oncellchange", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when a cell's value changes after an inline edit. Returns the draftValues object." }, { "name": "onloadmore", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when infinite loading loads more data." }, { "name": "onrowselection", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when a row is selected. Returns the selectedRows object." }, { "name": "onsort", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when a column is sorted. Returns fieldName and sortDirection." }, { "name": "onheaderaction", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when a header action is clicked. By default, it also closes the header actions menu. Returns the action and columnDefinition objects." }, { "name": "onrowaction", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when a row action is clicked. By default, it also closes the row actions menu. Returns the eventDetails object." }, { "name": "onresize", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the table renders columns the first time and every time its resized an specific column. Returns columnWidths." }, { "name": "onsave", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when clicking on the table footer bar's save button during inline edit. Returns the draftValues object." }, { "name": "oncancel", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when clicking on the table footer bar's cancel button during inline edit. All edited cells are reverted to their original values." } ], "dualListbox": [ { "name": "label", "type": "String", "access": "global", "required": true, "default": "", "description": "Label for the dual listbox." }, { "name": "sourceLabel", "type": "String", "access": "global", "required": true, "default": "", "description": "Label for source options listbox." }, { "name": "selectedLabel", "type": "String", "access": "global", "required": true, "default": "", "description": "Label for selected options listbox." }, { "name": "options", "type": "Object[]", "access": "global", "required": true, "default": "", "description": "A list of options that are available for selection. Each option has the following attributes: label and value." }, { "name": "downButtonLabel", "type": "String", "access": "global", "required": false, "default": "Move selection down", "description": "Label for down button." }, { "name": "removeButtonLabel", "type": "String", "access": "global", "required": false, "default": "Move selection to {sourceLabel}", "description": "Label for remove button." }, { "name": "addButtonLabel", "type": "String", "access": "global", "required": false, "default": "Move selection to {selectedLabel}", "description": "Label for add button." }, { "name": "upButtonLabel", "type": "String", "access": "global", "required": false, "default": "Move selection up", "description": "Label for up button." }, { "name": "requiredOptions", "type": "List", "access": "global", "required": false, "default": "", "description": "A list of required options that cannot be removed from selected options listbox. This list is populated with values from options attribute." }, { "name": "values", "type": "List", "access": "global", "required": false, "default": "", "description": "A list of default options that are included in the selected options listbox. This list is populated with values from the options attribute." }, { "name": "fieldLevelHelp", "type": "String", "access": "global", "required": false, "default": "", "description": "Help text detailing the purpose and function of the dual listbox." }, { "name": "min", "type": "Integer", "access": "global", "required": false, "default": "", "description": "Minimum number of options required in the selected options listbox." }, { "name": "max", "type": "Integer", "access": "global", "required": false, "default": "", "description": "Maximum number of options required in the selected options listbox." }, { "name": "disableReordering", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Set to true to hide the Up and Down buttons used for reordering the Selected list items." }, { "name": "size", "type": "Integer", "access": "global", "required": false, "default": "", "description": "Number of items that display before vertical scrollbars are displayed for the listboxes. Determines the vertical size of the dual listbox." }, { "name": "showActivityIndicator", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Displays a spinner to indicate activity in the listbox. This value defaults to false." } ], "dynamicIcon": [ { "name": "type", "type": "String", "access": "global", "required": true, "default": "", "description": "The Lightning Design System name of the dynamicIcon. Valid values are: ellie, eq, score, strength, trend, and waffle." }, { "name": "option", "type": "String", "access": "global", "required": false, "default": "", "description": "The option attribute changes the appearance of the dynamicIcon. The options available depend on the type attribute. For eq: play (default) or stop For score: positive (default) or negative For strength: -3, -2, -1, 0 (default), 1, 2, 3 For trend: neutral (default), up, or down" }, { "name": "alternativeText", "type": "String", "access": "global", "required": false, "default": "", "description": "The alternative text used to describe the dynamicIcon. This text should describe what’s happening. For example, 'Graph is refreshing', not what the icon looks like, 'Graph'." }, { "name": "onclick", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the icon is clicked." } ], "fileCard": [ { "name": "fileId", "type": "String", "access": "global", "required": true, "default": "", "description": "The Salesforce File ID (ContentDocument)." }, { "name": "description", "type": "String", "access": "global", "required": false, "default": "", "description": "The description of the file, by default it is set to the filename" }, { "name": "hideDescription", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Hides the file description in the caption if enabled" } ], "fileUpload": [ { "name": "label", "type": "String", "access": "global", "required": true, "default": "", "description": "The text label for the file uploader." }, { "name": "name", "type": "String", "access": "global", "required": true, "default": "", "description": "Specifies the name of the input element." }, { "name": "recordId", "type": "String", "access": "global", "required": true, "default": "", "description": "The record Id of the record that the uploaded file is associated to." }, { "name": "multiple", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Specifies whether a user can upload more than one file simultanesouly. This value defaults to false." }, { "name": "disabled", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Specifies whether this component should be displayed in a disabled state. Disabled components can't be clicked. This value defaults to false." }, { "name": "accept", "type": "List", "access": "global", "required": false, "default": "", "description": "Comma-separated list of file extensions that can be uploaded in the format .ext, such as .pdf, .jpg, or .png" }, { "name": "onuploadfinished", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when files have finished uploading." } ], "flexipageRegionInfo": [ { "name": "width", "type": "String", "access": "global", "required": false, "default": "", "description": "The width of the region that the component resides in." } ], "flow": [ { "name": "onstatuschange", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the interview’s status changes or a new screen is displayed." } ], "formattedAddress": [ { "name": "street", "type": "String", "access": "global", "required": false, "default": "", "description": "The street detail for the address." }, { "name": "city", "type": "String", "access": "global", "required": false, "default": "", "description": "The city detail for the address." }, { "name": "province", "type": "String", "access": "global", "required": false, "default": "", "description": "The province detail for the address." }, { "name": "country", "type": "String", "access": "global", "required": false, "default": "", "description": "The country detail for the address." }, { "name": "postalCode", "type": "String", "access": "global", "required": false, "default": "", "description": "The postalCode detail for the address." }, { "name": "latitude", "type": "Decimal", "access": "global", "required": false, "default": "", "description": "The latitude of the location if known. Latitude values must be within -90 and 90." }, { "name": "longitude", "type": "Decimal", "access": "global", "required": false, "default": "", "description": "The longitude of the location if known. Longitude values must be within -180 and 180." }, { "name": "disabled", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Specifies whether the address is clickable. This value defaults to false." }, { "name": "showStaticMap", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Displays a static map of the location using Google Maps. This value defaults to false." } ], "formattedDateTime": [ { "name": "value", "type": "Object", "access": "global", "required": true, "default": "", "description": "The value to be formatted, which can be a Date object, timestamp, or an ISO8601 formatted string." }, { "name": "hour12", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Determines whether time is displayed as 12-hour. If false, time displays as 24-hour. The default setting is determined by the user's locale." }, { "name": "hour12", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Determines whether time is displayed as 12-hour. If false, time displays as 24-hour. The default setting is determined by the user's locale." }, { "name": "weekday", "type": "String", "access": "global", "required": false, "default": "", "description": "Specifies how to display the day of the week. Allowed values are narrow, short, or long." }, { "name": "era", "type": "String", "access": "global", "required": false, "default": "", "description": "Allowed values are narrow, short, or long." }, { "name": "year", "type": "String", "access": "global", "required": false, "default": "", "description": "Allowed values are numeric or 2-digit." }, { "name": "month", "type": "String", "access": "global", "required": false, "default": "", "description": "Allowed values are 2-digit, narrow, short, or long." }, { "name": "day", "type": "String", "access": "global", "required": false, "default": "", "description": "Allowed values are numeric or 2-digit." }, { "name": "hour", "type": "String", "access": "global", "required": false, "default": "", "description": "Allowed values are numeric or 2-digit." }, { "name": "minute", "type": "String", "access": "global", "required": false, "default": "", "description": "Allowed values are numeric or 2-digit." }, { "name": "second", "type": "String", "access": "global", "required": false, "default": "", "description": "Allowed values are numeric or 2-digit." }, { "name": "timeZoneName", "type": "String", "access": "global", "required": false, "default": "", "description": "Display style of the time zone. Allowed values are short or long. For example, the Pacific time zone displays as 'PST' if you specify 'short', or 'Pacific Standard Time' if you specify 'long.'" }, { "name": "timeZone", "type": "String", "access": "global", "required": false, "default": "", "description": "The time zone to display. Use this attribute only if you want to override the default, which is the runtime environment's time zone. Specify a time zone listed in the IANA time zone database (https://www.iana.org/time-zones). For example, set the value to 'Pacific/Honolulu' to display Hawaii time. The short code UTC is also accepted." } ], "formattedEmail": [ { "name": "value", "type": "String", "access": "global", "required": true, "default": "", "description": "The email address that's displayed if a label is not provided." }, { "name": "label", "type": "String", "access": "global", "required": false, "default": "", "description": "The text label for the email." }, { "name": "hideIcon", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "If true, hides the email icon so only the email address is displayed." }, { "name": "onclick", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the email is clicked." } ], "formattedLocation": [ { "name": "latitude", "type": "Decimal", "access": "global", "required": true, "default": "", "description": "The latitude value of the geolocation. Latitude values must be within -90 and 90." }, { "name": "longitude", "type": "Decimal", "access": "global", "required": true, "default": "", "description": "The longitude value of the geolocation. Longitude values must be within -180 and 180." } ], "formattedName": [ { "name": "firstName", "type": "String", "access": "global", "required": false, "default": "", "description": "The value for the first name." }, { "name": "salutation", "type": "String", "access": "global", "required": false, "default": "", "description": "The value for the salutation, such as Dr. or Mrs." }, { "name": "lastName", "type": "String", "access": "global", "required": false, "default": "", "description": "The value for the last name." }, { "name": "middleName", "type": "String", "access": "global", "required": false, "default": "", "description": "The value for the middle name." }, { "name": "suffix", "type": "String", "access": "global", "required": false, "default": "", "description": "The value for the suffix." }, { "name": "informalName", "type": "String", "access": "global", "required": false, "default": "", "description": "The value for the informal name." }, { "name": "format", "type": "String", "access": "global", "required": false, "default": "long", "description": "The format for which to display the name. Valid values include short, medium, and long. This value defaults to long." } ], "formattedNumber": [ { "name": "format", "type": "Decimal", "access": "global", "required": true, "default": "", "description": "The value to be formatted." }, { "name": "style", "type": "String", "access": "global", "required": false, "default": "decimal", "description": "The number formatting style to use. Possible values are decimal, currency, and percent. This value defaults to decimal." }, { "name": "currencyCode", "type": "String", "access": "global", "required": false, "default": "", "description": "Only used if style='currency', this attribute determines which currency is displayed. Possible values are the ISO 4217 currency codes, such as 'USD' for the US dollar." }, { "name": "currencyDisplayAs", "type": "String", "access": "global", "required": false, "default": "symbol", "description": "Determines how currency is displayed. Possible values are symbol, code, and name. This value defaults to symbol." }, { "name": "minimumIntegerDigits", "type": "Integer", "access": "global", "required": false, "default": "", "description": "The minimum number of integer digits that are required. Possible values are from 1 to 21." }, { "name": "minimumFractionDigits", "type": "Integer", "access": "global", "required": false, "default": "", "description": "The minimum number of fraction digits that are required." }, { "name": "maximumFractionDigits", "type": "Integer", "access": "global", "required": false, "default": "", "description": "The maximum number of fraction digits that are allowed." }, { "name": "minimumSignificantDigits", "type": "Integer", "access": "global", "required": false, "default": "", "description": "The minimum number of significant digits that are required. Possible values are from 1 to 21." }, { "name": "maximumSignificantDigits", "type": "Integer", "access": "global", "required": false, "default": "", "description": "The maximum number of significant digits that are allowed. Possible values are from 1 to 21." } ], "formattedPhone": [ { "name": "value", "type": "Integer", "access": "global", "required": false, "default": "", "description": "Sets the phone number to display." }, { "name": "onclick", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the phone number is clicked." } ], "formattedRichText": [ { "name": "value", "type": "String", "access": "global", "required": false, "default": "", "description": "Sets the rich text to display." }, { "name": "linkify", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Prevents the component from creating links in the rich text." } ], "formattedText": [ { "name": "value", "type": "String", "access": "global", "required": false, "default": "", "description": "Text to output." }, { "name": "disableLinkify", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Specifies whether the text should be converted to a link. If set to true, URLs and email addresses are displayed in anchor tags." } ], "formattedUrl": [ { "name": "value", "type": "String", "access": "global", "required": false, "default": "", "description": "The time value to format." } ], "formattedTime": [ { "name": "value", "type": "String", "access": "global", "required": false, "default": "", "description": "The URL to be formatted." }, { "name": "target", "type": "String", "access": "global", "required": false, "default": "", "description": "Specifies where to open the link. Options include _blank, _parent, _self, and _top." }, { "name": "label", "type": "String", "access": "global", "required": false, "default": "", "description": "The text to display in the link." }, { "name": "tooltip", "type": "String", "access": "global", "required": false, "default": "", "description": "The text to display when the mouse hovers over the link." } ], "helptext": [ { "name": "content", "type": "String", "access": "global", "required": false, "default": "", "description": "Text to be shown in the popover." }, { "name": "iconName", "type": "String", "access": "global", "required": false, "default": "utility:info", "description": "The Lightning Design System name of the icon used as the visible element. Names are written in the format 'utility:info' where 'utility' is the category, and 'info' is the specific icon to be displayed. The default value is 'utility:info'." }, { "name": "iconVariant", "type": "String", "access": "global", "required": false, "default": "", "description": "The iconVariant changes the appearance of the icon. Accepted variants include inverse, warning, error." } ], "icon": [ { "name": "iconName", "type": "String", "access": "global", "required": true, "default": "", "description": "The Lightning Design System name of the icon. Names are written in the format 'utility:down' where 'utility' is the category, and 'down' is the specific icon to be displayed." }, { "name": "size", "type": "String", "access": "global", "required": false, "default": "medium", "description": "The size of the icon. Options include xx-small, x-small, small, medium, or large. This value defaults to medium." }, { "name": "variant", "type": "String", "access": "global", "required": false, "default": "", "description": "The variant changes the appearance of a utility icon. Accepted variants include inverse, success, warning, and error. Use the inverse variant to implement a white fill in utility icons on dark backgrounds." }, { "name": "alternativeText", "type": "String", "access": "global", "required": false, "default": "", "description": "The alternative text used to describe the icon. This text should describe what happens when you click the button, for example 'Upload File', not what the icon looks like, 'Paperclip'." }, { "name": "src", "type": "String", "access": "global", "required": false, "default": "", "description": "A uri path to a custom svg sprite, including the name of the resouce, for example: /assets/icons/standard-sprite/svg/test.svg#icon-heart" } ], "input": [ { "name": "type", "type": "Object[]", "access": "global", "required": false, "default": "text", "description": "The type of the input. This value defaults to text." }, { "name": "label", "type": "String", "access": "global", "required": true, "default": "", "description": "Text label for the input." }, { "name": "formatter", "type": "String", "access": "global", "required": false, "default": "", "description": "String value with the formatter to be used for number input. Valid values include decimal, percent, percent-fixed, and currency." }, { "name": "files", "type": "Object", "access": "global", "required": false, "default": "", "description": "A FileList that contains selected files. Use this attribute with file input type only." }, { "name": "isLoading", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "For the search type only. Specifies whether the spinner is displayed to indicate that data is loading. This value defaults to false." }, { "name": "placeholder", "type": "String", "access": "global", "required": false, "default": "", "description": "Text that is displayed when the field is empty, to prompt the user for a valid entry." }, { "name": "maxlength", "type": "Integer", "access": "global", "required": false, "default": "", "description": "The maximum number of characters allowed in the field. Use this attribute with email, password, search, tel, text, and url input types only." }, { "name": "minlength", "type": "Integer", "access": "global", "required": false, "default": "", "description": "The minimum number of characters allowed in the field. Use this attribute with email, password, search, tel, text, and url input types only." }, { "name": "pattern", "type": "String", "access": "global", "required": false, "default": "", "description": "Specifies the regular expression that the input's value is checked against. Use this attribute with email, password, search, tel, text, and url input types only." }, { "name": "autocomplete", "type": "String", "access": "global", "required": false, "default": "", "description": "Controls auto-filling of the field. Use this attribute with email, search, tel, text, and url input types only. Set the attribute to pass through autocomplete values to be interpreted by the browser." }, { "name": "fieldLevelHelp", "type": "String", "access": "global", "required": false, "default": "", "description": "Help text detailing the purpose and function of the input. This attribute isn't supported for file, radio, toggle, and checkbox-button types." }, { "name": "max", "type": "Object", "access": "global", "required": false, "default": "", "description": "The maximum acceptable value for the input. Use this attribute with number, range, date, time, and datetime input types only. For number and range type, the max value is a decimal number. For the date, time, and datetime types, the max value must use a valid string for the type." }, { "name": "min", "type": "Object", "access": "global", "required": false, "default": "", "description": "The minimum acceptable value for the input. Use this attribute with number, range, date, time, and datetime input types only. For number and range type, the max value is a decimal number. For the date, time, and datetime types, the max value must use a valid string for the type." }, { "name": "step", "type": "Object", "access": "global", "required": false, "default": "1", "description": "Granularity of the value, specified as a positive floating point number. Use this attribute with number and range input types only. Use 'any' when granularity is not a concern. This value defaults to 1." }, { "name": "checked", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Specifies whether the checkbox is checked. This value defaults to false." }, { "name": "timezone", "type": "String", "access": "global", "required": false, "default": "", "description": "Specifies the time zone used when type='datetime' only. This value defaults to the user’s Salesforce time zone setting." }, { "name": "dateStyle", "type": "String", "access": "global", "required": false, "default": "", "description": "The display style of the date when type='date' or type='datetime'. Valid values are short, medium (default), and long. The format of each style is specific to the locale. On mobile devices this attribute has no effect." }, { "name": "timeStyle", "type": "String", "access": "global", "required": false, "default": "", "description": "The display style of the time when type='time' or type='datetime'. Valid values are short (default), medium, and long. Currently, medium and long styles look the same. On mobile devices this attribute has no effect." }, { "name": "accept", "type": "String", "access": "global", "required": false, "default": "", "description": "Specifies the types of files that the server accepts. Use this attribute with file input type only." }, { "name": "multiple", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Specifies that a user can enter more than one value. Use this attribute with file and email input types only." }, { "name": "messageWhenBadInput", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message to be displayed when a bad input is detected." }, { "name": "messageWhenPatternMismatch", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message to be displayed when a pattern mismatch is detected." }, { "name": "messageWhenTypeMismatch", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message to be displayed when a type mismatch is detected." }, { "name": "messageWhenValueMissing", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message to be displayed when the value is missing." }, { "name": "messageWhenRangeOverflow", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message to be displayed when a range overflow is detected." }, { "name": "messageWhenRangeUnderflow", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message to be displayed when a range underflow is detected." }, { "name": "messageWhenStepMismatch", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message to be displayed when a step mismatch is detected." }, { "name": "messageWhenTooLong", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message to be displayed when the value is too long." }, { "name": "messageWhenTooShort", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message to be displayed when the value is too short" }, { "name": "messageToggleActive", "type": "String", "access": "global", "required": false, "default": "$Label.LightningControl.activeCapitalized", "description": "Text shown for the active state of a toggle. The default is \"Active\"." }, { "name": "messageToggleActive", "type": "String", "access": "global", "required": false, "default": "$Label.LightningControl.inactiveCapitalized", "description": "TText shown for then inactive state of a toggle. The default is \"Inactive\"." }, { "name": "ariaLabel", "type": "String", "access": "global", "required": false, "default": "", "description": "Describes the input to assistive technologies." }, { "name": "ariaLabelledBy", "type": "String", "access": "global", "required": false, "default": "", "description": "A space-separated list of element IDs that provide labels for the input." }, { "name": "ariaDescribedBy", "type": "String", "access": "global", "required": false, "default": "", "description": "A space-separated list of element IDs that provide descriptive labels for the input." }, { "name": "ariaControls", "type": "String", "access": "global", "required": false, "default": "", "description": "A space-separated list of element IDs whose presence or content is controlled by the input." }, { "name": "timeAriaLabel", "type": "String", "access": "global", "required": false, "default": "", "description": "Describes the time input to assistive technologies when type=datetime. On mobile devices, this label is merged with ariaLabel and dateAriaLabel to describe the native date time input." }, { "name": "timeAriaLabelledBy", "type": "String", "access": "global", "required": false, "default": "", "description": "A space-separated list of element IDs that provide descriptive labels for the time input when type=datetime. On mobile devices, this is merged with ariaDescribedBy and dateAriaDescribedBy to describe the native date time input." }, { "name": "timeAriaControls", "type": "String", "access": "global", "required": false, "default": "", "description": "A space-separated list of element IDs whose presence or content is controlled by the time input when type=datetime. On mobile devices, this is merged with ariaControls and dateAriaControls to describe the native date time input." }, { "name": "dateAriaLabel", "type": "String", "access": "global", "required": false, "default": "", "description": "Describes the date input to assistive technologies when type=datetime. On mobile devices, this label is merged with ariaLabel and timeAriaLabel to describe the native date time input." }, { "name": "dateAriaLabelledBy", "type": "String", "access": "global", "required": false, "default": "", "description": "A space-separated list of element IDs that provide labels for the date input when type=datetime. On mobile devices, this is merged with ariaLabelledBy and timeAriaLabelledBy to describe the native date time input." }, { "name": "dateAriaDescribedBy", "type": "String", "access": "global", "required": false, "default": "", "description": "A space-separated list of element IDs that provide descriptive labels for the date input when type=datetime. On mobile devices, this is merged with ariaDescribedBy and timeAriaDescribedBy to describe the native date time input." }, { "name": "dateAriaControls", "type": "String", "access": "global", "required": false, "default": "", "description": "A space-separated list of element IDs whose presence or content is controlled by the date input when type=datetime. On mobile devices, this is merged with ariaControls and timeAriaControls to describe the native date time input." } ], "inputAddress": [ { "name": "addressLabel", "type": "String", "access": "global", "required": false, "default": "", "description": "The label of the address compound field." }, { "name": "fieldLevelHelp", "type": "String", "access": "global", "required": false, "default": "", "description": "Help text detailing the purpose and function of the address compound field." }, { "name": "streetLabel", "type": "String", "access": "global", "required": false, "default": "", "description": "The label of the street field of the address." }, { "name": "cityLabel", "type": "String", "access": "global", "required": false, "default": "", "description": "The label of the city field of the address." }, { "name": "provinceLabel", "type": "String", "access": "global", "required": false, "default": "", "description": "The label of the province field of the address." }, { "name": "countryLabel", "type": "String", "access": "global", "required": false, "default": "", "description": "The label of the country field of the address." }, { "name": "postalCodeLabel", "type": "String", "access": "global", "required": false, "default": "", "description": "The label of the postal code field of the address." }, { "name": "street", "type": "String", "access": "global", "required": false, "default": "", "description": "The street field of the address." }, { "name": "city", "type": "String", "access": "global", "required": false, "default": "", "description": "The city field of the address." }, { "name": "province", "type": "String", "access": "global", "required": false, "default": "", "description": "The province field of the address." }, { "name": "provinceOptions", "type": "List", "access": "global", "required": false, "default": "", "description": "The array of label-value pairs for the province. Displays a dropdown menu of options." }, { "name": "country", "type": "String", "access": "global", "required": false, "default": "", "description": "The country field of the address." }, { "name": "countryOptions", "type": "List", "access": "global", "required": false, "default": "", "description": "The array of label-value pairs for the country. Displays a dropdown menu of options." }, { "name": "postalCode", "type": "String", "access": "global", "required": false, "default": "", "description": "The postal code field of the address." }, { "name": "disabled", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Specifies whether the address fields are disabled. This value defaults to false." }, { "name": "required", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Specifies whether the address fields are required. This value defaults to false." }, { "name": "readonly", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Specifies whether the address fields are read-only. This value defaults to false." }, { "name": "showAddressLookup", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Specifies whether to enable address lookup using Google Maps. This value defaults to false." }, { "name": "variant", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "The variant changes the appearance of the address compound field. Accepted variants include standard, label-inline, label-hidden, and label-stacked. This value defaults to standard. Use label-hidden to hide the label but make it available to assistive technology. Use label-inline to horizontally align the label and address fields. Use label-stacked to place the label above the address fields." } ], "inputField": [ { "name": "fieldName", "type": "String", "access": "global", "required": false, "default": "", "description": "The API name of the field to be displayed." }, { "name": "class", "type": "String", "access": "global", "required": false, "default": "", "description": "A CSS class for the outer element, in addition to the component's base classes." }, { "name": "value", "type": "String", "access": "global", "required": false, "default": "", "description": "The field value, which overrides the existing value." }, { "name": "onchange", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the input value changes." }, { "name": "disabled", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Whether or not the field is disabled. Defaults to false for readonly fields, true for other fields." }, { "name": "variant", "type": "String", "access": "global", "required": false, "default": "", "description": "The variant changes the label position of an input field. Accepted variants include standard (default), label-hidden, label-inline, and label-stacked. If variant is specified, the label position is determined by the variant. Otherwise, it is determined by the density setting of the parent form." } ], "inputLocation": [ { "name": "latitude", "type": "String", "access": "global", "required": false, "default": "", "description": "The latitude value. Latitude values must be within -90 and 90." }, { "name": "longitude", "type": "String", "access": "global", "required": false, "default": "", "description": "The longitude value. Longitude values must be within -180 and 180." }, { "name": "required", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Specifies whether the compound field must be filled out. An error message is displayed if a user interacts with the field and does not provide a value. This value defaults to false." }, { "name": "disabled", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Specifies whether the compound field should be disabled. Disabled fields are grayed out and not clickable. This value defaults to false." }, { "name": "readonly", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Specifies whether the compound field is read-only. This value defaults to false." }, { "name": "fieldLevelHelp", "type": "String", "access": "global", "required": false, "default": "", "description": "Help text detailing the purpose and function of geolocation compound field." }, { "name": "variant", "type": "String", "access": "global", "required": false, "default": "", "description": "The variant changes the appearance of the geolocation compound field. Accepted variants include standard, label-hidden, label-inline, and label-stacked. This value defaults to standard. This value defaults to standard. Use label-hidden to hide the label but make it available to assistive technology. Use label-inline to horizontally align the label and geolocation fields. Use label-stacked to place the label above the geolocation fields." }, { "name": "label", "type": "String", "access": "global", "required": false, "default": "", "description": "Text label for the geolocation compound field." } ], "inputName": [ { "name": "firstName", "type": "String", "access": "global", "required": false, "default": "", "description": "Displays the First Name field." }, { "name": "salutation", "type": "String", "access": "global", "required": false, "default": "", "description": "Displays the Salutation field as a dropdown menu. An array of label-value pairs must be provided using the options attribute." }, { "name": "lastName", "type": "String", "access": "global", "required": false, "default": "", "description": "Displays the Last Name field. This field is always displayed if you set required to true." }, { "name": "middleName", "type": "String", "access": "global", "required": false, "default": "", "description": "Displays the Middle Name field." }, { "name": "suffix", "type": "String", "access": "global", "required": false, "default": "", "description": "Displays the Suffix field." }, { "name": "informalName", "type": "String", "access": "global", "required": false, "default": "", "description": "Displays the Informal Name field." }, { "name": "options", "type": "List", "access": "global", "required": false, "default": "", "description": "Displays a list of salutation options, such as Dr. or Mrs., provided as label-value pairs." }, { "name": "required", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Specifies whether the compound field must be filled out. A red asterisk is displayed on the Last Name field. An error message is displayed if a user interacts with the Last Name field and does not provide a value. This value defaults to false." }, { "name": "disabled", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Specifies whether the compound field should be disabled. Disabled fields are grayed out and not clickable. This value defaults to false." }, { "name": "readonly", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Specifies whether the compound field is read-only. This value defaults to false." }, { "name": "variant", "type": "String", "access": "global", "required": false, "default": "", "description": "The variant changes the appearance of the name compound field. Accepted variants include standard, label-hidden, label-inline, and label-stacked. This value defaults to standard. This value defaults to standard. Use label-hidden to hide the label but make it available to assistive technology. Use label-inline to horizontally align the label and name fields. Use label-stacked to place the label above the name fields." }, { "name": "label", "type": "String", "access": "global", "required": false, "default": "", "description": "Text label for the compound field." }, { "name": "fieldsToDisplay", "type": "List", "access": "global", "required": false, "default": "['firstName', 'salutation', 'lastName']", "description": "List of fields to be displayed on the component. This value defaults to ['firstName', 'salutation', 'lastName']. Other field values include middleName, informalName, suffix." }, { "name": "fieldLevelHelp", "type": "String", "access": "global", "required": false, "default": "", "description": "Help text detailing the purpose and function of name compound field." } ], "inputRichText": [ { "name": "ariaLabel", "type": "String", "access": "global", "required": false, "default": "", "description": "Label describing the rich text editor to assistive technologies" }, { "name": "ariaLabelledby", "type": "String", "access": "global", "required": false, "default": "", "description": "An element ID that provides a label for the rich text editor." }, { "name": "ariaDescribedby", "type": "String", "access": "global", "required": false, "default": "", "description": "A space-separated list of element IDs that provides descriptive labels for the rich text editor." }, { "name": "label", "type": "String", "access": "global", "required": false, "default": "", "description": "Text label for the rich text editor." }, { "name": "labelVisible", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Specifies whether the label is visible or not. The default is false." }, { "name": "value", "type": "String", "access": "global", "required": false, "default": "", "description": "The HTML content in the rich text editor." }, { "name": "placeholder", "type": "String", "access": "global", "required": false, "default": "", "description": "Text that is displayed when the field is empty." }, { "name": "disabledCategories", "type": "List", "access": "global", "required": false, "default": "", "description": "A comma-separated list of button categories to remove from the toolbar." }, { "name": "disabled", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Specifies whether the editor is disabled. This value defaults to false." }, { "name": "valid", "type": "Boolean", "access": "global", "required": false, "default": true, "description": "Specifies whether the editor content is valid. If invalid, the slds-has-error class is added. This value defaults to true." }, { "name": "formats", "type": "List", "access": "global", "required": false, "default": "", "description": "A list of formats accepted by the text editor. By default, the list is computed based on enabled categories. The \"table\" format is always enabled to support copying and pasting of tables. If formats are specified, all desired formats must be specified. Omitting a format from the list removes the corresponding button." }, { "name": "variant", "type": "String", "access": "global", "required": false, "default": "", "description": "The variant changes the appearance of the toolbar. Accepted variant is bottom-toolbar which causes the toolbar to be displayed below the text box." }, { "name": "messageWhenBadInput", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message that's displayed when valid is false." }, { "name": "shareWithEntityId", "type": "String", "access": "global", "required": false, "default": "", "description": "Entity ID to share the image with." } ], "insertImageButton": [], "layout": [ { "name": "horizontalAlign", "type": "String", "access": "global", "required": false, "default": "", "description": "Determines how to spread the layout items horizontally. The alignment options are center, space, spread, and end." }, { "name": "verticalAlign", "type": "String", "access": "global", "required": false, "default": "", "description": "Determines how to spread the layout items vertically. The alignment options are start, center, end, and stretch." }, { "name": "multipleRows", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Determines whether to wrap the child items when they exceed the layout width. If true, the items wrap to the following line. This value defaults to false." }, { "name": "pullToBoundary", "type": "String", "access": "global", "required": false, "default": "", "description": "Pulls layout items to the layout boundaries and corresponds to the padding size on the layout item. Possible values are small, medium, or large." } ], "layoutItem": [ { "name": "size", "type": "Integer", "access": "global", "required": false, "default": "", "description": "If the viewport is divided into 12 parts, size indicates the relative space the container occupies. Size is expressed as an integer from 1 through 12. This applies for all device-types." }, { "name": "smallDeviceSize", "type": "Integer", "access": "global", "required": false, "default": "", "description": "If the viewport is divided into 12 parts, this attribute indicates the relative space the container occupies on device-types larger than mobile. It is expressed as an integer from 1 through 12." }, { "name": "mediumDeviceSize", "type": "Integer", "access": "global", "required": false, "default": "", "description": "If the viewport is divided into 12 parts, this attribute indicates the relative space the container occupies on device-types larger than tablet. It is expressed as an integer from 1 through 12." }, { "name": "largeDeviceSize", "type": "Integer", "access": "global", "required": false, "default": "", "description": "If the viewport is divided into 12 parts, this attribute indicates the relative space the container occupies on device-types larger than desktop. It is expressed as an integer from 1 through 12." }, { "name": "flexibility", "type": "Object", "access": "global", "required": false, "default": "", "description": "Make the item fluid so that it absorbs any extra space in its container or shrinks when there is less space. Allowed values are: auto (columns grow or shrink equally as space allows), shrink (columns shrink equally as space decreases), no-shrink (columns don't shrink as space reduces), grow (columns grow equally as space increases), no-grow (columns don't grow as space increases), no-flex (columns don't grow or shrink as space changes). Use a comma-separated value for multiple options, such as 'auto, no-shrink'." }, { "name": "padding", "type": "String", "access": "global", "required": false, "default": "", "description": "Sets padding to either the right and left sides of a container, or all sides of a container. Allowed values are horizontal-small, horizontal-medium, horizontal-large, around-small, around-medium, around-large." }, { "name": "alignmentBump", "type": "String", "access": "global", "required": false, "default": "", "description": "Specifies a direction to bump the alignment of adjacent layout items. Allowed values are left, top, right, bottom." } ], "listView": [ { "name": "objectApiName", "type": "String", "access": "global", "required": true, "default": "", "description": "The API name of the object to be displayed in this List View" }, { "name": "listName", "type": "String", "access": "global", "required": true, "default": "", "description": "The developer name of the List View" }, { "name": "rows", "type": "Integer", "access": "global", "required": false, "default": 50, "description": "Specifies the number of rows to initially load and additional rows after each subsequent 'Load More' click. The default and maximum number of rows value is 50" }, { "name": "showActionBar", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Specifies whether the action bar displays. This value defaults to false." }, { "name": "enableInlineEdit", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Specifies whether the inline edit of cells is enabled. This value defaults to false." }, { "name": "showRowLevelActions", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Specifies whether row level actions are displayed (as a dropdown menu in the last column of the row). This value defaults to false." }, { "name": "showSearchBar", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Specifies whether the search bar displays. This value defaults to false. Note: The server side may still disable search if it does not support searching." } ], "map": [ { "name": "zoomLevel", "type": "Integer", "access": "global", "required": false, "default": "", "description": "Corresponds to zoom levels defined in Google Maps API. If not specified, the map component automatically chooses an appropriate zoom level to show all markers with comfortable margins." }, { "name": "mapMarkers", "type": "Object[]", "access": "global", "required": true, "default": "", "description": "Array containing one or more objects with the address or coordinates to be displayed." }, { "name": "markersTitle", "type": "String", "access": "global", "required": false, "default": "", "description": "Provides the heading title for the markers when the map uses multiple markers. The title is displayed as a header for the list of clickable addresses." }, { "name": "center", "type": "Object", "access": "global", "required": false, "default": "", "description": "A location to use as the map's center. If center is not specified, the map centers automatically." }, { "name": "showFooter", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Shows footer with 'Open in Google Maps' link that opens an external window to display the selected marker location in Google Maps. Default value is false." }, { "name": "listView", "type": "String", "access": "global", "required": false, "default": "auto", "description": "Displays or hides the list of locations. Valid values are visible, hidden, or auto. This value defaults to auto, which shows the list only when multiple markers are present. Passing in an invalid value hides the list view." } ], "menuItem": [ { "name": "value", "type": "String", "access": "global", "required": false, "default": "", "description": "A value associated with the menu item." }, { "name": "iconName", "type": "String", "access": "global", "required": false, "default": "", "description": "The name of an icon to display after the text of the menu item." }, { "name": "label", "type": "String", "access": "global", "required": false, "default": "", "description": "Text of the menu item." }, { "name": "checked", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "If not specified, the menu item is not checkable. If true, a check mark is shown to the left of the menu item. If false, a check mark is not shown but there is space to accommodate one." }, { "name": "disabled", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "If true, the menu item is not actionable and is shown as disabled." }, { "name": "onactive", "type": "action", "access": "global", "required": false, "default": "", "description": "DEPRECATED. The action triggered when this menu item is selected." }, { "name": "isDraft", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "If true, the menu item shows a draft indicator. This value defaults to false." }, { "name": "draftAlternativeText", "type": "String", "access": "global", "required": false, "default": "", "description": "Describes the reason for showing the draft indicator. This is required when the isDraft attribute is true" }, { "name": "prefixIconName", "type": "String", "access": "global", "required": false, "default": "", "description": "The name of an icon to display before the text of the menu item." }, { "name": "href", "type": "String", "access": "global", "required": false, "default": "", "description": "URL for a link to use for the menu item." } ], "navigation": [], "navigationItemAPI": [], "notificationsLibrary": [], "omniToolkitAPI": [], "outputField": [ { "name": "fieldName", "type": "String", "access": "global", "required": false, "default": "", "description": "The API name of the field to be displayed." }, { "name": "variant", "type": "String", "access": "global", "required": false, "default": "standard", "description": "Changes the appearance of the output. Accepted variants include standard and label-hidden. This value defaults to standard." }, { "name": "class", "type": "String", "access": "global", "required": false, "default": "standard", "description": "A CSS class for the outer element, in addition to the component's base classes." } ], "overlayLibrary": [], "path": [ { "name": "recordId", "type": "String", "access": "global", "required": false, "default": "", "description": "The record's ID" }, { "name": "variant", "type": "String", "access": "global", "required": false, "default": "linear", "description": "Changes the appearance of the path. Choose between linear and non-linear formats. In linear paths, completed steps show a checkmark. In non-linear paths, completed steps show the step name. We show linear paths by default." }, { "name": "hideUpdateButton", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Specified whether the Mark Complete button is displayed next to the path. If true, the button is not displayed. The Mark Complete button is displayed by default." }, { "name": "onselect", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when a step on the path is clicked." } ], "picklistPath": [ { "name": "recordId", "type": "String", "access": "global", "required": false, "default": "", "description": "The record's ID" }, { "name": "variant", "type": "String", "access": "global", "required": false, "default": "linear", "description": "Changes the appearance of the path. Choose between linear and non-linear formats. In linear paths, completed steps show a checkmark. In non-linear paths, completed steps show the step name. We show linear paths by default." }, { "name": "picklistFieldApiName", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "The API name of the field from which the path is derived. For example, StageName for Opportunity." }, { "name": "onselect", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when a step on the path is clicked." } ], "pill": [ { "name": "href", "type": "String", "access": "global", "required": false, "default": "", "description": "The URL of the page that the link goes to." }, { "name": "onclick", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the button is clicked." }, { "name": "media", "type": "component[]", "access": "global", "required": false, "default": "", "description": "The icon or figure that's displayed next to the textual information." }, { "name": "hasError", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Specifies whether the pill has errors. The default is false." }, { "name": "onremove", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the pill is removed." }, { "name": "name", "type": "String", "access": "global", "required": false, "default": "", "description": "The name for the pill. This value is optional and can be used to identify the pill in a callback." } ], "pillContainer": [ { "name": "items", "type": "List", "access": "global", "required": false, "default": "", "description": "An array of items to be rendered as pills in a container." }, { "name": "label", "type": "String", "access": "global", "required": false, "default": "", "description": "Aria label for the pill container." }, { "name": "singleLine", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Whether keep pills in single line." }, { "name": "onitemremove", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when a pill is removed." } ], "progressBar": [ { "name": "variant", "type": "String", "access": "global", "required": false, "default": "base", "description": "The variant of the progress bar. Valid values are base and circular." }, { "name": "value", "type": "Integer", "access": "global", "required": false, "default": 0, "description": "The percentage value of the progress bar." }, { "name": "size", "type": "String", "access": "global", "required": false, "default": "medium", "description": "The size of the progress bar. Valid values are x-small, small, medium, and large. The default value is medium." } ], "progressIndicator": [ { "name": "type", "type": "String", "access": "global", "required": false, "default": "base", "description": "Changes the visual pattern of the indicator. Valid values are base and path. This value defaults to base." }, { "name": "currentStep", "type": "String", "access": "global", "required": false, "default": "", "description": "The current step, which must match the value attribute of one of progressStep components. If a step is not provided, the value of the first progressStep component is used." }, { "name": "variant", "type": "String", "access": "global", "required": false, "default": "", "description": "Changes the appearance of the progress indicator for the base type only. Valid values are base or shaded. The shaded variant adds a light gray border to the step indicators. This value defaults to base." }, { "name": "hasError", "type": "String", "access": "global", "required": false, "default": false, "description": "Indicates whether the current step is in error state and displays a warning icon on the step indicator. Applies to the base type only. This value defaults to false." } ], "quickActionAPI": [], "quipCard": [ { "name": "parentRecordId", "type": "String", "access": "global", "required": true, "default": "", "description": "ID of the Salesforce record to display the card for." } ], "radioGroup": [ { "name": "label", "type": "String", "access": "global", "required": true, "default": "", "description": "Text label for the radio group." }, { "name": "options", "type": "List", "access": "global", "required": true, "default": "", "description": "Array of label-value pairs for each radio button." }, { "name": "type", "type": "String", "access": "global", "required": false, "default": "radio", "description": "The style of the radio group. Valid types are radio or button. The default is radio." }, { "name": "messageWhenValueMissing", "type": "String", "access": "global", "required": false, "default": "", "description": "Optional message displayed when no radio button is selected and the required attribute is set to true." } ], "recordEditForm": [ { "name": "recordId", "type": "String", "access": "global", "required": false, "default": "", "description": "The ID of the record to be displayed." }, { "name": "objectApiName", "type": "String", "access": "global", "required": true, "default": "", "description": "The API name of the object." }, { "name": "class", "type": "String", "access": "global", "required": false, "default": "", "description": "A CSS class for the outer element, in addition to the component's base classes." }, { "name": "recordTypeId", "type": "String", "access": "global", "required": false, "default": "", "description": "The ID of the record type, which is required if you created multiple record types but don't have a default." }, { "name": "density", "type": "String", "access": "global", "required": false, "default": "", "description": "Sets the arrangement style of fields and labels in the form. Accepted values are compact, comfy, and auto (default). Use compact to display fields and their labels on the same line. Use comfy to display fields below their labels. Use auto to let the component dynamically set the density according to the user's Display Density setting and the width of the form." }, { "name": "onload", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the form data is loaded." }, { "name": "onsubmit", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the form is submitted. The form can be submitted only after it's loaded." }, { "name": "onsuccess", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the form is saved." }, { "name": "onerror", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when there is an error on form submission." } ], "recordForm": [ { "name": "fields", "type": "String[]", "access": "global", "required": false, "default": "", "description": "List of fields to be displayed. The fields display in the order you list them." }, { "name": "class", "type": "String", "access": "global", "required": false, "default": "", "description": "A CSS class for the outer element, in addition to the component's base classes." }, { "name": "recordId", "type": "String", "access": "global", "required": false, "default": "", "description": "The ID of the record to be displayed." }, { "name": "objectApiName", "type": "String", "access": "global", "required": true, "default": "", "description": "The API name of the object." }, { "name": "layoutType", "type": "String", "access": "global", "required": true, "default": "", "description": "The type of layout to use to display the form fields. Possible values: Compact, Full. When creating a new record, only the full layout is supported." }, { "name": "mode", "type": "String", "access": "global", "required": true, "default": "", "description": "Specifies the interaction and display style for the form. Possible values: view, edit, readonly. If a record ID is not provided, the default mode is edit, which displays a form to create new records. If a record ID is provided, the default mode is view, which displays field values with edit icons on updateable fields." }, { "name": "recordTypeId", "type": "String", "access": "global", "required": false, "default": "", "description": "The ID of the record type, which is required if you created multiple record types but don't have a default." }, { "name": "density", "type": "String", "access": "global", "required": false, "default": "", "description": "Sets the arrangement style of fields and labels in the form. Accepted values are compact, comfy, and auto (default). Use compact to display fields and their labels on the same line. Use comfy to display fields below their labels. Use auto to let the component dynamically set the density according to the user's Display Density setting and the width of the form." }, { "name": "onload", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the form data is loaded." }, { "name": "onsubmit", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the form is submitted. The form can be submitted only after it's loaded." }, { "name": "onsuccess", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the form is saved." }, { "name": "onerror", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when there is an error on form submission." } ], "recordViewForm": [ { "name": "recordId", "type": "String", "access": "global", "required": true, "default": "", "description": "The ID of the record to be displayed." }, { "name": "objectApiName", "type": "String", "access": "global", "required": true, "default": "", "description": "The API name of the object." }, { "name": "class", "type": "String", "access": "global", "required": false, "default": "", "description": "A CSS class for the outer element, in addition to the component's base classes." }, { "name": "density", "type": "String", "access": "global", "required": false, "default": "", "description": "Sets the arrangement style of fields and labels in the form. Accepted values are compact, comfy, and auto (default). Use compact to display fields and their labels on the same line. Use comfy to display fields below their labels. Use auto to let the component dynamically set the density according to the user's Display Density setting and the width of the form." } ], "relativeDateTime": [ { "name": "value", "type": "Object", "access": "global", "required": true, "default": "", "description": "The timestamp or JavaScript Date object to be formatted." } ], "select": [ { "name": "label", "type": "String", "access": "global", "required": true, "default": "", "description": "Text that describes the desired select input." }, { "name": "messageWhenValueMissing", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message to be displayed when the value is missing." } ], "slider": [ { "name": "value", "type": "Integer", "access": "global", "required": false, "default": "", "description": "The numerical value of the input range. This value defaults to 0." }, { "name": "onchange", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the slider value changes. You must pass any newly selected value back to the slider component to bind the new value to the slider." }, { "name": "min", "type": "Integer", "access": "global", "required": false, "default": "", "description": "The min value of the input range. This value defaults to 0." }, { "name": "max", "type": "Integer", "access": "global", "required": false, "default": "", "description": "The max value of the input range. This value defaults to 0." }, { "name": "step", "type": "String", "access": "global", "required": false, "default": "1", "description": "The step increment value of the input range. Example steps include 0.1, 1, or 10. This value defaults to 1." }, { "name": "size", "type": "String", "access": "global", "required": false, "default": "", "description": "The size value of the input range. This value default to empty, which is the base. Supports x-small, small, medium, and large." }, { "name": "type", "type": "String", "access": "global", "required": false, "default": "horizontal", "description": "The type of the input range position. This value defaults to horizontal." }, { "name": "label", "type": "String", "access": "global", "required": false, "default": "", "description": "The text label for the input range. Provide your own label to describe the slider. Otherwise, no label is displayed." }, { "name": "disabled", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "The disabled value of the input range. This value default to false." }, { "name": "variant", "type": "String", "access": "global", "required": false, "default": "standard", "description": "The variant changes the appearance of the slider. Accepted variants include standard and label-hidden. This value defaults to standard." }, { "name": "messageWhenBadInput", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message to be displayed when a bad input is detected." }, { "name": "messageWhenPatternMismatch", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message to be displayed when a pattern mismatch is detected." }, { "name": "messageWhenTypeMismatch", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message to be displayed when a type mismatch is detected." }, { "name": "messageWhenValueMissing", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message to be displayed when the value is missing." }, { "name": "messageWhenRangeOverflow", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message to be displayed when a range overflow is detected." }, { "name": "messageWhenRangeUnderflow", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message to be displayed when a range underflow is detected." }, { "name": "messageWhenStepMismatch", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message to be displayed when a step mismatch is detected." }, { "name": "messageWhenTooLong", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message to be displayed when the value is too long." }, { "name": "onblur", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the slider releases focus." }, { "name": "onfocus", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the slider receives focus." } ], "spinner": [ { "name": "size", "type": "String", "access": "global", "required": false, "default": "medium", "description": "The size of the spinner. Accepted sizes are small, medium, and large. This value defaults to medium." }, { "name": "variant", "type": "String", "access": "global", "required": false, "default": "", "description": "The variant changes the appearance of the spinner. Accepted variants are base, brand, and inverse. This value defaults to base." }, { "name": "alternativeText", "type": "String", "access": "global", "required": false, "default": "", "description": "The alternative text used to describe the reason for the wait and need for a spinner." } ], "tab": [ { "name": "id", "type": "String", "access": "global", "required": false, "default": "", "description": "The optional ID is used during tabset's onselect event to determine which tab was clicked." }, { "name": "label", "type": "component[]", "access": "global", "required": false, "default": "", "description": "The text that appears on the tab. The attribute accepts string values, but for compatibility with previous releases also accepts a component type. Only the text portion of the label value displays and any CSS classes that are applied are ignored." }, { "name": "iconName", "type": "String", "access": "global", "required": false, "default": "", "description": "The Lightning Design System name of an icon to display to the left of the tab label. Specify the name in the format 'utility:down' where 'utility' is the category, and 'down' is the icon to be displayed. Only utility icons can be used in this component." }, { "name": "iconAssistiveText", "type": "String", "access": "global", "required": false, "default": "", "description": "Assistive text for the icon specified by iconName." }, { "name": "showErrorIndicator", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Specifies whether there's an error in the tab content. An error icon is displayed to the right of the tab label." }, { "name": "onactive", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when this tab becomes active." } ], "tabset": [ { "name": "variant", "type": "String", "access": "global", "required": false, "default": "", "description": "The variant changes the appearance of the tabset. Accepted variants are default, scoped, and vertical." }, { "name": "selectedTabId", "type": "String", "access": "global", "required": false, "default": "", "description": "Allows you to set a specific tab to open by default. If this attribute is not used, the first tab opens by default." }, { "name": "onselect", "type": "action", "access": "global", "required": false, "default": "", "description": "The action that will run when the tab is clicked." } ], "textarea": [ { "name": "label", "type": "String", "access": "global", "required": true, "default": "", "description": "Text that describes the desired textarea input." }, { "name": "placeholder", "type": "String", "access": "global", "required": false, "default": "", "description": "Text that is displayed when the field is empty, to prompt the user for a valid entry." }, { "name": "maxlength", "type": "Integer", "access": "global", "required": false, "default": "", "description": "The maximum number of characters allowed in the textarea." }, { "name": "minlength", "type": "Integer", "access": "global", "required": false, "default": "", "description": "The minimum number of characters allowed in the textarea." }, { "name": "messageWhenBadInput", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message to be displayed when a bad input is detected." }, { "name": "messageWhenValueMissing", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message to be displayed when the value is missing." }, { "name": "messageWhenTooLong", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message to be displayed when the value is too long." }, { "name": "messageWhenTooShort", "type": "String", "access": "global", "required": false, "default": "", "description": "Error message to be displayed when the value is too short." } ], "tile": [ { "name": "label", "type": "String", "access": "global", "required": true, "default": "", "description": "The text label that displays in the tile and hover text." }, { "name": "href", "type": "String", "access": "global", "required": false, "default": "", "description": "The URL of the page that the link goes to." }, { "name": "media", "type": "component[]", "access": "global", "required": false, "default": "", "description": "The icon or figure that's displayed next to the textual information." } ], "tree": [ { "name": "items", "type": "Object", "access": "global", "required": false, "default": "base", "description": "An array of key-value pairs that describe the tree. Keys include label, name, disabled, expanded, and items." }, { "name": "header", "type": "String", "access": "global", "required": false, "default": "0", "description": "The text that's displayed as the tree heading." }, { "name": "onselect", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when a tree item is selected." } ], "treeGrid": [ { "name": "columns", "type": "List", "access": "global", "required": false, "default": "", "description": "Array of the columns object that's used to define the data types. Required properties include 'label', 'dataKey', and 'type'. The default type is 'text'." }, { "name": "data", "type": "Object", "access": "global", "required": false, "default": "", "description": "The array of data to be displayed." }, { "name": "expandedRows", "type": "List", "access": "global", "required": false, "default": "", "description": "The array of unique row IDs that are expanded." }, { "name": "selectedRows", "type": "List", "access": "global", "required": false, "default": "", "description": "The array of unique row IDs that are selected" }, { "name": "keyField", "type": "String", "access": "global", "required": true, "default": "", "description": "Required for better performance. Associates each row with a unique ID." }, { "name": "hideCheckboxColumn", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Hides or displays the checkbox column for row selection. To hide the checkbox column, set hideCheckboxColumn to true. The default is false." }, { "name": "isLoading", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Specifies whether more data is being loaded and displays a spinner if so. The default is false." }, { "name": "resizeColumnDisabled", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Specifies whether column resizing is disabled. The default is false." }, { "name": "minColumnWidth", "type": "Integer", "access": "global", "required": false, "default": "", "description": "The minimum width for all columns. The default is 50px." }, { "name": "maxColumnWidth", "type": "Integer", "access": "global", "required": false, "default": "", "description": "The maximum width for all columns. The default is 1000px." }, { "name": "onrowselection", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when a row is selected." }, { "name": "onrowaction", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when an operation its clicked. By default its to closes the actions menu." }, { "name": "onresize", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when the table renders columns the first time and every time its resized an specific column." }, { "name": "ontoggle", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when a row is toggled (expanded or collapsed)." }, { "name": "ontoggleall", "type": "action", "access": "global", "required": false, "default": "", "description": "The action triggered when all rows are toggled (expanded or collapsed)." }, { "name": "showRowNumberColumn", "type": "Boolean", "access": "global", "required": false, "default": "", "description": "Hides or displays the row number column. To show the row number column, set showRowNumberColumn to true. The default is false." }, { "name": "rowNumberOffset", "type": "Integer", "access": "global", "required": false, "default": "", "description": "Determines where to start counting the row number. The default is 0." } ], "unsavedChanges": [ { "name": "label", "type": "String", "access": "global", "required": false, "default": "", "description": "Label for the unsaved content which appears in prompt for save or discard" }, { "name": "onsave", "type": "action", "access": "global", "required": false, "default": "", "description": "Action to handle saving unsaved content" }, { "name": "ondiscard", "type": "action", "access": "global", "required": false, "default": "", "description": "Action to handle discarding unsaved content" } ], "utilityBarAPI": [], "verticalNavigation": [ { "name": "compact", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Specify true to reduce spacing between navigation items. This value defaults to false." }, { "name": "shaded", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Specify true when the vertical navigation is sitting on top of a shaded background. This value defaults to false." }, { "name": "onbeforeselect", "type": "action", "access": "global", "required": false, "default": "", "description": "Action fired before an item is selected. The event params include the `name` of the selected item. To prevent the onselect handler from running, call event.preventDefault() in the onbeforeselect handler." }, { "name": "onselect", "type": "action", "access": "global", "required": false, "default": "", "description": "Action fired when an item is selected. The event params include the `name` of the selected item." }, { "name": "selectedItem", "type": "String", "access": "global", "required": false, "default": "", "description": "Name of the nagivation item to make active." }, { "name": "ariaLabel", "type": "String", "access": "global", "required": false, "default": "", "description": "The aria label attribute for the navigation component" } ], "verticalNavigationItem": [ { "name": "label", "type": "String", "access": "global", "required": true, "default": "", "description": "The text displayed for the navigation item." }, { "name": "name", "type": "String", "access": "global", "required": true, "default": "", "description": "A unique identifier for the navigation item." }, { "name": "href", "type": "String", "access": "global", "required": false, "default": "", "description": "The URL of the page that the navigation item goes to." } ], "verticalNavigationItemBadge": [ { "name": "label", "type": "String", "access": "global", "required": true, "default": "", "description": "The text displayed for the navigation item." }, { "name": "name", "type": "String", "access": "global", "required": true, "default": "", "description": "A unique identifier for the navigation item." }, { "name": "href", "type": "String", "access": "global", "required": false, "default": "", "description": "The URL of the page that the navigation item goes to." }, { "name": "badgeCount", "type": "Integer", "access": "global", "required": false, "default": "", "description": "The number to show inside the badge. If this value is zero the badge will be hidden." }, { "name": "assistiveText", "type": "String", "access": "global", "required": false, "default": "New Items", "description": "Assistive text describing the number in the badge. This is used to enhance accessibility and is not displayed to the user." } ], "verticalNavigationItemIcon": [ { "name": "label", "type": "String", "access": "global", "required": true, "default": "", "description": "The text displayed for the navigation item." }, { "name": "name", "type": "String", "access": "global", "required": true, "default": "", "description": "A unique identifier for the navigation item." }, { "name": "href", "type": "String", "access": "global", "required": false, "default": "", "description": "The URL of the page that the navigation item goes to." }, { "name": "iconName", "type": "String", "access": "global", "required": false, "default": "", "description": "The Lightning Design System name of the icon. Names are written in the format 'utility:down' where 'utility' is the category, and 'down' is the specific icon to be displayed." } ], "verticalNavigationOverflow": [], "verticalNavigationSection": [ { "name": "label", "type": "String", "access": "global", "required": true, "default": "", "description": "The heading text for this section." } ], "workspaceAPI": [], "availableForChatterExtensionRenderer": [ { "name": "payload", "type": "Object", "access": "global", "required": false, "default": "", "description": "Payload preserved for this extension that is associated with this feed item." }, { "name": "variant", "type": "String", "access": "global", "required": false, "default": "FEED", "description": "The variant changes based on where the extension is rendered. Valid values are FEED and PREVIEW. The value defaults to FEED" } ], "availableForFlowActions": [ { "name": "timeout", "type": "Integer", "access": "global", "required": false, "default": "120", "description": "Maximum time (in seconds) an asynchronous call can take before returning control to the flow and executing the Local Action element's fault connector. The default value is 120. If the value is 0 or a negative number, the call never times out." } ], "availableForFlowScreens": [ { "name": "availableActions", "type": "String[]", "access": "global", "required": false, "default": "", "description": "The navigation actions available for this screen. Valid actions are NEXT, PREVIOUS, FINISH, and PAUSE." }, { "name": "screenHelpText", "type": "String", "access": "global", "required": false, "default": "", "description": "Help text for this screen." }, { "name": "navigateFlow", "type": "action", "access": "global", "required": false, "default": "", "description": "Reference the appropriate navigation action to move away from this screen." }, { "name": "validate", "type": "action", "access": "global", "required": false, "default": "", "description": "Custom validation to run when the flow is navigated to the next screen. Pass a function into this attribute that evaluates the component and returns values for isValid and errorMessage." }, { "name": "validate", "type": "action", "access": "global", "required": false, "default": "", "description": "Custom validation to run when the flow is navigated to the next screen. Pass a function into this attribute that evaluates the component and returns values for isValid and errorMessage." } ], "hasPageReference": [ { "name": "pageReference", "type": "Object", "access": "global", "required": false, "default": "120", "description": "An object with a String 'type' property and Object 'attributes' and 'state' properties." } ], "utilityItem": [ { "name": "supportsPopOut", "type": "Boolean", "access": "global", "required": false, "default": true, "description": "Controls the availability of pop-out functionality. Set to false to remove the pop-out option for the utility item." } ] }, "lightningcommunity": { "backButton": [ { "name": "iconName", "type": "String", "access": "global", "required": false, "default": "utility:chevronleft", "description": "The Lightning Design System name of the icon. Only utility icons can be used in this component." }, { "name": "onnavigationcomplete", "type": "action", "access": "global", "required": false, "default": "", "description": "Event handler action fired after every page navigation is complete. 'navigationcomplete' event provides 'canGoBack' boolean parameter value." }, { "name": "class", "type": "String", "access": "global", "required": false, "default": "", "description": "Styling class for back button." } ] }, "lightningsnapin": { "minimizedAPI": [], "prechatAPI": [], "settingsAPI": [] }, "ltng": { "require": [ { "name": "styles", "type": "string[]", "access": "global", "required": false, "default": "", "description": "The set of style sheets in dependency order that will be loaded." }, { "name": "scripts", "type": "string[]", "access": "global", "required": false, "default": "", "description": "The set of scripts in dependency order that will be loaded." } ] }, "clients": { "hasEventContext": [ { "name": "dates", "type": "Object", "access": "global", "required": false, "default": "", "description": "READONLY - An object representing the item context pertinent to the appointment." }, { "name": "location", "type": "String", "access": "global", "required": false, "default": "", "description": "READONLY - The location of the current event." } ], "hasItemContext": [ { "name": "mode", "type": "String", "access": "global", "required": false, "default": "", "description": "READONLY - An enum indicating the mode of the item. Possible values are 'view', 'edit'" }, { "name": "source", "type": "String", "access": "global", "required": false, "default": "", "description": "READONLY - An enum indicating where the source is coming from. Possible values are 'email', 'event'" }, { "name": "people", "type": "Object", "access": "global", "required": false, "default": "", "description": "READONLY - An object representing the contacts on the current item." }, { "name": "subject", "type": "String", "access": "global", "required": false, "default": "", "description": "READONLY - The subject of the current item." }, { "name": "messageBody", "type": "String", "access": "global", "required": false, "default": "", "description": "READONLY - The body of the current item in plain text" } ] }, "force": { "hasRecordId": [ { "name": "recordId", "type": "String", "access": "global", "required": false, "default": "", "description": "The record Id" } ], "hasSObjectName": [ { "name": "sObjectName", "type": "String", "access": "global", "required": false, "default": "", "description": "sObject name" } ] }, "forceChatter": { "feed": [ { "name": "feedDesign", "type": "String", "access": "global", "required": false, "default": "BROWSE", "description": "Valid values include DEFAULT ( shows inline comments on desktop, a bit more detail ) or BROWSE ( primarily an overview of the feed items )" }, { "name": "type", "type": "String", "access": "global", "required": false, "default": "", "description": "The strategy used to find items associated with the subject. Valid values include: Bookmarks, Company, DirectMessages, Feeds, Files, Filter, Groups, Home, Moderation, Mute, News, PendingReview, Record, Streams, To, Topics, UserProfile." }, { "name": "subjectId", "type": "String", "access": "global", "required": false, "default": "", "description": "For most feeds tied to an entity, this is used specified the desired entity. Defaults to the current user if not specified" } ], "fullFeed": [ { "name": "type", "type": "String", "access": "global", "required": false, "default": "NEWS", "description": "The strategy used to find items associated with the subject. Valid values include: News, Home, Record, To." }, { "name": "subjectId", "type": "String", "access": "global", "required": false, "default": "", "description": "For most feeds tied to an entity, this is used specified the desired entity. Defaults to the current user if not specified" }, { "name": "handleNavigationEvents", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Should this component handle navigation events for entities and urls. If true then navigation events will result in the entity or url being opened in a new window." } ], "publisher": [ { "name": "recordId", "type": "String", "access": "global", "required": false, "default": "", "description": "The record Id" }, { "name": "context", "type": "String", "access": "global", "required": true, "default": "", "description": "The context in which the component is being displayed (RECORD or GLOBAL). RECORD is for a record feed, and GLOBAL is for all other feed types. This attribute is case-sensitive." } ] }, "forceCommunity": { "appLauncher": [], "navigationMenuBase": [ { "name": "menuItems", "type": "Object", "access": "global", "required": true, "default": "", "description": "Automatically populated with menu item’s data. This attribute is read-only." } ], "notifications": [], "routeLink": [ { "name": "id", "type": "String", "access": "global", "required": false, "default": "", "description": "The ID of the anchor tag." }, { "name": "class", "type": "String", "access": "global", "required": false, "default": "", "description": "A CSS class for the anchor tag." }, { "name": "title", "type": "String", "access": "global", "required": false, "default": "", "description": "The text to display for the link tooltip." }, { "name": "label", "type": "String", "access": "global", "required": false, "default": "", "description": "The text displayed in the link." }, { "name": "routeInput", "type": "map", "access": "global", "required": true, "default": "", "description": "The map of dynamic parameters that create the link. Only recordId-based routes are supported." }, { "name": "onClick", "type": "action", "access": "global", "required": false, "default": "", "description": "Action to trigger when the anchor is clicked." } ], "waveDashboard": [ { "name": "recordId", "type": "String", "access": "global", "required": false, "default": "", "description": "Id of the current entity in the context of which the component is being displayed." }, { "name": "dashboardId", "type": "String", "access": "global", "required": false, "default": "", "description": "The unique ID of the dashboard. You can get a dashboard’s ID, an 18-character code beginning with 0FK, from the dashboard's URL, or you can request it through the API. This attribute can be used instead of the developer name, but it can't be included if the name has been set. One of the two is required." }, { "name": "developerName", "type": "String", "access": "global", "required": false, "default": "", "description": "The unique developer name of the dashboard. You can request the developer name through the API. This attribute can be used instead of the dashboard ID, but it can't be included if the ID has been set. One of the two is required" }, { "name": "hideOnError", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Controls whether or not users see a dashboard that has an error. When this attribute is set to true, if the dashboard has an error, it won’t appear on the page. When set to false, the dashboard appears but doesn’t show any data. An error can occur when a user doesn't have access to the dashboard or it has been deleted. " }, { "name": "height", "type": "Integer", "access": "global", "required": false, "default": 300, "description": "Specifies the height of the dashboard, in pixels." }, { "name": "showSharing", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "If true, and the dashboard is shareable, then the dashboard shows the Share icon. If false, the dashboard doesn't show the Share icon. To show the Share icon in the dashboard, the smallest supported frame size is 800 x 612 pixels." }, { "name": "showTitle", "type": "Boolean", "access": "global", "required": false, "default": true, "description": "If true, the dashboard’s title is included above the dashboard. If false, the dashboard appears without a title." }, { "name": "showHeader", "type": "Boolean", "access": "global", "required": false, "default": true, "description": "If true, the dashboard is displayed with a header bar that includes dashboard information and controls. If false, the dashboard appears without a header bar. Note that the header bar automatically appears when either showSharing or showTitle is true." }, { "name": "rendered", "type": "Boolean", "access": "global", "required": false, "default": true, "description": "Specifies whether or not the component is rendered on the page." }, { "name": "filter", "type": "String", "access": "global", "required": false, "default": "", "description": "Adds selections or filters to the embedded dashboard at runtime. The filter attribute is configured using JSON. For filtering by dimension, use this syntax: {'datasets' : {'dataset1': [ {'fields': ['field1'], 'selection': ['$value1', '$value2']}, {'fields': ['field2'], 'filter': { 'operator': 'operator1', 'values': ['$value3', '$value4']}}]}}. For filtering on measures, use this syntax: {'datasets' : {'dataset1': [ {'fields': ['field1'], 'selection': ['$value1', '$value2']}, {'fields': ['field2'], 'filter': { 'operator': 'operator1', 'values': [[$value3]]}}]}}. With the selection option, the dashboard is shown with all its data, and the specified dimension values are highlighted. With the filter option, the dashboard is shown with only filtered data. For more information, see https://help.salesforce.com/articleView?id=bi_embed_community_builder.htm. " }, { "name": "openLinksInNewWindow", "type": "Boolean", "access": "global", "required": false, "default": true, "description": "If false, links to other dashboards will be opened in the same window." }, { "name": "accessToken", "type": "String", "access": "global", "required": false, "default": "", "description": "A valid access token obtained by logging into Salesforce. Useful when the component is used by Lightning Out in a non-Salesforce domain." } ] }, "wave": { "waveDashboard": [ { "name": "recordId", "type": "String", "access": "global", "required": false, "default": "", "description": "Id of the current entity in the context of which the component is being displayed." }, { "name": "dashboardId", "type": "String", "access": "global", "required": false, "default": "", "description": "The unique ID of the dashboard. You can get a dashboard’s ID, an 18-character code beginning with 0FK, from the dashboard's URL, or you can request it through the API. This attribute can be used instead of the developer name, but it can't be included if the name has been set. One of the two is required." }, { "name": "developerName", "type": "String", "access": "global", "required": false, "default": "", "description": "The unique developer name of the dashboard. You can request the developer name through the API. This attribute can be used instead of the dashboard ID, but it can't be included if the ID has been set. One of the two is required" }, { "name": "hideOnError", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "Controls whether or not users see a dashboard that has an error. When this attribute is set to true, if the dashboard has an error, it won’t appear on the page. When set to false, the dashboard appears but doesn’t show any data. An error can occur when a user doesn't have access to the dashboard or it has been deleted. " }, { "name": "height", "type": "Integer", "access": "global", "required": false, "default": 300, "description": "Specifies the height of the dashboard, in pixels." }, { "name": "showSharing", "type": "Boolean", "access": "global", "required": false, "default": false, "description": "If true, and the dashboard is shareable, then the dashboard shows the Share icon. If false, the dashboard doesn't show the Share icon. To show the Share icon in the dashboard, the smallest supported frame size is 800 x 612 pixels." }, { "name": "showTitle", "type": "Boolean", "access": "global", "required": false, "default": true, "description": "If true, the dashboard’s title is included above the dashboard. If false, the dashboard appears without a title." }, { "name": "showHeader", "type": "Boolean", "access": "global", "required": false, "default": true, "description": "If true, the dashboard is displayed with a header bar that includes dashboard information and controls. If false, the dashboard appears without a header bar. Note that the header bar automatically appears when either showSharing or showTitle is true." }, { "name": "rendered", "type": "Boolean", "access": "global", "required": false, "default": true, "description": "Specifies whether or not the component is rendered on the page." }, { "name": "filter", "type": "String", "access": "global", "required": false, "default": "", "description": "Adds selections or filters to the embedded dashboard at runtime. The filter attribute is configured using JSON. For filtering by dimension, use this syntax: {'datasets' : {'dataset1': [ {'fields': ['field1'], 'selection': ['$value1', '$value2']}, {'fields': ['field2'], 'filter': { 'operator': 'operator1', 'values': ['$value3', '$value4']}}]}}. For filtering on measures, use this syntax: {'datasets' : {'dataset1': [ {'fields': ['field1'], 'selection': ['$value1', '$value2']}, {'fields': ['field2'], 'filter': { 'operator': 'operator1', 'values': [[$value3]]}}]}}. With the selection option, the dashboard is shown with all its data, and the specified dimension values are highlighted. With the filter option, the dashboard is shown with only filtered data. For more information, see https://help.salesforce.com/articleView?id=bi_embed_community_builder.htm. " }, { "name": "openLinksInNewWindow", "type": "Boolean", "access": "global", "required": false, "default": true, "description": "If false, links to other dashboards will be opened in the same window." }, { "name": "accessToken", "type": "String", "access": "global", "required": false, "default": "", "description": "A valid access token obtained by logging into Salesforce. Useful when the component is used by Lightning Out in a non-Salesforce domain." } ] } }