all files / addon/components/ polaris-button.js

100% Statements 9/9
100% Branches 14/14
100% Functions 6/6
100% Lines 9/9
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260                                                                                                                                                                                                                                                                                                                                                                                                                                                                            89× 89×       91×       25×                   90× 90×            
import Component from '@ember/component';
import { computed } from '@ember/object';
import { or } from '@ember/object/computed';
import { isPresent, isBlank, isNone } from '@ember/utils';
import { handleMouseUpByBlurring } from '../utils/focus';
import layout from '../templates/components/polaris-button';
 
/**
 * Polaris button component.
 * See https://polaris.shopify.com/components/actions/button
 */
export default Component.extend({
  // Polaris react behaviour is to render an anchor element if a URL is provided,
  // or a button element otherwise. Ember components can't support dynamic tagNames,
  // so we reproduce this behaviour using a dynamic component in block form in our template.
  tagName: '',
 
  layout,
 
  /**
   * The content to display inside the button
   *
   * This component can be used in block form,
   * in which case the block content will be used
   * instead of `text`
   *
   * @property text
   * @public
   * @type {String}
   * @default null
   */
  text: null,
 
  /**
   * URL to link to
   *
   * @property url
   * @public
   * @type {string}
   * @default null
   */
  url: null,
 
  /**
   * Display as primary button
   *
   * @property primary
   * @public
   * @type {boolean}
   * @default false
   */
  primary: false,
 
  /**
   * Display as destructive button
   *
   * @property destructive
   * @public
   * @type {boolean}
   * @default false
   */
  destructive: false,
 
  /**
   * Disable button
   *
   * @property disabled
   * @public
   * @type {boolean}
   * @default false
   */
  disabled: false,
 
  /**
   * 	Replaces button text with a spinner while a background action is being performed
   *
   * @property loading
   * @public
   * @type {boolean}
   * @default false
   */
  loading: false,
 
  /**
   * Change the size of the button
   *
   * @property size
   * @public
   * @type {enum}
   * @default null
   */
  size: null,
 
  /**
   * Display an outlined button
   *
   * @property outline
   * @public
   * @type {boolean}
   * @default false
   */
  outline: false,
 
  /**
   * Display full width button
   *
   * @property fullWidth
   * @public
   * @type {boolean}
   * @default false
   */
  fullWidth: false,
 
  /**
   * Display button with a disclosure icon
   *
   * @property disclosure
   * @public
   * @type {boolean}
   * @default false
   */
  disclosure: false,
 
  /**
   * Button will submit a form
   *
   * @property submit
   * @public
   * @type {boolean}
   * @default false
   */
  submit: false,
 
  /**
   * Use plain button style
   *
   * @property plain
   * @public
   * @type {boolean}
   * @default false
   */
  plain: false,
 
  /**
   * Force url to open in a new tab
   *
   * @property external
   * @public
   * @type {boolean}
   * @default false
   */
  external: false,
 
  /**
   * Icon to display to the left of the button content
   *
   * @property icon
   * @public
   * @type {SVG}
   * @default null
   */
  icon: null,
 
  /**
   * Visually hidden text for screen readers
   *
   * @property accessibilityLabel
   * @public
   * @type {string}
   * @default null
   */
  accessibilityLabel: null,
 
  /**
   * ID of the element this button reveals
   *
   * @property ariaControls
   * @public
   * @type {string}
   * @default null
   */
  ariaControls: null,
 
  /**
   * Whether the content revealed by this button is visible
   *
   * @property ariaExpanded
   * @public
   * @type {boolean|null}
   * @default null
   */
  ariaExpanded: null,
 
  /**
   * Callback when clicked
   *
   * @property onClick
   * @public
   * @type {function}
   * @default null
   */
  onClick: null,
 
  /**
   * Callback when button becomes focussed
   *
   * @property onFocus
   * @public
   * @type {function}
   * @default null
   */
  onFocus: null,
 
  /**
   * Callback when focus leaves button
   *
   * @property onBlur
   * @public
   * @type {function}
   * @default null
   */
  onBlur: null,
 
  /**
   * Computed properties.
   */
  isDisabled: or('disabled', 'loading').readOnly(),
 
  buttonComponentName: computed('url', function() {
    // TODO: refactor to use polaris-unstyled-link here
    const buttonType = isNone(this.get('url')) ? 'button' : 'link';
    return `polaris-button/${buttonType}`;
  }).readOnly(),
 
  iconOnly: computed('icon', 'text', function() {
    return isBlank(this.get('text')) && isPresent(this.get('icon'));
  }).readOnly(),
 
  iconSource: computed('icon', 'loading', function() {
    return this.get('loading') ? 'placeholder' : this.get('icon');
  }).readOnly(),
 
  disclosureIconSource: computed('loading', function() {
    return this.get('loading') ? 'placeholder' : 'caret-down';
  }).readOnly(),
 
  spinnerColor: computed('primary', 'destructive', function() {
    let { primary, destructive } = this.getProperties('primary', 'destructive');
    return primary || destructive ? 'white' : 'inkLightest';
  }).readOnly(),
 
  ariaExpandedValue: computed('ariaExpanded', function() {
    let ariaExpanded = this.get('ariaExpanded');
    return isPresent(ariaExpanded) ? ariaExpanded.toString() : null;
  }).readOnly(),
 
  handleMouseUpByBlurring,
});