{ "lightning-helptext": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "content", "type": "STRING", "description": "Text to be shown in the popover.", "access": "global", "parent": "lightning-helptext", "required": false }, { "name": "icon-name", "type": "STRING", "description": "The Lightning Design System name of the icon used as the visible element.\nNames are written in the format 'utility:info' where 'utility' is the category,\nand 'info' is the specific icon to be displayed.\nThe default is 'utility:info'.", "access": "global", "parent": "lightning-helptext", "required": false }, { "name": "icon-variant", "type": "STRING", "description": "Changes the appearance of the icon.\nAccepted variants include inverse, warning, error.", "access": "global", "parent": "lightning-helptext", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false } ], "description": "An icon with a text popover used for tooltips." }, "lightning-textarea": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "access-key", "type": "", "description": "The keyboard shortcut for input field.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the textarea field is disabled and users cannot interact with it.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "field-level-help", "type": "", "description": "The help text that appears in a popover.\nSet field-level help to provide an informational tooltip on the textarea input field.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "label", "type": "STRING", "description": "Text that describes the textarea input field.", "access": "global", "parent": "lightning-textarea", "required": true }, { "name": "max-length", "type": "", "description": "The maximum number of characters allowed in the textarea.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "maxlength", "type": "INTEGER", "description": "The maximum number of characters allowed in the textarea.", "required": false }, { "name": "message-when-bad-input", "type": "STRING", "description": "Error message to be displayed when a bad input is detected.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "message-when-too-long", "type": "STRING", "description": "Error message to be displayed when the value is too long.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "message-when-too-short", "type": "STRING", "description": "Error message to be displayed when the value is too short.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "message-when-value-missing", "type": "STRING", "description": "Error message to be displayed when the value is missing.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "min-length", "type": "", "description": "The minimum number of characters allowed in the textarea.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "minlength", "type": "INTEGER", "description": "The minimum number of characters allowed in the textarea.", "required": false }, { "name": "name", "type": "STRING", "description": "Specifies the name of an input element.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onchange", "type": "AURA.ACTION", "description": "The action triggered when a value attribute changes.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "placeholder", "type": "STRING", "description": "Text that is displayed when the field is empty,\nto prompt the user for a valid entry.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "read-only", "type": "", "description": "If present, the textarea field is read-only and cannot be edited.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "readonly", "type": "BOOLEAN", "description": "Specifies that an input field is read-only. This value defaults to false.", "required": false }, { "name": "required", "type": "BOOLEAN", "description": "If present, the textarea field must be filled out before the form can be submitted.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "validity", "type": "OBJECT", "description": "Represents the validity states of the textarea input, with respect to constraint validation.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "value", "type": "STRING", "description": "The value of the textarea input, also used as the default value during init.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of the textarea.\nAccepted variants include standard, label-hidden, label-inline, and label-stacked.\nThis value defaults to standard.\nUse label-hidden to hide the label but make it available to assistive technology.\nUse label-inline to horizontally align the label and textarea.\nUse label-stacked to place the label above the textarea.", "access": "global", "parent": "lightning-textarea", "required": false } ], "description": "Represents a multiline text input field.", "methods": [ { "name": "access-key", "type": "", "description": "The keyboard shortcut for input field.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the textarea field is disabled and users cannot interact with it.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "field-level-help", "type": "", "description": "The help text that appears in a popover.\nSet field-level help to provide an informational tooltip on the textarea input field.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "label", "type": "STRING", "description": "Text that describes the textarea input field.", "access": "global", "parent": "lightning-textarea", "required": true }, { "name": "max-length", "type": "", "description": "The maximum number of characters allowed in the textarea.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "maxlength", "type": "INTEGER", "description": "The maximum number of characters allowed in the textarea.", "required": false }, { "name": "message-when-bad-input", "type": "STRING", "description": "Error message to be displayed when a bad input is detected.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "message-when-too-long", "type": "STRING", "description": "Error message to be displayed when the value is too long.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "message-when-too-short", "type": "STRING", "description": "Error message to be displayed when the value is too short.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "message-when-value-missing", "type": "STRING", "description": "Error message to be displayed when the value is missing.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "min-length", "type": "", "description": "The minimum number of characters allowed in the textarea.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "minlength", "type": "INTEGER", "description": "The minimum number of characters allowed in the textarea.", "required": false }, { "name": "name", "type": "STRING", "description": "Specifies the name of an input element.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onchange", "type": "AURA.ACTION", "description": "The action triggered when a value attribute changes.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "placeholder", "type": "STRING", "description": "Text that is displayed when the field is empty,\nto prompt the user for a valid entry.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "read-only", "type": "", "description": "If present, the textarea field is read-only and cannot be edited.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "readonly", "type": "BOOLEAN", "description": "Specifies that an input field is read-only. This value defaults to false.", "required": false }, { "name": "required", "type": "BOOLEAN", "description": "If present, the textarea field must be filled out before the form can be submitted.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "validity", "type": "OBJECT", "description": "Represents the validity states of the textarea input, with respect to constraint validation.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "value", "type": "STRING", "description": "The value of the textarea input, also used as the default value during init.", "access": "global", "parent": "lightning-textarea", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of the textarea.\nAccepted variants include standard, label-hidden, label-inline, and label-stacked.\nThis value defaults to standard.\nUse label-hidden to hide the label but make it available to assistive technology.\nUse label-inline to horizontally align the label and textarea.\nUse label-stacked to place the label above the textarea.", "access": "global", "parent": "lightning-textarea", "required": false } ] }, "lightning-formatted-name": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "first-name", "type": "STRING", "description": "The value for the first name.", "access": "global", "parent": "lightning-formatted-name", "required": false }, { "name": "format", "type": "STRING", "description": "The format to use to display the name. Valid values include short, medium, and long. This value defaults to long.", "access": "global", "parent": "lightning-formatted-name", "required": false }, { "name": "informal-name", "type": "STRING", "description": "The value for the informal name.", "access": "global", "parent": "lightning-formatted-name", "required": false }, { "name": "last-name", "type": "STRING", "description": "The value for the last name.", "access": "global", "parent": "lightning-formatted-name", "required": false }, { "name": "middle-name", "type": "STRING", "description": "The value for the middle name.", "access": "global", "parent": "lightning-formatted-name", "required": false }, { "name": "salutation", "type": "STRING", "description": "The value for the salutation, such as Dr. or Mrs.", "access": "global", "parent": "lightning-formatted-name", "required": false }, { "name": "suffix", "type": "STRING", "description": "The value for the suffix, such as Jr. or Esq.", "access": "global", "parent": "lightning-formatted-name", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false } ], "description": "Displays a formatted name that can include a salutation and suffix." }, "lightning-vertical-navigation-item-badge": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "assistive-text", "type": "STRING", "description": "Assistive text describing the number in the badge, which enhances accessibility and is not displayed to the user.\nThe default is \"New Items\".", "access": "global", "parent": "lightning-vertical-navigation-item-badge", "required": false }, { "name": "badge-count", "type": "INTEGER", "description": "The number to show inside the badge. If this value is zero, the badge is hidden.\nThe default value is zero.", "access": "global", "parent": "lightning-vertical-navigation-item-badge", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "href", "type": "STRING", "description": "The URL of the page that the navigation item goes to.", "access": "global", "parent": "lightning-vertical-navigation-item-badge", "required": false }, { "name": "label", "type": "STRING", "description": "The text displayed for this navigation item.", "access": "global", "parent": "lightning-vertical-navigation-item-badge", "required": true }, { "name": "name", "type": "STRING", "description": "A unique identifier for this navigation item.", "access": "global", "parent": "lightning-vertical-navigation-item-badge", "required": true }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false } ], "description": "A link and badge within lightning-vertical-navigation-section or lightning-vertical-navigation-overflow." }, "lightningsnapin-base-chat-message": { "type": "module", "namespace": "lightningsnapin", "attributes": [ { "name": "message-content", "type": "", "description": "Message content based on the concrete type of the chat message.", "access": "global", "parent": "lightningsnapin-base-chat-message", "required": false }, { "name": "user-type", "type": "", "description": "The user type, which is either \"agent\" or \"chasitor\".", "access": "global", "parent": "lightningsnapin-base-chat-message", "required": false } ], "description": null }, "lightning-card": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "actions", "type": "AURA.COMPONENT[]", "description": "Actions are components such as button or buttonIcon. Actions are displayed in the header.", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "footer", "type": "OBJECT", "description": "The footer can include text or another component", "required": false }, { "name": "icon-name", "type": "STRING", "description": "The Lightning Design System name of the icon.\nNames are written in the format 'utility:down' where 'utility' is the category,\nand 'down' is the specific icon to be displayed.\nThe icon is displayed in the header to the left of the title.", "access": "global", "parent": "lightning-card", "required": false }, { "name": "title", "type": "OBJECT", "description": "The title can include text, and is displayed in the header.\nTo include additional markup or another component, use the title slot.", "access": "global", "parent": "lightning-card", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of the card.\nAccepted variants include base or narrow.\nThis value defaults to base.", "access": "global", "parent": "lightning-card", "required": false } ], "description": "Cards apply a container around a related grouping of information." }, "lightning-input-rich-text": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "aria-describedby", "type": "STRING", "description": "A space-separated list of element IDs that provides descriptive labels for the rich text editor.", "required": false }, { "name": "aria-label", "type": "STRING", "description": "Label describing the rich text editor to assistive technologies", "required": false }, { "name": "aria-labelledby", "type": "STRING", "description": "An element ID that provides a label for the rich text editor.", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "custom-buttons", "type": "", "description": "Reserved for internal use. Custom buttons to add to the toolbar.", "access": "global", "parent": "lightning-input-rich-text", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the editor is disabled and users cannot interact with it.", "access": "global", "parent": "lightning-input-rich-text", "required": false }, { "name": "disabled-categories", "type": "LIST", "description": "A comma-separated list of button categories to remove from the toolbar.", "access": "global", "parent": "lightning-input-rich-text", "required": false }, { "name": "formats", "type": "LIST", "description": "A allowlist of formats. By default, the list is computed based on enabled categories.\nThe 'table' format is always enabled to support copying and pasting of tables if formats are not provided.", "access": "global", "parent": "lightning-input-rich-text", "required": false }, { "name": "label", "type": "STRING", "description": "The label of the rich text editor.", "access": "global", "parent": "lightning-input-rich-text", "required": false }, { "name": "label-visible", "type": "BOOLEAN", "description": "If present, the label on the rich text editor is visible.", "access": "global", "parent": "lightning-input-rich-text", "required": false }, { "name": "message-when-bad-input", "type": "STRING", "description": "Error message to be displayed when invalid input is detected.", "access": "global", "parent": "lightning-input-rich-text", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "placeholder", "type": "STRING", "description": "Text that is displayed when the field is empty, to prompt the user for a valid entry.", "access": "global", "parent": "lightning-input-rich-text", "required": false }, { "name": "share-with-entity-id", "type": "STRING", "description": "Entity ID to share the image with.", "access": "global", "parent": "lightning-input-rich-text", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "valid", "type": "BOOLEAN", "description": "Specifies whether the editor content is valid. If invalid, the slds-has-error class is added. This value defaults to true.", "access": "global", "parent": "lightning-input-rich-text", "required": false }, { "name": "value", "type": "STRING", "description": "The HTML content in the rich text editor.", "access": "global", "parent": "lightning-input-rich-text", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of the toolbar. Accepted variant is bottom-toolbar which causes\nthe toolbar to be displayed below the text box.", "access": "global", "parent": "lightning-input-rich-text", "required": false } ], "description": "A WYSIWYG editor with a customizable toolbar for entering rich text", "methods": [ { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "aria-describedby", "type": "STRING", "description": "A space-separated list of element IDs that provides descriptive labels for the rich text editor.", "required": false }, { "name": "aria-label", "type": "STRING", "description": "Label describing the rich text editor to assistive technologies", "required": false }, { "name": "aria-labelledby", "type": "STRING", "description": "An element ID that provides a label for the rich text editor.", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "custom-buttons", "type": "", "description": "Reserved for internal use. Custom buttons to add to the toolbar.", "access": "global", "parent": "lightning-input-rich-text", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the editor is disabled and users cannot interact with it.", "access": "global", "parent": "lightning-input-rich-text", "required": false }, { "name": "disabled-categories", "type": "LIST", "description": "A comma-separated list of button categories to remove from the toolbar.", "access": "global", "parent": "lightning-input-rich-text", "required": false }, { "name": "formats", "type": "LIST", "description": "A allowlist of formats. By default, the list is computed based on enabled categories.\nThe 'table' format is always enabled to support copying and pasting of tables if formats are not provided.", "access": "global", "parent": "lightning-input-rich-text", "required": false }, { "name": "label", "type": "STRING", "description": "The label of the rich text editor.", "access": "global", "parent": "lightning-input-rich-text", "required": false }, { "name": "label-visible", "type": "BOOLEAN", "description": "If present, the label on the rich text editor is visible.", "access": "global", "parent": "lightning-input-rich-text", "required": false }, { "name": "message-when-bad-input", "type": "STRING", "description": "Error message to be displayed when invalid input is detected.", "access": "global", "parent": "lightning-input-rich-text", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "placeholder", "type": "STRING", "description": "Text that is displayed when the field is empty, to prompt the user for a valid entry.", "access": "global", "parent": "lightning-input-rich-text", "required": false }, { "name": "share-with-entity-id", "type": "STRING", "description": "Entity ID to share the image with.", "access": "global", "parent": "lightning-input-rich-text", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "valid", "type": "BOOLEAN", "description": "Specifies whether the editor content is valid. If invalid, the slds-has-error class is added. This value defaults to true.", "access": "global", "parent": "lightning-input-rich-text", "required": false }, { "name": "value", "type": "STRING", "description": "The HTML content in the rich text editor.", "access": "global", "parent": "lightning-input-rich-text", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of the toolbar. Accepted variant is bottom-toolbar which causes\nthe toolbar to be displayed below the text box.", "access": "global", "parent": "lightning-input-rich-text", "required": false } ] }, "lightning-progress-bar": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "size", "type": "STRING", "description": "The size of the progress bar.\nValid values are x-small, small, medium, and large.\nThe default value is medium.", "access": "global", "parent": "lightning-progress-bar", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "value", "type": "INTEGER", "description": "The percentage value of the progress bar.", "access": "global", "parent": "lightning-progress-bar", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of the progress bar.\nAccepted variants include base or circular.\nThis value defaults to base.", "access": "global", "parent": "lightning-progress-bar", "required": false } ], "description": "Displays a horizontal progress bar from left to right to indicate the progress of an operation." }, "lightning-formatted-phone": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "onclick", "type": "AURA.ACTION", "description": "The action triggered when the phone number is clicked.", "required": false }, { "name": "tab-index", "type": "", "description": "Reserved for internal use. Use tabindex instead to indicate if an element should be focusable.\nA value of 0 means that the element is focusable and\nparticipates in sequential keyboard navigation. A value of -1 means\nthat the element is focusable but does not participate in keyboard navigation.", "access": "global", "parent": "lightning-formatted-phone", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "value", "type": "INTEGER", "description": "Sets the phone number to display.", "access": "global", "parent": "lightning-formatted-phone", "required": false } ], "description": "Displays a phone number as a hyperlink with the tel: URL scheme." }, "lightning-record-picker": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "disabled", "type": "BOOLEAN", "description": "If present, the component is disabled and you can't interact with it.", "access": "global", "parent": "lightning-record-picker", "required": false }, { "name": "display-info", "type": "", "description": "The display configuration used to customize the way retrieved records are presented.", "access": "global", "parent": "lightning-record-picker", "required": false }, { "name": "field-level-help", "type": "STRING", "description": "Help text detailing the purpose and function of the record picker, displayed on hover for desktop and on click for mobile", "access": "global", "parent": "lightning-record-picker", "required": false }, { "name": "filter", "type": "", "description": "The filter applied to the retrieved records.", "access": "global", "parent": "lightning-record-picker", "required": false }, { "name": "label", "type": "STRING", "description": "The text label for the component.", "access": "global", "parent": "lightning-record-picker", "required": true }, { "name": "matching-info", "type": "", "description": "The matching configuration to customize the fields used to match the search results to the search term entered by the user.", "access": "global", "parent": "lightning-record-picker", "required": false }, { "name": "message-when-bad-input", "type": "STRING", "description": "The error message displayed when the user enters a search term in the input but doesn't select an option.", "access": "global", "parent": "lightning-record-picker", "required": false }, { "name": "object-api-name", "type": "STRING", "description": "The API name of the object for the retrieved records.", "access": "global", "parent": "lightning-record-picker", "required": true }, { "name": "placeholder", "type": "STRING", "description": "The text displayed when the input is empty to prompt the user to enter a search term.", "access": "global", "parent": "lightning-record-picker", "required": false }, { "name": "required", "type": "BOOLEAN", "description": "If present, specifies that a user must select a record. If no record is selected, the record picker is in an invalid state.", "access": "global", "parent": "lightning-record-picker", "required": false }, { "name": "value", "type": "STRING", "description": "The ID of the record that is selected in the record picker.", "access": "global", "parent": "lightning-record-picker", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of the component. The component displays the label above the combobox by default. Specify variant=\"label-hidden\" to hide the label but make it available to assistive technology. The only variant is label-hidden.", "access": "global", "parent": "lightning-record-picker", "required": false } ], "methods": [ { "name": "blur", "type": "", "description": "Remove the focus of the component.", "access": "global", "parent": "lightning-record-picker", "required": false }, { "name": "checkValidity", "type": "", "description": "Check if the component is in a valid state.", "access": "global", "parent": "lightning-record-picker", "required": false }, { "name": "clearSelection", "type": "", "description": "Clears the selected record.\nThis method does not clear the search term or refresh the validity message.", "access": "global", "parent": "lightning-record-picker", "required": false }, { "name": "focus", "type": "", "description": "Set the focus of the component.", "access": "global", "parent": "lightning-record-picker", "required": false }, { "name": "reportValidity", "type": "", "description": "Check if the component is in a valid state and refresh the validity message.\nIf the component is valid, it clears the validity error message.\nIf the component is invalid, it displays the validity error message.", "access": "global", "parent": "lightning-record-picker", "required": false }, { "name": "setCustomValidity", "type": "", "description": "Set a custom validity error message.", "access": "global", "parent": "lightning-record-picker", "required": false } ], "description": "A component that provides an input search field, that can search for Salesforce records." }, "lightningsnapin-base-prechat": { "type": "module", "namespace": "lightningsnapin", "attributes": [], "description": null }, "lightning-menu-item": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "access-key", "type": "", "description": "The keyboard shortcut for the menu item.", "access": "global", "parent": "lightning-menu-item", "required": false }, { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "checked", "type": "BOOLEAN", "description": "If present, a check mark displays on the left of the menu item if it's selected.", "access": "global", "parent": "lightning-menu-item", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the menu item is disabled and users cannot interact with it.", "access": "global", "parent": "lightning-menu-item", "required": false }, { "name": "download", "type": "", "description": "The name of a file that's downloaded when clicking a link in the menu item. Used with the href attribute.", "access": "global", "parent": "lightning-menu-item", "required": false }, { "name": "draft-alternative-text", "type": "STRING", "description": "Describes the reason for showing the draft indicator.\nThis is required when is-draft is present on the lightning-menu-item tag.", "access": "global", "parent": "lightning-menu-item", "required": false }, { "name": "href", "type": "STRING", "description": "URL for a link to use for the menu item.", "access": "global", "parent": "lightning-menu-item", "required": false }, { "name": "icon-name", "type": "STRING", "description": "The name of an icon to display after the text of the menu item.", "access": "global", "parent": "lightning-menu-item", "required": false }, { "name": "is-draft", "type": "BOOLEAN", "description": "If present, a draft indicator is shown on the menu item.\nA draft indicator is denoted by blue asterisk on the left of the menu item.\nWhen you use a draft indicator, include alternative text for accessibility using draft-alternative-text.", "access": "global", "parent": "lightning-menu-item", "required": false }, { "name": "label", "type": "STRING", "description": "Text of the menu item.", "access": "global", "parent": "lightning-menu-item", "required": false }, { "name": "onactive", "type": "AURA.ACTION", "description": "DEPRECATED. The action triggered when this menu item is selected.", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "prefix-icon-name", "type": "STRING", "description": "The name of an icon to display before the text of the menu item.", "access": "global", "parent": "lightning-menu-item", "required": false }, { "name": "tab-index", "type": "", "description": "Reserved for internal use. Use tabindex instead to indicate if an element should be focusable.\ntabindex can be set to 0 or -1.\nThe default tabindex value is 0, which means that the menu item is focusable and\nparticipates in sequential keyboard navigation. The value -1 means\nthat the menu item is focusable but does not participate in keyboard navigation.", "access": "global", "parent": "lightning-menu-item", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "value", "type": "STRING", "description": "A value associated with the menu item.", "access": "global", "parent": "lightning-menu-item", "required": false } ], "description": "Represents a list item in a menu.", "methods": [ { "name": "access-key", "type": "", "description": "The keyboard shortcut for the menu item.", "access": "global", "parent": "lightning-menu-item", "required": false }, { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "checked", "type": "BOOLEAN", "description": "If present, a check mark displays on the left of the menu item if it's selected.", "access": "global", "parent": "lightning-menu-item", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the menu item is disabled and users cannot interact with it.", "access": "global", "parent": "lightning-menu-item", "required": false }, { "name": "download", "type": "", "description": "The name of a file that's downloaded when clicking a link in the menu item. Used with the href attribute.", "access": "global", "parent": "lightning-menu-item", "required": false }, { "name": "draft-alternative-text", "type": "STRING", "description": "Describes the reason for showing the draft indicator.\nThis is required when is-draft is present on the lightning-menu-item tag.", "access": "global", "parent": "lightning-menu-item", "required": false }, { "name": "href", "type": "STRING", "description": "URL for a link to use for the menu item.", "access": "global", "parent": "lightning-menu-item", "required": false }, { "name": "icon-name", "type": "STRING", "description": "The name of an icon to display after the text of the menu item.", "access": "global", "parent": "lightning-menu-item", "required": false }, { "name": "is-draft", "type": "BOOLEAN", "description": "If present, a draft indicator is shown on the menu item.\nA draft indicator is denoted by blue asterisk on the left of the menu item.\nWhen you use a draft indicator, include alternative text for accessibility using draft-alternative-text.", "access": "global", "parent": "lightning-menu-item", "required": false }, { "name": "label", "type": "STRING", "description": "Text of the menu item.", "access": "global", "parent": "lightning-menu-item", "required": false }, { "name": "onactive", "type": "AURA.ACTION", "description": "DEPRECATED. The action triggered when this menu item is selected.", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "prefix-icon-name", "type": "STRING", "description": "The name of an icon to display before the text of the menu item.", "access": "global", "parent": "lightning-menu-item", "required": false }, { "name": "tab-index", "type": "", "description": "Reserved for internal use. Use tabindex instead to indicate if an element should be focusable.\ntabindex can be set to 0 or -1.\nThe default tabindex value is 0, which means that the menu item is focusable and\nparticipates in sequential keyboard navigation. The value -1 means\nthat the menu item is focusable but does not participate in keyboard navigation.", "access": "global", "parent": "lightning-menu-item", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "value", "type": "STRING", "description": "A value associated with the menu item.", "access": "global", "parent": "lightning-menu-item", "required": false } ] }, "lightning-ui-object-info-api": { "type": "module", "namespace": "lightning", "attributes": [], "description": null }, "lightning-pill": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "aria-selected", "type": "", "description": "Specifies the aria-selected of an element.", "access": "global", "parent": "lightning-pill", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "has-error", "type": "BOOLEAN", "description": "If present, the pill is shown with a red border and an error icon on the left of the label.", "access": "global", "parent": "lightning-pill", "required": false }, { "name": "href", "type": "STRING", "description": "The URL of the page that the link goes to.", "access": "global", "parent": "lightning-pill", "required": false }, { "name": "is-plain-link", "type": "", "description": "Reserved for internal use. Specifies whether the element variant is a plain link.", "access": "global", "parent": "lightning-pill", "required": false }, { "name": "label", "type": "STRING", "description": "The text label that displays in the pill.", "access": "global", "parent": "lightning-pill", "required": true }, { "name": "media", "type": "AURA.COMPONENT[]", "description": "The icon or figure that's displayed next to the textual information.", "required": false }, { "name": "name", "type": "STRING", "description": "The name for the pill. This value is optional and can be used to identify the pill in a callback.", "access": "global", "parent": "lightning-pill", "required": false }, { "name": "onclick", "type": "AURA.ACTION", "description": "The action triggered when the button is clicked.", "required": false }, { "name": "onremove", "type": "AURA.ACTION", "description": "The action triggered when the pill is removed.", "required": false }, { "name": "role", "type": "", "description": "Specifies the role of an element.", "access": "global", "parent": "lightning-pill", "required": false }, { "name": "tab-index", "type": "", "description": "Reserved for internal use. Use tabindex instead to indicate if an element should be focusable.\nA value of 0 means that the pill is focusable and\nparticipates in sequential keyboard navigation. A value of -1 means\nthat the pill is focusable but does not participate in keyboard navigation.", "access": "global", "parent": "lightning-pill", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "variant", "type": "", "description": "The variant changes the appearance of the pill.\nAccepted variants include link, plain, and plainLink.\nThe default variant is link, which creates a link in the pill when you specify the href attribute.\nThe plain variant renders the pill without a link and ignores the href attribute.\nThe plainLink variant is reserved for internal use.", "access": "global", "parent": "lightning-pill", "required": false } ], "description": "A pill displays a label that can contain links and can be removed from view." }, "lightning-button-icon": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "alternative-text", "type": "STRING", "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'.", "access": "global", "parent": "lightning-button-icon", "required": false }, { "name": "aria-atomic", "type": "STRING", "description": "Indicates whether assistive technologies will present all, or only parts of, the changed region. Valid values are 'true' or 'false'.", "required": false }, { "name": "aria-controls", "type": "STRING", "description": "A space-separated list of element IDs that this button controls the contents or presence of.", "required": false }, { "name": "aria-describedby", "type": "STRING", "description": "A space-separated list of element IDs that provides descriptive labels for the button.", "required": false }, { "name": "aria-expanded", "type": "STRING", "description": "Indicates whether an element the button controls is expanded or collapsed. Valid values are 'true' or 'false'.", "required": false }, { "name": "aria-label", "type": "STRING", "description": "Label describing the button to assistive technologies.", "required": false }, { "name": "aria-live", "type": "STRING", "description": "Indicates that the button will be updated. Valid values are 'assertive', 'polite', or 'off'.", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "Specifies whether this button should be displayed in a disabled state. Disabled buttons can't be clicked. This value defaults to false.", "required": false }, { "name": "icon-class", "type": "STRING", "description": "The class to be applied to the contained icon element.", "access": "global", "parent": "lightning-button-icon", "required": false }, { "name": "icon-name", "type": "STRING", "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.", "access": "global", "parent": "lightning-button-icon", "required": false }, { "name": "name", "type": "STRING", "description": "The name for the button element. This value is optional and can be used to identify the button in a callback.", "access": "global", "parent": "lightning-button-icon", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onclick", "type": "AURA.ACTION", "description": "The action that will be run when the button is clicked.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "size", "type": "STRING", "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.", "access": "global", "parent": "lightning-button-icon", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "tooltip", "type": "", "description": null, "access": "global", "parent": "lightning-button-icon", "required": false }, { "name": "type", "type": "STRING", "description": "Specifies the type of button. Valid values are button, reset, and submit. This value defaults to button.", "access": "global", "parent": "lightning-button-icon", "required": false }, { "name": "value", "type": "STRING", "description": "The value for the button element. This value is optional and can be used when submitting a form.", "access": "global", "parent": "lightning-button-icon", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of buttonIcon. Accepted variants include bare,\n container, brand, border, border-filled, bare-inverse, and border-inverse. This value defaults to border.", "access": "global", "parent": "lightning-button-icon", "required": false } ], "description": "An icon-only HTML button.", "methods": [ { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "alternative-text", "type": "STRING", "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'.", "access": "global", "parent": "lightning-button-icon", "required": false }, { "name": "aria-atomic", "type": "STRING", "description": "Indicates whether assistive technologies will present all, or only parts of, the changed region. Valid values are 'true' or 'false'.", "required": false }, { "name": "aria-controls", "type": "STRING", "description": "A space-separated list of element IDs that this button controls the contents or presence of.", "required": false }, { "name": "aria-describedby", "type": "STRING", "description": "A space-separated list of element IDs that provides descriptive labels for the button.", "required": false }, { "name": "aria-expanded", "type": "STRING", "description": "Indicates whether an element the button controls is expanded or collapsed. Valid values are 'true' or 'false'.", "required": false }, { "name": "aria-label", "type": "STRING", "description": "Label describing the button to assistive technologies.", "required": false }, { "name": "aria-live", "type": "STRING", "description": "Indicates that the button will be updated. Valid values are 'assertive', 'polite', or 'off'.", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "Specifies whether this button should be displayed in a disabled state. Disabled buttons can't be clicked. This value defaults to false.", "required": false }, { "name": "icon-class", "type": "STRING", "description": "The class to be applied to the contained icon element.", "access": "global", "parent": "lightning-button-icon", "required": false }, { "name": "icon-name", "type": "STRING", "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.", "access": "global", "parent": "lightning-button-icon", "required": false }, { "name": "name", "type": "STRING", "description": "The name for the button element. This value is optional and can be used to identify the button in a callback.", "access": "global", "parent": "lightning-button-icon", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onclick", "type": "AURA.ACTION", "description": "The action that will be run when the button is clicked.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "size", "type": "STRING", "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.", "access": "global", "parent": "lightning-button-icon", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "tooltip", "type": "", "description": null, "access": "global", "parent": "lightning-button-icon", "required": false }, { "name": "type", "type": "STRING", "description": "Specifies the type of button. Valid values are button, reset, and submit. This value defaults to button.", "access": "global", "parent": "lightning-button-icon", "required": false }, { "name": "value", "type": "STRING", "description": "The value for the button element. This value is optional and can be used when submitting a form.", "access": "global", "parent": "lightning-button-icon", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of buttonIcon. Accepted variants include bare,\n container, brand, border, border-filled, bare-inverse, and border-inverse. This value defaults to border.", "access": "global", "parent": "lightning-button-icon", "required": false } ] }, "lightning-progress-ring": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "value", "type": "", "description": "The percentage value of the progress ring. The value must be a number from 0 to 100.\nA value of 50 corresponds to a color fill of half the ring in a clockwise\nor counterclockwise direction, depending on the direction attribute.", "access": "global", "parent": "lightning-progress-ring", "required": false }, { "name": "variant", "type": "", "description": "Changes the appearance of the progress ring.\nAccepted variants include base, active-step, warning, expired, base-autocomplete.", "access": "global", "parent": "lightning-progress-ring", "required": false }, { "name": "direction", "type": "", "description": "Controls which way the color flows from the top of the ring, either clockwise or counterclockwise\nValid values include fill and drain. The fill value corresponds to a color flow in the clockwise direction.\nThe drain value indicates a color flow in the counterclockwise direction.", "access": "global", "parent": "lightning-progress-ring", "required": false }, { "name": "size", "type": "", "description": "The size of the progress ring. Valid values include medium and large.", "access": "global", "parent": "lightning-progress-ring", "required": false } ], "description": "Displays a circular progress indicator to provide feedback about an action or process.\nThis component requires API version 48.0 and later." }, "lightning-input-address": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "address-label", "type": "STRING", "description": "The label of the address compound field.", "access": "global", "parent": "lightning-input-address", "required": false }, { "name": "city", "type": "STRING", "description": "The city field of the address.", "access": "global", "parent": "lightning-input-address", "required": false }, { "name": "city-label", "type": "STRING", "description": "The label of the city field of the address.", "access": "global", "parent": "lightning-input-address", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "country", "type": "STRING", "description": "The country field of the address. If country-options is provided, this country value is selected by default.", "access": "global", "parent": "lightning-input-address", "required": false }, { "name": "country-label", "type": "STRING", "description": "The label of the country field of the address.", "access": "global", "parent": "lightning-input-address", "required": false }, { "name": "country-options", "type": "LIST", "description": "The array of label-value pairs for the country. Displays a dropdown menu of options.", "access": "global", "parent": "lightning-input-address", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the address fields are disabled and users cannot interact with them.", "access": "global", "parent": "lightning-input-address", "required": false }, { "name": "field-level-help", "type": "STRING", "description": "Help text detailing the purpose and function of the input.", "access": "global", "parent": "lightning-input-address", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the input releases focus.", "required": false }, { "name": "onchange", "type": "AURA.ACTION", "description": "The action triggered when the value changes.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the input receives focus.", "required": false }, { "name": "postal-code", "type": "STRING", "description": "The postal code field of the address.", "access": "global", "parent": "lightning-input-address", "required": false }, { "name": "postal-code-label", "type": "STRING", "description": "The label of the postal code field of the address.", "access": "global", "parent": "lightning-input-address", "required": false }, { "name": "province", "type": "STRING", "description": "The province field of the address. If province-options is provided, this province value is selected by default.", "access": "global", "parent": "lightning-input-address", "required": false }, { "name": "province-label", "type": "STRING", "description": "The label of the province field of the address.", "access": "global", "parent": "lightning-input-address", "required": false }, { "name": "province-options", "type": "LIST", "description": "The array of label-value pairs for the province. Displays a dropdown menu of options.", "access": "global", "parent": "lightning-input-address", "required": false }, { "name": "read-only", "type": "", "description": "If present, the address fields are read-only and cannot be edited.", "access": "global", "parent": "lightning-input-address", "required": false }, { "name": "readonly", "type": "BOOLEAN", "description": "Specifies whether the address fields are read-only. This value defaults to false.", "required": false }, { "name": "required", "type": "BOOLEAN", "description": "If present, the address fields must be filled before the form is submitted.", "access": "global", "parent": "lightning-input-address", "required": false }, { "name": "show-address-lookup", "type": "", "description": "If present, address lookup using Google Maps is enabled.", "access": "global", "parent": "lightning-input-address", "required": false }, { "name": "street", "type": "STRING", "description": "The street field of the address.", "access": "global", "parent": "lightning-input-address", "required": false }, { "name": "street-label", "type": "STRING", "description": "The label of the street field of the address.", "access": "global", "parent": "lightning-input-address", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "validity", "type": "", "description": "Represents the validity states that an element can be in, with respect to constraint validation.", "access": "global", "parent": "lightning-input-address", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of an input address field.\nAccepted variants include standard, label-hidden, label-inline, and label-stacked.\nThis value defaults to standard.\nUse label-hidden to hide the label but make it available to assistive technology.\nUse label-inline to horizontally align the label and input address field.\nUse label-stacked to place the label above the input address field.", "access": "global", "parent": "lightning-input-address", "required": false } ], "description": "Represents an address compound field." }, "lightning-formatted-date-time": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "day", "type": "STRING", "description": "Allowed values are numeric or 2-digit.", "access": "global", "parent": "lightning-formatted-date-time", "required": false }, { "name": "era", "type": "STRING", "description": "Allowed values are narrow, short, or long.", "access": "global", "parent": "lightning-formatted-date-time", "required": false }, { "name": "hour", "type": "STRING", "description": "Allowed values are numeric or 2-digit.", "access": "global", "parent": "lightning-formatted-date-time", "required": false }, { "name": "hour12", "type": "BOOLEAN", "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.", "access": "global", "parent": "lightning-formatted-date-time", "required": false }, { "name": "minute", "type": "STRING", "description": "Allowed values are numeric or 2-digit.", "access": "global", "parent": "lightning-formatted-date-time", "required": false }, { "name": "month", "type": "STRING", "description": "Allowed values are 2-digit, narrow, short, or long.", "access": "global", "parent": "lightning-formatted-date-time", "required": false }, { "name": "second", "type": "STRING", "description": "Allowed values are numeric or 2-digit.", "access": "global", "parent": "lightning-formatted-date-time", "required": false }, { "name": "time-zone", "type": "STRING", "description": "The time zone to display. Use this attribute only if you want to override the default, which is the runtime's\ntime zone. Specify a time zone listed in the IANA time zone database (https://www.iana.org/time-zones). For example, set\nthe value to 'Pacific/Honolulu' to display Hawaii time. The short code UTC is also accepted.", "access": "global", "parent": "lightning-formatted-date-time", "required": false }, { "name": "time-zone-name", "type": "STRING", "description": "Allowed values are short or long. For example, the Pacific time zone would display as 'PST'\nif you specify 'short', or 'Pacific Standard Time' if you specify 'long.'", "access": "global", "parent": "lightning-formatted-date-time", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "value", "type": "OBJECT", "description": "The value to be formatted, which can be a Date object, timestamp, or an ISO8601 formatted string.", "access": "global", "parent": "lightning-formatted-date-time", "required": false }, { "name": "weekday", "type": "STRING", "description": "Specifies how to display the day of the week. Allowed values are narrow, short, or long.", "access": "global", "parent": "lightning-formatted-date-time", "required": false }, { "name": "year", "type": "STRING", "description": "Allowed values are numeric or 2-digit.", "access": "global", "parent": "lightning-formatted-date-time", "required": false } ], "description": "Displays formatted date and time." }, "lightning-checkbox-group": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the checkbox group is disabled.\nCheckbox selections can't be changed for a disabled checkbox group.", "access": "global", "parent": "lightning-checkbox-group", "required": false }, { "name": "label", "type": "STRING", "description": "Text label for the checkbox group.", "access": "global", "parent": "lightning-checkbox-group", "required": true }, { "name": "message-when-value-missing", "type": "STRING", "description": "Optional message to be displayed when no checkbox is selected\nand the required attribute is set.", "access": "global", "parent": "lightning-checkbox-group", "required": false }, { "name": "name", "type": "STRING", "description": "The name of the checkbox group.", "access": "global", "parent": "lightning-checkbox-group", "required": true }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the checkbox group releases focus.", "required": false }, { "name": "onchange", "type": "AURA.ACTION", "description": "The action triggered when a checkbox value changes.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the checkbox group receives focus.", "required": false }, { "name": "options", "type": "LIST", "description": "Array of label-value pairs for each checkbox.", "access": "global", "parent": "lightning-checkbox-group", "required": true }, { "name": "required", "type": "BOOLEAN", "description": "If present, at least one checkbox must be selected.", "access": "global", "parent": "lightning-checkbox-group", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "validity", "type": "", "description": "Represents the validity states that an element can be in, with respect to constraint validation.", "access": "global", "parent": "lightning-checkbox-group", "required": false }, { "name": "value", "type": "STRING[]", "description": "The list of selected checkboxes.\nEach array entry contains the value of a selected checkbox.\nThe value of each checkbox is set in the options attribute.", "access": "global", "parent": "lightning-checkbox-group", "required": true }, { "name": "variant", "type": "", "description": "The variant changes the appearance of the checkbox group.\nAccepted variants include standard, label-hidden, label-inline, and label-stacked.\nThis value defaults to standard.\nUse label-hidden to hide the label but make it available to assistive technology.\nUse label-inline to horizontally align the label and checkbox group.\nUse label-stacked to place the label above the checkbox group.", "access": "global", "parent": "lightning-checkbox-group", "required": false } ], "description": "A checkbox group that enables selection of single or multiple options.", "methods": [ { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the checkbox group is disabled.\nCheckbox selections can't be changed for a disabled checkbox group.", "access": "global", "parent": "lightning-checkbox-group", "required": false }, { "name": "label", "type": "STRING", "description": "Text label for the checkbox group.", "access": "global", "parent": "lightning-checkbox-group", "required": true }, { "name": "message-when-value-missing", "type": "STRING", "description": "Optional message to be displayed when no checkbox is selected\nand the required attribute is set.", "access": "global", "parent": "lightning-checkbox-group", "required": false }, { "name": "name", "type": "STRING", "description": "The name of the checkbox group.", "access": "global", "parent": "lightning-checkbox-group", "required": true }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the checkbox group releases focus.", "required": false }, { "name": "onchange", "type": "AURA.ACTION", "description": "The action triggered when a checkbox value changes.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the checkbox group receives focus.", "required": false }, { "name": "options", "type": "LIST", "description": "Array of label-value pairs for each checkbox.", "access": "global", "parent": "lightning-checkbox-group", "required": true }, { "name": "required", "type": "BOOLEAN", "description": "If present, at least one checkbox must be selected.", "access": "global", "parent": "lightning-checkbox-group", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "validity", "type": "", "description": "Represents the validity states that an element can be in, with respect to constraint validation.", "access": "global", "parent": "lightning-checkbox-group", "required": false }, { "name": "value", "type": "STRING[]", "description": "The list of selected checkboxes.\nEach array entry contains the value of a selected checkbox.\nThe value of each checkbox is set in the options attribute.", "access": "global", "parent": "lightning-checkbox-group", "required": true }, { "name": "variant", "type": "", "description": "The variant changes the appearance of the checkbox group.\nAccepted variants include standard, label-hidden, label-inline, and label-stacked.\nThis value defaults to standard.\nUse label-hidden to hide the label but make it available to assistive technology.\nUse label-inline to horizontally align the label and checkbox group.\nUse label-stacked to place the label above the checkbox group.", "access": "global", "parent": "lightning-checkbox-group", "required": false } ] }, "lightning-accordion-section": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "actions", "type": "AURA.COMPONENT[]", "description": "Enables a custom menu implementation. Actions are displayed to the right of the section title.", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "label", "type": "STRING", "description": "The text that displays as the title of the section.", "access": "global", "parent": "lightning-accordion-section", "required": false }, { "name": "name", "type": "STRING", "description": "The unique section name to use with the active-section-name attribute in the accordion component.", "access": "global", "parent": "lightning-accordion-section", "required": false }, { "name": "title", "type": "STRING", "description": "Displays a tooltip text when the mouse moves over the element.", "access": "global", "parent": "lightning-accordion-section", "required": false } ], "description": "A single section that is nested in an accordion component." }, "lightning-vertical-navigation-item-icon": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "href", "type": "STRING", "description": "The URL of the page that the navigation item goes to.", "access": "global", "parent": "lightning-vertical-navigation-item-icon", "required": false }, { "name": "icon-name", "type": "STRING", "description": "The Lightning Design System name of the icon.\nNames are written in the format 'utility:down' where 'utility' is the category,\nand 'down' is the specific icon to be displayed.", "access": "global", "parent": "lightning-vertical-navigation-item-icon", "required": false }, { "name": "label", "type": "STRING", "description": "The text displayed for this navigation item.", "access": "global", "parent": "lightning-vertical-navigation-item-icon", "required": true }, { "name": "name", "type": "STRING", "description": "A unique identifier for this navigation item.", "access": "global", "parent": "lightning-vertical-navigation-item-icon", "required": true }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false } ], "description": "A link and icon within lightning-vertical-navigation-section or lightning-vertical-navigation-overflow." }, "lightning-radio-group": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the radio group is disabled and users cannot interact with it.", "access": "global", "parent": "lightning-radio-group", "required": false }, { "name": "label", "type": "STRING", "description": "Text label for the radio group.", "access": "global", "parent": "lightning-radio-group", "required": true }, { "name": "message-when-value-missing", "type": "STRING", "description": "Optional message displayed when no radio button is selected and the required attribute is set to true.", "access": "global", "parent": "lightning-radio-group", "required": false }, { "name": "name", "type": "STRING", "description": "Specifies the name of the radio button group. Only only one button can be selected if a name is specified\nfor the group.", "access": "global", "parent": "lightning-radio-group", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onchange", "type": "AURA.ACTION", "description": "The action triggered when a value attribute changes.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "options", "type": "LIST", "description": "Array of label-value pairs for each radio button.", "access": "global", "parent": "lightning-radio-group", "required": true }, { "name": "readonly", "type": "BOOLEAN", "description": "Specifies that an input field is read-only. This value defaults to false.", "required": false }, { "name": "required", "type": "BOOLEAN", "description": "If present, a radio button must be selected before the form can be submitted.", "access": "global", "parent": "lightning-radio-group", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "type", "type": "STRING", "description": "The style of the radio group. Options are radio or button. The default is radio.", "access": "global", "parent": "lightning-radio-group", "required": false }, { "name": "validity", "type": "OBJECT", "description": "Represents the validity states that an element can be in, with respect to constraint validation.", "access": "global", "parent": "lightning-radio-group", "required": false }, { "name": "value", "type": "OBJECT", "description": "Specifies the value of the selected radio button.", "access": "global", "parent": "lightning-radio-group", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of the radio group.\nAccepted variants include standard, label-hidden, label-inline, and label-stacked.\nThis value defaults to standard.\nUse label-hidden to hide the label but make it available to assistive technology.\nUse label-inline to horizontally align the label and radio group.\nUse label-stacked to place the label above the radio group.", "access": "global", "parent": "lightning-radio-group", "required": false } ], "description": "A radio button group that can have a single option selected.", "methods": [ { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the radio group is disabled and users cannot interact with it.", "access": "global", "parent": "lightning-radio-group", "required": false }, { "name": "label", "type": "STRING", "description": "Text label for the radio group.", "access": "global", "parent": "lightning-radio-group", "required": true }, { "name": "message-when-value-missing", "type": "STRING", "description": "Optional message displayed when no radio button is selected and the required attribute is set to true.", "access": "global", "parent": "lightning-radio-group", "required": false }, { "name": "name", "type": "STRING", "description": "Specifies the name of the radio button group. Only only one button can be selected if a name is specified\nfor the group.", "access": "global", "parent": "lightning-radio-group", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onchange", "type": "AURA.ACTION", "description": "The action triggered when a value attribute changes.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "options", "type": "LIST", "description": "Array of label-value pairs for each radio button.", "access": "global", "parent": "lightning-radio-group", "required": true }, { "name": "readonly", "type": "BOOLEAN", "description": "Specifies that an input field is read-only. This value defaults to false.", "required": false }, { "name": "required", "type": "BOOLEAN", "description": "If present, a radio button must be selected before the form can be submitted.", "access": "global", "parent": "lightning-radio-group", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "type", "type": "STRING", "description": "The style of the radio group. Options are radio or button. The default is radio.", "access": "global", "parent": "lightning-radio-group", "required": false }, { "name": "validity", "type": "OBJECT", "description": "Represents the validity states that an element can be in, with respect to constraint validation.", "access": "global", "parent": "lightning-radio-group", "required": false }, { "name": "value", "type": "OBJECT", "description": "Specifies the value of the selected radio button.", "access": "global", "parent": "lightning-radio-group", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of the radio group.\nAccepted variants include standard, label-hidden, label-inline, and label-stacked.\nThis value defaults to standard.\nUse label-hidden to hide the label but make it available to assistive technology.\nUse label-inline to horizontally align the label and radio group.\nUse label-stacked to place the label above the radio group.", "access": "global", "parent": "lightning-radio-group", "required": false } ] }, "lightning-pill-container": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "is-collapsible", "type": "", "description": "Specifies whether the pill container can be collapsed.", "access": "global", "parent": "lightning-pill-container", "required": false }, { "name": "is-expanded", "type": "", "description": "Specifies whether the pill container is expanded.", "access": "global", "parent": "lightning-pill-container", "required": false }, { "name": "items", "type": "LIST", "description": "An array of items to be rendered as pills in a container.", "access": "global", "parent": "lightning-pill-container", "required": false }, { "name": "label", "type": "STRING", "description": "Aria label for the pill container.", "access": "global", "parent": "lightning-pill-container", "required": false }, { "name": "onitemremove", "type": "AURA.ACTION", "description": "The action triggered when a pill is removed.", "required": false }, { "name": "single-line", "type": "BOOLEAN", "description": "Specifies whether to keep the pills in a single line.", "access": "global", "parent": "lightning-pill-container", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "variant", "type": "", "description": "The variant changes the appearance of the pill container. Accepted variants\ninclude standard and bare. This value defaults to standard.", "access": "global", "parent": "lightning-pill-container", "required": false } ], "description": "A list of pills grouped in a container. This component requires API version 42.0 and later." }, "lightning-badge": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "label", "type": "STRING", "description": "The text to be displayed inside the badge.", "access": "global", "parent": "lightning-badge", "required": true }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false } ], "description": "Represents a label which holds a small amount of information, such as the\nnumber of unread notifications." }, "lightning-tab": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "body", "type": "AURA.COMPONENTDEFREF[]", "description": "The body of the tab.", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "end-icon-alternative-text", "type": "", "description": "The alternative text for the icon specified by end-icon-name.", "access": "global", "parent": "lightning-tab", "required": false }, { "name": "end-icon-name", "type": "", "description": "The Lightning Design System name of an icon to display at the end of the tab label.\nSpecify the name in the format 'utility:check' where 'utility' is the category, and\n'check' is the icon to be displayed.", "access": "global", "parent": "lightning-tab", "required": false }, { "name": "icon-assistive-text", "type": "STRING", "description": "The alternative text for the icon specified by icon-name.", "access": "global", "parent": "lightning-tab", "required": false }, { "name": "icon-name", "type": "STRING", "description": "The Lightning Design System name of an icon to display at the beginning of the tab label.\nSpecify the name in the format 'utility:down' where 'utility' is the category, and\n'down' is the icon to be displayed. Only utility icons can be used.", "access": "global", "parent": "lightning-tab", "required": false }, { "name": "id", "type": "STRING", "description": "The optional ID is used during tabset's onselect event to determine which tab was clicked.", "required": false }, { "name": "label", "type": "AURA.COMPONENT[]", "description": "The text displayed in the tab header.", "access": "global", "parent": "lightning-tab", "required": false }, { "name": "onactive", "type": "AURA.ACTION", "description": "The action triggered when this tab becomes active.", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "show-error-indicator", "type": "BOOLEAN", "description": "Specifies whether there's an error in the tab content.\nAn error icon is displayed to the right of the tab label.", "access": "global", "parent": "lightning-tab", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Specifies text that displays in a tooltip over the tab content.", "access": "global", "parent": "lightning-tab", "required": false }, { "name": "value", "type": "", "description": "The optional string to identify which tab was clicked during the tab's active event.\nThis string is also used by active-tab-value in tabset to open a tab.", "access": "global", "parent": "lightning-tab", "required": false } ], "description": "A single tab in a tabset component.", "methods": [ { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "body", "type": "AURA.COMPONENTDEFREF[]", "description": "The body of the tab.", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "end-icon-alternative-text", "type": "", "description": "The alternative text for the icon specified by end-icon-name.", "access": "global", "parent": "lightning-tab", "required": false }, { "name": "end-icon-name", "type": "", "description": "The Lightning Design System name of an icon to display at the end of the tab label.\nSpecify the name in the format 'utility:check' where 'utility' is the category, and\n'check' is the icon to be displayed.", "access": "global", "parent": "lightning-tab", "required": false }, { "name": "icon-assistive-text", "type": "STRING", "description": "The alternative text for the icon specified by icon-name.", "access": "global", "parent": "lightning-tab", "required": false }, { "name": "icon-name", "type": "STRING", "description": "The Lightning Design System name of an icon to display at the beginning of the tab label.\nSpecify the name in the format 'utility:down' where 'utility' is the category, and\n'down' is the icon to be displayed. Only utility icons can be used.", "access": "global", "parent": "lightning-tab", "required": false }, { "name": "id", "type": "STRING", "description": "The optional ID is used during tabset's onselect event to determine which tab was clicked.", "required": false }, { "name": "label", "type": "AURA.COMPONENT[]", "description": "The text displayed in the tab header.", "access": "global", "parent": "lightning-tab", "required": false }, { "name": "onactive", "type": "AURA.ACTION", "description": "The action triggered when this tab becomes active.", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "show-error-indicator", "type": "BOOLEAN", "description": "Specifies whether there's an error in the tab content.\nAn error icon is displayed to the right of the tab label.", "access": "global", "parent": "lightning-tab", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Specifies text that displays in a tooltip over the tab content.", "access": "global", "parent": "lightning-tab", "required": false }, { "name": "value", "type": "", "description": "The optional string to identify which tab was clicked during the tab's active event.\nThis string is also used by active-tab-value in tabset to open a tab.", "access": "global", "parent": "lightning-tab", "required": false } ] }, "lightning-flow-support": { "type": "module", "namespace": "lightning", "attributes": [], "description": null }, "lightning-button-group": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false } ], "description": "Represents a group of buttons." }, "lightning-message-service": { "type": "module", "namespace": "lightning", "attributes": [], "description": null }, "lightning-button-stateful": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "icon-name-when-hover", "type": "STRING", "description": "The name of the icon to be used in the format 'utility:close' when the state is true and the button receives focus.", "access": "global", "parent": "lightning-button-stateful", "required": false }, { "name": "icon-name-when-off", "type": "STRING", "description": "The name of the icon to be used in the format 'utility:add' when the state is false.", "access": "global", "parent": "lightning-button-stateful", "required": false }, { "name": "icon-name-when-on", "type": "STRING", "description": "The name of the icon to be used in the format 'utility:check' when the state is true.", "access": "global", "parent": "lightning-button-stateful", "required": false }, { "name": "label-when-hover", "type": "STRING", "description": "The text to be displayed inside the button when state is true and the button receives focus.", "access": "global", "parent": "lightning-button-stateful", "required": false }, { "name": "label-when-off", "type": "STRING", "description": "The text to be displayed inside the button when state is false.", "access": "global", "parent": "lightning-button-stateful", "required": true }, { "name": "label-when-on", "type": "STRING", "description": "The text to be displayed inside the button when state is true.", "access": "global", "parent": "lightning-button-stateful", "required": true }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onclick", "type": "AURA.ACTION", "description": "The action triggered when the button is clicked.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "selected", "type": "", "description": "If present, the button is in the selected state.", "access": "global", "parent": "lightning-button-stateful", "required": false }, { "name": "state", "type": "BOOLEAN", "description": "The state of the button, which shows whether the button has been selected or not. The default state is false.", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of the button.\nAccepted variants include brand, destructive, inverse, neutral, success, and text.", "access": "global", "parent": "lightning-button-stateful", "required": false } ], "description": "A button that toggles between states.", "methods": [ { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "icon-name-when-hover", "type": "STRING", "description": "The name of the icon to be used in the format 'utility:close' when the state is true and the button receives focus.", "access": "global", "parent": "lightning-button-stateful", "required": false }, { "name": "icon-name-when-off", "type": "STRING", "description": "The name of the icon to be used in the format 'utility:add' when the state is false.", "access": "global", "parent": "lightning-button-stateful", "required": false }, { "name": "icon-name-when-on", "type": "STRING", "description": "The name of the icon to be used in the format 'utility:check' when the state is true.", "access": "global", "parent": "lightning-button-stateful", "required": false }, { "name": "label-when-hover", "type": "STRING", "description": "The text to be displayed inside the button when state is true and the button receives focus.", "access": "global", "parent": "lightning-button-stateful", "required": false }, { "name": "label-when-off", "type": "STRING", "description": "The text to be displayed inside the button when state is false.", "access": "global", "parent": "lightning-button-stateful", "required": true }, { "name": "label-when-on", "type": "STRING", "description": "The text to be displayed inside the button when state is true.", "access": "global", "parent": "lightning-button-stateful", "required": true }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onclick", "type": "AURA.ACTION", "description": "The action triggered when the button is clicked.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "selected", "type": "", "description": "If present, the button is in the selected state.", "access": "global", "parent": "lightning-button-stateful", "required": false }, { "name": "state", "type": "BOOLEAN", "description": "The state of the button, which shows whether the button has been selected or not. The default state is false.", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of the button.\nAccepted variants include brand, destructive, inverse, neutral, success, and text.", "access": "global", "parent": "lightning-button-stateful", "required": false } ] }, "lightning-dynamic-icon": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "alternative-text", "type": "STRING", "description": "The alternative text used to describe the dynamic icon.\nThis text should describe what's happening.\nFor example, 'Graph is refreshing', not what the icon looks like, 'Graph'.", "access": "global", "parent": "lightning-dynamic-icon", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "onclick", "type": "AURA.ACTION", "description": "The action triggered when the icon is clicked.", "required": false }, { "name": "option", "type": "STRING", "description": "The option attribute changes the appearance of the dynamic icon.\nThe options available depend on the type.\neq: play (default) or stop\nscore: positive (default) or negative\nstrength: -3, -2, -1, 0 (default), 1, 2, 3\ntrend: neutral (default), up, or down", "access": "global", "parent": "lightning-dynamic-icon", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "type", "type": "STRING", "description": "The Lightning Design System name of the dynamic icon.\nValid values are: ellie, eq, score, strength, trend, and waffle.", "access": "global", "parent": "lightning-dynamic-icon", "required": true } ], "description": "Represents various animated icons with different states." }, "lightning-tabset": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "active-tab-value", "type": "", "description": "Sets a specific tab to open by default using a string that matches a tab's value string. If not used, the first tab opens by default.", "access": "global", "parent": "lightning-tabset", "required": false }, { "name": "body", "type": "AURA.COMPONENTDEFREF[]", "description": "The body of the component. This could be one or more lightning:tab components.", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "onselect", "type": "AURA.ACTION", "description": "The action that will run when the tab is clicked.", "required": false }, { "name": "selected-tab-id", "type": "STRING", "description": "Allows you to set a specific tab to open by default. If this attribute is not used, the first tab opens by default.", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the tabset.", "access": "global", "parent": "lightning-tabset", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of the tabset. Accepted variants are standard, scoped, and vertical.", "access": "global", "parent": "lightning-tabset", "required": false } ], "description": "Represents a list of tabs." }, "lightning-breadcrumb": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "href", "type": "STRING", "description": "The URL of the page that the breadcrumb goes to.", "access": "global", "parent": "lightning-breadcrumb", "required": false }, { "name": "label", "type": "STRING", "description": "The text label for the breadcrumb.", "access": "global", "parent": "lightning-breadcrumb", "required": true }, { "name": "name", "type": "STRING", "description": "The name for the breadcrumb component. This value is optional and can be\nused to identify the breadcrumb in a callback.", "access": "global", "parent": "lightning-breadcrumb", "required": false }, { "name": "onclick", "type": "AURA.ACTION", "description": "The action triggered when the breadcrumb is clicked.", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false } ], "description": "An item in the hierarchy path of the page the user is on." }, "lightning-breadcrumbs": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false } ], "description": "A hierarchy path of the page you're currently visiting within the website or app." }, "lightning-relative-date-time": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "value", "type": "OBJECT", "description": "The timestamp or JavaScript Date object to be formatted.", "access": "global", "parent": "lightning-relative-date-time", "required": false } ], "description": "Displays the relative time difference between the source date-time and the provided date-time." }, "lightning-formatted-rich-text": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disable-linkify", "type": "BOOLEAN", "description": "If present, the component does not create links in the rich text.", "access": "global", "parent": "lightning-formatted-rich-text", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "value", "type": "STRING", "description": "Sets the rich text to display.", "access": "global", "parent": "lightning-formatted-rich-text", "required": false } ], "description": "Displays rich text that's formatted with allowlisted tags and attributes.\nOther tags and attributes are removed and only their text content is displayed." }, "lightning-tree": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "header", "type": "STRING", "description": "The text that's displayed as the tree heading.", "access": "global", "parent": "lightning-tree", "required": false }, { "name": "items", "type": "OBJECT", "description": "An array of key-value pairs that describe the tree. See the Documentation tab for more information.", "access": "global", "parent": "lightning-tree", "required": false }, { "name": "onselect", "type": "AURA.ACTION", "description": "The action triggered when a tree item is selected.", "required": false }, { "name": "selected-item", "type": "", "description": "Selects and highlights the specified tree item. Tree item names are case-sensitive.\nIf the tree item is nested, selecting this item also expands the parent branches.", "access": "global", "parent": "lightning-tree", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false } ], "description": "Displays a nested tree." }, "lightning-file-upload": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "accept", "type": "LIST", "description": "Comma-separated list of file extensions that can be uploaded\nin the format .ext, such as .pdf, .jpg, or .png.", "access": "global", "parent": "lightning-file-upload", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "Specifies whether this component should be displayed in a disabled state.\nDisabled components can't be clicked. The default is false.", "access": "global", "parent": "lightning-file-upload", "required": false }, { "name": "label", "type": "STRING", "description": "The text label for the file uploader.", "access": "global", "parent": "lightning-file-upload", "required": true }, { "name": "multiple", "type": "BOOLEAN", "description": "Specifies whether a user can upload more than one file simultaneously.\nThe default is false.", "access": "global", "parent": "lightning-file-upload", "required": false }, { "name": "name", "type": "STRING", "description": "Specifies the name of the input element.", "access": "global", "parent": "lightning-file-upload", "required": true }, { "name": "onuploadfinished", "type": "AURA.ACTION", "description": "The action triggered when files have finished uploading.", "required": false }, { "name": "record-id", "type": "STRING", "description": "The record Id of the record that the uploaded file is associated to.", "access": "global", "parent": "lightning-file-upload", "required": true }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false } ], "description": "A file uploader for uploading and attaching files to records." }, "lightning-formatted-time": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "value", "type": "STRING", "description": "Time value to format.", "access": "global", "parent": "lightning-formatted-time", "required": false } ], "description": "Displays a formatted time in user's locale format." }, "lightning-tree-grid": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "columns", "type": "LIST", "description": "Array of the columns object that's used to define the data types.\nRequired properties include 'label', 'fieldName', and 'type'. The default type is 'text'.\nSee the Documentation tab for more information.", "access": "global", "parent": "lightning-tree-grid", "required": false }, { "name": "data", "type": "OBJECT", "description": "The array of data to be displayed.", "access": "global", "parent": "lightning-tree-grid", "required": false }, { "name": "expanded-rows", "type": "LIST", "description": "The array of unique row IDs for rows that are expanded.", "access": "global", "parent": "lightning-tree-grid", "required": false }, { "name": "hide-checkbox-column", "type": "BOOLEAN", "description": "If present, the checkbox column for row selection is hidden.", "access": "global", "parent": "lightning-tree-grid", "required": false }, { "name": "is-loading", "type": "BOOLEAN", "description": "If present, a spinner is displayed to indicate that more data is being loaded.", "access": "global", "parent": "lightning-tree-grid", "required": false }, { "name": "key-field", "type": "STRING", "description": "Required for better performance. Associates each row with a unique ID.", "access": "global", "parent": "lightning-tree-grid", "required": false }, { "name": "max-column-width", "type": "INTEGER", "description": "The maximum width for all columns. The default is 1000px.", "access": "global", "parent": "lightning-tree-grid", "required": false }, { "name": "min-column-width", "type": "INTEGER", "description": "The minimum width for all columns. The default is 50px.", "access": "global", "parent": "lightning-tree-grid", "required": false }, { "name": "onresize", "type": "AURA.ACTION", "description": "The action triggered when the table renders columns the first time and every time its resized an specific column.", "required": false }, { "name": "onrowaction", "type": "AURA.ACTION", "description": "The action triggered when an operation its clicked. By default its to closes the actions menu.", "required": false }, { "name": "onrowselection", "type": "AURA.ACTION", "description": "The action triggered when a row is selected.", "required": false }, { "name": "ontoggle", "type": "AURA.ACTION", "description": "The action triggered when a row is toggled (expanded or collapsed).", "required": false }, { "name": "ontoggleall", "type": "AURA.ACTION", "description": "The action triggered when all rows are toggled (expanded or collapsed).", "required": false }, { "name": "resize-column-disabled", "type": "BOOLEAN", "description": "If present, column resizing is disabled.", "access": "global", "parent": "lightning-tree-grid", "required": false }, { "name": "row-number-offset", "type": "INTEGER", "description": "Determines where to start counting the row number. The default is 0.", "access": "global", "parent": "lightning-tree-grid", "required": false }, { "name": "selected-rows", "type": "LIST", "description": "The array of unique row IDs that are selected.", "access": "global", "parent": "lightning-tree-grid", "required": false }, { "name": "show-row-number-column", "type": "BOOLEAN", "description": "If present, the row number column are shown in the first column.", "access": "global", "parent": "lightning-tree-grid", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false } ], "description": "Displays a hierarchical view of data in a table." }, "lightning-platform-show-toast-event": { "type": "module", "namespace": "lightning", "attributes": [], "description": null }, "lightning-input-location": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the geolocation fields are disabled and users cannot interact with them.", "access": "global", "parent": "lightning-input-location", "required": false }, { "name": "field-level-help", "type": "STRING", "description": "Help text detailing the purpose and function of the input.", "access": "global", "parent": "lightning-input-location", "required": false }, { "name": "label", "type": "STRING", "description": "The label of the geolocation compound field.", "access": "global", "parent": "lightning-input-location", "required": false }, { "name": "latitude", "type": "STRING", "description": "The latitude value. Latitude values must be within -90 and 90.", "access": "global", "parent": "lightning-input-location", "required": false }, { "name": "longitude", "type": "STRING", "description": "The longitude value. Longitude values must be within -180 and 180.", "access": "global", "parent": "lightning-input-location", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the input releases focus.", "required": false }, { "name": "onchange", "type": "AURA.ACTION", "description": "The action triggered when the value changes.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the input receives focus.", "required": false }, { "name": "read-only", "type": "", "description": "If present, the geolocations fields are read-only and cannot be edited.", "access": "global", "parent": "lightning-input-location", "required": false }, { "name": "readonly", "type": "BOOLEAN", "description": "Specifies whether the compound field is read-only. This value defaults to false.", "required": false }, { "name": "required", "type": "BOOLEAN", "description": "If present, the geolocation fields must be filled out before the form is submitted.\nAn error message is displayed if a user interacts with the field\nand does not provide a value.", "access": "global", "parent": "lightning-input-location", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "validity", "type": "", "description": "Represents the validity states that an element can be in, with respect to constraint validation.", "access": "global", "parent": "lightning-input-location", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of a geolocation compound field.\nAccepted variants include standard, label-hidden, label-inline, and label-stacked.\nThis value defaults to standard.\nUse label-hidden to hide the label but make it available to assistive technology.\nUse label-inline to horizontally align the label and geolocation fields.\nUse label-stacked to place the label above the geolocation fields.", "access": "global", "parent": "lightning-input-location", "required": false } ], "description": "Represents a geolocation compound field that accepts a latitude and longitude value." }, "lightning-input-field": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "dirty", "type": "", "description": "Reserved for internal use. If present, the field has been modified by the user but not saved or submitted.", "access": "global", "parent": "lightning-input-field", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the field is grayed out and users can't interact with it.\nDisabled fields don't receive focus and are skipped in tabbing navigation.", "access": "global", "parent": "lightning-input-field", "required": false }, { "name": "field-name", "type": "STRING", "description": "The API name of the field to be displayed.", "access": "global", "parent": "lightning-input-field", "required": false }, { "name": "onchange", "type": "AURA.ACTION", "description": "The action triggered when the input value changes.", "required": false }, { "name": "readonly", "type": "", "description": "Specifies whether an input field is read-only. This value defaults to false.\nNot supported for the following field types: rich text, picklist, multi-select picklist, and lookup.\nA read-only field is not disabled by default.", "access": "global", "parent": "lightning-input-field", "required": false }, { "name": "required", "type": "", "description": "If present, the input field must be filled out before the form is submitted.", "access": "global", "parent": "lightning-input-field", "required": false }, { "name": "value", "type": "STRING", "description": "The field value, which overrides the existing value.", "access": "global", "parent": "lightning-input-field", "required": false }, { "name": "variant", "type": "", "description": "The variant changes the label position of an input field.\nAccepted variants include standard, label-hidden, label-inline, and label-stacked.\nThe variant, if specified, determines the label position.\nOtherwise, the density setting of the parent form determines the label position.", "access": "global", "parent": "lightning-input-field", "required": false } ], "description": "Represents an editable input for a field on a Salesforce object." }, "lightning-formatted-address": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "city", "type": "STRING", "description": "The city detail for the address.", "access": "global", "parent": "lightning-formatted-address", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "country", "type": "STRING", "description": "The country detail for the address.", "access": "global", "parent": "lightning-formatted-address", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the address is displayed as plain text and is not clickable.", "access": "global", "parent": "lightning-formatted-address", "required": false }, { "name": "latitude", "type": "DECIMAL", "description": "The latitude of the location if known. Latitude values must be within -90 and 90.", "access": "global", "parent": "lightning-formatted-address", "required": false }, { "name": "longitude", "type": "DECIMAL", "description": "The longitude of the location if known. Longitude values must be within -180 and 180.", "access": "global", "parent": "lightning-formatted-address", "required": false }, { "name": "postal-code", "type": "STRING", "description": "The postal code detail for the address.", "access": "global", "parent": "lightning-formatted-address", "required": false }, { "name": "province", "type": "STRING", "description": "The province detail for the address.", "access": "global", "parent": "lightning-formatted-address", "required": false }, { "name": "show-static-map", "type": "", "description": "Displays a static map of the location using Google Maps. This value defaults to false.", "access": "global", "parent": "lightning-formatted-address", "required": false }, { "name": "street", "type": "STRING", "description": "The street detail for the address.", "access": "global", "parent": "lightning-formatted-address", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false } ], "description": "Displays a formatted address with a link to the given location on Google Maps.\nThe link is opened in a new tab.\nA static map can be displayed with the address for better context." }, "lightning-combobox": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "aria-described-by", "type": "", "description": "Reserved for internal use. Use the standard aria-describedby instead. A space-separated list of element IDs that provide descriptive labels for the combobox.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "aria-labelled-by", "type": "", "description": "Reserved for internal use. Use the standard aria-labelledby instead. A space-separated list of element IDs that provide labels for the combobox.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the combobox is disabled and users cannot interact with it.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "dropdown-alignment", "type": "STRING", "description": "Specifies where the drop-down list is aligned with or anchored to\nthe selection field. By default the list is aligned with the\nselection field at the top left so the list opens down. Use bottom-left\nto make the selection field display at the bottom so the list opens\nabove it. Use auto to let the component determine where to open\nthe list based on space available.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "field-level-help", "type": "STRING", "description": "Help text detailing the purpose and function of the combobox.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "label", "type": "STRING", "description": "Text label for the combobox.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "message-when-value-missing", "type": "STRING", "description": "Error message to be displayed when the value is missing and input is required.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "name", "type": "STRING", "description": "Specifies the name of the combobox.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onchange", "type": "AURA.ACTION", "description": "The action triggered when a value attribute changes.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "options", "type": "OBJECT[]", "description": "A list of options that are available for selection. Each option has the following attributes: label and value.", "access": "global", "parent": "lightning-combobox", "required": true }, { "name": "placeholder", "type": "STRING", "description": "Text that is displayed before an option is selected, to prompt the user\nto select an option. The default is \"Select an Option\".", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "read-only", "type": "", "description": "If present, the combobox is read-only.\nA read-only combobox is also disabled.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "readonly", "type": "BOOLEAN", "description": "Specifies that an input field is read-only. This value defaults to false.", "required": false }, { "name": "required", "type": "BOOLEAN", "description": "If present, a value must be selected before the form can be submitted.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "spinner-active", "type": "BOOLEAN", "description": "If present, a spinner is displayed below the menu items to indicate loading activity.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "validity", "type": "OBJECT", "description": "Represents the validity states that an element can be in, with respect to constraint validation.", "access": "global", "parent": "lightning-combobox", "required": true }, { "name": "value", "type": "OBJECT", "description": "Specifies the value of an input element.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of the combobox.\nAccepted variants include standard, label-hidden, label-inline, and label-stacked.\nThis value defaults to standard.\nUse label-hidden to hide the label but make it available to assistive technology.\nUse label-inline to horizontally align the label and combobox.\nUse label-stacked to place the label above the combobox.", "access": "global", "parent": "lightning-combobox", "required": false } ], "description": "A widget that provides an input field that is readonly,\naccompanied by a dropdown list of selectable options.", "methods": [ { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "aria-described-by", "type": "", "description": "Reserved for internal use. Use the standard aria-describedby instead. A space-separated list of element IDs that provide descriptive labels for the combobox.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "aria-labelled-by", "type": "", "description": "Reserved for internal use. Use the standard aria-labelledby instead. A space-separated list of element IDs that provide labels for the combobox.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the combobox is disabled and users cannot interact with it.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "dropdown-alignment", "type": "STRING", "description": "Specifies where the drop-down list is aligned with or anchored to\nthe selection field. By default the list is aligned with the\nselection field at the top left so the list opens down. Use bottom-left\nto make the selection field display at the bottom so the list opens\nabove it. Use auto to let the component determine where to open\nthe list based on space available.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "field-level-help", "type": "STRING", "description": "Help text detailing the purpose and function of the combobox.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "label", "type": "STRING", "description": "Text label for the combobox.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "message-when-value-missing", "type": "STRING", "description": "Error message to be displayed when the value is missing and input is required.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "name", "type": "STRING", "description": "Specifies the name of the combobox.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onchange", "type": "AURA.ACTION", "description": "The action triggered when a value attribute changes.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "options", "type": "OBJECT[]", "description": "A list of options that are available for selection. Each option has the following attributes: label and value.", "access": "global", "parent": "lightning-combobox", "required": true }, { "name": "placeholder", "type": "STRING", "description": "Text that is displayed before an option is selected, to prompt the user\nto select an option. The default is \"Select an Option\".", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "read-only", "type": "", "description": "If present, the combobox is read-only.\nA read-only combobox is also disabled.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "readonly", "type": "BOOLEAN", "description": "Specifies that an input field is read-only. This value defaults to false.", "required": false }, { "name": "required", "type": "BOOLEAN", "description": "If present, a value must be selected before the form can be submitted.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "spinner-active", "type": "BOOLEAN", "description": "If present, a spinner is displayed below the menu items to indicate loading activity.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "validity", "type": "OBJECT", "description": "Represents the validity states that an element can be in, with respect to constraint validation.", "access": "global", "parent": "lightning-combobox", "required": true }, { "name": "value", "type": "OBJECT", "description": "Specifies the value of an input element.", "access": "global", "parent": "lightning-combobox", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of the combobox.\nAccepted variants include standard, label-hidden, label-inline, and label-stacked.\nThis value defaults to standard.\nUse label-hidden to hide the label but make it available to assistive technology.\nUse label-inline to horizontally align the label and combobox.\nUse label-stacked to place the label above the combobox.", "access": "global", "parent": "lightning-combobox", "required": false } ] }, "lightning-avatar": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "alternative-text", "type": "STRING", "description": "The alternative text used to describe the avatar, which is displayed as\nhover text on the image.", "access": "global", "parent": "lightning-avatar", "required": true }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "fallback-icon-name", "type": "STRING", "description": "The Lightning Design System name of the icon used as a fallback when the\nimage fails to load. The initials fallback relies on this for its\nbackground color. Names are written in the format 'standard:account'\nwhere 'standard' is the category, and 'account' is the specific icon to\nbe displayed. Only icons from the standard and custom categories are\nallowed.", "access": "global", "parent": "lightning-avatar", "required": false }, { "name": "initials", "type": "STRING", "description": "If the record name contains two words, like first and last name, use the\nfirst capitalized letter of each. For records that only have a single\nword name, use the first two letters of that word using one capital and\none lower case letter.", "access": "global", "parent": "lightning-avatar", "required": false }, { "name": "size", "type": "STRING", "description": "The size of the avatar. Valid values are x-small, small, medium, and large. This value defaults to medium.", "access": "global", "parent": "lightning-avatar", "required": false }, { "name": "src", "type": "STRING", "description": "The URL for the image.", "access": "global", "parent": "lightning-avatar", "required": true }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the shape of the avatar. Valid values are empty,\ncircle, and square. This value defaults to square.", "access": "global", "parent": "lightning-avatar", "required": false } ], "description": "A visual representation of an object." }, "lightning-formatted-url": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "label", "type": "STRING", "description": "The text to display in the link.", "access": "global", "parent": "lightning-formatted-url", "required": false }, { "name": "onclick", "type": "AURA.ACTION", "description": "The action triggered when the URL is clicked.", "required": false }, { "name": "tab-index", "type": "", "description": "Reserved for internal use. Use tabindex instead to indicate if an element should be focusable.\nA value of 0 means that the element is focusable and\nparticipates in sequential keyboard navigation. A value of -1 means\nthat the element is focusable but does not participate in keyboard navigation.", "access": "global", "parent": "lightning-formatted-url", "required": false }, { "name": "target", "type": "STRING", "description": "Specifies where to open the link. Options include _blank, _parent, _self, and _top.\nThis value defaults to _self.", "access": "global", "parent": "lightning-formatted-url", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "tooltip", "type": "STRING", "description": "The text to display when the mouse hovers over the link.\nA link doesn't display a tooltip unless a text value is provided.", "access": "global", "parent": "lightning-formatted-url", "required": false }, { "name": "value", "type": "STRING", "description": "The URL to format.", "access": "global", "parent": "lightning-formatted-url", "required": false } ], "description": "Displays a URL as a hyperlink." }, "lightning-formatted-text": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "linkify", "type": "BOOLEAN", "description": "If present, URLs and email addresses are displayed in anchor tags.\nThey are displayed in plain text by default.", "access": "global", "parent": "lightning-formatted-text", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "value", "type": "STRING", "description": "Sets the text to display.", "access": "global", "parent": "lightning-formatted-text", "required": false } ], "description": "Displays text, replaces newlines with line breaks, and linkifies if requested." }, "lightning-vertical-navigation": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "aria-label", "type": "STRING", "description": "The aria label attribute for the navigation component", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "compact", "type": "BOOLEAN", "description": "If present, spacing between navigation items is reduced.", "access": "global", "parent": "lightning-vertical-navigation", "required": false }, { "name": "onbeforeselect", "type": "AURA.ACTION", "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.", "required": false }, { "name": "onselect", "type": "AURA.ACTION", "description": "Action fired when an item is selected. The event params include the `name` of the selected item.", "required": false }, { "name": "selected-item", "type": "STRING", "description": "Name of the navigation item to make active.\nAn active item is highlighted in blue.", "access": "global", "parent": "lightning-vertical-navigation", "required": false }, { "name": "shaded", "type": "BOOLEAN", "description": "If present, the vertical navigation is displayed on top of a shaded background.", "access": "global", "parent": "lightning-vertical-navigation", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false } ], "description": "A vertical list of links that either take the user to another page or parts of the page the user is in." }, "lightning-button-icon-stateful": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "alternative-text", "type": "STRING", "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'.", "access": "global", "parent": "lightning-button-icon-stateful", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "Specifies whether this button should be displayed in a disabled state. Disabled buttons can't be clicked. This value defaults to false.", "required": false }, { "name": "icon-name", "type": "STRING", "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. Note: Only utility icons can be used in this component.", "access": "global", "parent": "lightning-button-icon-stateful", "required": false }, { "name": "name", "type": "STRING", "description": "The name for the button element. This value is optional and can be used to identify the button in a callback.", "access": "global", "parent": "lightning-button-icon-stateful", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onclick", "type": "AURA.ACTION", "description": "The action that will be run when the button is clicked.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "selected", "type": "BOOLEAN", "description": "Specifies whether button is in selected state or not", "access": "global", "parent": "lightning-button-icon-stateful", "required": false }, { "name": "size", "type": "STRING", "description": "The size of the buttonIcon. Options include xx-small, x-small, small, and medium. This value defaults to medium.", "access": "global", "parent": "lightning-button-icon-stateful", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "value", "type": "STRING", "description": "The value for the button element. This value is optional and can be used when submitting a form.", "access": "global", "parent": "lightning-button-icon-stateful", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of buttonIcon. Accepted variants include border, border-filled, and border-inverse. This value defaults to border.", "access": "global", "parent": "lightning-button-icon-stateful", "required": false } ], "description": "An icon-only button that retains state. This component requires API version 41.0 and later.", "methods": [ { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "alternative-text", "type": "STRING", "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'.", "access": "global", "parent": "lightning-button-icon-stateful", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "Specifies whether this button should be displayed in a disabled state. Disabled buttons can't be clicked. This value defaults to false.", "required": false }, { "name": "icon-name", "type": "STRING", "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. Note: Only utility icons can be used in this component.", "access": "global", "parent": "lightning-button-icon-stateful", "required": false }, { "name": "name", "type": "STRING", "description": "The name for the button element. This value is optional and can be used to identify the button in a callback.", "access": "global", "parent": "lightning-button-icon-stateful", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onclick", "type": "AURA.ACTION", "description": "The action that will be run when the button is clicked.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "selected", "type": "BOOLEAN", "description": "Specifies whether button is in selected state or not", "access": "global", "parent": "lightning-button-icon-stateful", "required": false }, { "name": "size", "type": "STRING", "description": "The size of the buttonIcon. Options include xx-small, x-small, small, and medium. This value defaults to medium.", "access": "global", "parent": "lightning-button-icon-stateful", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "value", "type": "STRING", "description": "The value for the button element. This value is optional and can be used when submitting a form.", "access": "global", "parent": "lightning-button-icon-stateful", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of buttonIcon. Accepted variants include border, border-filled, and border-inverse. This value defaults to border.", "access": "global", "parent": "lightning-button-icon-stateful", "required": false } ] }, "lightning-record-form": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "columns", "type": "NUMBER", "description": "Specifies the number of columns for the form.", "access": "global", "parent": "lightning-record-form", "required": false }, { "name": "density", "type": "", "description": "Sets the arrangement style of fields and labels in the form.\nAccepted values are compact, comfy, and auto (default).\nUse compact to display fields and their labels on the same line.\nUse comfy to display fields below their labels.\nUse auto to let the component dynamically set\nthe density according to the user's Display Density setting\nand the width of the form.", "access": "global", "parent": "lightning-record-form", "required": false }, { "name": "fields", "type": "STRING[]", "description": "List of fields to be displayed. The fields display in the order you list them.", "access": "global", "parent": "lightning-record-form", "required": false }, { "name": "layout-type", "type": "STRING", "description": "The type of layout to use to display the form fields. Possible values: Compact, Full.\nWhen creating a new record, only the full layout is supported.", "access": "global", "parent": "lightning-record-form", "required": false }, { "name": "mode", "type": "STRING", "description": "Specifies the interaction and display style for the form.\nPossible values: view, edit, readonly.\nIf a record ID is not provided, the default mode is edit, which displays a form to create new records.\nIf a record ID is provided, the default mode is view, which displays field values with edit icons on updateable fields.", "access": "global", "parent": "lightning-record-form", "required": false }, { "name": "object-api-name", "type": "STRING", "description": "The API name of the object.", "access": "global", "parent": "lightning-record-form", "required": true }, { "name": "onerror", "type": "AURA.ACTION", "description": "The action triggered when there is an error on form submission.", "required": false }, { "name": "onload", "type": "AURA.ACTION", "description": "The action triggered when the form data is loaded.", "required": false }, { "name": "onsubmit", "type": "AURA.ACTION", "description": "The action triggered when the form is submitted.", "required": false }, { "name": "onsuccess", "type": "AURA.ACTION", "description": "The action triggered when the form is saved.", "required": false }, { "name": "record-id", "type": "STRING", "description": "The ID of the record to be displayed.", "access": "global", "parent": "lightning-record-form", "required": false }, { "name": "record-type-id", "type": "STRING", "description": "The ID of the record type, which is required if you created\nmultiple record types but don't have a default.", "access": "global", "parent": "lightning-record-form", "required": false } ], "description": "Creates an editable form or display form for a record." }, "lightning-ui-list-api": { "type": "module", "namespace": "lightning", "attributes": [], "description": null }, "lightning-button-menu": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "access-key", "type": "", "description": "The keyboard shortcut for the button menu.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "alternative-text", "type": "STRING", "description": "The assistive text for the button.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "body", "type": "AURA.COMPONENTDEFREF[]", "description": "The body of the component.", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the menu can be opened by users.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "draft-alternative-text", "type": "STRING", "description": "Describes the reason for showing the draft indicator.\nThis is required when is-draft is true.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "icon-name", "type": "STRING", "description": "The name of the icon to be used in the format 'utility:down'.\nIf an icon other than 'utility:down' or 'utility:chevrondown' is used,\na utility:down icon is appended to the right of that icon.\nThis value defaults to utility:down.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "icon-size", "type": "STRING", "description": "The size of the icon.\nOptions include xx-small, x-small, medium, or large.\nThis value defaults to medium.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "is-draft", "type": "BOOLEAN", "description": "If present, the menu trigger shows a draft indicator.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "is-loading", "type": "BOOLEAN", "description": "If present, the menu is in a loading state and shows a spinner.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "label", "type": "STRING", "description": "Optional text to be shown on the button.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "loading-state-alternative-text", "type": "STRING", "description": "Message displayed while the menu is in the loading state.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "menu-alignment", "type": "STRING", "description": "Determines the alignment of the menu relative to the button.\nAvailable options are: auto, left, center, right, bottom-left, bottom-center, bottom-right.\nThe auto option aligns the dropdown menu based on available space.\nThis value defaults to left.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "name", "type": "STRING", "description": "The name for the button element. This value is optional and can be used to identify the button in a callback.", "required": false }, { "name": "nubbin", "type": "", "description": "If present, a nubbin is present on the menu.\nA nubbin is a stub that protrudes from the menu item towards the button menu.\nThe nubbin position is based on the menu-alignment.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "onopen", "type": "AURA.ACTION", "description": "Action fired when the menu is opened.", "required": false }, { "name": "onselect", "type": "AURA.ACTION", "description": "Action fired when a menu item is selected. The 'detail.menuItem' property of the passed event is the selected menu item.", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the button menu.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "tooltip", "type": "", "description": null, "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "value", "type": "STRING", "description": "The value for the button element.\nThis value is optional and can be used when submitting a form.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the look of the button.\nAccepted variants include bare, container, border, border-filled, bare-inverse, and border-inverse.\nThis value defaults to border.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "visible", "type": "BOOLEAN", "description": "If true, the menu items are displayed. This value defaults to false.", "required": false } ], "description": "Represents a dropdown menu with a list of actions or functions.", "methods": [ { "name": "access-key", "type": "", "description": "The keyboard shortcut for the button menu.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "alternative-text", "type": "STRING", "description": "The assistive text for the button.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "body", "type": "AURA.COMPONENTDEFREF[]", "description": "The body of the component.", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the menu can be opened by users.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "draft-alternative-text", "type": "STRING", "description": "Describes the reason for showing the draft indicator.\nThis is required when is-draft is true.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "icon-name", "type": "STRING", "description": "The name of the icon to be used in the format 'utility:down'.\nIf an icon other than 'utility:down' or 'utility:chevrondown' is used,\na utility:down icon is appended to the right of that icon.\nThis value defaults to utility:down.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "icon-size", "type": "STRING", "description": "The size of the icon.\nOptions include xx-small, x-small, medium, or large.\nThis value defaults to medium.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "is-draft", "type": "BOOLEAN", "description": "If present, the menu trigger shows a draft indicator.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "is-loading", "type": "BOOLEAN", "description": "If present, the menu is in a loading state and shows a spinner.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "label", "type": "STRING", "description": "Optional text to be shown on the button.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "loading-state-alternative-text", "type": "STRING", "description": "Message displayed while the menu is in the loading state.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "menu-alignment", "type": "STRING", "description": "Determines the alignment of the menu relative to the button.\nAvailable options are: auto, left, center, right, bottom-left, bottom-center, bottom-right.\nThe auto option aligns the dropdown menu based on available space.\nThis value defaults to left.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "name", "type": "STRING", "description": "The name for the button element. This value is optional and can be used to identify the button in a callback.", "required": false }, { "name": "nubbin", "type": "", "description": "If present, a nubbin is present on the menu.\nA nubbin is a stub that protrudes from the menu item towards the button menu.\nThe nubbin position is based on the menu-alignment.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "onopen", "type": "AURA.ACTION", "description": "Action fired when the menu is opened.", "required": false }, { "name": "onselect", "type": "AURA.ACTION", "description": "Action fired when a menu item is selected. The 'detail.menuItem' property of the passed event is the selected menu item.", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the button menu.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "tooltip", "type": "", "description": null, "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "value", "type": "STRING", "description": "The value for the button element.\nThis value is optional and can be used when submitting a form.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the look of the button.\nAccepted variants include bare, container, border, border-filled, bare-inverse, and border-inverse.\nThis value defaults to border.", "access": "global", "parent": "lightning-button-menu", "required": false }, { "name": "visible", "type": "BOOLEAN", "description": "If true, the menu items are displayed. This value defaults to false.", "required": false } ] }, "lightning-map": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "center", "type": "OBJECT", "description": "A location to use as the map's center.\nIf center is not specified, the map centers automatically.", "access": "global", "parent": "lightning-map", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "list-view", "type": "", "description": "Displays or hides the list of locations. Valid values are visible, hidden, or auto.\nThis value defaults to auto, which shows the list only when multiple markers are present.\nPassing in an invalid value hides the list view.", "access": "global", "parent": "lightning-map", "required": false }, { "name": "map-markers", "type": "OBJECT", "description": "One or more objects with the address or latitude and longitude to be displayed on the map.\nIf latitude and longitude are provided, the address is ignored.", "access": "global", "parent": "lightning-map", "required": true }, { "name": "markers-title", "type": "STRING", "description": "Provides the heading title for the markers. Required if specifying multiple markers.\nThe title is displayed below the map as a header for the list of clickable addresses.", "access": "global", "parent": "lightning-map", "required": false }, { "name": "selected-marker-value", "type": "", "description": "Provides the value of the currently selected marker.\nReturns undefined if you don’t pass value to map-markers.", "access": "global", "parent": "lightning-map", "required": false }, { "name": "show-footer", "type": "BOOLEAN", "description": "If present, the footer element is displayed below the map.\nThe footer shows an 'Open in Google Maps' link that opens an external window\nto display the selected marker location in Google Maps. Default value is false.", "access": "global", "parent": "lightning-map", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "zoom-level", "type": "INTEGER", "description": "The zoom levels as defined by Google Maps API.\nIf a zoom level is not specified, a default zoom level is applied to accommodate all markers on the map.", "access": "global", "parent": "lightning-map", "required": false } ], "description": "Displays a map with markers for one or more locations." }, "lightningsnapin-minimized": { "type": "module", "namespace": "lightningsnapin", "attributes": [], "description": null }, "lightning-input-name": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the input name field is disabled and users cannot interact with it.", "access": "global", "parent": "lightning-input-name", "required": false }, { "name": "field-level-help", "type": "STRING", "description": "Help text detailing the purpose and function of the input.", "access": "global", "parent": "lightning-input-name", "required": false }, { "name": "fields-to-display", "type": "LIST", "description": "List of fields to be displayed on the component. This value defaults to\n['firstName', 'salutation', 'lastName']. Other field values include middleName,\ninformalName, suffix.", "access": "global", "parent": "lightning-input-name", "required": false }, { "name": "first-name", "type": "STRING", "description": "Displays the First Name field.", "access": "global", "parent": "lightning-input-name", "required": false }, { "name": "first-name-label", "type": "", "description": "Reserved for internal use.", "access": "global", "parent": "lightning-input-name", "required": false }, { "name": "informal-name", "type": "STRING", "description": "Displays the Informal Name field.", "access": "global", "parent": "lightning-input-name", "required": false }, { "name": "informal-name-label", "type": "", "description": "Reserved for internal use.", "access": "global", "parent": "lightning-input-name", "required": false }, { "name": "label", "type": "STRING", "description": "The label of the input name field.", "access": "global", "parent": "lightning-input-name", "required": false }, { "name": "last-name", "type": "STRING", "description": "Displays the Last Name field.", "access": "global", "parent": "lightning-input-name", "required": false }, { "name": "last-name-label", "type": "", "description": "Reserved for internal use.", "access": "global", "parent": "lightning-input-name", "required": false }, { "name": "middle-name", "type": "STRING", "description": "Displays the Middle Name field.", "access": "global", "parent": "lightning-input-name", "required": false }, { "name": "middle-name-label", "type": "", "description": "Reserved for internal use.", "access": "global", "parent": "lightning-input-name", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the input releases focus.", "required": false }, { "name": "onchange", "type": "AURA.ACTION", "description": "The action triggered when the value changes.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the input receives focus.", "required": false }, { "name": "options", "type": "LIST", "description": "Displays a list of salutation options, such as Dr. or Mrs., provided as label-value pairs.", "access": "global", "parent": "lightning-input-name", "required": false }, { "name": "read-only", "type": "", "description": "If present, the input name field is read-only and cannot be edited.", "access": "global", "parent": "lightning-input-name", "required": false }, { "name": "readonly", "type": "BOOLEAN", "description": "Specifies whether the compound field is read-only. This value defaults to false.", "required": false }, { "name": "required", "type": "BOOLEAN", "description": "If present, the input name field must be filled out before the form is submitted.\nA red asterisk is displayed on the Last Name field. An error\nmessage is displayed if a user interacts with the Last Name\nfield and does not provide a value.", "access": "global", "parent": "lightning-input-name", "required": false }, { "name": "salutation", "type": "STRING", "description": "Displays the Salutation field as a dropdown menu. Use the options attribute to provide salutations in an array of label-value pairs.", "access": "global", "parent": "lightning-input-name", "required": false }, { "name": "salutation-label", "type": "", "description": "Reserved for internal use.", "access": "global", "parent": "lightning-input-name", "required": false }, { "name": "suffix", "type": "STRING", "description": "Displays the Suffix field.", "access": "global", "parent": "lightning-input-name", "required": false }, { "name": "suffix-label", "type": "", "description": "Reserved for internal use.", "access": "global", "parent": "lightning-input-name", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "validity", "type": "", "description": "Represents the validity states that an element can be in, with respect to constraint validation.", "access": "global", "parent": "lightning-input-name", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of a name compound field.\nAccepted variants include standard, label-hidden, label-inline, and label-stacked.\nThis value defaults to standard.\nUse label-hidden to hide the label but make it available to assistive technology.\nUse label-inline to horizontally align the label and name fields.\nUse label-stacked to place the label above the name fields.", "access": "global", "parent": "lightning-input-name", "required": false } ], "description": "Represents a name compound field." }, "lightning-spinner": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "alternative-text", "type": "STRING", "description": "The alternative text used to describe the reason for the wait and need for a spinner.", "access": "global", "parent": "lightning-spinner", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "size", "type": "STRING", "description": "The size of the spinner. Accepted sizes are small, medium, and large. This value defaults to medium.", "access": "global", "parent": "lightning-spinner", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of the spinner.\nAccepted variants include base, brand, and inverse. The default is base.", "access": "global", "parent": "lightning-spinner", "required": false } ], "description": "Displays an animated spinner." }, "lightning-platform-resource-loader": { "type": "module", "namespace": "lightning", "attributes": [], "description": null }, "lightning-icon": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "alternative-text", "type": "STRING", "description": "The alternative text used to describe the icon.\nThis text should describe what happens when you click the button,\nfor example 'Upload File', not what the icon looks like, 'Paperclip'.", "access": "global", "parent": "lightning-icon", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "icon-name", "type": "STRING", "description": "The Lightning Design System name of the icon.\nNames are written in the format 'utility:down' where 'utility' is the category,\nand 'down' is the specific icon to be displayed.", "access": "global", "parent": "lightning-icon", "required": true }, { "name": "size", "type": "STRING", "description": "The size of the icon. Options include xx-small, x-small, small, medium, or large.\nThe default is medium.", "access": "global", "parent": "lightning-icon", "required": false }, { "name": "src", "type": "STRING", "description": "A uri path to a custom svg sprite, including the name of the resouce,\nfor example: /assets/icons/standard-sprite/svg/test.svg#icon-heart", "access": "global", "parent": "lightning-icon", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of a utility icon.\nAccepted variants include inverse, success, warning, and error.\nUse the inverse variant to implement a white fill in utility icons on dark backgrounds.", "access": "global", "parent": "lightning-icon", "required": false } ], "description": "Represents a visual element that provides context and enhances usability." }, "lightning-ui-record-api": { "type": "module", "namespace": "lightning", "attributes": [], "description": null }, "lightning-click-to-dial": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "params", "type": "STRING", "description": "Comma-separated list of parameters to pass to the third-party phone system.", "access": "global", "parent": "lightning-click-to-dial", "required": false }, { "name": "record-id", "type": "STRING", "description": "The Salesforce record Id that's associated with the phone number.\nThis Id is passed by the component and does not get validated.", "access": "global", "parent": "lightning-click-to-dial", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "value", "type": "STRING", "description": "The phone number to be dialed.", "access": "global", "parent": "lightning-click-to-dial", "required": true } ], "description": "Renders a formatted phone number as click-to-dial enabled or disabled for Open CTI and Voice." }, "lightning-vertical-navigation-item": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "href", "type": "STRING", "description": "The URL of the page that the navigation item goes to.", "access": "global", "parent": "lightning-vertical-navigation-item", "required": false }, { "name": "label", "type": "STRING", "description": "The text displayed for the navigation item.", "access": "global", "parent": "lightning-vertical-navigation-item", "required": true }, { "name": "name", "type": "STRING", "description": "A unique identifier for the navigation item.\nThe name is used by the `select` event on lightning-vertical-navigation to identify which item is selected.", "access": "global", "parent": "lightning-vertical-navigation-item", "required": true }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false } ], "description": "A text-only link within lightning-vertical-navigation-section or lightning-vertical-navigation-overflow." }, "lightning-formatted-number": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "currency-code", "type": "STRING", "description": "Only used if format-style='currency', this attribute determines which currency is\ndisplayed. Possible values are the ISO 4217 currency codes, such as 'USD' for the US dollar.", "access": "global", "parent": "lightning-formatted-number", "required": false }, { "name": "currency-display-as", "type": "STRING", "description": "Determines how currency is displayed. Possible values are symbol, code, and name. This value defaults to symbol.", "access": "global", "parent": "lightning-formatted-number", "required": false }, { "name": "format-style", "type": "", "description": "The number formatting style to use. Possible values are decimal, currency,\nand percent. This value defaults to decimal.", "access": "global", "parent": "lightning-formatted-number", "required": false }, { "name": "maximum-fraction-digits", "type": "INTEGER", "description": "The maximum number of fraction digits that are allowed.", "access": "global", "parent": "lightning-formatted-number", "required": false }, { "name": "maximum-significant-digits", "type": "INTEGER", "description": "The maximum number of significant digits that are allowed. Possible values are from 1 to 21.", "access": "global", "parent": "lightning-formatted-number", "required": false }, { "name": "minimum-fraction-digits", "type": "INTEGER", "description": "The minimum number of fraction digits that are required.", "access": "global", "parent": "lightning-formatted-number", "required": false }, { "name": "minimum-integer-digits", "type": "INTEGER", "description": "The minimum number of integer digits that are required. Possible values are from 1 to 21.", "access": "global", "parent": "lightning-formatted-number", "required": false }, { "name": "minimum-significant-digits", "type": "INTEGER", "description": "The minimum number of significant digits that are required. Possible values are from 1 to 21.", "access": "global", "parent": "lightning-formatted-number", "required": false }, { "name": "style", "type": "STRING", "description": "The number formatting style to use. Possible values are decimal, currency, and percent. This value defaults to decimal.", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "value", "type": "DECIMAL", "description": "The value to be formatted.", "access": "global", "parent": "lightning-formatted-number", "required": true } ], "description": "Displays formatted numbers for decimals, currency, and percentages." }, "lightning-datatable": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "columns", "type": "LIST", "description": "Array of the columns object that's used to define the data types.\nRequired properties include 'label', 'fieldName', and 'type'. The default type is 'text'.\nSee the Documentation tab for more information.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "data", "type": "OBJECT", "description": "The array of data to be displayed.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "default-sort-direction", "type": "STRING", "description": "Specifies the default sorting direction on an unsorted column.\nValid options include 'asc' and 'desc'.\nThe default is 'asc' for sorting in ascending order.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "draft-values", "type": "OBJECT", "description": "The current values per row that are provided during inline edit.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "enable-infinite-loading", "type": "BOOLEAN", "description": "If present, you can load a subset of data and then display more\nwhen users scroll to the end of the table.\nUse with the onloadmore event handler to retrieve more data.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "errors", "type": "OBJECT", "description": "Specifies an object containing information about cell level, row level, and table level errors.\nWhen it's set, error messages are displayed on the table accordingly.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "hide-checkbox-column", "type": "BOOLEAN", "description": "If present, the checkbox column for row selection is hidden.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "hide-table-header", "type": "", "description": "If present, the table header is hidden.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "is-loading", "type": "BOOLEAN", "description": "If present, a spinner is shown to indicate that more data is loading.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "key-field", "type": "STRING", "description": "Required for better performance.\nAssociates each row with a unique ID.", "access": "global", "parent": "lightning-datatable", "required": true }, { "name": "load-more-offset", "type": "INTEGER", "description": "Determines when to trigger infinite loading based on\nhow many pixels the table's scroll position is from the bottom of the table.\nThe default is 20.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "max-column-width", "type": "INTEGER", "description": "The maximum width for all columns.\nThe default is 1000px.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "max-row-selection", "type": "INTEGER", "description": "The maximum number of rows that can be selected.\nCheckboxes are used for selection by default,\nand radio buttons are used when maxRowSelection is 1.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "min-column-width", "type": "INTEGER", "description": "The minimum width for all columns.\nThe default is 50px.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "oncancel", "type": "AURA.ACTION", "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.", "required": false }, { "name": "oncellchange", "type": "AURA.ACTION", "description": "The action triggered when a cell's value changes after an inline edit. Returns the draftValues object.", "required": false }, { "name": "onheaderaction", "type": "AURA.ACTION", "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.", "required": false }, { "name": "onloadmore", "type": "AURA.ACTION", "description": "The action triggered when infinite loading loads more data.", "required": false }, { "name": "onresize", "type": "AURA.ACTION", "description": "The action triggered when the table renders columns the first time and every time its resized an specific column. Returns columnWidths.", "required": false }, { "name": "onrowaction", "type": "AURA.ACTION", "description": "The action triggered when a row action is clicked. By default, it also closes the row actions menu. Returns the eventDetails object.", "required": false }, { "name": "onrowselection", "type": "AURA.ACTION", "description": "The action triggered when a row is selected. Returns the selectedRows object.", "required": false }, { "name": "onsave", "type": "AURA.ACTION", "description": "The action triggered when clicking on the table footer bar's save button during inline edit. Returns the draftValues object.", "required": false }, { "name": "onsort", "type": "AURA.ACTION", "description": "The action triggered when a column is sorted. Returns fieldName and sortDirection.", "required": false }, { "name": "resize-column-disabled", "type": "BOOLEAN", "description": "If present, column resizing is disabled.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "resize-step", "type": "INTEGER", "description": "The width to resize the column when a user presses left or right arrow.\nThe default is 10px.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "row-number-offset", "type": "INTEGER", "description": "Determines where to start counting the row number.\nThe default is 0.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "selected-rows", "type": "LIST", "description": "Enables programmatic row selection with a list of key-field values.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "show-row-number-column", "type": "BOOLEAN", "description": "If present, the row numbers are shown in the first column.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "sorted-by", "type": "STRING", "description": "The column fieldName that controls the sorting order.\nSort the data using the onsort event handler.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "sorted-direction", "type": "STRING", "description": "Specifies the sorting direction.\nSort the data using the onsort event handler.\nValid options include 'asc' and 'desc'.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "suppress-bottom-bar", "type": "", "description": "If present, the footer that displays the Save and Cancel buttons is hidden during inline editing.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "wrap-text-max-lines", "type": "", "description": "This value specifies the number of lines after which the\ncontent will be cut off and hidden. It must be at least 1 or more.\nThe text in the last line is truncated and shown with an ellipsis.", "access": "global", "parent": "lightning-datatable", "required": false } ], "description": "A table that displays rows and columns of data.", "methods": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "columns", "type": "LIST", "description": "Array of the columns object that's used to define the data types.\nRequired properties include 'label', 'fieldName', and 'type'. The default type is 'text'.\nSee the Documentation tab for more information.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "data", "type": "OBJECT", "description": "The array of data to be displayed.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "default-sort-direction", "type": "STRING", "description": "Specifies the default sorting direction on an unsorted column.\nValid options include 'asc' and 'desc'.\nThe default is 'asc' for sorting in ascending order.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "draft-values", "type": "OBJECT", "description": "The current values per row that are provided during inline edit.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "enable-infinite-loading", "type": "BOOLEAN", "description": "If present, you can load a subset of data and then display more\nwhen users scroll to the end of the table.\nUse with the onloadmore event handler to retrieve more data.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "errors", "type": "OBJECT", "description": "Specifies an object containing information about cell level, row level, and table level errors.\nWhen it's set, error messages are displayed on the table accordingly.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "hide-checkbox-column", "type": "BOOLEAN", "description": "If present, the checkbox column for row selection is hidden.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "hide-table-header", "type": "", "description": "If present, the table header is hidden.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "is-loading", "type": "BOOLEAN", "description": "If present, a spinner is shown to indicate that more data is loading.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "key-field", "type": "STRING", "description": "Required for better performance.\nAssociates each row with a unique ID.", "access": "global", "parent": "lightning-datatable", "required": true }, { "name": "load-more-offset", "type": "INTEGER", "description": "Determines when to trigger infinite loading based on\nhow many pixels the table's scroll position is from the bottom of the table.\nThe default is 20.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "max-column-width", "type": "INTEGER", "description": "The maximum width for all columns.\nThe default is 1000px.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "max-row-selection", "type": "INTEGER", "description": "The maximum number of rows that can be selected.\nCheckboxes are used for selection by default,\nand radio buttons are used when maxRowSelection is 1.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "min-column-width", "type": "INTEGER", "description": "The minimum width for all columns.\nThe default is 50px.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "oncancel", "type": "AURA.ACTION", "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.", "required": false }, { "name": "oncellchange", "type": "AURA.ACTION", "description": "The action triggered when a cell's value changes after an inline edit. Returns the draftValues object.", "required": false }, { "name": "onheaderaction", "type": "AURA.ACTION", "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.", "required": false }, { "name": "onloadmore", "type": "AURA.ACTION", "description": "The action triggered when infinite loading loads more data.", "required": false }, { "name": "onresize", "type": "AURA.ACTION", "description": "The action triggered when the table renders columns the first time and every time its resized an specific column. Returns columnWidths.", "required": false }, { "name": "onrowaction", "type": "AURA.ACTION", "description": "The action triggered when a row action is clicked. By default, it also closes the row actions menu. Returns the eventDetails object.", "required": false }, { "name": "onrowselection", "type": "AURA.ACTION", "description": "The action triggered when a row is selected. Returns the selectedRows object.", "required": false }, { "name": "onsave", "type": "AURA.ACTION", "description": "The action triggered when clicking on the table footer bar's save button during inline edit. Returns the draftValues object.", "required": false }, { "name": "onsort", "type": "AURA.ACTION", "description": "The action triggered when a column is sorted. Returns fieldName and sortDirection.", "required": false }, { "name": "resize-column-disabled", "type": "BOOLEAN", "description": "If present, column resizing is disabled.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "resize-step", "type": "INTEGER", "description": "The width to resize the column when a user presses left or right arrow.\nThe default is 10px.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "row-number-offset", "type": "INTEGER", "description": "Determines where to start counting the row number.\nThe default is 0.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "selected-rows", "type": "LIST", "description": "Enables programmatic row selection with a list of key-field values.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "show-row-number-column", "type": "BOOLEAN", "description": "If present, the row numbers are shown in the first column.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "sorted-by", "type": "STRING", "description": "The column fieldName that controls the sorting order.\nSort the data using the onsort event handler.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "sorted-direction", "type": "STRING", "description": "Specifies the sorting direction.\nSort the data using the onsort event handler.\nValid options include 'asc' and 'desc'.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "suppress-bottom-bar", "type": "", "description": "If present, the footer that displays the Save and Cancel buttons is hidden during inline editing.", "access": "global", "parent": "lightning-datatable", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "wrap-text-max-lines", "type": "", "description": "This value specifies the number of lines after which the\ncontent will be cut off and hidden. It must be at least 1 or more.\nThe text in the last line is truncated and shown with an ellipsis.", "access": "global", "parent": "lightning-datatable", "required": false } ] }, "lightning-button": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "aria-atomic", "type": "STRING", "description": "Indicates whether assistive technologies will present all, or only parts of, the changed region. Valid values are 'true' or 'false'.", "required": false }, { "name": "aria-controls", "type": "STRING", "description": "A space-separated list of element IDs that this button controls the contents or presence of.", "required": false }, { "name": "aria-describedby", "type": "STRING", "description": "A space-separated list of element IDs that provides descriptive labels for the button.", "required": false }, { "name": "aria-expanded", "type": "STRING", "description": "Indicates whether an element the button controls is expanded or collapsed. Valid values are 'true' or 'false'.", "required": false }, { "name": "aria-label", "type": "STRING", "description": "Label describing the button to assistive technologies.", "required": false }, { "name": "aria-live", "type": "STRING", "description": "Indicates that the button will be updated. Valid values are 'assertive', 'polite', or 'off'.", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "Specifies whether this button should be displayed in a disabled state. Disabled buttons can't be clicked. This value defaults to false.", "required": false }, { "name": "icon-name", "type": "STRING", "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.", "access": "global", "parent": "lightning-button", "required": false }, { "name": "icon-position", "type": "STRING", "description": "Describes the position of the icon with respect to body. Options include left and right. This value defaults to left.", "access": "global", "parent": "lightning-button", "required": false }, { "name": "label", "type": "STRING", "description": "The text to be displayed inside the button.", "access": "global", "parent": "lightning-button", "required": false }, { "name": "name", "type": "STRING", "description": "The name for the button element. This value is optional and can be used to identify the button in a callback.", "access": "global", "parent": "lightning-button", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onclick", "type": "AURA.ACTION", "description": "The action triggered when the button is clicked.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "type", "type": "STRING", "description": "Specifies the type of button. Valid values are button, reset, and submit. This value defaults to button.", "access": "global", "parent": "lightning-button", "required": false }, { "name": "value", "type": "STRING", "description": "The value for the button element. This value is optional and can be used when submitting a form.", "access": "global", "parent": "lightning-button", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of the button. Accepted variants include base, neutral, brand, destructive, inverse and success. This value defaults to neutral.", "access": "global", "parent": "lightning-button", "required": false } ], "description": "Represents a button element.", "methods": [ { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "aria-atomic", "type": "STRING", "description": "Indicates whether assistive technologies will present all, or only parts of, the changed region. Valid values are 'true' or 'false'.", "required": false }, { "name": "aria-controls", "type": "STRING", "description": "A space-separated list of element IDs that this button controls the contents or presence of.", "required": false }, { "name": "aria-describedby", "type": "STRING", "description": "A space-separated list of element IDs that provides descriptive labels for the button.", "required": false }, { "name": "aria-expanded", "type": "STRING", "description": "Indicates whether an element the button controls is expanded or collapsed. Valid values are 'true' or 'false'.", "required": false }, { "name": "aria-label", "type": "STRING", "description": "Label describing the button to assistive technologies.", "required": false }, { "name": "aria-live", "type": "STRING", "description": "Indicates that the button will be updated. Valid values are 'assertive', 'polite', or 'off'.", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "Specifies whether this button should be displayed in a disabled state. Disabled buttons can't be clicked. This value defaults to false.", "required": false }, { "name": "icon-name", "type": "STRING", "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.", "access": "global", "parent": "lightning-button", "required": false }, { "name": "icon-position", "type": "STRING", "description": "Describes the position of the icon with respect to body. Options include left and right. This value defaults to left.", "access": "global", "parent": "lightning-button", "required": false }, { "name": "label", "type": "STRING", "description": "The text to be displayed inside the button.", "access": "global", "parent": "lightning-button", "required": false }, { "name": "name", "type": "STRING", "description": "The name for the button element. This value is optional and can be used to identify the button in a callback.", "access": "global", "parent": "lightning-button", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onclick", "type": "AURA.ACTION", "description": "The action triggered when the button is clicked.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "type", "type": "STRING", "description": "Specifies the type of button. Valid values are button, reset, and submit. This value defaults to button.", "access": "global", "parent": "lightning-button", "required": false }, { "name": "value", "type": "STRING", "description": "The value for the button element. This value is optional and can be used when submitting a form.", "access": "global", "parent": "lightning-button", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of the button. Accepted variants include base, neutral, brand, destructive, inverse and success. This value defaults to neutral.", "access": "global", "parent": "lightning-button", "required": false } ] }, "lightning-emp-api": { "type": "module", "namespace": "lightning", "attributes": [], "description": null }, "lightning-carousel": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disable-auto-refresh", "type": "BOOLEAN", "description": "If present, the carousel stops looping\nafter the last item is displayed.", "access": "global", "parent": "lightning-carousel", "required": false }, { "name": "disable-auto-scroll", "type": "BOOLEAN", "description": "If present, images do not automatically scroll and users must click the indicators to scroll.", "access": "global", "parent": "lightning-carousel", "required": false }, { "name": "scroll-duration", "type": "INTEGER", "description": "The auto scroll duration. The default is 5 seconds, after that the next\nimage is displayed.", "access": "global", "parent": "lightning-carousel", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false } ], "description": "A collection of images that are displayed one at a time." }, "lightning-layout": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "body", "type": "AURA.COMPONENT[]", "description": "Body of the layout component.", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "horizontal-align", "type": "STRING", "description": "Determines how to spread the layout items horizontally.\nThe alignment options are center, space, spread, and end.", "access": "global", "parent": "lightning-layout", "required": false }, { "name": "multiple-rows", "type": "BOOLEAN", "description": "If present, layout items wrap to the following line when they exceed the layout width.", "access": "global", "parent": "lightning-layout", "required": false }, { "name": "pull-to-boundary", "type": "STRING", "description": "Pulls layout items to the layout boundaries and corresponds\nto the padding size on the layout item. Possible values are small, medium, or large.", "access": "global", "parent": "lightning-layout", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "vertical-align", "type": "STRING", "description": "Determines how to align the layout items vertically in the container.\nThe alignment options are start, center, end, and stretch.", "access": "global", "parent": "lightning-layout", "required": false } ], "description": "Represents a responsive grid system for arranging containers on a page." }, "lightning-record-view-form": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "density", "type": "", "description": "Sets the arrangement style of fields and labels in the form.\nAccepted values are compact, comfy, and auto (default).\nUse compact to display fields and their labels on the same line.\nUse comfy to display fields below their labels.\nUse auto to let the component dynamically set\nthe density according to the user's Display Density setting\nand the width of the form.", "access": "global", "parent": "lightning-record-view-form", "required": false }, { "name": "object-api-name", "type": "STRING", "description": "The API name of the object.", "access": "global", "parent": "lightning-record-view-form", "required": true }, { "name": "record-id", "type": "STRING", "description": "The ID of the record to be displayed.", "access": "global", "parent": "lightning-record-view-form", "required": true } ], "description": "Represents a record view layout that displays one or more fields, provided by lightning-output-field." }, "lightning-dual-listbox": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "add-button-label", "type": "STRING", "description": "Label for add button.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "disable-reordering", "type": "BOOLEAN", "description": "If present, the Up and Down buttons used for reordering the selected list items are hidden.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the listbox is disabled and users cannot interact with it.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "down-button-label", "type": "STRING", "description": "Label for down button.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "field-level-help", "type": "STRING", "description": "Help text detailing the purpose and function of the dual listbox.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "label", "type": "STRING", "description": "Label for the dual listbox.", "access": "global", "parent": "lightning-dual-listbox", "required": true }, { "name": "max", "type": "INTEGER", "description": "Maximum number of options allowed in the selected options listbox.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "message-when-range-overflow", "type": "", "description": "Error message to be displayed when a range overflow is detected.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "message-when-range-underflow", "type": "", "description": "Error message to be displayed when a range underflow is detected.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "message-when-value-missing", "type": "", "description": "Error message to be displayed when the value is missing and input is required.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "min", "type": "INTEGER", "description": "Minimum number of options required in the selected options listbox.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "name", "type": "STRING", "description": "Specifies the name of an input element.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onchange", "type": "AURA.ACTION", "description": "The action triggered when a value attribute changes.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "options", "type": "OBJECT[]", "description": "A list of options that are available for selection. Each option has the following attributes: label and value.", "access": "global", "parent": "lightning-dual-listbox", "required": true }, { "name": "readonly", "type": "BOOLEAN", "description": "Specifies that an input field is read-only. This value defaults to false.", "required": false }, { "name": "remove-button-label", "type": "STRING", "description": "Label for remove button.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "required", "type": "BOOLEAN", "description": "If present, the user must add an item to the selected listbox before submitting the form.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "required-options", "type": "LIST", "description": "A list of required options that cannot be removed from selected options listbox. This list is populated with values from the options attribute.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "selected-label", "type": "STRING", "description": "Label for the selected options listbox.", "access": "global", "parent": "lightning-dual-listbox", "required": true }, { "name": "show-activity-indicator", "type": "BOOLEAN", "description": "If present, a spinner is displayed in the first listbox to indicate loading activity.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "size", "type": "INTEGER", "description": "Number of items that display in the listboxes before vertical scrollbars are displayed. Determines the vertical size of the listbox.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "source-label", "type": "STRING", "description": "Label for the source options listbox.", "access": "global", "parent": "lightning-dual-listbox", "required": true }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "up-button-label", "type": "STRING", "description": "Label for up button.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "validity", "type": "OBJECT", "description": "Represents the validity states that an element can be in, with respect to constraint validation.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "value", "type": "OBJECT", "description": "A list of default options that are included in the selected options listbox. This list is populated with values from the options attribute.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "values", "type": "LIST", "description": "A list of default options that are included in the selected options list box. This list is populated with values from the options attribute.", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of the dual listbox.\nAccepted variants include standard, label-hidden, label-inline, and label-stacked.\nThis value defaults to standard.\nUse label-hidden to hide the label but make it available to assistive technology.\nUse label-inline to horizontally align the label and dual listbox.\nUse label-stacked to place the label above the dual listbox.", "access": "global", "parent": "lightning-dual-listbox", "required": false } ], "description": "A pair of listboxes that enables multiple options to be selected and reordered.", "methods": [ { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "add-button-label", "type": "STRING", "description": "Label for add button.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "disable-reordering", "type": "BOOLEAN", "description": "If present, the Up and Down buttons used for reordering the selected list items are hidden.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the listbox is disabled and users cannot interact with it.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "down-button-label", "type": "STRING", "description": "Label for down button.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "field-level-help", "type": "STRING", "description": "Help text detailing the purpose and function of the dual listbox.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "label", "type": "STRING", "description": "Label for the dual listbox.", "access": "global", "parent": "lightning-dual-listbox", "required": true }, { "name": "max", "type": "INTEGER", "description": "Maximum number of options allowed in the selected options listbox.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "message-when-range-overflow", "type": "", "description": "Error message to be displayed when a range overflow is detected.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "message-when-range-underflow", "type": "", "description": "Error message to be displayed when a range underflow is detected.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "message-when-value-missing", "type": "", "description": "Error message to be displayed when the value is missing and input is required.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "min", "type": "INTEGER", "description": "Minimum number of options required in the selected options listbox.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "name", "type": "STRING", "description": "Specifies the name of an input element.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onchange", "type": "AURA.ACTION", "description": "The action triggered when a value attribute changes.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "options", "type": "OBJECT[]", "description": "A list of options that are available for selection. Each option has the following attributes: label and value.", "access": "global", "parent": "lightning-dual-listbox", "required": true }, { "name": "readonly", "type": "BOOLEAN", "description": "Specifies that an input field is read-only. This value defaults to false.", "required": false }, { "name": "remove-button-label", "type": "STRING", "description": "Label for remove button.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "required", "type": "BOOLEAN", "description": "If present, the user must add an item to the selected listbox before submitting the form.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "required-options", "type": "LIST", "description": "A list of required options that cannot be removed from selected options listbox. This list is populated with values from the options attribute.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "selected-label", "type": "STRING", "description": "Label for the selected options listbox.", "access": "global", "parent": "lightning-dual-listbox", "required": true }, { "name": "show-activity-indicator", "type": "BOOLEAN", "description": "If present, a spinner is displayed in the first listbox to indicate loading activity.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "size", "type": "INTEGER", "description": "Number of items that display in the listboxes before vertical scrollbars are displayed. Determines the vertical size of the listbox.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "source-label", "type": "STRING", "description": "Label for the source options listbox.", "access": "global", "parent": "lightning-dual-listbox", "required": true }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "up-button-label", "type": "STRING", "description": "Label for up button.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "validity", "type": "OBJECT", "description": "Represents the validity states that an element can be in, with respect to constraint validation.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "value", "type": "OBJECT", "description": "A list of default options that are included in the selected options listbox. This list is populated with values from the options attribute.", "access": "global", "parent": "lightning-dual-listbox", "required": false }, { "name": "values", "type": "LIST", "description": "A list of default options that are included in the selected options list box. This list is populated with values from the options attribute.", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of the dual listbox.\nAccepted variants include standard, label-hidden, label-inline, and label-stacked.\nThis value defaults to standard.\nUse label-hidden to hide the label but make it available to assistive technology.\nUse label-inline to horizontally align the label and dual listbox.\nUse label-stacked to place the label above the dual listbox.", "access": "global", "parent": "lightning-dual-listbox", "required": false } ] }, "lightning-formatted-email": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "hide-icon", "type": "", "description": "If present, the email icon is hidden and only the email address is displayed.", "access": "global", "parent": "lightning-formatted-email", "required": false }, { "name": "label", "type": "STRING", "description": "The text label for the email address.", "access": "global", "parent": "lightning-formatted-email", "required": false }, { "name": "onclick", "type": "AURA.ACTION", "description": "The action triggered when the email is clicked.", "required": false }, { "name": "tab-index", "type": "", "description": "Reserved for internal use. Use tabindex instead to indicate if an element should be focusable.\nA value of 0 means that the element is focusable and\nparticipates in sequential keyboard navigation. A value of -1 means\nthat the element is focusable but does not participate in keyboard navigation.", "access": "global", "parent": "lightning-formatted-email", "required": false }, { "name": "value", "type": "STRING", "description": "The email address that's displayed if a label is not provided.", "access": "global", "parent": "lightning-formatted-email", "required": true } ], "description": "Displays an email as a hyperlink with the mailto: URL scheme." }, "lightning-navigation": { "type": "module", "namespace": "lightning", "attributes": [], "description": "Generates URL for a given pageReference. This component requires API version 43.0 and later.", "methods": [] }, "lightning-page-reference-utils": { "type": "module", "namespace": "lightning", "attributes": [], "description": null }, "lightning-tile": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "actions", "type": "", "description": "A list of actions that's displayed in a dropdown menu.", "access": "global", "parent": "lightning-tile", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "href", "type": "STRING", "description": "The URL of the page that the link goes to.", "access": "global", "parent": "lightning-tile", "required": false }, { "name": "label", "type": "STRING", "description": "The text label that displays in the tile as the heading and hover text.", "access": "global", "parent": "lightning-tile", "required": true }, { "name": "media", "type": "AURA.COMPONENT[]", "description": "The icon or figure that's displayed next to the textual information.", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "type", "type": "", "description": "The tile type. Valid values are 'standard' and 'media'.\nThe default is 'standard'.", "access": "global", "parent": "lightning-tile", "required": false } ], "description": "A grouping of related information associated with a record." }, "lightning-progress-indicator": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "current-step", "type": "STRING", "description": "Set current-step to match the value attribute of one of progress-step components.\nIf current-step is not provided, the value of the first progress-step component is used.", "access": "global", "parent": "lightning-progress-indicator", "required": false }, { "name": "has-error", "type": "BOOLEAN", "description": "If present, the current step is in error state and an error icon is displayed on the step indicator.\nOnly the base type can display errors.", "access": "global", "parent": "lightning-progress-indicator", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "type", "type": "STRING", "description": "Changes the visual pattern of the indicator. Valid values are base and path.\nThe default is base.", "access": "global", "parent": "lightning-progress-indicator", "required": false }, { "name": "variant", "type": "STRING", "description": "Changes the appearance of the progress indicator for the base type only.\nValid values are base or shaded. The shaded variant adds a light gray border to the step indicators.\nThe default is base.", "access": "global", "parent": "lightning-progress-indicator", "required": false } ], "description": "Provides a visual indication on the progress of a particular process." }, "lightning-input": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "accept", "type": "STRING", "description": "Specifies the types of files that the server accepts. Use this attribute with file input type only.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "access-key", "type": "", "description": "Specifies a shortcut key to activate or focus an element.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "aria-controls", "type": "STRING", "description": "A space-separated list of element IDs whose presence or content is controlled by the input.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "aria-describedby", "type": "STRING", "description": "A space-separated list of element IDs that provide descriptive labels for the input.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "aria-label", "type": "STRING", "description": "Describes the input to assistive technologies.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "aria-labelled-by", "type": "STRING", "description": "A space-separated list of element IDs that provide labels for the input.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "autocomplete", "type": "", "description": "Controls auto-filling of the field. Use this attribute with\nemail, search, tel, text, and url input types only. Set the attribute to pass\nthrough autocomplete values to be interpreted by the browser.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "checked", "type": "BOOLEAN", "description": "If present, the checkbox is selected.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "date-aria-controls", "type": "STRING", "description": "A space-separated list of element IDs whose presence or content is controlled by the\ndate input when type='datetime'. On mobile devices, this is merged with aria-controls\nand time-aria-controls to describe the native date time input.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "date-aria-describedby", "type": "STRING", "description": "A space-separated list of element IDs that provide descriptive labels for the date input when\ntype='datetime'. On mobile devices, this is merged with aria-describedby and time-aria-describedby\nto describe the native date time input.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "date-aria-label", "type": "STRING", "description": "Describes the date input to assistive technologies when type='datetime'. On mobile devices,\nthis label is merged with aria-label and time-aria-label to describe the native date time input.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "date-aria-labelled-by", "type": "STRING", "description": "A space-separated list of element IDs that provide labels for the date input when type='datetime'.\nOn mobile devices, this is merged with aria-labelled-by and time-aria-labelled-by to describe\nthe native date time input.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "date-style", "type": "", "description": "The display style of the date when type='date' or type='datetime'. Valid values are\nshort, medium (default), and long. The format of each style is specific to the locale.\nOn mobile devices this attribute has no effect.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the input field is disabled and users cannot interact with it.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "field-level-help", "type": "", "description": "Help text detailing the purpose and function of the input.\nThis attribute isn't supported for file, radio, toggle, and checkbox-button types.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "files", "type": "OBJECT", "description": "A FileList that contains selected files. Use this attribute with the file input type only.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "format-fraction-digits", "type": "", "description": "Reserved for internal use.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "formatter", "type": "STRING", "description": "String value with the formatter to be used for number input. Valid values include\ndecimal, percent, percent-fixed, and currency.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "is-loading", "type": "BOOLEAN", "description": "For the search type only. If present, a spinner is displayed to indicate that data is loading.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "label", "type": "STRING", "description": "Text label for the input.", "access": "global", "parent": "lightning-input", "required": true }, { "name": "max", "type": "OBJECT", "description": "The maximum acceptable value for the input. Use this attribute with number,\nrange, date, time, and datetime input types only. For number and range type, the max value is a\ndecimal number. For the date, time, and datetime types, the max value must use a valid string for the type.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "max-length", "type": "", "description": "The maximum number of characters allowed in the field.\nUse this attribute with email, password, search, tel, text, and url input types only.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "maxlength", "type": "INTEGER", "description": "The maximum number of characters allowed in the field.", "required": false }, { "name": "message-toggle-active", "type": "STRING", "description": "Text shown for the active state of a toggle. The default is \"Active\".", "access": "global", "parent": "lightning-input", "required": false }, { "name": "message-toggle-inactive", "type": "STRING", "description": "Text shown for the inactive state of a toggle. The default is \"Inactive\".", "access": "global", "parent": "lightning-input", "required": false }, { "name": "message-when-bad-input", "type": "STRING", "description": "Error message to be displayed when a bad input is detected.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "message-when-pattern-mismatch", "type": "STRING", "description": "Error message to be displayed when a pattern mismatch is detected.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "message-when-range-overflow", "type": "STRING", "description": "Error message to be displayed when a range overflow is detected.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "message-when-range-underflow", "type": "STRING", "description": "Error message to be displayed when a range underflow is detected.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "message-when-step-mismatch", "type": "STRING", "description": "Error message to be displayed when a step mismatch is detected.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "message-when-too-long", "type": "STRING", "description": "Error message to be displayed when the value is too long.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "message-when-too-short", "type": "STRING", "description": "Error message to be displayed when the value is too short.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "message-when-type-mismatch", "type": "STRING", "description": "Error message to be displayed when a type mismatch is detected.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "message-when-value-missing", "type": "STRING", "description": "Error message to be displayed when the value is missing.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "min", "type": "OBJECT", "description": "The minimum acceptable value for the input. Use this attribute with number,\nrange, date, time, and datetime input types only. For number and range types, the min value\nis a decimal number. For the date, time, and datetime types, the min value must use a valid string for the type.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "min-length", "type": "", "description": "The minimum number of characters allowed in the field.\nUse this attribute with email, password, search, tel, text, and url input types only.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "minlength", "type": "INTEGER", "description": "The minimum number of characters allowed in the field.", "required": false }, { "name": "multiple", "type": "BOOLEAN", "description": "Specifies that a user can enter more than one value. Use this attribute with file and email input types only.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "name", "type": "STRING", "description": "Specifies the name of an input element.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onchange", "type": "AURA.ACTION", "description": "The action triggered when a value attribute changes.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "pattern", "type": "STRING", "description": "Specifies the regular expression that the input's value is checked against.\nThis attribute is supported for email, password, search, tel, text, and url types.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "placeholder", "type": "STRING", "description": "Text that is displayed when the field is empty, to prompt the user for a valid entry. Use this attribute with date, email, number, password, search, tel, text, time, and url input types only.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "read-only", "type": "", "description": "If present, the input field is read-only and cannot be edited by users.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "readonly", "type": "BOOLEAN", "description": "Specifies that an input field is read-only. This value defaults to false.", "required": false }, { "name": "required", "type": "BOOLEAN", "description": "If present, the input field must be filled out before the form is submitted.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "step", "type": "OBJECT", "description": "Granularity of the value, specified as a positive floating point number.\nUse this attribute with number and range input types only.\nUse 'any' when granularity is not a concern. This value defaults to 1.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "time-aria-controls", "type": "STRING", "description": "A space-separated list of element IDs whose presence or content is controlled by the\ntime input when type='datetime'. On mobile devices, this is merged with aria-controls\nand date-aria-controls to describe the native date time input.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "time-aria-describedby", "type": "STRING", "description": "A space-separated list of element IDs that provide descriptive labels for the time input when\ntype='datetime'. On mobile devices, this is merged with aria-described-by and date-aria-described-by\nto describe the native date time input.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "time-aria-label", "type": "STRING", "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.", "required": false }, { "name": "time-aria-labelled-by", "type": "STRING", "description": "A space-separated list of element IDs that provide labels for the time input when type='datetime'.\nOn mobile devices, this is merged with aria-labelled-by and date-aria-labelled-by to describe\nthe native date time input.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "time-style", "type": "", "description": "The display style of the time when type='time' or type='datetime'. Valid values are\nshort (default), medium, and long. Currently, medium and long styles look the same.\nOn mobile devices this attribute has no effect.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "timezone", "type": "STRING", "description": "Specifies the time zone used when type='datetime' only. This value defaults to the user's Salesforce time zone setting.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "type", "type": "STRING", "description": "The type of the input. This value defaults to text.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "validity", "type": "OBJECT", "description": "Represents the validity states that an element can be in, with respect to constraint validation.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "value", "type": "OBJECT", "description": "Specifies the value of an input element.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of an input field.\nAccepted variants include standard, label-inline, label-hidden, and label-stacked.\nThis value defaults to standard, which displays the label above the field.\nUse label-hidden to hide the label but make it available to assistive technology.\nUse label-inline to horizontally align the label and input field.\nUse label-stacked to place the label above the input field.", "access": "global", "parent": "lightning-input", "required": false } ], "description": "Represents interactive controls that accept user input depending on the type attribute.", "methods": [ { "name": "accept", "type": "STRING", "description": "Specifies the types of files that the server accepts. Use this attribute with file input type only.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "access-key", "type": "", "description": "Specifies a shortcut key to activate or focus an element.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "accesskey", "type": "STRING", "description": "Specifies a shortcut key to activate or focus an element.", "required": false }, { "name": "aria-controls", "type": "STRING", "description": "A space-separated list of element IDs whose presence or content is controlled by the input.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "aria-describedby", "type": "STRING", "description": "A space-separated list of element IDs that provide descriptive labels for the input.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "aria-label", "type": "STRING", "description": "Describes the input to assistive technologies.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "aria-labelled-by", "type": "STRING", "description": "A space-separated list of element IDs that provide labels for the input.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "autocomplete", "type": "", "description": "Controls auto-filling of the field. Use this attribute with\nemail, search, tel, text, and url input types only. Set the attribute to pass\nthrough autocomplete values to be interpreted by the browser.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "checked", "type": "BOOLEAN", "description": "If present, the checkbox is selected.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "date-aria-controls", "type": "STRING", "description": "A space-separated list of element IDs whose presence or content is controlled by the\ndate input when type='datetime'. On mobile devices, this is merged with aria-controls\nand time-aria-controls to describe the native date time input.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "date-aria-described-by", "type": "STRING", "description": "A space-separated list of element IDs that provide descriptive labels for the date input when\ntype='datetime'. On mobile devices, this is merged with aria-described-by and time-aria-described-by\nto describe the native date time input.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "date-aria-label", "type": "STRING", "description": "Describes the date input to assistive technologies when type='datetime'. On mobile devices,\nthis label is merged with aria-label and time-aria-label to describe the native date time input.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "date-aria-labelled-by", "type": "STRING", "description": "A space-separated list of element IDs that provide labels for the date input when type='datetime'.\nOn mobile devices, this is merged with aria-labelled-by and time-aria-labelled-by to describe\nthe native date time input.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "date-style", "type": "", "description": "The display style of the date when type='date' or type='datetime'. Valid values are\nshort, medium (default), and long. The format of each style is specific to the locale.\nOn mobile devices this attribute has no effect.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the input field is disabled and users cannot interact with it.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "field-level-help", "type": "", "description": "Help text detailing the purpose and function of the input.\nThis attribute isn't supported for file, radio, toggle, and checkbox-button types.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "files", "type": "OBJECT", "description": "A FileList that contains selected files. Use this attribute with the file input type only.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "format-fraction-digits", "type": "", "description": "Reserved for internal use.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "formatter", "type": "STRING", "description": "String value with the formatter to be used for number input. Valid values include\ndecimal, percent, percent-fixed, and currency.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "is-loading", "type": "BOOLEAN", "description": "For the search type only. If present, a spinner is displayed to indicate that data is loading.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "label", "type": "STRING", "description": "Text label for the input.", "access": "global", "parent": "lightning-input", "required": true }, { "name": "max", "type": "OBJECT", "description": "The maximum acceptable value for the input. Use this attribute with number,\nrange, date, time, and datetime input types only. For number and range type, the max value is a\ndecimal number. For the date, time, and datetime types, the max value must use a valid string for the type.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "max-length", "type": "", "description": "The maximum number of characters allowed in the field.\nUse this attribute with email, password, search, tel, text, and url input types only.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "maxlength", "type": "INTEGER", "description": "The maximum number of characters allowed in the field.", "required": false }, { "name": "message-toggle-active", "type": "STRING", "description": "Text shown for the active state of a toggle. The default is \"Active\".", "access": "global", "parent": "lightning-input", "required": false }, { "name": "message-toggle-inactive", "type": "STRING", "description": "Text shown for the inactive state of a toggle. The default is \"Inactive\".", "access": "global", "parent": "lightning-input", "required": false }, { "name": "message-when-bad-input", "type": "STRING", "description": "Error message to be displayed when a bad input is detected.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "message-when-pattern-mismatch", "type": "STRING", "description": "Error message to be displayed when a pattern mismatch is detected.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "message-when-range-overflow", "type": "STRING", "description": "Error message to be displayed when a range overflow is detected.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "message-when-range-underflow", "type": "STRING", "description": "Error message to be displayed when a range underflow is detected.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "message-when-step-mismatch", "type": "STRING", "description": "Error message to be displayed when a step mismatch is detected.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "message-when-too-long", "type": "STRING", "description": "Error message to be displayed when the value is too long.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "message-when-too-short", "type": "STRING", "description": "Error message to be displayed when the value is too short.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "message-when-type-mismatch", "type": "STRING", "description": "Error message to be displayed when a type mismatch is detected.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "message-when-value-missing", "type": "STRING", "description": "Error message to be displayed when the value is missing.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "min", "type": "OBJECT", "description": "The minimum acceptable value for the input. Use this attribute with number,\nrange, date, time, and datetime input types only. For number and range types, the min value\nis a decimal number. For the date, time, and datetime types, the min value must use a valid string for the type.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "min-length", "type": "", "description": "The minimum number of characters allowed in the field.\nUse this attribute with email, password, search, tel, text, and url input types only.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "minlength", "type": "INTEGER", "description": "The minimum number of characters allowed in the field.", "required": false }, { "name": "multiple", "type": "BOOLEAN", "description": "Specifies that a user can enter more than one value. Use this attribute with file and email input types only.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "name", "type": "STRING", "description": "Specifies the name of an input element.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the element releases focus.", "required": false }, { "name": "onchange", "type": "AURA.ACTION", "description": "The action triggered when a value attribute changes.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the element receives focus.", "required": false }, { "name": "pattern", "type": "STRING", "description": "Specifies the regular expression that the input's value is checked against.\nThis attribute is supported for email, password, search, tel, text, and url types.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "placeholder", "type": "STRING", "description": "Text that is displayed when the field is empty, to prompt the user for a valid entry. Use this attribute with date, email, number, password, search, tel, text, time, and url input types only.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "read-only", "type": "", "description": "If present, the input field is read-only and cannot be edited by users.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "readonly", "type": "BOOLEAN", "description": "Specifies that an input field is read-only. This value defaults to false.", "required": false }, { "name": "required", "type": "BOOLEAN", "description": "If present, the input field must be filled out before the form is submitted.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "step", "type": "OBJECT", "description": "Granularity of the value, specified as a positive floating point number.\nUse this attribute with number and range input types only.\nUse 'any' when granularity is not a concern. This value defaults to 1.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "tabindex", "type": "INTEGER", "description": "Specifies the tab order of an element (when the tab button is used for navigating).", "required": false }, { "name": "time-aria-controls", "type": "STRING", "description": "A space-separated list of element IDs whose presence or content is controlled by the\ntime input when type='datetime'. On mobile devices, this is merged with aria-controls\nand date-aria-controls to describe the native date time input.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "time-aria-described-by", "type": "STRING", "description": "A space-separated list of element IDs that provide descriptive labels for the time input when\ntype='datetime'. On mobile devices, this is merged with aria-described-by and date-aria-described-by\nto describe the native date time input.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "time-aria-label", "type": "STRING", "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.", "required": false }, { "name": "time-aria-labelled-by", "type": "STRING", "description": "A space-separated list of element IDs that provide labels for the time input when type='datetime'.\nOn mobile devices, this is merged with aria-labelled-by and date-aria-labelled-by to describe\nthe native date time input.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "time-style", "type": "", "description": "The display style of the time when type='time' or type='datetime'. Valid values are\nshort (default), medium, and long. Currently, medium and long styles look the same.\nOn mobile devices this attribute has no effect.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "timezone", "type": "STRING", "description": "Specifies the time zone used when type='datetime' only. This value defaults to the user's Salesforce time zone setting.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "type", "type": "STRING", "description": "The type of the input. This value defaults to text.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "validity", "type": "OBJECT", "description": "Represents the validity states that an element can be in, with respect to constraint validation.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "value", "type": "OBJECT", "description": "Specifies the value of an input element.", "access": "global", "parent": "lightning-input", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of an input field.\nAccepted variants include standard, label-inline, label-hidden, and label-stacked.\nThis value defaults to standard, which displays the label above the field.\nUse label-hidden to hide the label but make it available to assistive technology.\nUse label-inline to horizontally align the label and input field.\nUse label-stacked to place the label above the input field.", "access": "global", "parent": "lightning-input", "required": false } ] }, "lightning-output-field": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "field-class", "type": "", "description": "A CSS class for the outer element, in addition to the component's base classes.", "access": "global", "parent": "lightning-output-field", "required": false }, { "name": "field-name", "type": "STRING", "description": "The API name of the field to be displayed.", "access": "global", "parent": "lightning-output-field", "required": false }, { "name": "variant", "type": "STRING", "description": "Changes the appearance of the output. Accepted variants\ninclude standard and label-hidden. This value defaults to standard.", "access": "global", "parent": "lightning-output-field", "required": false } ], "description": "Represents a read-only display of a label, help text, and value for a field on a Salesforce object." }, "lightning-layout-item": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "alignment-bump", "type": "STRING", "description": "Specifies a direction to bump the alignment of adjacent layout items. Allowed values are left, top, right, bottom.", "access": "global", "parent": "lightning-layout-item", "required": false }, { "name": "body", "type": "AURA.COMPONENT[]", "description": "The body of the component. In markup, this is everything in the body of the tag.", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "flexibility", "type": "OBJECT", "description": "Make the item fluid so that it absorbs any extra space in its\ncontainer or shrinks when there is less space. Allowed values are:\nauto (columns grow or shrink equally as space allows),\nshrink (columns shrink equally as space decreases),\nno-shrink (columns don't shrink as space reduces),\ngrow (columns grow equally as space increases),\nno-grow (columns don't grow as space increases),\nno-flex (columns don't grow or shrink as space changes).\nUse a comma-separated value for multiple options, such as 'auto, no-shrink'.", "access": "global", "parent": "lightning-layout-item", "required": false }, { "name": "large-device-size", "type": "INTEGER", "description": "If the viewport is divided into 12 parts, this attribute indicates\nthe relative space the container occupies on device-types larger than\ndesktop. It is expressed as an integer from 1 through 12.", "access": "global", "parent": "lightning-layout-item", "required": false }, { "name": "medium-device-size", "type": "INTEGER", "description": "If the viewport is divided into 12 parts, this attribute indicates\nthe relative space the container occupies on device-types larger than\ntablet. It is expressed as an integer from 1 through 12.", "access": "global", "parent": "lightning-layout-item", "required": false }, { "name": "padding", "type": "STRING", "description": "Sets padding to either the right and left sides of a container,\nor all sides of a container. Allowed values are horizontal-small,\nhorizontal-medium, horizontal-large, around-small, around-medium, around-large.", "access": "global", "parent": "lightning-layout-item", "required": false }, { "name": "size", "type": "INTEGER", "description": "If the viewport is divided into 12 parts, size indicates the\nrelative space the container occupies. Size is expressed as\nan integer from 1 through 12. This applies for all device-types.", "access": "global", "parent": "lightning-layout-item", "required": false }, { "name": "small-device-size", "type": "INTEGER", "description": "If the viewport is divided into 12 parts, this attribute indicates\nthe relative space the container occupies on device-types larger than\nmobile. It is expressed as an integer from 1 through 12.", "access": "global", "parent": "lightning-layout-item", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false } ], "description": "The basic element in a lightning-layout component.\nA layout item groups information together to define visual grids, spacing, and sections." }, "lightning-formatted-location": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "latitude", "type": "DECIMAL", "description": "The latitude of the geolocation. Latitude values must be within -90 and 90.", "access": "global", "parent": "lightning-formatted-location", "required": true }, { "name": "longitude", "type": "DECIMAL", "description": "The longitude of the geolocation. Longitude values must be within -180 and 180.", "access": "global", "parent": "lightning-formatted-location", "required": true }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false } ], "description": "Displays a geolocation in decimal degrees using the format [latitude, longitude]." }, "lightning-accordion": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "active-section-name", "type": "STRING", "description": "Expands the specified accordion sections. Section names are case-sensitive.\nTo support multiple expanded sections, include allow-multiple-sections-open in your markup.\nBy default, only the first section in the accordion is expanded.", "access": "global", "parent": "lightning-accordion", "required": false }, { "name": "allow-multiple-sections-open", "type": "BOOLEAN", "description": "If present, the accordion allows multiple open sections.\nOtherwise, opening a section closes another that's currently open.", "access": "global", "parent": "lightning-accordion", "required": false }, { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "onsectiontoggle", "type": "AURA.ACTION", "description": "Action fired when the open sections change, it contains all open sections.", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "access": "global", "parent": "lightning-accordion", "required": false } ], "description": "A collection of vertically stacked sections with multiple content areas." }, "lightning-slider": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the slider is disabled and users cannot interact with it.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "label", "type": "STRING", "description": "Text label to describe the slider. Provide your own label to describe the slider.", "access": "global", "parent": "lightning-slider", "required": true }, { "name": "max", "type": "INTEGER", "description": "The maximum value of the input range. The default is 100.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "message-when-bad-input", "type": "STRING", "description": "Error message to be displayed when a bad input is detected.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "message-when-pattern-mismatch", "type": "STRING", "description": "Error message to be displayed when a pattern mismatch is detected.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "message-when-range-overflow", "type": "STRING", "description": "Error message to be displayed when a range overflow is detected.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "message-when-range-underflow", "type": "STRING", "description": "Error message to be displayed when a range underflow is detected.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "message-when-step-mismatch", "type": "STRING", "description": "Error message to be displayed when a step mismatch is detected.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "message-when-too-long", "type": "STRING", "description": "Error message to be displayed when the value is too long.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "message-when-type-mismatch", "type": "STRING", "description": "Error message to be displayed when a type mismatch is detected.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "message-when-value-missing", "type": "STRING", "description": "Error message to be displayed when the value is missing.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "min", "type": "INTEGER", "description": "The minimum value of the input range. The default is 0.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the slider releases focus.", "required": false }, { "name": "onchange", "type": "STRING", "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.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the slider receives focus.", "required": false }, { "name": "size", "type": "STRING", "description": "The size of the slider.\nThe default is an empty string, which sets the slider to the width of the viewport. Accepted values are x-small, small, medium, and large.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "step", "type": "STRING", "description": "The step increment value of the input range.\nExample steps include 0.1, 1, or 10. The default is 1.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "type", "type": "STRING", "description": "The type determines the orientation of the slider. Accepted values are vertical and horizontal. The default is horizontal.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "validity", "type": "", "description": "Represents the validity states of the slider input, with respect to constraint validation.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "value", "type": "INTEGER", "description": "The numerical value of the slider. The default is 0.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of the slider.\nAccepted variants include standard and label-hidden.\nThe default is standard.", "access": "global", "parent": "lightning-slider", "required": false } ], "description": "An input range slider for specifying a value between two specified numbers.", "methods": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "disabled", "type": "BOOLEAN", "description": "If present, the slider is disabled and users cannot interact with it.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "label", "type": "STRING", "description": "Text label to describe the slider. Provide your own label to describe the slider.", "access": "global", "parent": "lightning-slider", "required": true }, { "name": "max", "type": "INTEGER", "description": "The maximum value of the input range. The default is 100.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "message-when-bad-input", "type": "STRING", "description": "Error message to be displayed when a bad input is detected.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "message-when-pattern-mismatch", "type": "STRING", "description": "Error message to be displayed when a pattern mismatch is detected.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "message-when-range-overflow", "type": "STRING", "description": "Error message to be displayed when a range overflow is detected.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "message-when-range-underflow", "type": "STRING", "description": "Error message to be displayed when a range underflow is detected.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "message-when-step-mismatch", "type": "STRING", "description": "Error message to be displayed when a step mismatch is detected.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "message-when-too-long", "type": "STRING", "description": "Error message to be displayed when the value is too long.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "message-when-type-mismatch", "type": "STRING", "description": "Error message to be displayed when a type mismatch is detected.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "message-when-value-missing", "type": "STRING", "description": "Error message to be displayed when the value is missing.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "min", "type": "INTEGER", "description": "The minimum value of the input range. The default is 0.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "onblur", "type": "AURA.ACTION", "description": "The action triggered when the slider releases focus.", "required": false }, { "name": "onchange", "type": "STRING", "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.", "required": false }, { "name": "onfocus", "type": "AURA.ACTION", "description": "The action triggered when the slider receives focus.", "required": false }, { "name": "size", "type": "STRING", "description": "The size of the slider.\nThe default is an empty string, which sets the slider to the width of the viewport. Accepted values are x-small, small, medium, and large.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "step", "type": "STRING", "description": "The step increment value of the input range.\nExample steps include 0.1, 1, or 10. The default is 1.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "title", "type": "STRING", "description": "Displays tooltip text when the mouse moves over the element.", "required": false }, { "name": "type", "type": "STRING", "description": "The type determines the orientation of the slider. Accepted values are vertical and horizontal. The default is horizontal.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "validity", "type": "", "description": "Represents the validity states of the slider input, with respect to constraint validation.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "value", "type": "INTEGER", "description": "The numerical value of the slider. The default is 0.", "access": "global", "parent": "lightning-slider", "required": false }, { "name": "variant", "type": "STRING", "description": "The variant changes the appearance of the slider.\nAccepted variants include standard and label-hidden.\nThe default is standard.", "access": "global", "parent": "lightning-slider", "required": false } ] }, "lightning-record-edit-form": { "type": "module", "namespace": "lightning", "attributes": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "density", "type": "", "description": "Sets the arrangement style of fields and labels in the form.\nAccepted values are compact, comfy, and auto (default).\nUse compact to display fields and their labels on the same line.\nUse comfy to display fields below their labels.\nUse auto to let the component dynamically set\nthe density according to the user's Display Density setting\nand the width of the form.", "access": "global", "parent": "lightning-record-edit-form", "required": false }, { "name": "field-names", "type": "", "description": "Reserved for internal use. Names of the fields to include in the form.", "access": "global", "parent": "lightning-record-edit-form", "required": false }, { "name": "form-class", "type": "", "description": "A CSS class for the form element.", "access": "global", "parent": "lightning-record-edit-form", "required": false }, { "name": "layout-type", "type": "", "description": "The type of layout to use to display the form fields. Possible values: Compact, Full.", "access": "global", "parent": "lightning-record-edit-form", "required": false }, { "name": "object-api-name", "type": "STRING", "description": "The API name of the object.", "access": "global", "parent": "lightning-record-edit-form", "required": true }, { "name": "onerror", "type": "AURA.ACTION", "description": "The action triggered when there is an error on form submission.", "required": false }, { "name": "onload", "type": "AURA.ACTION", "description": "The action triggered when the form data is loaded.", "required": false }, { "name": "onsubmit", "type": "AURA.ACTION", "description": "The action triggered when the form is submitted.", "required": false }, { "name": "onsuccess", "type": "AURA.ACTION", "description": "The action triggered when the form is saved.", "required": false }, { "name": "record-id", "type": "STRING", "description": "The ID of the record to be displayed.", "access": "global", "parent": "lightning-record-edit-form", "required": false }, { "name": "record-type-id", "type": "STRING", "description": "The ID of the record type, which is required if you created\nmultiple record types but don't have a default.", "access": "global", "parent": "lightning-record-edit-form", "required": false } ], "description": "Represents a record edit layout that displays one or more fields, provided by lightning-input-field.", "methods": [ { "name": "class", "type": "STRING", "description": "A CSS class for the outer element, in addition to the component's base classes.", "required": false }, { "name": "density", "type": "", "description": "Sets the arrangement style of fields and labels in the form.\nAccepted values are compact, comfy, and auto (default).\nUse compact to display fields and their labels on the same line.\nUse comfy to display fields below their labels.\nUse auto to let the component dynamically set\nthe density according to the user's Display Density setting\nand the width of the form.", "access": "global", "parent": "lightning-record-edit-form", "required": false }, { "name": "field-names", "type": "", "description": "Reserved for internal use. Names of the fields to include in the form.", "access": "global", "parent": "lightning-record-edit-form", "required": false }, { "name": "form-class", "type": "", "description": "A CSS class for the form element.", "access": "global", "parent": "lightning-record-edit-form", "required": false }, { "name": "layout-type", "type": "", "description": "The type of layout to use to display the form fields. Possible values: Compact, Full.", "access": "global", "parent": "lightning-record-edit-form", "required": false }, { "name": "object-api-name", "type": "STRING", "description": "The API name of the object.", "access": "global", "parent": "lightning-record-edit-form", "required": true }, { "name": "onerror", "type": "AURA.ACTION", "description": "The action triggered when there is an error on form submission.", "required": false }, { "name": "onload", "type": "AURA.ACTION", "description": "The action triggered when the form data is loaded.", "required": false }, { "name": "onsubmit", "type": "AURA.ACTION", "description": "The action triggered when the form is submitted.", "required": false }, { "name": "onsuccess", "type": "AURA.ACTION", "description": "The action triggered when the form is saved.", "required": false }, { "name": "record-id", "type": "STRING", "description": "The ID of the record to be displayed.", "access": "global", "parent": "lightning-record-edit-form", "required": false }, { "name": "record-type-id", "type": "STRING", "description": "The ID of the record type, which is required if you created\nmultiple record types but don't have a default.", "access": "global", "parent": "lightning-record-edit-form", "required": false } ] } }