@atlaskit/share 6.15.1 → 6.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # @atlaskit/share
2
2
 
3
+ ## 6.16.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [#185948](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/185948)
8
+ [`169677f95fce5`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/169677f95fce5) -
9
+ [ux] Add a new customTriggerButtonIcon prop to the Share Dialog Component. This prop is passed to
10
+ the renderCustomTriggerButton function, allowing consumers to dynamically update the icon
11
+ displayed on the custom trigger button.
12
+
13
+ ### Patch Changes
14
+
15
+ - Updated dependencies
16
+
3
17
  ## 6.15.1
4
18
 
5
19
  ### Patch Changes
@@ -344,6 +344,7 @@ var ShareDialogContainerInternal = exports.ShareDialogContainerInternal = /*#__P
344
344
  dialogPlacement = _this$props3.dialogPlacement,
345
345
  loadUserOptions = _this$props3.loadUserOptions,
346
346
  renderCustomTriggerButton = _this$props3.renderCustomTriggerButton,
347
+ customTriggerButtonIcon = _this$props3.customTriggerButtonIcon,
347
348
  shareContentType = _this$props3.shareContentType,
348
349
  shareContentSubType = _this$props3.shareContentSubType,
349
350
  shareContentId = _this$props3.shareContentId,
@@ -398,6 +399,7 @@ var ShareDialogContainerInternal = exports.ShareDialogContainerInternal = /*#__P
398
399
  onDialogOpen: this.handleDialogOpen,
399
400
  onShareSubmit: this.handleSubmitShare,
400
401
  renderCustomTriggerButton: renderCustomTriggerButton,
402
+ customTriggerButtonIcon: customTriggerButtonIcon,
401
403
  shareContentType: shareContentType,
402
404
  shareContentSubType: shareContentSubType,
403
405
  shareContentId: shareContentId,
@@ -430,6 +430,7 @@ var ShareDialogWithTriggerInternalLegacy = exports.ShareDialogWithTriggerInterna
430
430
  formatMessage = _this$props6.intl.formatMessage,
431
431
  isDisabled = _this$props6.isDisabled,
432
432
  renderCustomTriggerButton = _this$props6.renderCustomTriggerButton,
433
+ customTriggerButtonIcon = _this$props6.customTriggerButtonIcon,
433
434
  triggerButtonIcon = _this$props6.triggerButtonIcon,
434
435
  triggerButtonTooltipText = _this$props6.triggerButtonTooltipText,
435
436
  triggerButtonTooltipPosition = _this$props6.triggerButtonTooltipPosition,
@@ -449,7 +450,8 @@ var ShareDialogWithTriggerInternalLegacy = exports.ShareDialogWithTriggerInterna
449
450
  error: shareError,
450
451
  isDisabled: isDisabled,
451
452
  isSelected: isDialogOpen,
452
- onClick: _this.onTriggerClick
453
+ onClick: _this.onTriggerClick,
454
+ iconBefore: customTriggerButtonIcon
453
455
  }, triggerProps);
454
456
  } else {
455
457
  button = (0, _react2.jsx)(_ShareButton.default, {
@@ -415,6 +415,7 @@ var ShareDialogWithTriggerInternal = exports.ShareDialogWithTriggerInternal = /*
415
415
  formatMessage = _this$props6.intl.formatMessage,
416
416
  isDisabled = _this$props6.isDisabled,
417
417
  renderCustomTriggerButton = _this$props6.renderCustomTriggerButton,
418
+ customTriggerButtonIcon = _this$props6.customTriggerButtonIcon,
418
419
  triggerButtonIcon = _this$props6.triggerButtonIcon,
419
420
  triggerButtonTooltipText = _this$props6.triggerButtonTooltipText,
420
421
  triggerButtonTooltipPosition = _this$props6.triggerButtonTooltipPosition,
@@ -434,7 +435,8 @@ var ShareDialogWithTriggerInternal = exports.ShareDialogWithTriggerInternal = /*
434
435
  error: shareError,
435
436
  isDisabled: isDisabled,
436
437
  isSelected: isDialogOpen,
437
- onClick: _this.onTriggerClick
438
+ onClick: _this.onTriggerClick,
439
+ iconBefore: customTriggerButtonIcon
438
440
  }, triggerProps);
439
441
  } else {
440
442
  button = /*#__PURE__*/_react.default.createElement(_ShareButton.default, {
@@ -13,7 +13,7 @@ var buildAttributes = function buildAttributes() {
13
13
  var attributes = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
14
14
  return _objectSpread({
15
15
  packageName: "@atlaskit/share",
16
- packageVersion: "6.15.0"
16
+ packageVersion: "6.15.1"
17
17
  }, attributes);
18
18
  };
19
19
  var createEvent = function createEvent(eventType, source, action, actionSubject, actionSubjectId) {
@@ -291,6 +291,7 @@ export class ShareDialogContainerInternal extends React.Component {
291
291
  dialogPlacement,
292
292
  loadUserOptions,
293
293
  renderCustomTriggerButton,
294
+ customTriggerButtonIcon,
294
295
  shareContentType,
295
296
  shareContentSubType,
296
297
  shareContentId,
@@ -347,6 +348,7 @@ export class ShareDialogContainerInternal extends React.Component {
347
348
  onDialogOpen: this.handleDialogOpen,
348
349
  onShareSubmit: this.handleSubmitShare,
349
350
  renderCustomTriggerButton: renderCustomTriggerButton,
351
+ customTriggerButtonIcon: customTriggerButtonIcon,
350
352
  shareContentType: shareContentType,
351
353
  shareContentSubType: shareContentSubType,
352
354
  shareContentId: shareContentId,
@@ -412,6 +412,7 @@ export class ShareDialogWithTriggerInternalLegacy extends React.PureComponent {
412
412
  },
413
413
  isDisabled,
414
414
  renderCustomTriggerButton,
415
+ customTriggerButtonIcon,
415
416
  triggerButtonIcon,
416
417
  triggerButtonTooltipText,
417
418
  triggerButtonTooltipPosition,
@@ -434,7 +435,8 @@ export class ShareDialogWithTriggerInternalLegacy extends React.PureComponent {
434
435
  error: shareError,
435
436
  isDisabled,
436
437
  isSelected: isDialogOpen,
437
- onClick: this.onTriggerClick
438
+ onClick: this.onTriggerClick,
439
+ iconBefore: customTriggerButtonIcon
438
440
  }, triggerProps);
439
441
  } else {
440
442
  button = jsx(ShareButton, {
@@ -393,6 +393,7 @@ export class ShareDialogWithTriggerInternal extends React.PureComponent {
393
393
  },
394
394
  isDisabled,
395
395
  renderCustomTriggerButton,
396
+ customTriggerButtonIcon,
396
397
  triggerButtonIcon,
397
398
  triggerButtonTooltipText,
398
399
  triggerButtonTooltipPosition,
@@ -415,7 +416,8 @@ export class ShareDialogWithTriggerInternal extends React.PureComponent {
415
416
  error: shareError,
416
417
  isDisabled,
417
418
  isSelected: isDialogOpen,
418
- onClick: this.onTriggerClick
419
+ onClick: this.onTriggerClick,
420
+ iconBefore: customTriggerButtonIcon
419
421
  }, triggerProps);
420
422
  } else {
421
423
  button = /*#__PURE__*/React.createElement(ShareButton, {
@@ -1,7 +1,7 @@
1
1
  import { isEmail, isExternalUser, isGroup, isTeam, isUser } from '@atlaskit/smart-user-picker';
2
2
  const buildAttributes = (attributes = {}) => ({
3
3
  packageName: "@atlaskit/share",
4
- packageVersion: "6.15.0",
4
+ packageVersion: "6.15.1",
5
5
  ...attributes
6
6
  });
7
7
  const createEvent = (eventType, source, action, actionSubject, actionSubjectId, attributes = {}) => ({
@@ -337,6 +337,7 @@ export var ShareDialogContainerInternal = /*#__PURE__*/function (_React$Componen
337
337
  dialogPlacement = _this$props3.dialogPlacement,
338
338
  loadUserOptions = _this$props3.loadUserOptions,
339
339
  renderCustomTriggerButton = _this$props3.renderCustomTriggerButton,
340
+ customTriggerButtonIcon = _this$props3.customTriggerButtonIcon,
340
341
  shareContentType = _this$props3.shareContentType,
341
342
  shareContentSubType = _this$props3.shareContentSubType,
342
343
  shareContentId = _this$props3.shareContentId,
@@ -391,6 +392,7 @@ export var ShareDialogContainerInternal = /*#__PURE__*/function (_React$Componen
391
392
  onDialogOpen: this.handleDialogOpen,
392
393
  onShareSubmit: this.handleSubmitShare,
393
394
  renderCustomTriggerButton: renderCustomTriggerButton,
395
+ customTriggerButtonIcon: customTriggerButtonIcon,
394
396
  shareContentType: shareContentType,
395
397
  shareContentSubType: shareContentSubType,
396
398
  shareContentId: shareContentId,
@@ -427,6 +427,7 @@ export var ShareDialogWithTriggerInternalLegacy = /*#__PURE__*/function (_React$
427
427
  formatMessage = _this$props6.intl.formatMessage,
428
428
  isDisabled = _this$props6.isDisabled,
429
429
  renderCustomTriggerButton = _this$props6.renderCustomTriggerButton,
430
+ customTriggerButtonIcon = _this$props6.customTriggerButtonIcon,
430
431
  triggerButtonIcon = _this$props6.triggerButtonIcon,
431
432
  triggerButtonTooltipText = _this$props6.triggerButtonTooltipText,
432
433
  triggerButtonTooltipPosition = _this$props6.triggerButtonTooltipPosition,
@@ -446,7 +447,8 @@ export var ShareDialogWithTriggerInternalLegacy = /*#__PURE__*/function (_React$
446
447
  error: shareError,
447
448
  isDisabled: isDisabled,
448
449
  isSelected: isDialogOpen,
449
- onClick: _this.onTriggerClick
450
+ onClick: _this.onTriggerClick,
451
+ iconBefore: customTriggerButtonIcon
450
452
  }, triggerProps);
451
453
  } else {
452
454
  button = jsx(ShareButton, {
@@ -408,6 +408,7 @@ export var ShareDialogWithTriggerInternal = /*#__PURE__*/function (_React$PureCo
408
408
  formatMessage = _this$props6.intl.formatMessage,
409
409
  isDisabled = _this$props6.isDisabled,
410
410
  renderCustomTriggerButton = _this$props6.renderCustomTriggerButton,
411
+ customTriggerButtonIcon = _this$props6.customTriggerButtonIcon,
411
412
  triggerButtonIcon = _this$props6.triggerButtonIcon,
412
413
  triggerButtonTooltipText = _this$props6.triggerButtonTooltipText,
413
414
  triggerButtonTooltipPosition = _this$props6.triggerButtonTooltipPosition,
@@ -427,7 +428,8 @@ export var ShareDialogWithTriggerInternal = /*#__PURE__*/function (_React$PureCo
427
428
  error: shareError,
428
429
  isDisabled: isDisabled,
429
430
  isSelected: isDialogOpen,
430
- onClick: _this.onTriggerClick
431
+ onClick: _this.onTriggerClick,
432
+ iconBefore: customTriggerButtonIcon
431
433
  }, triggerProps);
432
434
  } else {
433
435
  button = /*#__PURE__*/React.createElement(ShareButton, {
@@ -6,7 +6,7 @@ var buildAttributes = function buildAttributes() {
6
6
  var attributes = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
7
7
  return _objectSpread({
8
8
  packageName: "@atlaskit/share",
9
- packageVersion: "6.15.0"
9
+ packageVersion: "6.15.1"
10
10
  }, attributes);
11
11
  };
12
12
  var createEvent = function createEvent(eventType, source, action, actionSubject, actionSubjectId) {
@@ -79,6 +79,7 @@ export declare const ShareDialogContainer: React.ForwardRefExoticComponent<Omit<
79
79
  originTracingFactory?: OriginTracingFactory | undefined;
80
80
  productId?: import("../types").ProductId | undefined;
81
81
  renderCustomTriggerButton?: import("../types").RenderCustomTriggerButton | undefined;
82
+ customTriggerButtonIcon?: React.ComponentType<import("@atlaskit/icon").NewCoreIconProps> | undefined;
82
83
  shareAri?: string | undefined;
83
84
  shareContentType?: string | undefined;
84
85
  shareContentSubType?: string | undefined;
@@ -53,6 +53,8 @@ export type ShareDialogContainerProps = {
53
53
  productId: ProductId;
54
54
  /** Render function for a custom Share Dialog Trigger Button. */
55
55
  renderCustomTriggerButton?: RenderCustomTriggerButton;
56
+ /** An Icon used for the custom Share Dialog Trigger Button */
57
+ customTriggerButtonIcon?: React.ComponentType<NewCoreIconProps>;
56
58
  /** Atlassian Resource Identifier of a Site resource to be shared. */
57
59
  shareAri: string;
58
60
  /** Content Type of the resource to be shared. It will also affect on the successful share message in the flag. A pre-defined list as follows:*/
@@ -1,5 +1,6 @@
1
1
  /// <reference types="react" />
2
2
  import type { AnalyticsEventPayload } from '@atlaskit/analytics-next';
3
+ import { type NewCoreIconProps } from '@atlaskit/icon';
3
4
  import type { Placement } from '@atlaskit/popper';
4
5
  import type { TriggerProps } from '@atlaskit/popup';
5
6
  import type { ConfigResponse } from '../clients/ShareServiceClient';
@@ -12,6 +13,7 @@ export type RenderCustomTriggerButton = (args: {
12
13
  isDisabled?: boolean;
13
14
  isSelected?: boolean;
14
15
  onClick: () => void;
16
+ iconBefore?: React.ComponentType<NewCoreIconProps>;
15
17
  }, triggerProps: TriggerProps) => React.ReactNode;
16
18
  export type DialogPlacement = Placement;
17
19
  /**
@@ -19,7 +21,7 @@ export type DialogPlacement = Placement;
19
21
  * with the demo page and clearly visible options on that page.
20
22
  */
21
23
  export type DialogBoundariesElement = 'viewport' | 'window' | 'scrollParent';
22
- export type ShareDialogWithTriggerProps = Pick<ShareDialogContainerProps, 'onTriggerButtonClick' | 'isAutoOpenDialog' | 'shouldCloseOnEscapePress' | 'dialogPlacement' | 'loadUserOptions' | 'onDialogOpen' | 'onDialogClose' | 'onUserSelectionChange' | 'renderCustomTriggerButton' | 'shareContentType' | 'shareContentSubType' | 'shareContentId' | 'shareFormTitle' | 'shareFormHelperMessage' | 'showFlags' | 'enableSmartUserPicker' | 'loggedInAccountId' | 'triggerButtonAppearance' | 'triggerButtonIcon' | 'triggerButtonStyle' | 'triggerButtonTooltipPosition' | 'triggerButtonTooltipText' | 'cloudId' | 'bottomMessage' | 'product' | 'productAttributes' | 'customHeader' | 'customFooter' | 'isCopyDisabled' | 'isPublicLink' | 'integrationMode' | 'isMenuItemSelected' | 'shareFieldsFooter' | 'shareIntegrations' | 'additionalTabs' | 'builtInTabContentWidth' | 'shareAri' | 'tabIndex' | 'copyTooltipText' | 'dialogZIndex' | 'orgId' | 'isBrowseUsersDisabled' | 'userPickerOptions' | 'isSubmitShareDisabled' | 'additionalUserFields' | 'isExtendedShareDialogEnabled' | 'CustomSubmitButton'> & {
24
+ export type ShareDialogWithTriggerProps = Pick<ShareDialogContainerProps, 'onTriggerButtonClick' | 'isAutoOpenDialog' | 'shouldCloseOnEscapePress' | 'dialogPlacement' | 'loadUserOptions' | 'onDialogOpen' | 'onDialogClose' | 'onUserSelectionChange' | 'renderCustomTriggerButton' | 'customTriggerButtonIcon' | 'shareContentType' | 'shareContentSubType' | 'shareContentId' | 'shareFormTitle' | 'shareFormHelperMessage' | 'showFlags' | 'enableSmartUserPicker' | 'loggedInAccountId' | 'triggerButtonAppearance' | 'triggerButtonIcon' | 'triggerButtonStyle' | 'triggerButtonTooltipPosition' | 'triggerButtonTooltipText' | 'cloudId' | 'bottomMessage' | 'product' | 'productAttributes' | 'customHeader' | 'customFooter' | 'isCopyDisabled' | 'isPublicLink' | 'integrationMode' | 'isMenuItemSelected' | 'shareFieldsFooter' | 'shareIntegrations' | 'additionalTabs' | 'builtInTabContentWidth' | 'shareAri' | 'tabIndex' | 'copyTooltipText' | 'dialogZIndex' | 'orgId' | 'isBrowseUsersDisabled' | 'userPickerOptions' | 'isSubmitShareDisabled' | 'additionalUserFields' | 'isExtendedShareDialogEnabled' | 'CustomSubmitButton'> & {
23
25
  config?: ConfigResponse;
24
26
  isFetchingConfig?: boolean;
25
27
  children?: RenderCustomTriggerButton;
@@ -79,6 +79,7 @@ export declare const ShareDialogContainer: React.ForwardRefExoticComponent<Omit<
79
79
  originTracingFactory?: OriginTracingFactory | undefined;
80
80
  productId?: import("../types").ProductId | undefined;
81
81
  renderCustomTriggerButton?: import("../types").RenderCustomTriggerButton | undefined;
82
+ customTriggerButtonIcon?: React.ComponentType<import("@atlaskit/icon").NewCoreIconProps> | undefined;
82
83
  shareAri?: string | undefined;
83
84
  shareContentType?: string | undefined;
84
85
  shareContentSubType?: string | undefined;
@@ -53,6 +53,8 @@ export type ShareDialogContainerProps = {
53
53
  productId: ProductId;
54
54
  /** Render function for a custom Share Dialog Trigger Button. */
55
55
  renderCustomTriggerButton?: RenderCustomTriggerButton;
56
+ /** An Icon used for the custom Share Dialog Trigger Button */
57
+ customTriggerButtonIcon?: React.ComponentType<NewCoreIconProps>;
56
58
  /** Atlassian Resource Identifier of a Site resource to be shared. */
57
59
  shareAri: string;
58
60
  /** Content Type of the resource to be shared. It will also affect on the successful share message in the flag. A pre-defined list as follows:*/
@@ -1,5 +1,6 @@
1
1
  /// <reference types="react" />
2
2
  import type { AnalyticsEventPayload } from '@atlaskit/analytics-next';
3
+ import { type NewCoreIconProps } from '@atlaskit/icon';
3
4
  import type { Placement } from '@atlaskit/popper';
4
5
  import type { TriggerProps } from '@atlaskit/popup';
5
6
  import type { ConfigResponse } from '../clients/ShareServiceClient';
@@ -12,6 +13,7 @@ export type RenderCustomTriggerButton = (args: {
12
13
  isDisabled?: boolean;
13
14
  isSelected?: boolean;
14
15
  onClick: () => void;
16
+ iconBefore?: React.ComponentType<NewCoreIconProps>;
15
17
  }, triggerProps: TriggerProps) => React.ReactNode;
16
18
  export type DialogPlacement = Placement;
17
19
  /**
@@ -19,7 +21,7 @@ export type DialogPlacement = Placement;
19
21
  * with the demo page and clearly visible options on that page.
20
22
  */
21
23
  export type DialogBoundariesElement = 'viewport' | 'window' | 'scrollParent';
22
- export type ShareDialogWithTriggerProps = Pick<ShareDialogContainerProps, 'onTriggerButtonClick' | 'isAutoOpenDialog' | 'shouldCloseOnEscapePress' | 'dialogPlacement' | 'loadUserOptions' | 'onDialogOpen' | 'onDialogClose' | 'onUserSelectionChange' | 'renderCustomTriggerButton' | 'shareContentType' | 'shareContentSubType' | 'shareContentId' | 'shareFormTitle' | 'shareFormHelperMessage' | 'showFlags' | 'enableSmartUserPicker' | 'loggedInAccountId' | 'triggerButtonAppearance' | 'triggerButtonIcon' | 'triggerButtonStyle' | 'triggerButtonTooltipPosition' | 'triggerButtonTooltipText' | 'cloudId' | 'bottomMessage' | 'product' | 'productAttributes' | 'customHeader' | 'customFooter' | 'isCopyDisabled' | 'isPublicLink' | 'integrationMode' | 'isMenuItemSelected' | 'shareFieldsFooter' | 'shareIntegrations' | 'additionalTabs' | 'builtInTabContentWidth' | 'shareAri' | 'tabIndex' | 'copyTooltipText' | 'dialogZIndex' | 'orgId' | 'isBrowseUsersDisabled' | 'userPickerOptions' | 'isSubmitShareDisabled' | 'additionalUserFields' | 'isExtendedShareDialogEnabled' | 'CustomSubmitButton'> & {
24
+ export type ShareDialogWithTriggerProps = Pick<ShareDialogContainerProps, 'onTriggerButtonClick' | 'isAutoOpenDialog' | 'shouldCloseOnEscapePress' | 'dialogPlacement' | 'loadUserOptions' | 'onDialogOpen' | 'onDialogClose' | 'onUserSelectionChange' | 'renderCustomTriggerButton' | 'customTriggerButtonIcon' | 'shareContentType' | 'shareContentSubType' | 'shareContentId' | 'shareFormTitle' | 'shareFormHelperMessage' | 'showFlags' | 'enableSmartUserPicker' | 'loggedInAccountId' | 'triggerButtonAppearance' | 'triggerButtonIcon' | 'triggerButtonStyle' | 'triggerButtonTooltipPosition' | 'triggerButtonTooltipText' | 'cloudId' | 'bottomMessage' | 'product' | 'productAttributes' | 'customHeader' | 'customFooter' | 'isCopyDisabled' | 'isPublicLink' | 'integrationMode' | 'isMenuItemSelected' | 'shareFieldsFooter' | 'shareIntegrations' | 'additionalTabs' | 'builtInTabContentWidth' | 'shareAri' | 'tabIndex' | 'copyTooltipText' | 'dialogZIndex' | 'orgId' | 'isBrowseUsersDisabled' | 'userPickerOptions' | 'isSubmitShareDisabled' | 'additionalUserFields' | 'isExtendedShareDialogEnabled' | 'CustomSubmitButton'> & {
23
25
  config?: ConfigResponse;
24
26
  isFetchingConfig?: boolean;
25
27
  children?: RenderCustomTriggerButton;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/share",
3
- "version": "6.15.1",
3
+ "version": "6.16.0",
4
4
  "description": "Fabric Share Element",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -56,7 +56,7 @@
56
56
  "@atlaskit/tabs": "^18.1.0",
57
57
  "@atlaskit/textarea": "^8.0.0",
58
58
  "@atlaskit/theme": "^19.0.0",
59
- "@atlaskit/tokens": "^5.4.0",
59
+ "@atlaskit/tokens": "^5.5.0",
60
60
  "@atlaskit/tooltip": "^20.3.0",
61
61
  "@atlaskit/ufo": "^0.4.0",
62
62
  "@atlaskit/user-picker": "^11.3.0",