@salesforce/design-system-react
Version:
Salesforce Lightning Design System for React
27 lines • 339 kB
Plain Text
/Users/vu/forks/design-system-react/components/global-header/help.jsx:15:propTypes = {\n /**\n * **Assistive text for accessibility**\n * * `triggerButton`: Assistive text for the GlobalHeaderHelp trigger button. The default is `Help and Training`.\n */\n assistiveText: PropTypes.shape({\n triggerButton: PropTypes.string,\n }),\n /**\n * A `Popover` component. The props from this popover will be merged and override any default props. The `children` prop will be ignored.\n */\n popover: PropTypes.node,\n}
/Users/vu/forks/design-system-react/components/data-table/row-actions.jsx:31:propTypes = {\n /**\n * Description of the menu for screenreaders.\n */\n assistiveText: PropTypes.object,\n /**\n * Class names to be added to the actions menu.\n */\n className: PropTypes.string,\n /**\n * HTML ID to be added to the actions menu.\n */\n id: PropTypes.string,\n /**\n * `DataTable` row item\n */\n item: PropTypes.object,\n /**\n * Disable hint styling which changes the color of the dropdown svg on hover over.\n */\n noHint: PropTypes.bool,\n /**\n * Triggered when an item is selected.\n */\n onAction: PropTypes.func,\n /**\n * `Dropdown` options. See `Dropdown`.\n */\n options: PropTypes.array,\n /**\n * A [Dropdown](http://react.lightningdesignsystem.com/components/dropdown-menus/) component. The props from this drop will be merged and override any default props.\n * **Note:** onAction will not be overridden, both `DropDown`'s onSelect(dropDownActionOption) and onAction(rowItem, dropdownActionOption) will be called with appropriate parameters\n */\n dropdown: PropTypes.node,\n }
/Users/vu/forks/design-system-react/components/data-table/highlight-cell.jsx:29:propTypes = {\n /**\n * The contents of the cell. Equivalent to `props.item[props.property]`\n */\n children: PropTypes.oneOfType([PropTypes.node, PropTypes.string]),\n /**\n * The string of text (or Regular Expression) to highlight.\n */\n search: PropTypes.any,\n}
/Users/vu/forks/design-system-react/components/global-header/dropdown.jsx:57:propTypes = {\n /**\n * Aligns the right or left side of the menu with the respective side of the trigger. This is not intended for use with `nubbinPosition`.\n */\n align: PropTypes.oneOf(['left', 'right']),\n /**\n * Extra classnames to apply to the dropdown menu.\n */\n className: PropTypes.string,\n /**\n * CSS classes to be added to `li` element.\n */\n buttonClassName: PropTypes.oneOfType([\n PropTypes.array,\n PropTypes.object,\n PropTypes.string,\n ]),\n /**\n * Name of the icon. Visit <a href="http://www.lightningdesignsystem.com/resources/icons">Lightning Design System Icons</a> to reference icon names.\n */\n iconName: PropTypes.string,\n /**\n * For icon variants, please reference <a href="http://www.lightningdesignsystem.com/components/buttons/#icon">Lightning Design System Icons</a>.\n */\n iconVariant: PropTypes.oneOf([\n 'bare',\n 'container',\n 'border',\n 'border-filled',\n 'more',\n 'global-header',\n ]),\n /**\n * A unique ID is needed in order to support keyboard navigation, ARIA support, and connect the dropdown to the triggering button.\n */\n id: PropTypes.string,\n /**\n * Adds custom styling such as inverse fill and special sizing/spacing\n */\n globalAction: PropTypes.bool,\n /**\n * Positions dropdown menu with a nubbin--that is the arrow notch. The placement options correspond to the placement of the nubbin. This is implemeted with CSS classes and is best used with a `Button` with "icon container" styling. Dropdown menus will still be contained to the closest scrolling parent.\n */\n nubbinPosition: PropTypes.oneOf([\n 'top left',\n 'top',\n 'top right',\n 'bottom left',\n 'bottom',\n 'bottom right',\n ]),\n /**\n * Offset adds pixels to the absolutely positioned dropdown menu in the format: ([vertical]px [horizontal]px).\n */\n offset: PropTypes.string,\n /**\n * Triggered when an item in the menu is clicked.\n */\n onSelect: PropTypes.func,\n /**\n * An array of menu item.\n */\n options: PropTypes.array.isRequired,\n}
/Users/vu/forks/design-system-react/components/button-stateful/index.jsx:29:propTypes = {\n /**\n * 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).\n */\n active: PropTypes.bool,\n /**\n * **Assistive text for accessibility.**\n * This 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 <code>icon</code> prop and use the <code>label</code> prop.\n */\n assistiveText: PropTypes.shape({\n icon: PropTypes.string,\n }),\n /**\n * Disables the button and adds disabled styling.\n */\n disabled: PropTypes.bool,\n /**\n * Icon associated with the stateful button. Accepts an `Icon` component\n */\n icon: PropTypes.node,\n /**\n * Triggered when focus is removed.\n */\n onBlur: PropTypes.func,\n /**\n * Triggered when the button is clicked.\n */\n onClick: PropTypes.func,\n /**\n * Triggered when component is focused.\n */\n onFocus: PropTypes.func,\n /**\n * Triggered when a key is pressed down\n */\n onKeyDown: PropTypes.func,\n /**\n * Triggered when a key is pressed and released\n */\n onKeyPress: PropTypes.func,\n /**\n * Triggered when a key is released\n */\n onKeyUp: PropTypes.func,\n /**\n * Triggered when a mouse button is pressed down\n */\n onMouseDown: PropTypes.func,\n /**\n * Triggered when a mouse arrow hovers\n */\n onMouseEnter: PropTypes.func,\n /**\n * If true, button scales to 100% width on small form factors.\n */\n responsive: PropTypes.bool,\n /**\n * Initial label and icon (optional) of button.\n */\n stateOne: PropTypes.object,\n /**\n * Selected label and icon (optional) of button.\n */\n stateTwo: PropTypes.object,\n /**\n * Deselect label and icon (optional) of button.\n */\n stateThree: PropTypes.object,\n /**\n * Write "-1" if you don't want the user to tab to the button.\n */\n tabIndex: PropTypes.string,\n /**\n * Different types of buttons\n */\n variant: PropTypes.oneOf([\n 'base',\n 'neutral',\n 'brand',\n 'destructive',\n 'icon',\n 'icon-filled',\n ]),\n}
/Users/vu/forks/design-system-react/components/progress-indicator/private/step.jsx:21:propTypes = {\n /**\n * **Assistive text for accessibility**\n * This object is merged with the default props object on every render.\n * * `completedStep`: Label for a completed step. The default is `Completed Step`\n * * `disabledStep`: Label for disabled step. The default is `Disabled Step`\n * * `errorStep`: Label for a step with an error. The default is `Error Step`\n * * `percentage`: Label for Progress Bar. The default is `Progress: [this.props.value]%`. You will need to calculate the percentage yourself if changing this string.\n * * `step`: Label for a step. It will be typically followed by the number of the step such as "Step 1".\n */\n assistiveText: PropTypes.shape({\n completedStep: PropTypes.string,\n disabledStep: PropTypes.string,\n percentage: PropTypes.string,\n step: PropTypes.string,\n }),\n /**\n * Id for Steps, ranging in [0, steps.length).\n */\n id: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),\n /**\n * Index of step. Used for id's if no step ID exists\n */\n index: PropTypes.number,\n /**\n * Determines if the step has been completed\n */\n\n isCompleted: PropTypes.bool,\n /**\n * Determines if the step has been disabled\n */\n isDisabled: PropTypes.bool,\n /**\n * Determines if the step contains an error\n */\n isError: PropTypes.bool,\n /**\n * Determines if the step is currently selected (active)\n */\n isSelected: PropTypes.bool,\n /**\n * Label of tooltip attached to the step if applicable.\n */\n label: PropTypes.node,\n /**\n * Triggered when click on individual steps. By default, it receives an event and returns all info passed to that step.\n * users are able to re-define it by passing a function as a prop\n */\n onClick: PropTypes.func,\n /**\n * Triggered when focus on individual steps. By default, it receives an event and returns all info passed to that step.\n * users are able to re-define it by passing a function as a prop\n */\n onFocus: PropTypes.func,\n /**\n * Step object. This is passed into event callbacks.\n */\n step: PropTypes.object,\n /**\n * Determines if the tooltip attached to step is always open.\n * This is mainly for dev test purpose.\n * Usually the tooltip should only show when hover.\n */\n tooltipIsOpen: PropTypes.bool,\n /**\n * Please select one of the following:\n * * `absolute` - (default if `variant` is `modal`) The dialog will use `position: absolute` and style attributes to position itself. This allows inverted placement or flipping of the dialog.\n * * `overflowBoundaryElement` - (default if `variant` is `base`) The dialog will overflow scrolling parents. Use on elements that are aligned to the left or right of their target and don't care about the target being within a scrolling parent. Typically this is a popover or tooltip. Dropdown menus can usually open up and down if no room exists. In order to achieve this a portal element will be created and attached to `body`. This element will render into that detached render tree.\n * * `relative` - No styling or portals will be used. Menus will be positioned relative to their triggers. This is a great choice for HTML snapshot testing.\n */\n tooltipPosition: PropTypes.oneOf([\n 'absolute',\n 'overflowBoundaryElement',\n 'relative',\n ]),\n}
/Users/vu/forks/design-system-react/components/data-table/cell.jsx:62:propTypes = {\n /**\n * The contents of the cell. This can be simple text or DOM nodes. Equivalent to `props.item[props.property]`\n */\n children: PropTypes.oneOfType([PropTypes.node, PropTypes.string]),\n /**\n * Class names to be added to the cell.\n */\n className: PropTypes.oneOfType([\n PropTypes.array,\n PropTypes.object,\n PropTypes.string,\n ]),\n /**\n * Use this if you are creating an advanced table (selectable, sortable, or resizable rows)\n */\n fixedLayout: PropTypes.bool,\n /**\n * The item from the items which represents this row.\n */\n item: PropTypes.object,\n /**\n * The primary column for a row. This is almost always the first column.\n */\n primaryColumn: PropTypes.bool,\n /**\n * The property of this item to display.\n */\n property: PropTypes.string,\n /**\n * Shows on hover. Useful for truncated cells.\n */\n title: PropTypes.string,\n /**\n * Width of column. This is required for advanced/fixed layout tables. Please provide units. (`rems` are recommended)\n */\n width: PropTypes.string,\n}
/Users/vu/forks/design-system-react/components/icon-settings/index.jsx:55:propTypes = {\n /**\n * Path to the root icon folder\n * example: `/assets/icons`\n */\n iconPath: PropTypes.string,\n /**\n * Function to allow developers to return a custom icon path--for instance, on the same page with a local anchor (`#down`). This is helpful for when there are Cross-Origin Resource Sharing (CORS) issues with SVGs that are located on another domain such as a CDN. `({category, name}) => { return \`#${name}\` }`\n */\n onRequestIconPath: PropTypes.func,\n /**\n * Path to the action sprite\n * example: '@salesforce-ux/design-system/assets/icons/action-sprite/svg/symbols.svg';\n */\n actionSprite: PropTypes.string,\n /**\n * Path to the custom sprite\n * example: '@salesforce-ux/design-system/assets/icons/custom-sprite/svg/symbols.svg';\n */\n customSprite: PropTypes.string,\n /**\n * Path to the doctype sprite\n * example: '@salesforce-ux/design-system/assets/icons/doctype-sprite/svg/symbols.svg';\n */\n doctypeSprite: PropTypes.string,\n /**\n * Path to the standard sprite\n * example: '@salesforce-ux/design-system/assets/icons/standard-sprite/svg/symbols.svg';\n */\n standardSprite: PropTypes.string,\n /**\n * Path to the utility sprite\n * example: '@salesforce-ux/design-system/assets/icons/utility-sprite/svg/symbols.svg';\n */\n utilitySprite: PropTypes.string,\n}
/Users/vu/forks/design-system-react/components/illustration/index.jsx:104:propTypes = {\n /**\n * CSS classes that are applied to the SVG. _Tested with Mocha testing._\n */\n className: PropTypes.oneOfType([\n PropTypes.array,\n PropTypes.object,\n PropTypes.string,\n ]),\n /**\n * A heading text. It is required if illustration is present. _Tested with snapshot testing._ _Tested with Mocha testing._\n */\n heading: PropTypes.string,\n /**\n * A custom SVG object to use instead of the supplied SLDS illustrations, look in `design-system-react/icons` for examples and syntax. _Tested with snapshot testing._ _Tested with Mocha testing._\n */\n illustration: PropTypes.object,\n /**\n * Indicates whether the illustration SVGs are from the design-system-react repo. If yes, set to true.\n */\n internalIllustration: PropTypes.bool.isRequired,\n /**\n * A message body below the heading to further communicate the state of the component. _Tested with snapshot testing._ _Tested with Mocha testing._\n */\n messageBody: PropTypes.oneOfType([PropTypes.string, PropTypes.node]),\n /**\n * Name of the illustration. Visit <a href='https://lightningdesignsystem.com/components/illustration/'>Lightning Design System Illustration</a> to reference illustration names. _Tested with snapshot testing._ _Tested with Mocha testing._\n */\n name: PropTypes.string,\n /**\n * Path to the illustration SVG image. _Tested with snapshot testing._\n */\n path: PropTypes.string,\n /**\n * Size of the illustration. _Tested with snapshot testing._ _Tested with Mocha testing._\n */\n size: PropTypes.oneOf(['small', 'large']),\n /**\n * Custom styles to be passed to the illustration SVG. _Tested with Mocha testing._\n */\n style: PropTypes.object,\n}
/Users/vu/forks/design-system-react/components/accordion/index.jsx:15:propTypes = {\n /**\n * CSS class names to be added to the accordion component. _Tested with snapshot testing._\n */\n className: PropTypes.oneOfType([\n PropTypes.array,\n PropTypes.object,\n PropTypes.string,\n ]),\n /**\n * HTML id for accordion component. _Tested with snapshot testing._\n */\n id: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),\n /**\n * The panel content for the Accordion component. Accordion panels should be added as <AccordionPanel />. Event handler for the accordion panels should be added to `<AccordionPanel />`. Optional `panelContentActions` component may be passed as prop. _Tested with Mocha framework and snapshot testing._\n *\n * Example:\n * ```\n * <SLDSAccordion>\n * <SLDSAccordionpanel />\n * <SLDSAccordionpanel />\n * <SLDSAccordionpanel />\n * </SLDSAccordion>\n * ```\n */\n children: PropTypes.node.isRequired,\n}
/Users/vu/forks/design-system-react/components/welcome-mat/tile.jsx:20:propTypes = {\n /**\n * **Assistive text for accessibility.**\n * This object is merged with the default props object on every render.\n * * `completeIcon`: Text that is visually hidden but read aloud by screenreaders to tell the user what the complete icon means.\n */\n assistiveText: PropTypes.shape({\n completedIcon: PropTypes.string,\n }),\n /**\n * CSS class names to be added to the container element. `array`, `object`, or `string` are accepted.\n */\n className: PropTypes.oneOfType([\n PropTypes.array,\n PropTypes.object,\n PropTypes.string,\n ]),\n /**\n * HTML id for component.\n */\n id: PropTypes.string,\n /**\n * Title for the tile component.\n */\n title: PropTypes.string,\n /**\n * Description for the tile component.\n */\n description: PropTypes.string,\n /**\n * Href for the tile link\n */\n href: PropTypes.string,\n /**\n * Icon for the tile\n */\n icon: PropTypes.node,\n /**\n * Whether the tile is completed\n */\n isComplete: PropTypes.bool,\n /**\n * Variant of the Welcome Mat Tile\n */\n variant: PropTypes.oneOf([\n 'steps',\n 'info-only',\n 'splash',\n 'trailhead-connected',\n ]),\n}
/Users/vu/forks/design-system-react/components/expression/group.jsx:21:propTypes = {\n /**\n * **Assistive text for accessibility.**\n * * `label`: For users of assistive technology, assistive text for the expression group's label.\n * * `addCondition`: For users of assistive technology, assistive text for the Add Condition button's icon.\n * * `addGroup`: For users of assistive technology, assistive text for the Add Group button's icon.\n */\n assistiveText: PropTypes.shape({\n label: PropTypes.string,\n addCondition: PropTypes.string,\n addGroup: PropTypes.string,\n }),\n /**\n * HTML id for ExpressionGroup component.\n */\n id: PropTypes.string,\n /**\n * `ExpressionGroup` children, accepts `ExpressionCondition`. (Also accepts sub-`ExpressionGroup` if `isRoot`)\n */\n children: PropTypes.node,\n /**\n * CSS classes to be added to the element with class `.slds-expression__group`. Uses `classNames` [API](https://github.com/JedWatson/classnames).\n */\n className: PropTypes.oneOfType([\n PropTypes.array,\n PropTypes.object,\n PropTypes.string,\n ]),\n /**\n * Callbacks for various expression group events such as trigger change, add condition etc\n */\n events: PropTypes.shape({\n onChangeTrigger: PropTypes.func,\n onChangeCustomLogicValue: PropTypes.func,\n onAddCondition: PropTypes.func,\n onAddGroup: PropTypes.func,\n }),\n /**\n * If set to true, the component will focus on the first focusable input upon mounting. This is useful for accessibility when adding new groups.\n */\n focusOnMount: PropTypes.bool,\n /**\n * **Text labels for internationalization**\n * This object is merged with the default props object on every render.\n * * `addCondition`: Label for the Add Condition Button. Defaults to "Add Condition"\n * * `addGroup`: Label for the Add Group Button. Defaults to "Add Group"\n * * `customLogic`: Label for the text box for inputting `customLogicValue`, if the `triggerType` is `custom`. Defaults to "Custom Logic"\n * * `label`: Label for the expression group, to indicate condition connectors based on the parent's trigger-type chosen. Defaults to ""\n * * `takeAction`: Label for the `triggerType` selector. Defaults to "Take Action When"\n * * `triggerAll`: Label for the `all` value within the trigger selector\n * * `triggerAlways`: Label for the `always` value within the trigger selector\n * * `triggerAny`: Label for the `any` value within the trigger selector\n * * `triggerCustom`: Label for the `custom` value within the trigger selector\n * * `triggerFormula`: Label for the `formula` value within the trigger selector\n */\n labels: PropTypes.shape({\n addCondition: PropTypes.string,\n addGroup: PropTypes.string,\n customLogic: PropTypes.string,\n label: PropTypes.string,\n takeAction: PropTypes.string,\n triggerAll: PropTypes.string,\n triggerAlways: PropTypes.string,\n triggerAny: PropTypes.string,\n triggerCustom: PropTypes.string,\n triggerFormula: PropTypes.string,\n }),\n /**\n * Whether the group is at root level\n */\n isRoot: PropTypes.bool,\n /**\n * Trigger type for the Group\n */\n triggerType: PropTypes.oneOf(['all', 'any', 'custom', 'always', 'formula']),\n /**\n * Sets the input for the custom logic value input box, shown if the `triggerType` is set to `custom`.\n */\n customLogicValue: PropTypes.string,\n}
/Users/vu/forks/design-system-react/components/time-picker/index.jsx:65:propTypes = {\n /**\n * If true, constrains the menu to the scroll parent. See `Dropdown`.\n */\n constrainToScrollParent: PropTypes.bool,\n /**\n * Disables the input and prevents editing the contents.\n */\n disabled: PropTypes.bool,\n /**\n * Time formatting function\n */\n formatter: PropTypes.func,\n /**\n * Sets the dialog width to the width of the target. Menus attached to `input` typically follow this UX pattern.\n */\n inheritTargetWidth: PropTypes.bool,\n /**\n * This label appears above the input.\n */\n label: PropTypes.string,\n /**\n * Custom element that overrides the default Menu Item component.\n */\n listItemRenderer: PropTypes.func,\n /**\n * Please select one of the following:\n * * `absolute` - (default) The dialog will use `position: absolute` and style attributes to position itself. This allows inverted placement or flipping of the dialog.\n * * `overflowBoundaryElement` - The dialog will overflow scrolling parents. Use on elements that are aligned to the left or right of their target and don't care about the target being within a scrolling parent. Typically this is a popover or tooltip. Dropdown menus can usually open up and down if no room exists. In order to achieve this a portal element will be created and attached to `body`. This element will render into that detached render tree.\n * * `relative` - No styling or portals will be used. Menus will be positioned relative to their triggers. This is a great choice for HTML snapshot testing.\n */\n menuPosition: PropTypes.oneOf([\n 'absolute',\n 'overflowBoundaryElement',\n 'relative',\n ]),\n /**\n * Receives the props `(dateValue, stringValue)`\n */\n onDateChange: PropTypes.func,\n /**\n * Parsing date string into Date\n */\n parser: PropTypes.func,\n /**\n * Text that will appear in an empty input.\n */\n placeholder: PropTypes.string,\n /**\n * If true, adds asterisk next to input label to indicate it is a required field.\n */\n required: PropTypes.bool,\n /**\n * Frequency of options\n */\n stepInMinutes: PropTypes.number,\n /**\n * Value for input that is parsed to create an internal state in the `date` format.\n */\n strValue: PropTypes.string,\n /**\n * Instance an internal state in the `date` format.\n */\n value: PropTypes.instanceOf(Date),\n }
/Users/vu/forks/design-system-react/components/welcome-mat/info-badge.jsx:19:propTypes = {\n /**\n * **Assistive text for accessibility.**\n * * `completed` : For users of assistive technology, assistive text for completed icon.\n */\n assistiveText: PropTypes.shape({\n completed: PropTypes.string,\n }),\n /**\n * CSS class names to be added to the container element. `array`, `object`, or `string` are accepted.\n */\n className: PropTypes.oneOfType([\n PropTypes.array,\n PropTypes.object,\n PropTypes.string,\n ]),\n /**\n * HTML id for component.\n */\n id: PropTypes.string,\n /**\n * Icon for the tile\n */\n image: PropTypes.string,\n /**\n * Whether the trail is completed\n */\n isComplete: PropTypes.bool,\n /**\n * Actions to be rendered on completion of the trail\n */\n onCompleteRenderActions: PropTypes.func,\n}
/Users/vu/forks/design-system-react/components/alert/container.jsx:11:propTypes = {\n /**\n * CSS classes to be added to tag with `.slds-notify_alert`. Uses `classNames` [API](https://github.com/JedWatson/classnames).\n */\n className: PropTypes.oneOfType([\n PropTypes.array,\n PropTypes.object,\n PropTypes.string,\n ]),\n /**\n * Alert components\n */\n children: PropTypes.node,\n}
/Users/vu/forks/design-system-react/components/utilities/highlighter/index.jsx:79:propTypes = {\n /**\n * The full string to display.\n */\n children: PropTypes.oneOfType([\n PropTypes.string,\n PropTypes.number,\n PropTypes.bool,\n PropTypes.node,\n ]),\n className: PropTypes.string,\n /**\n * The string of text (or Regular Expression) to highlight.\n */\n search: PropTypes.any,\n}
/Users/vu/forks/design-system-react/components/input/search.jsx:81:propTypes = {\n /**\n * **Assistive text for accessibility.**\n * This object is merged with the default props object on every render.\n * * `label`: Assistive text to search input\n */\n assistiveText: PropTypes.shape({\n label: PropTypes.string,\n }),\n /**\n * Adds a clear button to right side of the input\n */\n clearable: PropTypes.bool,\n /**\n * Triggers when the clear button is clicked\n */\n onClear: PropTypes.func,\n /**\n * This event fires when enter is pressed in the `input` or the search button is clicked.\n */\n onSearch: PropTypes.func,\n /**\n * Placeholder for the input\n */\n placeholder: PropTypes.string,\n}
/Users/vu/forks/design-system-react/components/combobox/private/menu.jsx:14:propTypes = {\n /*\n * Active descendant in menu\n */\n activeOption: PropTypes.object,\n /*\n * Index of active descendant in menu\n */\n activeOptionIndex: PropTypes.number,\n /**\n * CSS classes to be added to container `div` tag. Uses `classNames` [API](https://github.com/JedWatson/classnames).\n */\n className: PropTypes.oneOfType([\n PropTypes.array,\n PropTypes.object,\n PropTypes.string,\n ]),\n /**\n * CSS classes to be added to tag with `.slds-dropdown`. Uses `classNames` [API](https://github.com/JedWatson/classnames).\n */\n classNameMenu: PropTypes.oneOfType([\n PropTypes.array,\n PropTypes.object,\n PropTypes.string,\n ]),\n /**\n * CSS classes to be added to menu sub header `span` tag. Uses `classNames` [API](https://github.com/JedWatson/classnames).\n */\n classNameMenuSubHeader: PropTypes.oneOfType([\n PropTypes.array,\n PropTypes.object,\n PropTypes.string,\n ]),\n /**\n * Sets the dialog width to the width of one of the following:\n * `target`: (Menus attached to `input` typically follow this UX pattern),\n * `menu`: Consider setting a menuMaxWidth if using this value. If not, width will be set to width of largest menu item.\n * 'none'\n */\n inheritWidthOf: PropTypes.oneOf(['target', 'menu', 'none']),\n /*\n * Id used for assistive technology\n */\n inputId: PropTypes.string,\n /**\n * Determines the height of the menu based on SLDS CSS classes.\n */\n itemVisibleLength: PropTypes.oneOf([5, 7, 10]),\n /**\n * **Text labels for internationalization**\n * This object is merged with the default props object on every render.\n * * `noOptionsFound`: Custom message that renders when no matches found. The default empty state is just text that says, 'No matches found.'.\n */\n labels: PropTypes.shape({\n noOptionsFound: PropTypes.oneOfType([PropTypes.node, PropTypes.string])\n .isRequired,\n }),\n /**\n * Accepts a custom menu item rendering function that becomes a custom component and is passed in the following props:\n * * `assistiveText`: Object, `assistiveText` prop that is passed into Combobox\n * * `option`: Object, option data for item being rendered that is passed into Combobox\n * * `selected`: Boolean, allows rendering of `assistiveText.optionSelectedInMenu` in Readonly Combobox\n *\n * _Tested with snapshot testing._\n */\n onRenderMenuItem: PropTypes.func,\n /**\n * Accepts a ref function or object (React.createRef() or otherwise) to store the menu DOM reference once available\n */\n menuRef: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),\n /*\n * Sets a maximum width that the menu will be if `inheritWidthOf` is menu.\n */\n maxWidth: PropTypes.string,\n /*\n * Callback when option is selected with keyboard or mouse\n */\n onSelect: PropTypes.func,\n /*\n * Menu options\n */\n options: PropTypes.array,\n /*\n * Callback to remove active descendent\n */\n resetActiveOption: PropTypes.func,\n /*\n * Selected options\n */\n selection: PropTypes.array,\n /*\n * Adds loading spinner below the options\n */\n hasMenuSpinner: PropTypes.bool,\n /*\n * Object for creating Add item below the options\n */\n optionsAddItem: PropTypes.arrayOf(\n PropTypes.shape({\n id: PropTypes.string,\n icon: PropTypes.node,\n label: PropTypes.oneOfType([PropTypes.string, PropTypes.func]),\n })\n ),\n /*\n * Object for creating Search item on top of the options\n */\n optionsSearchEntity: PropTypes.arrayOf(\n PropTypes.shape({\n id: PropTypes.string,\n icon: PropTypes.node,\n label: PropTypes.oneOfType([PropTypes.string, PropTypes.func]),\n })\n ),\n /**\n * Accepts a tooltip that is displayed when hovering on disabled menu items.\n */\n tooltipMenuItemDisabled: PropTypes.element,\n /**\n * Changes styles of the menu option\n */\n variant: PropTypes.oneOf(['icon-title-subtitle', 'checkbox']),\n isSelected: PropTypes.func,\n assistiveText: PropTypes.object,\n}
/Users/vu/forks/design-system-react/components/expression/index.jsx:17:propTypes = {\n /**\n * HTML id for component.\n */\n id: PropTypes.string,\n /**\n * `Expression` children, accepts `ExpressionCondition` & `ExpressionGroup`\n */\n children: PropTypes.node,\n /**\n * Callbacks for various expression events such as trigger change, add group etc\n */\n events: PropTypes.shape({\n onChangeTrigger: PropTypes.func,\n onAddGroup: PropTypes.func,\n onAddCondition: PropTypes.func,\n onChangeCustomLogicValue: PropTypes.func,\n }),\n /**\n * **Text labels for internationalization**\n * This object is merged with the default props object on every render.\n * * `addCondition`: Label for the Add Condition Button. Defaults to "Add Condition"\n * * `addGroup`: Label for the Add Group Button. Defaults to "Add Group"\n * * `customLogic`: Label for the text box for inputting `customLogicValue`, if the `triggerType` is `custom`. Defaults to "Custom Logic"\n * * `takeAction`: Label for the `triggerType` selector. Defaults to "Take Action When"\n * * `title` : Title for the Expression. Defaults to "Conditions"\n * * `triggerAll`: Label for the `all` value within the trigger selector\n * * `triggerAlways`: Label for the `always` value within the trigger selector\n * * `triggerAny`: Label for the `any` value within the trigger selector\n * * `triggerCustom`: Label for the `custom` value within the trigger selector\n * * `triggerFormula`: Label for the `formula` value within the trigger selector\n */\n labels: PropTypes.shape({\n addCondition: PropTypes.string,\n addGroup: PropTypes.string,\n customLogic: PropTypes.string,\n takeAction: PropTypes.string,\n title: PropTypes.string,\n triggerAll: PropTypes.string,\n triggerAlways: PropTypes.string,\n triggerAny: PropTypes.string,\n triggerCustom: PropTypes.string,\n triggerFormula: PropTypes.string,\n }),\n /**\n * CSS classes to be added to the element with class `.slds-expression`. Uses `classNames` [API](https://github.com/JedWatson/classnames).\n */\n className: PropTypes.oneOfType([\n PropTypes.array,\n PropTypes.object,\n PropTypes.string,\n ]),\n /**\n * Sets the trigger type for the expression.\n */\n triggerType: PropTypes.oneOf(['all', 'any', 'custom', 'always', 'formula']),\n /**\n * Sets the input for the custom logic value input box, shown if the `triggerType` is set to `custom`.\n */\n customLogicValue: PropTypes.string,\n}
/Users/vu/forks/design-system-react/components/avatar/index.jsx:28:propTypes = {\n /**\n * **Assistive text for accessibility.**\n * This object is merged with the default props object on every render.\n * * `icon`: Assistive text for accessibility that labels the icon.\n */\n assistiveText: PropTypes.shape({\n icon: PropTypes.string,\n }),\n /**\n * Alt attribute to be applied to image (base case) element.\n */\n imgAlt: PropTypes.string,\n /**\n * Source attribute to be applied to image (base case) element.\n */\n imgSrc: PropTypes.string,\n /**\n * Initials attribute to optionally pass in initials directly in case of "initials" fallback case.\n */\n initials: PropTypes.string,\n /**\n * Avatar with initials that are dark text on light background\n */\n inverse: PropTypes.bool,\n /**\n * Label attibute to display inside "initials" fallback case. Will be passed as title prop in `abbr` element to provide more specificity.\n */\n label: PropTypes.string,\n /**\n * Avatar variants to apply relevant styling (circle: user, square: entity) and icon rendering if applicable.\n */\n variant: PropTypes.oneOf(['entity', 'user']).isRequired,\n /**\n * Size of the icon in "icon" fallback case.\n */\n size: PropTypes.oneOf(['x-small', 'small', 'medium', 'large']).isRequired,\n /**\n * Title attribute for the avatar container.\n */\n title: PropTypes.string,\n}
/Users/vu/forks/design-system-react/components/alert/index.jsx:19:propTypes = {\n /**\n * **Assistive text for accessibility**\n * This 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._\n */\n assistiveText: PropTypes.shape({\n closeButton: PropTypes.oneOfType([PropTypes.string, PropTypes.node]),\n }),\n /**\n * CSS classes to be added to tag with `.slds-notify_alert`. Uses `classNames` [API](https://github.com/JedWatson/classnames).\n * _Tested with snapshot testing._\n */\n className: PropTypes.oneOfType([\n PropTypes.array,\n PropTypes.object,\n PropTypes.string,\n ]),\n /**\n * 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._\n */\n dismissible: PropTypes.bool,\n /**\n * 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._\n */\n icon: PropTypes.node,\n /**\n * **Text labels for internationalization**\n * This 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._\n */\n labels: PropTypes.shape({\n heading: PropTypes.oneOfType([PropTypes.string, PropTypes.node]),\n headingLink: PropTypes.oneOfType([PropTypes.string, PropTypes.node]),\n }),\n /**\n * Triggered by link. _Tested with Mocha testing._\n */\n onClickHeadingLink: PropTypes.func,\n /**\n * Triggered by close button. This is a controlled component. _Tested with Mocha testing._\n */\n onRequestClose: PropTypes.func,\n /**\n * Custom styles to be passed to the component. _Tested with Mocha testing._\n */\n style: PropTypes.object,\n /**\n * The type of alert. _Tested with snapshot testing._\n */\n variant: PropTypes.oneOf(['error', 'info', 'offline', 'warning']).isRequired,\n}
/Users/vu/forks/design-system-react/components/files/index.jsx:18:propTypes = {\n /**\n * CSS class names to be added to the container element. `array`, `object`, or `string` are accepted.\n */\n className: PropTypes.oneOfType([\n PropTypes.array,\n PropTypes.object,\n PropTypes.string,\n ]),\n /**\n * HTML id for component.\n */\n id: PropTypes.string,\n /**\n * Crop ratio for the file preview image\n */\n crop: PropTypes.oneOf(['16-by-9', '4-by-3', '1-by-1']),\n /**\n * Column class names to be added each file in the grid\n */\n columnClassName: PropTypes.string,\n}
/Users/vu/forks/design-system-react/components/files/file.jsx:21:propTypes = {\n /**\n * **Assistive text for accessibility**\n * * download - description for the download button if present\n * * image - description for the file image\n * * link - description for the file link\n * * loading - description for the loading spinner if present\n * * moreActions - description for the more actions dropdown if present\n */\n assistiveText: PropTypes.shape({\n download: PropTypes.string,\n image: PropTypes.string,\n link: PropTypes.string,\n loading: PropTypes.string,\n moreActions: PropTypes.string,\n }),\n /**\n * CSS class names to be added to the container element. `array`, `object`, or `string` are accepted.\n */\n className: PropTypes.oneOfType([\n PropTypes.array,\n PropTypes.object,\n PropTypes.string,\n ]),\n /**\n * Controls different cropping aspect ratios for the component\n */\n crop: PropTypes.oneOf(['16-by-9', '4-by-3', '1-by-1']),\n /**\n * HTML id for component.\n */\n id: PropTypes.string,\n /**\n * Action to be done on clicking download button; doesn't show download button if empty\n */\n onClickDownload: PropTypes.func,\n /**\n * Function that is called when image is clicked; can be used instead of href for more advanced event handling\n */\n onClickImage: PropTypes.func,\n /**\n * Dropdown for more actions button; doesn't show more actions button if empty\n */\n moreActionsDropdown: PropTypes.node,\n /**\n * Icon associated with the file. Accepts an Icon component\n */\n icon: PropTypes.node,\n /**\n * Icon to be shown in top left corner of File component. Accepts an Icon component\n */\n externalIcon: PropTypes.node,\n /**\n * Link to thumbnail image\n */\n image: PropTypes.string,\n /**\n * Controls whether file preview is loading\n */\n isLoading: PropTypes.bool,\n /**\n * Href attribute for image\n */\n href: PropTypes.string,\n /**\n * Labels for the File Component\n * * image - title for the file. Required.\n */\n labels: PropTypes.shape({\n title: PropTypes.string.isRequired,\n }),\n /**\n * Controls whether the file's title should be visible\n */\n hasNoVisibleTitle: PropTypes.bool,\n}
/Users/vu/forks/design-system-react/components/popover/popover.jsx:94:propTypes = {\n /**\n * Aligns the popover with the respective side of the trigger. That is `top` will place the `Popover` above the trigger.\n */\n align: PropTypes.oneOf([\n 'top',\n 'top left',\n 'top right',\n 'right',\n 'right top',\n 'right bottom',\n 'bottom',\n 'bottom left',\n 'bottom right',\n 'left',\n 'left top',\n 'left bottom',\n ]),\n /**\n * **Assistive text for accessibility.**\n * This object is merged with the default props object on every render.\n * * `closeButton`: This is a visually hidden label for the close button.\n */\n assistiveText: PropTypes.shape({\n closeButton: PropTypes.string,\n }),\n /**\n * HTML `id` of heading for popover. Only use if your header is within your popover body.\n */\n ariaLabelledby: PropTypes.string,\n /**\n * Multiple children of any kind are allowed, but the first child must serve as the trigger component. Many props will be passed into this trigger related to popover interactions. The trigger needs to be a clickable element, such as a `Button` or an anchor tag (`a`).\n */\n children: PropTypes.node.isRequired,\n /**\n * The contents of the popover. This should also accept arrays.\n */\n body: PropTypes.oneOfType([PropTypes.node, PropTypes.array]).isRequired,\n /**\n * CSS classes to be added to the popover footer. That is the element with `.slds-popover__body` on it.\n */\n classNameBody: PropTypes.oneOfType([\n PropTypes.array,\n PropTypes.object,\n PropTypes.string,\n ]),\n /**\n * CSS classes to be added to the popover footer. That is the element with `.slds-popover__footer` on it.\n */\n classNameFooter: PropTypes.oneOfType([\n PropTypes.array,\n PropTypes.object,\n PropTypes.string,\n ]),\n /**\n * This prop is passed onto the triggering `Button`. Prevent popover from opening. Also applies disabled styling to trigger button.\n */\n disabled: PropTypes.bool,\n /**\n * A footer is an optional. Buttons are often placed here.\n */\n footer: PropTypes.node,\n /**\n * An object of CSS styles that are applied to the `slds-popover__footer` DOM element.\n */\n footerStyle: PropTypes.object,\n /**\n * Used with `walkthrough` variant to provide action buttons (ex: "Next" / "Skip" / etc) for a walkthrough popover footer. Accepts either a single node or array of nodes for multiple buttons.\n */\n footerWalkthroughActions: PropTypes.oneOfType([\n PropTypes.node,\n PropTypes.arrayOf(PropTypes.node),\n ]),\n /**\n * Determines if the popover has a close button or not. Default is `false`\n */\n hasNoCloseButton: PropTypes.bool,\n /**\n * Determines if the popover has a nubbin or not. Default is `false`\n */\n hasNoNubbin: PropTypes.bool,\n /**\n * Prevents the Popover from changing position based on the viewport/window. If set to true your popover can extend outside the viewport _and_ overflow outside of a scrolling parent. If this happens, you might want to consider making the popover contents scrollable to fit the menu on the screen. When enabled, `position` `absolute` is used.\n */\n hasStaticAlignment: PropTypes.bool,\n /**\n * Removes `display:inline-block` from the trigger button.\n */\n hasNoTriggerStyles: PropTypes.bool,\n /**\n * All popovers require a heading that labels the popover for assistive technology users. This text will be placed within a heading HTML tag, or in an h2 within the popover body if used with `variant="walkthrough-action"`. A heading is **highly recommended for accessibility reasons.** Please see `ariaLabelledby` prop.\n */\n heading: PropTypes.oneOfType([PropTypes.string, PropTypes.node]),\n /**\n * Icon displayed in the `feature` variant\n */\n icon: PropTypes.node,\n /**\n * By default, a unique ID will be created at render to support keyboard navigation, ARIA roles, and connect the popover to the triggering button. This ID will be applied to the triggering element. `${id}-popover`, `${id}-dialog-heading`, `${id}-dialog-body` are also created.\n */\n id: PropTypes.string,\n /**\n * Forces the popover to be open or closed. See controlled/uncontrolled callback/prop pattern for more on suggested use [](https://github.com/salesforce-ux/design-system-react/blob/master/CONTRIBUTING.md#concepts-and-best-practices) You will want this if Popover is to be a controlled component.\n */\n isOpen: PropTypes.bool,\n /**\n * This function is passed onto the triggering `Button`. Triggered when the trigger button is clicked. You will want this if Popover is to be a controlled component.\n */\n onClick: PropTypes.func,\n /**\n * This function is triggered when the dialog is closed. This occurs when the Dialog child component (that is the actual popover) is unmounted and removed from the DOM. This function returns `{event, { trigger, componentWillUnmount }`. Trigger can have the values `cancel`, `clickOutside`, or `newPopover`.\n */\n onClose: PropTypes.func,\n /**\n * Called when a key is pressed.\n */\n onKeyDown: PropTypes.func,\n /**\n * Called when mouse clicks down on the trigger button.\n */\n onMouseDown: PropTypes.func,\n /**\n * This function is triggered when the Dialog child component (that is the actual popover) is mounted and added to the DOM. The parameters are `event, { portal: }`. `portal` can be used as a React tree root node.\n */\n onOpen: PropTypes.func,\n /**\n * This function is triggered when the user clicks outside the Popover or clicks the close button. You will want to define this if Popover is to be a controlled component. Most of the time you will want to set `isOpen` to `false` when this is triggered unless you need to validate something.\n */\n onRequestClose: PropTypes.func,\n /**\n * Callback that returns an element or React `ref` to align the Popover with. If the target element has not been rendered yet, the popover will use the triggering element as the attachment target instead. NOTE: `position="relative"` is not compatible with custom targets that are not the triggering element.\n */\n onRequestTargetElement: PropTypes.func,\n /**\n * Please select one of the following:\n * * `absolute` - (default) The dialog will use `position: absolute` and style attributes to position itself. This allows inverted placement or flipping of the dialog.\n * * `overflowBoundaryElement` - The dialog will overflow scrolling parents. Use on elements that are aligned to the left or right of their target and don't care about the target being within a scrolling parent. Typically this is a popover or tooltip. Dropdown menus can usually open up and down if no room exists. In order to achieve this a portal element will be created and attached to `body`. This element will render into that detached render tree.\n * * `relative` - No styling or portals will be used. Menus will be positioned relative to their triggers. This is a great choice for HTML snapshot testing. NOTE: this setting is not compatible with custom targets outside the trigger\n */\n position: PropTypes.oneOf([\n 'absolute',\n 'overflowBoundaryElement',\n 'relative',\n ]),\n /**\n * Used with `walkthrough` variant to provide the step text (ex: "Step 1 of 4") for a walkthrough popover footer. If used with `variant="walkthrough-action"`, it will be placed in the popover body.\n */\n stepText: PropTypes.string,\n /**\n * An object of CSS styles that are applied to the `slds-popover` DOM element.\n */\n style: PropTypes.object,\n /**\n * If `true`, adds a transparent overlay when the menu is open to handle outside clicks. Allows clicks on iframes to be captured, but also forces a double-click to interact with other elements. If a function is passed, custom overlay logic may be defined by the app.\n */\n overlay: PropTypes.oneOfType([PropTypes.bool, PropTypes.func]),\n /**\n * CSS classes to be added to wrapping trigger `div` around the button.\n */\n triggerClassName: PropTypes.oneOfType([\n PropTypes.array,\n PropTypes.object,\n PropTypes.string,\n ]),\n /**\n * Determines the type of the popover. `error` and `warning` allows the content body to scroll. Default is `base` _Tested with snaphots._\n */\n variant: PropTypes.oneOf([\n 'base',\n 'error',\n 'feature',\n 'walkthrough',\n 'walkthrough-action',\n 'warning',\n ]),\n }
/Users/vu/forks/design-system-react/components/location-map/index.jsx:19:propTypes = {\n /**\n * CSS class names to be added with `slds-map` class. `array`, `object`, or `string` are accepted.\n */\n className: PropTypes.oneOfType([\n PropTypes.array,\n PropTypes.object,\n PropTypes.string,\n ]),\n /**\n * CSS class names to be added to the container element. `array`, `object`, or `string` are accepted.\n */\n classNameContainer: PropTypes.oneOfType([\n PropTypes.array,\n PropTypes.object,\n PropTypes.string,\n ]),\n /**\n * Accepts location object that will be shown if no location has been selected. Required\n * * `id` : A unique identifier string for the location\n * * `name` : Name of the location\n * * `address` : Address of the location\n */\n defaultLocation: PropTypes.shape({\n id: PropTypes.string.isRequired,\n name: PropTypes.string.isRequired,\n address: PropTypes.string.isRequired,\n }).isRequired,\n /**\n * HTML id for component.\n */\n id: PropTypes.string,\n /**\n * Labels\n * * `title` - Title for the LocationMap component.\n */\n labels: PropTypes.shape({\n title: PropTypes.string,\n }),\n /**\n * Array of locations objects for the LocationMap component.**\n * Each location object can contain:\n * * `id` : A unique identifier string for the location\n * * `name` : Name of the location\n * * `address` : Address of the location\n */\n locations: PropTypes.arrayOf(\n PropTypes.shape({\n id: PropTypes.string.isRequired,\n name: PropTypes.string.isRequired,\n address: PropTypes.string.isRequired,\n })\n ).isRequired,\n /**\n * Callback function triggered when a location is selected\n */\n onClickLocation: PropTypes.func,\n /**\n * Accepts a Google Map API Key that will be used for showing the map\n */\n googleAPIKey: PropTypes.string.isRequired,\n /**\n * Accepts location object that will be shown when selected\n * * `id` : A unique identifier string for the location\n * * `name` : Name of the location\n * * `address` : Address of the location\n */\n selection: PropTypes.shape({\n id: PropTypes.string.isRequired,\n name: PropTypes.string.isRequired,\n address: PropTypes.string.isRequired,\n }),\n}
/Users/vu/forks/design-system-react/components/files/private/file-actions.jsx:69:propTypes = {\n /**\n * Action to be done on clicking download button; doesnt show download button if empty\n */\n onClickDownload: PropTypes.func,\n /**\n * Dropdown for More Actions; doesn't show More actions button if empty\n */\n moreActionsDropdown: PropTypes.node,\n /**\n * Labels for the file component\n */\n hasNoVisibleTitle: PropTypes.bool,\n}
/Users/vu/forks/design-system-react/components/utilities/pill/index.jsx:18:propTypes = {\n /**\n * Pill is the actively focused pill within a pill container. This will request focus on the DOM node.\n */\n active: PropTypes.bool,\n /**\n * **Assistive text for accessibility**\n * This object is merged with the default props object on every render.\n * * `pressDeleteOrBackspace`: Informs user of keyboard keys to press in order to remove a pill\n */\n assistiveText: PropTypes.shape({\n remove: PropTypes.string,\n }),\n /**\n * SLDSAvatar component to show on the left of the pill.\n * _Tested with Mocha framework._\n */\n avatar: PropTypes.element,\n /**\n * Applies the bare style to the component.\n * _Tested with Mocha framework._\n */\n bare: PropTypes.bool,\n /*\n * Pills are often used for selection of a type of entity such as days in a daypicker. This prop allows you to pass in data that will be passed back to the event handler.\n */\n eventData: PropTypes.object,\n /*\n * Callbacks for various pill events such as click, focus, etc\n */\n events: PropTypes.shape({\n onClick: PropTypes.func,\n onFocus: PropTypes.func,\n onRequestFocus: PropTypes.func.isRequired,\n onRequestFocusOnNextPill: PropTypes.func.isRequired,\n onRequestFocusOnPreviousPill: PropTypes.func.isRequired,\n onRequestRemove: PropTypes.func.isRequired,\n }),\n /**\n * Applies the error style to the component.\n * _Tested with Mocha framework._\n */\n hasError: PropTypes.bool,\n /*\n * The icon next to the pill label.\n */\n icon: PropTypes.