@instructure/ui-tree-browser 10.25.1-snapshot-4 → 10.25.1-snapshot-5

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.
Files changed (43) hide show
  1. package/CHANGELOG.md +5 -2
  2. package/es/TreeBrowser/TreeBrowserContext.js +39 -0
  3. package/es/TreeBrowser/TreeButton/index.js +10 -5
  4. package/es/TreeBrowser/TreeButton/styles.js +12 -9
  5. package/es/TreeBrowser/TreeCollection/index.js +10 -5
  6. package/es/TreeBrowser/TreeCollection/styles.js +9 -7
  7. package/es/TreeBrowser/TreeNode/index.js +10 -5
  8. package/es/TreeBrowser/index.js +17 -10
  9. package/es/TreeBrowser/props.js +3 -2
  10. package/lib/TreeBrowser/TreeBrowserContext.js +44 -0
  11. package/lib/TreeBrowser/TreeButton/index.js +10 -5
  12. package/lib/TreeBrowser/TreeButton/styles.js +12 -9
  13. package/lib/TreeBrowser/TreeCollection/index.js +10 -5
  14. package/lib/TreeBrowser/TreeCollection/styles.js +9 -7
  15. package/lib/TreeBrowser/TreeNode/index.js +10 -5
  16. package/lib/TreeBrowser/index.js +17 -10
  17. package/lib/TreeBrowser/props.js +3 -2
  18. package/package.json +13 -13
  19. package/src/TreeBrowser/TreeBrowserContext.ts +49 -0
  20. package/src/TreeBrowser/TreeButton/index.tsx +7 -3
  21. package/src/TreeBrowser/TreeButton/styles.ts +19 -12
  22. package/src/TreeBrowser/TreeCollection/index.tsx +7 -3
  23. package/src/TreeBrowser/TreeCollection/styles.ts +12 -7
  24. package/src/TreeBrowser/TreeNode/index.tsx +7 -3
  25. package/src/TreeBrowser/index.tsx +19 -11
  26. package/src/TreeBrowser/props.ts +8 -2
  27. package/tsconfig.build.tsbuildinfo +1 -1
  28. package/types/TreeBrowser/TreeBrowserContext.d.ts +20 -0
  29. package/types/TreeBrowser/TreeBrowserContext.d.ts.map +1 -0
  30. package/types/TreeBrowser/TreeButton/index.d.ts +4 -1
  31. package/types/TreeBrowser/TreeButton/index.d.ts.map +1 -1
  32. package/types/TreeBrowser/TreeButton/styles.d.ts +4 -1
  33. package/types/TreeBrowser/TreeButton/styles.d.ts.map +1 -1
  34. package/types/TreeBrowser/TreeCollection/index.d.ts +4 -1
  35. package/types/TreeBrowser/TreeCollection/index.d.ts.map +1 -1
  36. package/types/TreeBrowser/TreeCollection/styles.d.ts +3 -1
  37. package/types/TreeBrowser/TreeCollection/styles.d.ts.map +1 -1
  38. package/types/TreeBrowser/TreeNode/index.d.ts +4 -1
  39. package/types/TreeBrowser/TreeNode/index.d.ts.map +1 -1
  40. package/types/TreeBrowser/index.d.ts +3 -2
  41. package/types/TreeBrowser/index.d.ts.map +1 -1
  42. package/types/TreeBrowser/props.d.ts +4 -0
  43. package/types/TreeBrowser/props.d.ts.map +1 -1
@@ -0,0 +1,49 @@
1
+ /*
2
+ * The MIT License (MIT)
3
+ *
4
+ * Copyright (c) 2015 - present Instructure, Inc.
5
+ *
6
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ * of this software and associated documentation files (the "Software"), to deal
8
+ * in the Software without restriction, including without limitation the rights
9
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
+ * copies of the Software, and to permit persons to whom the Software is
11
+ * furnished to do so, subject to the following conditions:
12
+ *
13
+ * The above copyright notice and this permission notice shall be included in all
14
+ * copies or substantial portions of the Software.
15
+ *
16
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22
+ * SOFTWARE.
23
+ */
24
+
25
+ import { createContext } from 'react'
26
+
27
+ type TreeBrowserContextType = {
28
+ /**
29
+ * Whether to enable animation for the TreeBrowser
30
+ */
31
+ animation?: boolean
32
+ }
33
+
34
+ /**
35
+ * ---
36
+ * category: utilities/react
37
+ * ---
38
+ * React context created by the `TreeBrowser` component to hold its data which are
39
+ * read by its children.
40
+ *
41
+ * @module
42
+ */
43
+ const TreeBrowserContext = createContext<TreeBrowserContextType>({
44
+ animation: true
45
+ })
46
+
47
+ export default TreeBrowserContext
48
+ export { TreeBrowserContext }
49
+ export type { TreeBrowserContextType }
@@ -22,7 +22,7 @@
22
22
  * SOFTWARE.
23
23
  */
24
24
 
25
- import { Component } from 'react'
25
+ import { Component, ContextType } from 'react'
26
26
 
27
27
  import { testable } from '@instructure/ui-testable'
28
28
  import { Img } from '@instructure/ui-img'
@@ -33,6 +33,7 @@ import generateStyles from './styles'
33
33
  import generateComponentTheme from './theme'
34
34
  import type { TreeBrowserButtonProps } from './props'
35
35
  import { allowedProps, propTypes } from './props'
36
+ import TreeBrowserContext from '../TreeBrowserContext'
36
37
 
37
38
  // Todo: merge TreeButton and TreeNode: TreeButton should be a special type of TreeNode
38
39
 
@@ -50,6 +51,9 @@ class TreeButton extends Component<TreeBrowserButtonProps> {
50
51
  static allowedProps = allowedProps
51
52
  static propTypes = propTypes
52
53
 
54
+ static contextType = TreeBrowserContext
55
+ declare context: ContextType<typeof TreeBrowserContext>
56
+
53
57
  static defaultProps = {
54
58
  type: 'treeButton',
55
59
  size: 'medium',
@@ -62,11 +66,11 @@ class TreeButton extends Component<TreeBrowserButtonProps> {
62
66
  ref: Element | null = null
63
67
 
64
68
  componentDidMount() {
65
- this.props.makeStyles?.()
69
+ this.props.makeStyles?.({ animation: this.context?.animation })
66
70
  }
67
71
 
68
72
  componentDidUpdate() {
69
- this.props.makeStyles?.()
73
+ this.props.makeStyles?.({ animation: this.context?.animation })
70
74
  }
71
75
 
72
76
  defaultContentRenderer(props: TreeBrowserButtonProps) {
@@ -45,11 +45,13 @@ const transform = keyframes`
45
45
  * Generates the style object from the theme and provided additional information
46
46
  * @param {Object} componentTheme The theme variable object.
47
47
  * @param {Object} props the props of the component, the style is applied to
48
+ * @param {Object} state the state of the component, the style is applied to
48
49
  * @return {Object} The final style object, which will be used in the component
49
50
  */
50
51
  const generateStyles = (
51
52
  componentTheme: TreeBrowserButtonTheme,
52
- props: TreeBrowserButtonProps
53
+ props: TreeBrowserButtonProps,
54
+ state: { animation?: boolean }
53
55
  ): TreeBrowserButtonStyle => {
54
56
  const { size, variant, selected, focused, level } = props
55
57
 
@@ -226,14 +228,18 @@ const generateStyles = (
226
228
  borderRadius: componentTheme.borderRadius,
227
229
  position: 'relative',
228
230
  zIndex: 1,
229
- transform: 'translate3d(-2%, 0, 0)',
230
- opacity: 0.01,
231
- transformOrigin: 'left center',
232
- animationName: transform,
233
- animationDuration: '0.2s',
234
- animationFillMode: 'forwards',
235
- animationTimingFunction: 'ease-out',
236
- animationDelay: '0.2s',
231
+ ...(state.animation
232
+ ? {
233
+ transform: 'translate3d(-2%, 0, 0)',
234
+ opacity: 0.01,
235
+ transformOrigin: 'left center',
236
+ animationName: transform,
237
+ animationDuration: '0.2s',
238
+ animationFillMode: 'forwards',
239
+ animationTimingFunction: 'ease-out',
240
+ animationDelay: '0.2s'
241
+ }
242
+ : {}),
237
243
  outline: '0',
238
244
  padding: '0',
239
245
  ...(variant === 'folderTree' &&
@@ -278,9 +284,10 @@ const generateStyles = (
278
284
  ? componentTheme.selectedBackgroundColor
279
285
  : componentTheme.hoverBackgroundColor,
280
286
 
281
- '[class$=-treeButton__textName], [class$=-treeButton__textDescriptor], [class$=-treeButton__icon], [class$=-treeButton__node]': {
282
- color: componentTheme.hoverTextColor
283
- }
287
+ '[class$=-treeButton__textName], [class$=-treeButton__textDescriptor], [class$=-treeButton__icon], [class$=-treeButton__node]':
288
+ {
289
+ color: componentTheme.hoverTextColor
290
+ }
284
291
  },
285
292
  ...(selected && {
286
293
  backgroundColor: componentTheme.selectedBackgroundColor
@@ -22,7 +22,7 @@
22
22
  * SOFTWARE.
23
23
  */
24
24
 
25
- import { Component, ReactElement, SyntheticEvent } from 'react'
25
+ import { Component, ContextType, ReactElement, SyntheticEvent } from 'react'
26
26
 
27
27
  import { testable } from '@instructure/ui-testable'
28
28
  import { withStyle } from '@instructure/emotion'
@@ -36,6 +36,7 @@ import type { TreeBrowserCollectionProps, TreeCollectionState } from './props'
36
36
  import type { CompareObject } from '../props'
37
37
  import { allowedProps, propTypes } from './props'
38
38
  import { CollectionItem, CollectionProps, CollectionData } from '../props'
39
+ import TreeBrowserContext from '../TreeBrowserContext'
39
40
 
40
41
  type AriaSelectedType = { 'aria-selected'?: boolean }
41
42
 
@@ -56,6 +57,9 @@ class TreeCollection extends Component<
56
57
  static allowedProps = allowedProps
57
58
  static propTypes = propTypes
58
59
 
60
+ static contextType = TreeBrowserContext
61
+ declare context: ContextType<typeof TreeBrowserContext>
62
+
59
63
  static defaultProps = {
60
64
  collections: [],
61
65
  items: [],
@@ -76,10 +80,10 @@ class TreeCollection extends Component<
76
80
  }
77
81
 
78
82
  componentDidMount() {
79
- this.props.makeStyles?.()
83
+ this.props.makeStyles?.({ animation: this.context?.animation })
80
84
  }
81
85
  componentDidUpdate() {
82
- this.props.makeStyles?.()
86
+ this.props.makeStyles?.({ animation: this.context?.animation })
83
87
  }
84
88
 
85
89
  get itemsLevel() {
@@ -48,7 +48,8 @@ const list = keyframes`
48
48
 
49
49
  const generateStyles = (
50
50
  componentTheme: TreeBrowserCollectionTheme,
51
- props: TreeBrowserCollectionProps
51
+ props: TreeBrowserCollectionProps,
52
+ state: { animation?: boolean }
52
53
  ): TreeBrowserCollectionStyle => {
53
54
  const { size, variant } = props
54
55
  const sizeMap = {
@@ -115,12 +116,16 @@ const generateStyles = (
115
116
  bottom: '1.1875rem',
116
117
  insetInlineStart: '0',
117
118
  insetInlineEnd: 'auto',
118
- transform: 'scaleY(0.01)',
119
- transformOrigin: 'center top',
120
- animationName: list,
121
- animationDuration: '0.2s',
122
- animationFillMode: 'forwards',
123
- animationTimingFunction: 'ease-out',
119
+ ...(state.animation
120
+ ? {
121
+ transform: 'scaleY(0.01)',
122
+ transformOrigin: 'center top',
123
+ animationName: list,
124
+ animationDuration: '0.2s',
125
+ animationFillMode: 'forwards',
126
+ animationTimingFunction: 'ease-out'
127
+ }
128
+ : {}),
124
129
  pointerEvents: 'none',
125
130
  width: componentTheme.borderWidth,
126
131
  background: componentTheme.borderColor
@@ -22,7 +22,7 @@
22
22
  * SOFTWARE.
23
23
  */
24
24
 
25
- import { Component } from 'react'
25
+ import { Component, ContextType } from 'react'
26
26
 
27
27
  import { Img } from '@instructure/ui-img'
28
28
  import { callRenderProp } from '@instructure/ui-react-utils'
@@ -33,6 +33,7 @@ import generateStyles from '../TreeButton/styles'
33
33
  import generateComponentTheme from '../TreeButton/theme'
34
34
  import type { TreeBrowserNodeProps } from './props'
35
35
  import { allowedProps, propTypes } from './props'
36
+ import TreeBrowserContext from '../TreeBrowserContext'
36
37
 
37
38
  // Todo: merge TreeButton and TreeNode: TreeButton should be a special type of TreeNode
38
39
 
@@ -52,6 +53,9 @@ class TreeNode extends Component<TreeBrowserNodeProps> {
52
53
  static allowedProps = allowedProps
53
54
  static propTypes = propTypes
54
55
 
56
+ static contextType = TreeBrowserContext
57
+ declare context: ContextType<typeof TreeBrowserContext>
58
+
55
59
  static defaultProps = {
56
60
  size: 'medium',
57
61
  variant: 'folderTree',
@@ -62,11 +66,11 @@ class TreeNode extends Component<TreeBrowserNodeProps> {
62
66
  ref: Element | null = null
63
67
 
64
68
  componentDidMount() {
65
- this.props.makeStyles?.()
69
+ this.props.makeStyles?.({ animation: this.context?.animation })
66
70
  }
67
71
 
68
72
  componentDidUpdate() {
69
- this.props.makeStyles?.()
73
+ this.props.makeStyles?.({ animation: this.context?.animation })
70
74
  }
71
75
 
72
76
  handleRef = (el: HTMLDivElement) => {
@@ -45,6 +45,7 @@ import type {
45
45
  TreeBrowserState
46
46
  } from './props'
47
47
  import { allowedProps, propTypes } from './props'
48
+ import TreeBrowserContext from './TreeBrowserContext'
48
49
 
49
50
  /**
50
51
  ---
@@ -72,7 +73,8 @@ class TreeBrowser extends Component<TreeBrowserProps, TreeBrowserState> {
72
73
  selectionType: 'none',
73
74
  sortOrder: function () {
74
75
  return 0
75
- }
76
+ },
77
+ animation: true
76
78
  }
77
79
 
78
80
  static Node = TreeNode
@@ -364,18 +366,24 @@ class TreeBrowser extends Component<TreeBrowserProps, TreeBrowserState> {
364
366
  const { styles } = this.props
365
367
 
366
368
  return (
367
- <ul
368
- css={styles?.treeBrowser}
369
- tabIndex={0}
370
- role="tree"
371
- onKeyDown={this.handleKeyDown}
372
- ref={(el) => {
373
- this.ref = el
369
+ <TreeBrowserContext.Provider
370
+ value={{
371
+ animation: this.props.animation
374
372
  }}
375
- aria-label={this.props.treeLabel}
376
373
  >
377
- {this.renderRoot()}
378
- </ul>
374
+ <ul
375
+ css={styles?.treeBrowser}
376
+ tabIndex={0}
377
+ role="tree"
378
+ onKeyDown={this.handleKeyDown}
379
+ ref={(el) => {
380
+ this.ref = el
381
+ }}
382
+ aria-label={this.props.treeLabel}
383
+ >
384
+ {this.renderRoot()}
385
+ </ul>
386
+ </TreeBrowserContext.Provider>
379
387
  )
380
388
  }
381
389
  }
@@ -83,6 +83,10 @@ type TreeBrowserOwnProps = {
83
83
  * An optional compare function to specify order of the collections and the items
84
84
  */
85
85
  sortOrder?: (obj1: any, obj2: any) => number
86
+ /**
87
+ * Whether to enable animation for the TreeBrowser
88
+ */
89
+ animation?: boolean
86
90
  } & TreeBrowserBaseProps
87
91
 
88
92
  // props shared between TreeBrowser, TreeCollection
@@ -204,7 +208,8 @@ const propTypes: PropValidators<PropKeys> = {
204
208
  onItemClick: PropTypes.func,
205
209
  treeLabel: PropTypes.string,
206
210
  renderContent: PropTypes.func,
207
- sortOrder: PropTypes.func
211
+ sortOrder: PropTypes.func,
212
+ animation: PropTypes.bool
208
213
  }
209
214
 
210
215
  const allowedProps: AllowedPropKeys = [
@@ -227,7 +232,8 @@ const allowedProps: AllowedPropKeys = [
227
232
  'onItemClick',
228
233
  'treeLabel',
229
234
  'renderContent',
230
- 'sortOrder'
235
+ 'sortOrder',
236
+ 'animation'
231
237
  ]
232
238
 
233
239
  type TreeBrowserState = {