|
| 1 | +/* Copyright (c) 2015-present, salesforce.com, inc. All rights reserved */ |
| 2 | +/* Licensed under BSD 3-Clause - see LICENSE.txt or git.io/sfdc-license */ |
| 3 | + |
| 4 | +// # App Launcher Component |
| 5 | + |
| 6 | +// Based on SLDS v2.1.0-rc.2 |
| 7 | + |
| 8 | +// ## Dependencies |
| 9 | + |
| 10 | +// ### React |
| 11 | +import React from 'react'; |
| 12 | +import PropTypes from 'prop-types'; |
| 13 | + |
| 14 | +// ### classNames |
| 15 | +import classNames from 'classnames'; |
| 16 | + |
| 17 | +// ### isFunction |
| 18 | +import isFunction from 'lodash.isfunction'; |
| 19 | + |
| 20 | +// This component's `checkProps` which issues warnings to developers about properties when in development mode (similar to React's built in development tools) |
| 21 | +import checkProps from './check-props'; |
| 22 | + |
| 23 | +// ## Children |
| 24 | +import Modal from '../modal'; |
| 25 | + |
| 26 | +// ## Constants |
| 27 | +import { APP_LAUNCHER } from '../../utilities/constants'; |
| 28 | + |
| 29 | +/** |
| 30 | + * The App Launcher allows the user to quickly access all the apps and functionality with their organization. |
| 31 | + * The App Launcher should generally only be used as a sub-component of the [Global Navigation Bar](/components/global-navigation-bar) |
| 32 | + * |
| 33 | + * Also note: App Launcher is not included in the standard component export. To import it, you must reference it directly via its path. |
| 34 | + * Example: |
| 35 | + * ``` |
| 36 | + * import AppLauncher from 'design-system-react/components/app-launcher'; |
| 37 | + * import AppLauncherTile from 'design-system-react/components/app-launcher/tile'; |
| 38 | + * import AppLauncherSection from 'design-system-react/components/app-launcher/section'; |
| 39 | + * ``` |
| 40 | + * |
| 41 | + * USAGE EXAMPLE: |
| 42 | + * ``` |
| 43 | + * <AppLauncher> |
| 44 | + * <AppLauncherSection> |
| 45 | + * <AppLauncherTile /> |
| 46 | + * <AppLauncherTile /> |
| 47 | + * <AppLauncherTile /> |
| 48 | + * </AppLauncherSection> |
| 49 | + * <AppLauncherSection> |
| 50 | + * <AppLauncherTile /> |
| 51 | + * <AppLauncherTile /> |
| 52 | + * </AppLauncherSection> |
| 53 | + * </AppLauncher> |
| 54 | + * ``` |
| 55 | + * |
| 56 | + * By 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. |
| 57 | + * ``` |
| 58 | + * import settings from 'design-system-react/components/settings'; |
| 59 | + * settings.setAppElement('#mount'); |
| 60 | + * ``` |
| 61 | + */ |
| 62 | + |
| 63 | +const AppLauncher = React.createClass({ |
| 64 | + // ### Display Name |
| 65 | + // Always use the canonical component name as the React display name. |
| 66 | + displayName: APP_LAUNCHER, |
| 67 | + |
| 68 | + // ### Prop Types |
| 69 | + propTypes: { |
| 70 | + /** |
| 71 | + * One or more `<AppLauncherSection />`s each containing one or more `<AppLauncherTile />`s |
| 72 | + */ |
| 73 | + children: PropTypes.node.isRequired, |
| 74 | + /** |
| 75 | + * Control the open/close state of the App Launcher |
| 76 | + */ |
| 77 | + isOpen: PropTypes.bool, |
| 78 | + /** |
| 79 | + * CSS classes to be added to App Launcher Modal. |
| 80 | + */ |
| 81 | + modalClassName: PropTypes.oneOfType([PropTypes.array, PropTypes.object, PropTypes.string]), |
| 82 | + /** |
| 83 | + * Button that exists in the upper right hand corner of the App Launcher modal |
| 84 | + */ |
| 85 | + modalHeaderButton: PropTypes.node, |
| 86 | + /** |
| 87 | + * Allows longer application names without truncating them. |
| 88 | + */ |
| 89 | + noTruncate: PropTypes.bool, |
| 90 | + /** |
| 91 | + * Callback when the App Launcher Modal is closed |
| 92 | + */ |
| 93 | + onClose: PropTypes.func, |
| 94 | + /** |
| 95 | + * Search bar for the Modal's header. Will typically be an instance of `design-system-react/forms/input/search` |
| 96 | + */ |
| 97 | + search: PropTypes.node, |
| 98 | + /** |
| 99 | + * Set the App Launcher's title text (for localization) |
| 100 | + */ |
| 101 | + title: PropTypes.string, |
| 102 | + /** |
| 103 | + * Assistive text for app launcher icon |
| 104 | + */ |
| 105 | + triggerAssistiveText: PropTypes.string, |
| 106 | + /** |
| 107 | + * This is typically the name of the cloud or application |
| 108 | + */ |
| 109 | + triggerName: PropTypes.node, |
| 110 | + /** |
| 111 | + * Callback when the App Launcher icon is clicked |
| 112 | + */ |
| 113 | + triggerOnClick: PropTypes.func |
| 114 | + }, |
| 115 | + |
| 116 | + componentWillMount () { |
| 117 | + // `checkProps` issues warnings to developers about properties (similar to React's built in development tools) |
| 118 | + checkProps(APP_LAUNCHER, this.props); |
| 119 | + }, |
| 120 | + |
| 121 | + getDefaultProps () { |
| 122 | + return { |
| 123 | + triggerAssistiveText: 'Open App Launcher', |
| 124 | + title: 'App Launcher' |
| 125 | + }; |
| 126 | + }, |
| 127 | + |
| 128 | + getInitialState () { |
| 129 | + return { |
| 130 | + isOpen: false |
| 131 | + }; |
| 132 | + }, |
| 133 | + |
| 134 | + openAppLauncher (event) { |
| 135 | + this.setState({ isOpen: true }); |
| 136 | + |
| 137 | + if (isFunction(this.props.triggerOnClick)) { |
| 138 | + this.props.triggerOnClick(event); |
| 139 | + } |
| 140 | + }, |
| 141 | + |
| 142 | + closeAppLauncher (event) { |
| 143 | + this.setState({ isOpen: false }); |
| 144 | + |
| 145 | + if (isFunction(this.props.onClose)) { |
| 146 | + this.props.onClose(event); |
| 147 | + } |
| 148 | + }, |
| 149 | + |
| 150 | + renderSearch () { |
| 151 | + let returnVal; |
| 152 | + |
| 153 | + if (this.props.search) { |
| 154 | + returnVal = ( |
| 155 | + <div |
| 156 | + className="slds-app-launcher__header-search" |
| 157 | + ref={(component) => { |
| 158 | + if (component) { |
| 159 | + if (!this.focusedOnSearch) { |
| 160 | + const input = component.querySelector('input'); |
| 161 | + if (input) { |
| 162 | + // push to end of stack so click event doesn't blur the focus |
| 163 | + setTimeout(() => { |
| 164 | + input.focus(); |
| 165 | + this.focusedOnSearch = true; |
| 166 | + }, 0); |
| 167 | + } |
| 168 | + } |
| 169 | + } else { |
| 170 | + this.focusedOnSearch = false; |
| 171 | + } |
| 172 | + }} |
| 173 | + > |
| 174 | + {this.props.search} |
| 175 | + </div> |
| 176 | + ); |
| 177 | + } |
| 178 | + |
| 179 | + return returnVal; |
| 180 | + }, |
| 181 | + |
| 182 | + render () { |
| 183 | + const isOpen = this.props.isOpen !== undefined ? this.props.isOpen : this.state.isOpen; |
| 184 | + |
| 185 | + // Should be removed in the future by adding a reset class of some sort. |
| 186 | + const style = this.props.noTruncate ? { maxWidth: 'none' } : null; |
| 187 | + |
| 188 | + const customModalHeader = ( |
| 189 | + <div className="slds-grid slds-grid--align-spread slds-grid--vertical-align-center"> |
| 190 | + <h2 className="slds-text-heading--medium">{this.props.title}</h2> |
| 191 | + |
| 192 | + {this.renderSearch()} |
| 193 | + |
| 194 | + { |
| 195 | + this.props.modalHeaderButton |
| 196 | + ? this.props.modalHeaderButton |
| 197 | + : <span className="slds-size--1-of-7" /> |
| 198 | + } |
| 199 | + </div> |
| 200 | + ); |
| 201 | + |
| 202 | + // Not present in SLDS, but is consistent with other implementations of App Launcher. This also prevents resizing/jumping around when filtering. It will start clipping the modal close button at 600px viewport height. |
| 203 | + const modalContentStaticHeight = '90%'; |
| 204 | + |
| 205 | + return ( |
| 206 | + <div className="slds-context-bar__item slds-no-hover" style={style}> |
| 207 | + <div className="slds-context-bar__icon-action"> |
| 208 | + <button |
| 209 | + aria-haspopup="true" |
| 210 | + className="slds-button slds-icon-waffle_container slds-context-bar__button" |
| 211 | + onClick={this.openAppLauncher} |
| 212 | + > |
| 213 | + <span className="slds-icon-waffle"> |
| 214 | + <span className="slds-r1" /> |
| 215 | + <span className="slds-r2" /> |
| 216 | + <span className="slds-r3" /> |
| 217 | + <span className="slds-r4" /> |
| 218 | + <span className="slds-r5" /> |
| 219 | + <span className="slds-r6" /> |
| 220 | + <span className="slds-r7" /> |
| 221 | + <span className="slds-r8" /> |
| 222 | + <span className="slds-r9" /> |
| 223 | + </span> |
| 224 | + {this.props.triggerAssistiveText && <span className="slds-assistive-text">{this.props.triggerAssistiveText}</span>} |
| 225 | + </button> |
| 226 | + </div> |
| 227 | + <Modal |
| 228 | + contentClassName="slds-modal__content slds-app-launcher__content slds-p-around--medium" |
| 229 | + contentStyle={{ minHeight: modalContentStaticHeight }} |
| 230 | + isOpen={isOpen} |
| 231 | + onRequestClose={this.closeAppLauncher} |
| 232 | + containerClassName={classNames('app-launcher', this.props.modalClassName)} |
| 233 | + size="large" |
| 234 | + header={customModalHeader} |
| 235 | + headerClassName="slds-app-launcher__header" |
| 236 | + > |
| 237 | + {this.props.children} |
| 238 | + </Modal> |
| 239 | + {this.props.triggerName |
| 240 | + ? <span |
| 241 | + className={classNames( |
| 242 | + 'slds-context-bar__label-action slds-context-bar__app-name', |
| 243 | + { 'slds-truncate': !this.props.noTruncate }) |
| 244 | + } |
| 245 | + > |
| 246 | + {this.props.triggerName} |
| 247 | + </span> |
| 248 | + : null |
| 249 | + } |
| 250 | + </div> |
| 251 | + ); |
| 252 | + } |
| 253 | +}); |
| 254 | + |
| 255 | +module.exports = AppLauncher; |
0 commit comments