@elliemae/ds-tooltip 2.3.2 → 2.4.0-rc.1

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.
@@ -2,28 +2,28 @@
2
2
 
3
3
  Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
- var reactDesc = require('react-desc');
5
+ var dsPropsHelpers = require('@elliemae/ds-props-helpers');
6
6
  var constants = require('./constants.js');
7
7
 
8
8
  const propTypes = {
9
- text: reactDesc.PropTypes.string.description('Tooltip text to be displayed on hover/focus').isRequired,
10
- textAlign: reactDesc.PropTypes.oneOf(constants.TEXT_ALIGNMENT).description('Tooltip text alignment').defaultValue('left'),
11
- wrapWords: reactDesc.PropTypes.bool.description('Break words into a new line. Useful when words exceed tooltip max-lenght.').defaultValue(false),
12
- children: reactDesc.PropTypes.node.description('Element to tie the tooltip to, must be a single node').isRequired,
13
- withoutPortal: reactDesc.PropTypes.bool.description('Whether or not the tooltip content should appear in a DOM portal or not').defaultValue(true),
14
- withoutArrow: reactDesc.PropTypes.bool.description('Whether or not the tooltip should use the arrow').defaultValue(false),
15
- boundaryElement: reactDesc.PropTypes.element.description('Bounding element to calculate upon, defaults to "clippingParents",' + 'which are the scrolling containers that may cause element to be partially or fully cut off').defaultValue(undefined),
16
- withoutAnimation: reactDesc.PropTypes.bool.description('Whether or not the popper context menu should be animated').defaultValue(false),
17
- animationDuration: reactDesc.PropTypes.number.description('Popper context menus Animation duration in ms').defaultValue(100),
18
- portalDOMContainer: reactDesc.PropTypes.element.description('When using portal, the container in which to append the DOM content, defaults to document body').defaultValue(undefined),
19
- startPlacementPreference: reactDesc.PropTypes.oneOf(constants.PLACEMENT).description('start placement preferences, as per popperjs placement option').defaultValue("'top'"),
20
- placementOrderPreference: reactDesc.PropTypes.arrayOf(reactDesc.PropTypes.oneOf(constants.PLACEMENT)).description('Array of placement preferences, as per popperjs "flip" placement option').defaultValue("['top', 'bottom', 'left', 'right']"),
21
- zIndex: reactDesc.PropTypes.number.description('popperjs content z-index').defaultValue(1),
22
- customOffset: reactDesc.PropTypes.arrayOf(reactDesc.PropTypes.number).description('placement offset array').defaultValue([0, 14]),
23
- modifiers: reactDesc.PropTypes.array.description('modifiers array for full-custom tooltip-js override, https://tooltip.js.org/docs/v2/modifiers/').defaultValue(1),
24
- id: reactDesc.PropTypes.string.description('Optional id appended to data-testid').defaultValue(''),
25
- onOpen: reactDesc.PropTypes.func.description('Optional callback to be invoked when the tooltip opens').defaultValue('() => {}'),
26
- onClose: reactDesc.PropTypes.func.description('Optional callback to be invoked when the tooltip closes').defaultValue('() => {}')
9
+ text: dsPropsHelpers.PropTypes.string.description('Tooltip text to be displayed on hover/focus').isRequired,
10
+ textAlign: dsPropsHelpers.PropTypes.oneOf(constants.TEXT_ALIGNMENT).description('Tooltip text alignment').defaultValue('left'),
11
+ wrapWords: dsPropsHelpers.PropTypes.bool.description('Break words into a new line. Useful when words exceed tooltip max-lenght.').defaultValue(false),
12
+ children: dsPropsHelpers.PropTypes.node.description('Element to tie the tooltip to, must be a single node').isRequired,
13
+ withoutPortal: dsPropsHelpers.PropTypes.bool.description('Whether or not the tooltip content should appear in a DOM portal or not').defaultValue(true),
14
+ withoutArrow: dsPropsHelpers.PropTypes.bool.description('Whether or not the tooltip should use the arrow').defaultValue(false),
15
+ boundaryElement: dsPropsHelpers.PropTypes.element.description('Bounding element to calculate upon, defaults to "clippingParents",' + 'which are the scrolling containers that may cause element to be partially or fully cut off').defaultValue(undefined),
16
+ withoutAnimation: dsPropsHelpers.PropTypes.bool.description('Whether or not the popper context menu should be animated').defaultValue(false),
17
+ animationDuration: dsPropsHelpers.PropTypes.number.description('Popper context menus Animation duration in ms').defaultValue(100),
18
+ portalDOMContainer: dsPropsHelpers.PropTypes.element.description('When using portal, the container in which to append the DOM content, defaults to document body').defaultValue(undefined),
19
+ startPlacementPreference: dsPropsHelpers.PropTypes.oneOf(constants.PLACEMENT).description('start placement preferences, as per popperjs placement option').defaultValue("'top'"),
20
+ placementOrderPreference: dsPropsHelpers.PropTypes.arrayOf(dsPropsHelpers.PropTypes.oneOf(constants.PLACEMENT)).description('Array of placement preferences, as per popperjs "flip" placement option').defaultValue("['top', 'bottom', 'left', 'right']"),
21
+ zIndex: dsPropsHelpers.PropTypes.number.description('popperjs content z-index').defaultValue(1),
22
+ customOffset: dsPropsHelpers.PropTypes.arrayOf(dsPropsHelpers.PropTypes.number).description('placement offset array').defaultValue([0, 14]),
23
+ modifiers: dsPropsHelpers.PropTypes.array.description('modifiers array for full-custom tooltip-js override, https://tooltip.js.org/docs/v2/modifiers/').defaultValue(1),
24
+ id: dsPropsHelpers.PropTypes.string.description('Optional id appended to data-testid').defaultValue(''),
25
+ onOpen: dsPropsHelpers.PropTypes.func.description('Optional callback to be invoked when the tooltip opens').defaultValue('() => {}'),
26
+ onClose: dsPropsHelpers.PropTypes.func.description('Optional callback to be invoked when the tooltip closes').defaultValue('() => {}')
27
27
  };
28
28
 
29
29
  exports.propTypes = propTypes;
@@ -1,4 +1,4 @@
1
- import { PropTypes } from 'react-desc';
1
+ import { PropTypes } from '@elliemae/ds-props-helpers';
2
2
  import { TEXT_ALIGNMENT, PLACEMENT } from './constants.js';
3
3
 
4
4
  const propTypes = {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@elliemae/ds-tooltip",
3
- "version": "2.3.2",
3
+ "version": "2.4.0-rc.1",
4
4
  "license": "MIT",
5
5
  "description": "ICE MT - Dimsum - Tooltip",
6
6
  "module": "./esm/index.js",
@@ -104,15 +104,15 @@
104
104
  "build": "node ../../scripts/build/build.js"
105
105
  },
106
106
  "dependencies": {
107
- "@elliemae/ds-button": "2.3.2",
108
- "@elliemae/ds-classnames": "2.3.2",
109
- "@elliemae/ds-popper": "2.3.2",
110
- "@elliemae/ds-popperjs": "2.3.2",
111
- "@elliemae/ds-portal": "2.3.2",
112
- "@elliemae/ds-props-helpers": "2.3.2",
113
- "@elliemae/ds-shared": "2.3.2",
114
- "@elliemae/ds-system": "2.3.2",
115
- "@elliemae/ds-utilities": "2.3.2",
107
+ "@elliemae/ds-button": "2.4.0-rc.1",
108
+ "@elliemae/ds-classnames": "2.4.0-rc.1",
109
+ "@elliemae/ds-popper": "2.4.0-rc.1",
110
+ "@elliemae/ds-popperjs": "2.4.0-rc.1",
111
+ "@elliemae/ds-portal": "2.4.0-rc.1",
112
+ "@elliemae/ds-props-helpers": "2.4.0-rc.1",
113
+ "@elliemae/ds-shared": "2.4.0-rc.1",
114
+ "@elliemae/ds-system": "2.4.0-rc.1",
115
+ "@elliemae/ds-utilities": "2.4.0-rc.1",
116
116
  "@popperjs/core": "~2.9.2",
117
117
  "react-desc": "~4.1.3",
118
118
  "react-popper": "~2.2.5"
@@ -1,61 +1,6 @@
1
- /// <reference path="../../../../../shared/typings/react-desc.d.ts" />
2
- /// <reference types="react" />
1
+ import React from 'react';
3
2
  import type { DSTooltipV3T } from './propTypes';
4
- declare const DSTooltipV3: {
5
- (props: DSTooltipV3T.Props): JSX.Element;
6
- propTypes: {
7
- text: import("react-desc").PropTypesDescValue;
8
- textAlign: {
9
- deprecated: import("react-desc").PropTypesDescValidator;
10
- };
11
- wrapWords: {
12
- deprecated: import("react-desc").PropTypesDescValidator;
13
- };
14
- children: import("react-desc").PropTypesDescValue;
15
- withoutPortal: {
16
- deprecated: import("react-desc").PropTypesDescValidator;
17
- };
18
- withoutArrow: {
19
- deprecated: import("react-desc").PropTypesDescValidator;
20
- };
21
- boundaryElement: {
22
- deprecated: import("react-desc").PropTypesDescValidator;
23
- };
24
- withoutAnimation: {
25
- deprecated: import("react-desc").PropTypesDescValidator;
26
- };
27
- animationDuration: {
28
- deprecated: import("react-desc").PropTypesDescValidator;
29
- };
30
- portalDOMContainer: {
31
- deprecated: import("react-desc").PropTypesDescValidator;
32
- };
33
- startPlacementPreference: {
34
- deprecated: import("react-desc").PropTypesDescValidator;
35
- };
36
- placementOrderPreference: {
37
- deprecated: import("react-desc").PropTypesDescValidator;
38
- };
39
- zIndex: {
40
- deprecated: import("react-desc").PropTypesDescValidator;
41
- };
42
- customOffset: {
43
- deprecated: import("react-desc").PropTypesDescValidator;
44
- };
45
- modifiers: {
46
- deprecated: import("react-desc").PropTypesDescValidator;
47
- };
48
- id: {
49
- deprecated: import("react-desc").PropTypesDescValidator;
50
- };
51
- onOpen: {
52
- deprecated: import("react-desc").PropTypesDescValidator;
53
- };
54
- onClose: {
55
- deprecated: import("react-desc").PropTypesDescValidator;
56
- };
57
- };
58
- };
3
+ declare const DSTooltipV3: React.ComponentType<DSTooltipV3T.Props>;
59
4
  declare const DSTooltipV3WithSchema: import("@elliemae/ds-props-helpers/types/propTypes/types").DocumentedReactComponent<DSTooltipV3T.Props>;
60
5
  export { DSTooltipV3, DSTooltipV3WithSchema };
61
6
  export default DSTooltipV3;
@@ -1,5 +1,4 @@
1
- /// <reference path="../../../../../shared/typings/react-desc.d.ts" />
2
- /// <reference types="react" />
1
+ import { WeakValidationMap } from 'react';
3
2
  import { PLACEMENT, TEXT_ALIGNMENT } from './constants';
4
3
  export declare namespace DSTooltipV3T {
5
4
  type Placement = typeof PLACEMENT[number];
@@ -33,55 +32,4 @@ export declare namespace DSTooltipV3T {
33
32
  interface InternalProps extends DefaultProps, PropsRequired, PropsOptional {
34
33
  }
35
34
  }
36
- export declare const propTypes: {
37
- text: import("react-desc").PropTypesDescValue;
38
- textAlign: {
39
- deprecated: import("react-desc").PropTypesDescValidator;
40
- };
41
- wrapWords: {
42
- deprecated: import("react-desc").PropTypesDescValidator;
43
- };
44
- children: import("react-desc").PropTypesDescValue;
45
- withoutPortal: {
46
- deprecated: import("react-desc").PropTypesDescValidator;
47
- };
48
- withoutArrow: {
49
- deprecated: import("react-desc").PropTypesDescValidator;
50
- };
51
- boundaryElement: {
52
- deprecated: import("react-desc").PropTypesDescValidator;
53
- };
54
- withoutAnimation: {
55
- deprecated: import("react-desc").PropTypesDescValidator;
56
- };
57
- animationDuration: {
58
- deprecated: import("react-desc").PropTypesDescValidator;
59
- };
60
- portalDOMContainer: {
61
- deprecated: import("react-desc").PropTypesDescValidator;
62
- };
63
- startPlacementPreference: {
64
- deprecated: import("react-desc").PropTypesDescValidator;
65
- };
66
- placementOrderPreference: {
67
- deprecated: import("react-desc").PropTypesDescValidator;
68
- };
69
- zIndex: {
70
- deprecated: import("react-desc").PropTypesDescValidator;
71
- };
72
- customOffset: {
73
- deprecated: import("react-desc").PropTypesDescValidator;
74
- };
75
- modifiers: {
76
- deprecated: import("react-desc").PropTypesDescValidator;
77
- };
78
- id: {
79
- deprecated: import("react-desc").PropTypesDescValidator;
80
- };
81
- onOpen: {
82
- deprecated: import("react-desc").PropTypesDescValidator;
83
- };
84
- onClose: {
85
- deprecated: import("react-desc").PropTypesDescValidator;
86
- };
87
- };
35
+ export declare const propTypes: WeakValidationMap<unknown>;