{ "accordion": { "description": "An accordion allows a user to toggle the display of sections of content.\nThe accordion component wraps accordion panels that can be selected and expanded. It accepts children to define the content displayed within.", "methods": [ { "name": "onClickSummary", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "onKeyDownSummary", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": null } ], "returns": null }, { "name": "addSummaryButton", "docblock": null, "modifiers": [], "params": [ { "name": "button", "type": null } ], "returns": null } ], "props": { "className": { "type": { "name": "union", "value": [ { "name": "array" }, { "name": "object" }, { "name": "string" } ] }, "required": false, "description": "CSS class names to be added to the accordion component. _Tested with snapshot testing._" }, "id": { "type": { "name": "union", "value": [ { "name": "number" }, { "name": "string" } ] }, "required": false, "description": "HTML id for accordion component. _Tested with snapshot testing._" }, "children": { "type": { "name": "node" }, "required": true, "description": "The panel content for the Accordion component. Accordion panels should be added as . Event handler for the accordion panels should be added to ``. Optional `panelContentActions` component may be passed as prop. _Tested with Mocha framework and snapshot testing._\n\nExample:\n```\n\n \n \n \n\n```" } }, "route": "accordions", "display-name": "Accordions", "SLDS-component-path": "/components/accordion", "dependencies": [ { "panel": { "description": "The panel content for the Accordion component.", "methods": [], "props": { "children": { "type": { "name": "node" }, "required": false, "description": "The panel content for the Accordion component. Accordion panels should be added as . Event handler for the accordion panels should be added to ``. Optional `panelContentActions` component may be passed as prop. _Tested with Mocha framework and snapshot testing._" }, "expanded": { "type": { "name": "bool" }, "required": true, "description": "Indicates whether item is expanded or not, which should be handled by `onTogglePanel`. _Tested with Mocha framework and snapshot testing._" }, "id": { "type": { "name": "union", "value": [ { "name": "number" }, { "name": "string" } ] }, "required": true, "description": "Id of the item belonging to this panel. _Tested with snapshot testing._" }, "panelContentActions": { "type": { "name": "node" }, "required": false, "description": "Component that can be passed as prop to ``. As an example, a menu dropdown could be used here to handle additional actions for each accordion panel. _Tested with Mocha framework._" }, "onKeyDownSummary": { "type": { "name": "func" }, "required": false, "description": "Callback that will run whenever there is a keydown on the panel button. Function doesn't change the state of the component." }, "onTogglePanel": { "type": { "name": "func" }, "required": true, "description": "Callback that will run whenever a panel is toggled. Function should handle state to toggle `expanded` prop. _Tested with Mocha framework._" }, "refs": { "type": { "name": "shape", "value": { "summaryButton": { "name": "func", "required": false } } }, "required": false, "description": "Ref callback that will pass in panel's `input` tag" }, "summary": { "type": { "name": "union", "value": [ { "name": "string" }, { "name": "node" } ] }, "required": true, "description": "Summary in the span element in the header of this panel. The summary is truncated and so the title element should contain the full text so that it is accessible on hover. _Tested with snapshot testing._" }, "title": { "type": { "name": "string" }, "required": false, "description": "HTML title attribute. _Tested with snapshot testing._" } }, "name": "panel", "source": "/components/accordion/panel.jsx" } } ] }, "alert": { "description": "Alert banners communicate a state that affects the entire system, not just a feature or page. It persists over a session and appears without the user initiating the action. View [banner guidelines](https://www.lightningdesignsystem.com/guidelines/messaging/components/banners/).", "methods": [ { "name": "saveButtonRef", "docblock": null, "modifiers": [], "params": [ { "name": "component", "type": null } ], "returns": null } ], "props": { "assistiveText": { "type": { "name": "shape", "value": { "closeButton": { "name": "union", "value": [ { "name": "string" }, { "name": "node" } ], "required": false } } }, "required": false, "description": "**Assistive text for accessibility**\nThis object is merged with the default props object on every render.\n* `closeButton`: This is a visually hidden label for the close button.\n_Tested with snapshot testing._", "defaultValue": { "value": "{\n\tcloseButton: 'Close',\n}", "computed": false } }, "className": { "type": { "name": "union", "value": [ { "name": "array" }, { "name": "object" }, { "name": "string" } ] }, "required": false, "description": "CSS classes to be added to tag with `.slds-notify_alert`. Uses `classNames` [API](https://github.com/JedWatson/classnames).\n_Tested with snapshot testing._" }, "dismissible": { "type": { "name": "bool" }, "required": false, "description": "Allows user to click a close button. Banners should be dismissible only if they communicate future impact to the system,\n_Tested with snapshot testing._" }, "icon": { "type": { "name": "node" }, "required": false, "description": "Icon of type `~/components/icon`. This icon will be cloned and additional props appended. The default icons are:\n* info variant: `utility:info`\n* error variant: `utility:error`\n* offline variant: `utility:offline`\n* warning variant: `utility:warning`\n\n_Tested with snapshot testing._" }, "labels": { "type": { "name": "shape", "value": { "heading": { "name": "union", "value": [ { "name": "string" }, { "name": "node" } ], "required": false }, "headingLink": { "name": "union", "value": [ { "name": "string" }, { "name": "node" } ], "required": false } } }, "required": false, "description": "**Text labels for internationalization**\nThis object is merged with the default props object on every render.\n* `heading`: text within heading tag\n* `headingLink`: Text of link that triggers `onClickHeadingLink`. Inline links should pass a keyed array of React components into `labels.heading`.\n\n_Tested with snapshot testing._", "defaultValue": { "value": "{}", "computed": false } }, "onClickHeadingLink": { "type": { "name": "func" }, "required": false, "description": "Triggered by link. _Tested with Mocha testing._" }, "onRequestClose": { "type": { "name": "func" }, "required": false, "description": "Triggered by close button. This is a controlled component. _Tested with Mocha testing._" }, "style": { "type": { "name": "object" }, "required": false, "description": "Custom styles to be passed to the component. _Tested with Mocha testing._" }, "variant": { "type": { "name": "enum", "value": [ { "value": "'error'", "computed": false }, { "value": "'info'", "computed": false }, { "value": "'offline'", "computed": false }, { "value": "'warning'", "computed": false } ] }, "required": false, "description": "The type of alert. _Tested with snapshot testing._", "defaultValue": { "value": "'info'", "computed": false } } }, "route": "alerts", "display-name": "Alerts", "SLDS-component-path": "/components/alert", "dependencies": [ { "container": { "description": "A fixed container for alert banners.", "methods": [], "props": { "className": { "type": { "name": "union", "value": [ { "name": "array" }, { "name": "object" }, { "name": "string" } ] }, "required": false, "description": "CSS classes to be added to tag with `.slds-notify_alert`. Uses `classNames` [API](https://github.com/JedWatson/classnames)." }, "children": { "type": { "name": "node" }, "required": false, "description": "Alert components" } }, "name": "container", "source": "/components/alert/container.jsx" } } ] }, "app-launcher": { "description": "The App Launcher allows the user to quickly access all the apps and functionality with their organization.\nThe App Launcher should generally only be used as a sub-component of the [Global Navigation Bar](/components/global-navigation-bar)\n\nUSAGE EXAMPLE:\n```\n\n\t\n\t\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\n```\n\nBy default, `Modal`, a child component of App Launcher, will add `aria-hidden=true` to the `body` tag, but this disables some assistive technologies. To prevent this you can add the following to your application with `#mount` being the root node of your application that you would like to hide from assistive technologies when the `Modal` is open.\n```\nimport settings from 'design-system-react/components/settings';\nsettings.setAppElement('#mount');\n```", "methods": [ { "name": "getId", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "openAppLauncher", "docblock": null, "modifiers": [], "params": [ { "name": "event", "type": null } ], "returns": null }, { "name": "closeAppLauncher", "docblock": null, "modifiers": [], "params": [ { "name": "event", "type": null } ], "returns": null }, { "name": "renderSearch", "docblock": null, "modifiers": [], "params": [], "returns": null } ], "props": { "assistiveText": { "type": { "name": "shape", "value": { "trigger": { "name": "string", "required": false } } }, "required": false, "description": "**Assistive text for accessibility.**\nThis object is merged with the default props object on every render.\n* `trigger`: This is a visually hidden label for the app launcher icon.", "defaultValue": { "value": "{\n\ttrigger: 'Open App Launcher',\n}", "computed": false } }, "ariaHideApp": { "type": { "name": "bool" }, "required": false, "description": "Boolean indicating if the appElement should be hidden.", "defaultValue": { "value": "true", "computed": false } }, "children": { "type": { "name": "node" }, "required": true, "description": "One or more ``s, each containing one or more ``s or ``s" }, "id": { "type": { "name": "string" }, "required": false, "description": "The app launcher id. If not provided, one will be generated for accessibility" }, "isOpen": { "type": { "name": "bool" }, "required": false, "description": "Control the open/close state of the App Launcher" }, "modalClassName": { "type": { "name": "union", "value": [ { "name": "array" }, { "name": "object" }, { "name": "string" } ] }, "required": false, "description": "CSS classes to be added to App Launcher Modal." }, "modalHeaderButton": { "type": { "name": "node" }, "required": false, "description": "Button that exists in the upper right hand corner of the App Launcher modal" }, "noTruncate": { "type": { "name": "bool" }, "required": false, "description": "Allows longer application names without truncating them." }, "onClose": { "type": { "name": "func" }, "required": false, "description": "Callback when the App Launcher Modal is closed" }, "search": { "type": { "name": "node" }, "required": false, "description": "Search bar for the Modal's header. Will typically be an instance of `design-system-react/input/search`" }, "title": { "type": { "name": "string" }, "required": false, "description": "Set the App Launcher's title text (for localization)", "defaultValue": { "value": "'App Launcher'", "computed": false } }, "triggerName": { "type": { "name": "node" }, "required": false, "description": "This is typically the name of the cloud or application" }, "triggerOnClick": { "type": { "name": "func" }, "required": false, "description": "Callback when the App Launcher icon is clicked" } }, "route": "app-launcher", "display-name": "App Launcher", "SLDS-component-path": "/components/app-launcher", "dependencies": [ { "expandable-section": { "description": "App Launcher Sections allow users to categorize App Tiles & Links as well as toggle their display. It is a superset of components/expandable-section with content formatting.\nAll Expandable Section props are compatible with props passed to this component.", "methods": [ { "name": "toggleOpen", "docblock": null, "modifiers": [], "params": [ { "name": "event", "type": null }, { "name": "data", "type": null } ], "returns": null } ], "props": { "assistiveText": { "type": { "name": "shape", "value": { "toggleSection": { "name": "string", "required": false } } }, "required": false, "description": "**Assistive text for accessibility.**\n* `toggleSection`: Label for the icon that expands / collapses the section" }, "children": { "type": { "name": "node" }, "required": false, "description": "Contents of the section" }, "className": { "type": { "name": "union", "value": [ { "name": "array" }, { "name": "object" }, { "name": "string" } ] }, "required": false, "description": "Class names to be added to the `slds-section` classed node" }, "id": { "type": { "name": "string" }, "required": false, "description": "Unique identifier for the expandable section. The id is automatically generated if not provided" }, "isOpen": { "type": { "name": "bool" }, "required": false, "description": "Specifies whether the section is expanded or collapsed. If not provided, component will use its own state to manage this itself" }, "nonCollapsible": { "type": { "name": "bool" }, "required": false, "description": "Specifies whether the section can be expanded or collapsed. Defaults to `false`" }, "onToggleOpen": { "type": { "name": "func" }, "required": false, "description": "Callback for when the section is expanded or collapsed. Passes event object and data object with `isOpen` bool." }, "title": { "type": { "name": "string" }, "required": true, "description": "The title for the section" } }, "name": "expandable-section", "source": "/components/app-launcher/expandable-section.jsx" } }, { "link": { "description": "App Launcher Link component creates simple links to be used in \"All Items\" sections", "methods": [], "props": { "children": { "type": { "name": "node" }, "required": false, "description": "Contents of the link" }, "className": { "type": { "name": "union", "value": [ { "name": "array" }, { "name": "object" }, { "name": "string" } ] }, "required": false, "description": "Classes to be applied to the link" }, "href": { "type": { "name": "string" }, "required": false, "description": "The `href` attribute of the link. If the `onClick` callback is specified this URL will be prevented from changing the browser's location.", "defaultValue": { "value": "'#'", "computed": false } }, "onClick": { "type": { "name": "func" }, "required": false, "description": "Callback for when the link is clicked. Passes back event and data object with href prop. Prevents click from changing browser's location if set." }, "search": { "type": { "name": "string" }, "required": false, "description": "Text used to highlight content in link" }, "title": { "type": { "name": "string" }, "required": false, "description": "The title for the link. If not provided it will attempt to use child content if that content is a string." } }, "name": "link", "source": "/components/app-launcher/link.jsx" } }, { "tile": { "description": "App Launcher Tiles provide information and links to a user's apps", "methods": [ { "name": "handleClick", "docblock": null, "modifiers": [], "params": [ { "name": "event", "type": null } ], "returns": null } ], "props": { "assistiveText": { "type": { "name": "shape", "value": { "dragIconText": { "name": "string", "required": false } } }, "required": false, "description": "**Assistive text for accessibility.**\n* `dragIconText`: Text that describes the purpose of the drag handle icon.", "defaultValue": { "value": "{\n\tdragIconText: 'Reorder',\n}", "computed": false } }, "className": { "type": { "name": "union", "value": [ { "name": "array" }, { "name": "object" }, { "name": "string" } ] }, "required": false, "description": "Class names to be added to the tile." }, "description": { "type": { "name": "string" }, "required": false, "description": "The description of the app. Not visible on small tiles." }, "descriptionHeading": { "type": { "name": "string" }, "required": false, "description": "Heading for app description. NOTE: this prop is DEPRECATED and use should be avoided" }, "href": { "type": { "name": "string" }, "required": false, "description": "The `href` attribute of the tile. Please pass in bookmarkable URLs from your routing library. If the `onClick` callback is specified this URL will be prevented from changing the browser's location.", "defaultValue": { "value": "'#'", "computed": false } }, "iconBackgroundColor": { "type": { "name": "string" }, "required": false, "description": "Background color to be used on the icon. Only applied if iconNode is undefined" }, "iconNode": { "type": { "name": "node" }, "required": false, "description": "Icon node for app tile. Takes priority over `iconText`" }, "iconText": { "type": { "name": "string" }, "required": false, "description": "Text to be used as an icon. Only renders if iconNode is undefined" }, "isOpenTooltip": { "type": { "name": "bool" }, "required": false, "description": "Open the More Tooltip" }, "moreLabel": { "type": { "name": "string" }, "required": false, "description": "The localized text for the \"More information\" tooltip.", "defaultValue": { "value": "' More'", "computed": false } }, "onClick": { "type": { "name": "func" }, "required": false, "description": "Function that will be executed when clicking on a tile" }, "search": { "type": { "name": "string" }, "required": false, "description": "Text used to highlight content in app tiles" }, "title": { "type": { "name": "string" }, "required": true, "description": "App name for the tile's title." } }, "name": "tile", "source": "/components/app-launcher/tile.jsx" } } ] }, "avatar": { "description": "The avatar component represents an object or entity. An image is the preferred format for an avatar.\n If the `imgSrc` prop is undefined, and if a `label` or `initials` prop is available, the fallback avatar will render with initials. If initals are passed in directly in the `initials` prop, this will render in the fallback avatar. If `initals` prop is unavailable but a `label` prop is available, the fallback avatar will render with built initials of the user name or entity name.\n\n Intials built from the `label` prop will apply the following logic: If the label name contains two words, like first and last name, the first letter of each will be capitalized and returned. For labels that only have a single word name, the first two letters of that word, using one capital and one lower case letter, will be returned. For labels that contain three or more words, the first character of the first and last words will be capitalized and returned.\n\n If `initials` or `label` are not available, the fallback avatar will render a standard icon. If `variant='user'`, a user icon will\n render. If `variant='entity'`, an account icon will render.", "methods": [ { "name": "buildInitials", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "handleImageError", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "renderBaseAvatar", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "renderIconAvatar", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "renderInitialsAvatar", "docblock": null, "modifiers": [], "params": [], "returns": null } ], "props": { "assistiveText": { "type": { "name": "shape", "value": { "icon": { "name": "string", "required": false } } }, "required": false, "description": "**Assistive text for accessibility.**\nThis object is merged with the default props object on every render.\n* `icon`: Assistive text for accessibility that labels the icon.", "defaultValue": { "value": "{\n\ticon: 'User or Account Icon',\n}", "computed": false } }, "imgAlt": { "type": { "name": "string" }, "required": false, "description": "Alt attribute to be applied to image (base case) element.", "defaultValue": { "value": "''", "computed": false } }, "imgSrc": { "type": { "name": "string" }, "required": false, "description": "Source attribute to be applied to image (base case) element." }, "initials": { "type": { "name": "string" }, "required": false, "description": "Initials attribute to optionally pass in initials directly in case of \"initials\" fallback case." }, "inverse": { "type": { "name": "bool" }, "required": false, "description": "Avatar with initials that are dark text on light background" }, "label": { "type": { "name": "string" }, "required": false, "description": "Label attibute to display inside \"initials\" fallback case. Will be passed as title prop in `abbr` element to provide more specificity." }, "variant": { "type": { "name": "enum", "value": [ { "value": "'entity'", "computed": false }, { "value": "'user'", "computed": false } ] }, "required": false, "description": "Avatar variants to apply relevant styling (circle: user, square: entity) and icon rendering if applicable.", "defaultValue": { "value": "'user'", "computed": false } }, "size": { "type": { "name": "enum", "value": [ { "value": "'x-small'", "computed": false }, { "value": "'small'", "computed": false }, { "value": "'medium'", "computed": false }, { "value": "'large'", "computed": false } ] }, "required": false, "description": "Size of the icon in \"icon\" fallback case.", "defaultValue": { "value": "'medium'", "computed": false } }, "title": { "type": { "name": "string" }, "required": false, "description": "Title attribute for the avatar container.", "defaultValue": { "value": "'user avatar'", "computed": false } } }, "route": "avatars", "display-name": "Avatars", "SLDS-component-path": "/components/avatar", "dependencies": [] }, "badge": { "description": "Badges are labels which hold small amounts of information.", "methods": [ { "name": "getId", "docblock": "Get the Badge's HTML id. Generate a new one if no ID present.", "modifiers": [], "params": [], "returns": null, "description": "Get the Badge's HTML id. Generate a new one if no ID present." } ], "props": { "className": { "type": { "name": "union", "value": [ { "name": "array" }, { "name": "object" }, { "name": "string" } ] }, "required": false, "description": "CSS classes that are applied to the component" }, "id": { "type": { "name": "string" }, "required": false, "description": "Id of component, if desired. If not provided an id is automatically generated" }, "style": { "type": { "name": "object" }, "required": false, "description": "Custom styles to be passed to the component" }, "color": { "type": { "name": "enum", "value": [ { "value": "'default'", "computed": false }, { "value": "'inverse'", "computed": false }, { "value": "'light'", "computed": false }, { "value": "'success'", "computed": false }, { "value": "'warning'", "computed": false }, { "value": "'error'", "computed": false } ] }, "required": false, "description": "Color variant for the badge component", "defaultValue": { "value": "'default'", "computed": false } }, "iconAlignment": { "type": { "name": "enum", "value": [ { "value": "'left'", "computed": false }, { "value": "'right'", "computed": false } ] }, "required": false, "description": "Icon alignment for the badge component", "defaultValue": { "value": "'left'", "computed": false } }, "content": { "type": { "name": "union", "value": [ { "name": "string" }, { "name": "node" } ] }, "required": false, "description": "Content to be placed inside the badge component" } }, "route": "badge", "display-name": "Badge", "SLDS-component-path": "/components/badges", "dependencies": [] }, "brand-band": { "description": "The brand band provides theming capability that adds personality and improves information density and contrast.\n\nNOTE: you may find that themes other than 'default' fail to load the appropriate styling in your application.\nIf this occurs the cause is very likely to be CSP settings on the server hosting your application protecting against style injections.\nChanging these settings is not recommended. Instead, add the following styles to any stylesheet provided by the server itself (such as an external stylesheet):\n\nWhen using 'lightning-theme':\n.slds-brand-band.dsr-brand-band_lightning-blue:before {\n background-image: url(/assets/images/themes/oneSalesforce/banner-brand-default.png), linear-gradient(to top, rgba(175, 197, 222, 0) 0, #1B5F9E);\n}\n.slds-brand-band.dsr-brand-band_lightning-blue:after {\n background-image: linear-gradient(to bottom, rgba(175, 197, 222, 0) 60%, #AFC5DE);\n}\n\nFor more information on the problem, [see this Stack Overflow question](https://stackoverflow.com/questions/17766817/refused-to-apply-inline-style-because-it-violates-the-following-content-security)", "methods": [ { "name": "injectLightningBlueStyles", "docblock": null, "modifiers": [ "static" ], "params": [], "returns": null }, { "name": "getId", "docblock": null, "modifiers": [], "params": [], "returns": null } ], "props": { "children": { "type": { "name": "node" }, "required": false, "description": "Primary application grid layout or a white background component such as a `Card` should be passed into this component." }, "className": { "type": { "name": "union", "value": [ { "name": "array" }, { "name": "object" }, { "name": "string" } ] }, "required": false, "description": "CSS classes that are applied to the component" }, "id": { "type": { "name": "string" }, "required": false, "description": "Id of component, if desired. If not provided an id is automatically generated" }, "image": { "type": { "name": "enum", "value": [ { "value": "'default'", "computed": false }, { "value": "'none'", "computed": false } ] }, "required": false, "description": "Image of the brand band", "defaultValue": { "value": "'default'", "computed": false } }, "backgroundSize": { "type": { "name": "enum", "value": [ { "value": "'contain'", "computed": false }, { "value": "'cover'", "computed": false } ] }, "required": false, "description": "Background size of the brand band. Default is 'contain'", "defaultValue": { "value": "'contain'", "computed": false } }, "size": { "type": { "name": "enum", "value": [ { "value": "'small'", "computed": false }, { "value": "'medium'", "computed": false }, { "value": "'large'", "computed": false } ] }, "required": false, "description": "Size of the brand band. Default is 'medium'", "defaultValue": { "value": "'medium'", "computed": false } }, "style": { "type": { "name": "object" }, "required": false, "description": "Custom styles to be passed to the component" }, "styleContainer": { "type": { "name": "object" }, "required": false, "description": "Custom styles to be passed to the component container" }, "theme": { "type": { "name": "enum", "value": [ { "value": "'default'", "computed": false }, { "value": "'lightning-blue'", "computed": false } ] }, "required": false, "description": "Different brand band styling.\nNOTE: using 'lightning-blue' may result in incorrect styling depending on server CSP settings. See opening component documentation above for details.", "defaultValue": { "value": "'default'", "computed": false } } }, "route": "brand-band", "display-name": "Brand Band", "SLDS-component-path": "/components/brand-band", "dependencies": [] }, "breadcrumb": { "description": "Use breadcrumbs to note the path of a record and help the user to navigate back to the parent.Breadcrumb based on SLDS 2.1.0-dev", "methods": [], "props": { "assistiveText": { "type": { "name": "shape", "value": { "label": { "name": "string", "required": false } } }, "required": false, "description": "**Assistive text for accessibility.**\nThis object is merged with the default props object on every render.\n* `label`: The assistive text for the breadcrumb trail.", "defaultValue": { "value": "{\n\tlabel: 'Breadcrumbs',\n}", "computed": false } }, "id": { "type": { "name": "string" }, "required": false, "description": "A unique ID is needed in order to support keyboard navigation, ARIA support, and connect the dropdown to the triggering button." }, "overflowDropdownMenu": { "type": { "name": "node" }, "required": false, "description": "Overflow menu of the type [Dropdown](/components/menu-dropdowns)" }, "styleContainer": { "type": { "name": "object" }, "required": false, "description": "Custom styles to be passed to the containing `nav` tag" }, "trail": { "type": { "name": "array" }, "required": true, "description": "An array of anchor elements that define the path to the current record." } }, "route": "breadcrumbs", "display-name": "Breadcrumbs", "SLDS-component-path": "/components/breadcrumb", "dependencies": [] }, "builder-header": { "description": "Every builder needs a builder header, which contains basic navigation elements. It also shows the builder type and content name.", "methods": [], "props": { "assistiveText": { "type": { "name": "shape", "value": { "backIcon": { "name": "string", "required": false }, "helpIcon": { "name": "string", "required": false }, "icon": { "name": "string", "required": false } } }, "required": false, "description": "**Assistive text for accessibility**\nThis object is merged with the default props object on every render.\n* `backIcon`: Used for the back icon.\n* `helpIcon`: Used for the help icon.\n* `icon`: Used for the main icon next to the header title.\n* _Tested with snapshot testing._", "defaultValue": { "value": "{\n\tbackIcon: 'Back',\n\thelpIcon: 'Help',\n\ticon: 'Builder',\n}", "computed": false } }, "children": { "type": { "name": "node" }, "required": false, "description": "Provide children of the types ``, ``, or `` to define the structure of the header.\n```\n\n \n \n \n\n```" }, "className": { "type": { "name": "union", "value": [ { "name": "array" }, { "name": "object" }, { "name": "string" } ] }, "required": false, "description": "CSS classes to be added to tag with `.slds-builder-header_container`. Uses `classNames` [API](https://github.com/JedWatson/classnames). _Tested with snapshot testing._" }, "events": { "type": { "name": "shape", "value": { "onClickBack": { "name": "func", "required": false }, "onClickHelp": { "name": "func", "required": false } } }, "required": false, "description": "Event Callbacks\n* `onClickBack`: Called when the Back link is clicked.\n* `onClickHelp`: Called when the Help link is clicked.\n_Tested with Mocha testing._" }, "iconCategory": { "type": { "name": "string" }, "required": false, "description": "Category of the title icon from [lightningdesignsystem.com/icons/](https://www.lightningdesignsystem.com/icons/)", "defaultValue": { "value": "'utility'", "computed": false } }, "iconClassName": { "type": { "name": "union", "value": [ { "name": "array" }, { "name": "object" }, { "name": "string" } ] }, "required": false, "description": "CSS classes that are applied to the title icon." }, "iconName": { "type": { "name": "string" }, "required": false, "description": "Name of the title icon. Visit Lightning Design System Icons to reference icon names.", "defaultValue": { "value": "'builder'", "computed": false } }, "iconPath": { "type": { "name": "string" }, "required": false, "description": "Path to the title icon. This will override any global icon settings." }, "labels": { "type": { "name": "shape", "value": { "back": { "name": "string", "required": false }, "help": { "name": "string", "required": false }, "pageType": { "name": "string", "required": false }, "title": { "name": "string", "required": false } } }, "required": false, "description": "**Text labels for internationalization**\nThis object is merged with the default props object on every render.\n* `back`: The label for the Back link.\n* `help`: The label for the Help link.\n* `pageType`: The label that describes the page type.\n* `title`: The label for the page title.\n_Tested with snapshot testing._", "defaultValue": { "value": "{\n\tback: 'Back',\n\thelp: 'Help',\n\tpageType: 'Page Type',\n\ttitle: 'App Name',\n}", "computed": false } }, "style": { "type": { "name": "object" }, "required": false, "description": "Custom styles applied to the `.slds-builder-header_container` element." } }, "route": "builder-header", "display-name": "Builder Header", "SLDS-component-path": "/components/builder-header", "dependencies": [ { "nav": { "description": "The navigation section of the header.", "methods": [], "props": { "children": { "type": { "name": "node" }, "required": false, "description": "Provide children of the types `` or `` to define the structure of the navigation section.\n```\n\n \n \n \n \n\n```" } }, "name": "nav", "source": "/components/builder-header/nav.jsx" } }, { "nav-dropdown": { "description": "A dropdown within the navigation section of the header.", "methods": [], "composes": [ "../menu-dropdown/menu-dropdown" ], "name": "nav-dropdown", "source": "/components/builder-header/nav-dropdown.jsx" } }, { "nav-link": { "description": "A link within the navigation section of the header.", "methods": [], "props": { "assistiveText": { "type": { "name": "shape", "value": { "icon": { "name": "string", "required": false } } }, "required": false, "description": "**Assistive text for accessibility**\nThis object is merged with the default props object on every render.\n* `icon`: Used for the icon next to the link text.\n* _Tested with snapshot testing._" }, "iconCategory": { "type": { "name": "enum", "value": [ { "value": "'action'", "computed": false }, { "value": "'custom'", "computed": false }, { "value": "'doctype'", "computed": false }, { "value": "'standard'", "computed": false }, { "value": "'utility'", "computed": false } ] }, "required": false, "description": "Name of the icon category. Visit Lightning Design System Icons to reference icon categories." }, "iconName": { "type": { "name": "string" }, "required": false, "description": "Name of the icon. Visit Lightning Design System Icons to reference icon names." }, "iconPath": { "type": { "name": "string" }, "required": false, "description": "Path to the icon. This will override any global icon settings." }, "label": { "type": { "name": "string" }, "required": false, "description": "Text for the link." }, "onClick": { "type": { "name": "func" }, "required": false, "description": "Triggered when the link is clicked." } }, "name": "nav-link", "source": "/components/builder-header/nav-link.jsx" } }, { "toolbar": { "description": "The toolbar section of the header.", "methods": [], "props": { "assistiveText": { "type": { "name": "shape", "value": { "actions": { "name": "string", "required": false } } }, "required": false, "description": "**Assistive text for accessibility**\nThis object is merged with the default props object on every render.\n* `actions`: Used for the aria-label for the actions section of the toolbar.\n* _Tested with snapshot testing._", "defaultValue": { "value": "{\n\tactions: 'Actions',\n}", "computed": false } }, "children": { "type": { "name": "node" }, "required": false, "description": "Provide children of the type `` to define the structure of the toolbar section.\n```\n\n \n \n \n \n\n```" }, "onRenderActions": { "type": { "name": "func" }, "required": false, "description": "Renders the actions section of the header." } }, "name": "toolbar", "source": "/components/builder-header/toolbar.jsx" } }, { "utilities": { "description": "The navigation section of the header.", "methods": [], "props": { "children": { "type": { "name": "node" }, "required": false, "description": "Provide children of the types `` or `` to define the structure of the utilities section.\n```\n\n \n \n \n \n\n```" } }, "name": "utilities", "source": "/components/builder-header/utilities.jsx" } }, { "misc": { "description": "The miscellaneous section of the header.", "methods": [], "props": { "children": { "type": { "name": "node" }, "required": false, "description": "Provide custom content in place of Page Type label\n```\n\n \n Custom content\n \n\n```" } }, "name": "misc", "source": "/components/builder-header/misc.jsx" } } ] }, "button-group": { "description": "The ButtonGroup component wraps other components (ie. Button, MenuDropdown, PopoverTooltip, Checkboxes, etc).", "methods": [ { "name": "getId", "docblock": null, "modifiers": [], "params": [], "returns": null } ], "props": { "children": { "type": { "name": "node" }, "required": true, "description": "Children are expected to be components. If last button triggers a dropdown menu, use Dropdown instead of Button. _Tested with snapshot testing._" }, "className": { "type": { "name": "union", "value": [ { "name": "array" }, { "name": "object" }, { "name": "string" } ] }, "required": false, "description": "CSS classes added to `slds-button-group` or `slds-checkbox_button-group` tag" }, "classNameContainer": { "type": { "name": "union", "value": [ { "name": "array" }, { "name": "object" }, { "name": "string" } ] }, "required": false, "description": "If the `labels.label` prop is set, a `.slds-form-element` classed fieldset element is added as a container. This prop applies classes to that element" }, "id": { "type": { "name": "string" }, "required": false, "description": "HTML id for component." }, "labels": { "type": { "name": "shape", "value": { "error": { "name": "string", "required": false }, "label": { "name": "string", "required": false } } }, "required": false, "description": "**Text labels for internationalization**\nThis object is merged with the default props object on every render.\n* `error`: Message to display when any of Checkboxes are in an error state. _Tested with snapshot testing._\n* `label`: This label appears above the button group. _Tested with snapshot testing._", "defaultValue": { "value": "{}", "computed": false } }, "variant": { "type": { "name": "enum", "value": [ { "value": "'checkbox'", "computed": false }, { "value": "'list'", "computed": false } ] }, "required": false, "description": "Use checkbox variant for \"Checkbox Button Group\" styling and add Checkbox components as children _Tested with snapshot testing._" } }, "route": "button-groups", "display-name": "Button Groups", "SLDS-component-path": "/components/button-group", "dependencies": [] }, "button-stateful": { "description": "The ButtonStateful component is a variant of the Lightning Design System Button component. It is used for buttons that have a state of unselected or selected.\nFor icon buttons, use variant='icon'. For buttons with labels or buttons with labels and icons, pass data to the state props (ie. stateOne={{iconName: 'add', label: 'Join'}}).\nAlthough not listed in the prop table, all `aria-*` props will be added to the button element if passed in.\nIf no `aria-*` props are passed in, aria-live='polite' is used for `icon` and `icon-filled` variants,\nand aria-live='assertive' is used for the remaining variants.", "methods": [ { "name": "getClassName", "docblock": null, "modifiers": [], "params": [ { "name": "active", "type": null } ], "returns": null }, { "name": "handleBlur", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": null } ], "returns": null }, { "name": "handleClick", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": null } ], "returns": null } ], "props": { "active": { "type": { "name": "bool" }, "required": false, "description": "Specifies the current state of the button. If set, the button will act as a ['controlled' component](https://facebook.github.io/react/docs/forms.html#controlled-components)." }, "assistiveText": { "type": { "name": "shape", "value": { "icon": { "name": "string", "required": false } } }, "required": false, "description": "**Assistive text for accessibility.**\nThis object is merged with the default props object on every render.\n* `icon`: Text that is visually hidden but read aloud by screenreaders to tell the user what the icon means. This should also include the state of the button. If the button has an icon and a visible label, you can omit the icon prop and use the label prop.", "defaultValue": { "value": "{ icon: '' }", "computed": false } }, "disabled": { "type": { "name": "bool" }, "required": false, "description": "Disables the button and adds disabled styling.", "defaultValue": { "value": "false", "computed": false } }, "icon": { "type": { "name": "node" }, "required": false, "description": "Icon associated with the stateful button. Accepts an `Icon` component" }, "onBlur": { "type": { "name": "func" }, "required": false, "description": "Triggered when focus is removed." }, "onClick": { "type": { "name": "func" }, "required": false, "description": "Triggered when the button is clicked." }, "onFocus": { "type": { "name": "func" }, "required": false, "description": "Triggered when component is focused." }, "onKeyDown": { "type": { "name": "func" }, "required": false, "description": "Triggered when a key is pressed down" }, "onKeyPress": { "type": { "name": "func" }, "required": false, "description": "Triggered when a key is pressed and released" }, "onKeyUp": { "type": { "name": "func" }, "required": false, "description": "Triggered when a key is released" }, "onMouseDown": { "type": { "name": "func" }, "required": false, "description": "Triggered when a mouse button is pressed down" }, "onMouseEnter": { "type": { "name": "func" }, "required": false, "description": "Triggered when a mouse arrow hovers" }, "responsive": { "type": { "name": "bool" }, "required": false, "description": "If true, button scales to 100% width on small form factors.", "defaultValue": { "value": "false", "computed": false } }, "stateOne": { "type": { "name": "object" }, "required": false, "description": "Initial label and icon (optional) of button.", "defaultValue": { "value": "{ iconName: 'add', label: 'Follow' }", "computed": false } }, "stateTwo": { "type": { "name": "object" }, "required": false, "description": "Selected label and icon (optional) of button.", "defaultValue": { "value": "{ iconName: 'check', label: 'Following' }", "computed": false } }, "stateThree": { "type": { "name": "object" }, "required": false, "description": "Deselect label and icon (optional) of button.", "defaultValue": { "value": "{ iconName: 'close', label: 'Unfollow' }", "computed": false } }, "tabIndex": { "type": { "name": "string" }, "required": false, "description": "Write \"-1\" if you don't want the user to tab to the button." }, "variant": { "type": { "name": "enum", "value": [ { "value": "'base'", "computed": false }, { "value": "'neutral'", "computed": false }, { "value": "'brand'", "computed": false }, { "value": "'destructive'", "computed": false }, { "value": "'icon'", "computed": false }, { "value": "'icon-filled'", "computed": false } ] }, "required": false, "description": "Different types of buttons" }, "iconSize": { "defaultValue": { "value": "'medium'", "computed": false }, "required": false } }, "route": "stateful-buttons", "display-name": "Stateful Buttons", "SLDS-component-path": "/components/button/#flavor-stateful", "dependencies": [] }, "button": { "description": "The Button component is the Lightning Design System Button component. The Button should be used for label buttons, icon buttons, or buttons that have both labels and icons.\nEither a label or assistiveText.icon is required; see the Prop Details table below. For buttons that maintain selected/unselected states, use the ButtonStateful component.\nAlthough not listed in the prop table, all `aria-*`, `data-*` and `form*` props will be added to the `button` element if passed in.", "methods": [ { "name": "getClassName", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "handleClick", "docblock": null, "modifiers": [], "params": [ { "name": "event", "type": null } ], "returns": null }, { "name": "renderIcon", "docblock": null, "modifiers": [], "params": [ { "name": "name", "type": null } ], "returns": null }, { "name": "renderLabel", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "renderButton", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "renderTooltip", "docblock": null, "modifiers": [], "params": [], "returns": null } ], "props": { "assistiveText": { "type": { "name": "shape", "value": { "icon": { "name": "string", "required": false } } }, "required": false, "description": "**Assistive text for accessibility.**\nThis object is merged with the default props object on every render.\n* `icon`: Text that is visually hidden but read aloud by screenreaders to tell the user what the icon means. If the button has an icon and a visible label, you can omit the assistiveText.icon prop and use the label prop.", "defaultValue": { "value": "{ icon: '' }", "computed": false } }, "buttonRef": { "type": { "name": "func" }, "required": false, "description": "Callback that passes in the DOM reference of the `