@tanstack/router-devtools 1.20.1 → 1.20.3-alpha.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.
Files changed (57) hide show
  1. package/README.md +3 -1
  2. package/dist/cjs/index.cjs +12 -3
  3. package/dist/cjs/index.cjs.map +1 -1
  4. package/dist/cjs/index.d.cts +2 -1
  5. package/dist/esm/index.d.ts +2 -1
  6. package/dist/esm/index.js +6 -3
  7. package/dist/esm/index.js.map +1 -1
  8. package/package.json +34 -34
  9. package/src/index.tsx +6 -1
  10. package/dist/cjs/Explorer.cjs +0 -306
  11. package/dist/cjs/Explorer.cjs.map +0 -1
  12. package/dist/cjs/Explorer.d.cts +0 -46
  13. package/dist/cjs/devtools.cjs +0 -1181
  14. package/dist/cjs/devtools.cjs.map +0 -1
  15. package/dist/cjs/devtools.d.cts +0 -65
  16. package/dist/cjs/logo.cjs +0 -1012
  17. package/dist/cjs/logo.cjs.map +0 -1
  18. package/dist/cjs/logo.d.cts +0 -2
  19. package/dist/cjs/theme.d.cts +0 -34
  20. package/dist/cjs/tokens.cjs +0 -302
  21. package/dist/cjs/tokens.cjs.map +0 -1
  22. package/dist/cjs/tokens.d.cts +0 -298
  23. package/dist/cjs/useLocalStorage.cjs +0 -45
  24. package/dist/cjs/useLocalStorage.cjs.map +0 -1
  25. package/dist/cjs/useLocalStorage.d.cts +0 -1
  26. package/dist/cjs/useMediaQuery.d.cts +0 -1
  27. package/dist/cjs/utils.cjs +0 -82
  28. package/dist/cjs/utils.cjs.map +0 -1
  29. package/dist/cjs/utils.d.cts +0 -23
  30. package/dist/esm/Explorer.d.ts +0 -46
  31. package/dist/esm/Explorer.js +0 -289
  32. package/dist/esm/Explorer.js.map +0 -1
  33. package/dist/esm/devtools.d.ts +0 -65
  34. package/dist/esm/devtools.js +0 -1181
  35. package/dist/esm/devtools.js.map +0 -1
  36. package/dist/esm/logo.d.ts +0 -2
  37. package/dist/esm/logo.js +0 -1012
  38. package/dist/esm/logo.js.map +0 -1
  39. package/dist/esm/theme.d.ts +0 -34
  40. package/dist/esm/tokens.d.ts +0 -298
  41. package/dist/esm/tokens.js +0 -302
  42. package/dist/esm/tokens.js.map +0 -1
  43. package/dist/esm/useLocalStorage.d.ts +0 -1
  44. package/dist/esm/useLocalStorage.js +0 -46
  45. package/dist/esm/useLocalStorage.js.map +0 -1
  46. package/dist/esm/useMediaQuery.d.ts +0 -1
  47. package/dist/esm/utils.d.ts +0 -23
  48. package/dist/esm/utils.js +0 -82
  49. package/dist/esm/utils.js.map +0 -1
  50. package/src/Explorer.tsx +0 -357
  51. package/src/devtools.tsx +0 -1401
  52. package/src/logo.tsx +0 -817
  53. package/src/theme.tsx +0 -31
  54. package/src/tokens.ts +0 -305
  55. package/src/useLocalStorage.ts +0 -52
  56. package/src/useMediaQuery.ts +0 -39
  57. package/src/utils.ts +0 -183
package/src/Explorer.tsx DELETED
@@ -1,357 +0,0 @@
1
- import * as React from 'react'
2
- import { clsx as cx } from 'clsx'
3
- import { tokens } from './tokens'
4
- import { displayValue, styled } from './utils'
5
- import { css } from 'goober'
6
-
7
- type ExpanderProps = {
8
- expanded: boolean
9
- style?: React.CSSProperties
10
- }
11
-
12
- export const Expander = ({ expanded, style = {} }: ExpanderProps) => (
13
- <span className={getStyles().expander}>
14
- <svg
15
- xmlns="http://www.w3.org/2000/svg"
16
- width="12"
17
- height="12"
18
- fill="none"
19
- viewBox="0 0 24 24"
20
- className={cx(getStyles().expanderIcon(expanded))}
21
- >
22
- <path
23
- stroke="currentColor"
24
- strokeLinecap="round"
25
- strokeLinejoin="round"
26
- strokeWidth="2"
27
- d="M9 18l6-6-6-6"
28
- ></path>
29
- </svg>
30
- </span>
31
- )
32
-
33
- type Entry = {
34
- label: string
35
- }
36
-
37
- type RendererProps = {
38
- handleEntry: HandleEntryFn
39
- label?: React.ReactNode
40
- value: unknown
41
- subEntries: Entry[]
42
- subEntryPages: Entry[][]
43
- type: string
44
- expanded: boolean
45
- toggleExpanded: () => void
46
- pageSize: number
47
- renderer?: Renderer
48
- filterSubEntries?: (subEntries: Property[]) => Property[]
49
- }
50
-
51
- /**
52
- * Chunk elements in the array by size
53
- *
54
- * when the array cannot be chunked evenly by size, the last chunk will be
55
- * filled with the remaining elements
56
- *
57
- * @example
58
- * chunkArray(['a','b', 'c', 'd', 'e'], 2) // returns [['a','b'], ['c', 'd'], ['e']]
59
- */
60
- export function chunkArray<T>(array: T[], size: number): T[][] {
61
- if (size < 1) return []
62
- let i = 0
63
- const result: T[][] = []
64
- while (i < array.length) {
65
- result.push(array.slice(i, i + size))
66
- i = i + size
67
- }
68
- return result
69
- }
70
-
71
- type Renderer = (props: RendererProps) => React.ReactNode
72
-
73
- export const DefaultRenderer: Renderer = ({
74
- handleEntry,
75
- label,
76
- value,
77
- subEntries = [],
78
- subEntryPages = [],
79
- type,
80
- expanded = false,
81
- toggleExpanded,
82
- pageSize,
83
- renderer,
84
- }) => {
85
- const [expandedPages, setExpandedPages] = React.useState<number[]>([])
86
- const [valueSnapshot, setValueSnapshot] = React.useState(undefined)
87
-
88
- const refreshValueSnapshot = () => {
89
- setValueSnapshot((value as () => any)())
90
- }
91
-
92
- return (
93
- <div className={getStyles().entry}>
94
- {subEntryPages.length ? (
95
- <>
96
- <button
97
- className={getStyles().expandButton}
98
- onClick={() => toggleExpanded()}
99
- >
100
- <Expander expanded={expanded} />
101
- {label}
102
- <span className={getStyles().info}>
103
- {String(type).toLowerCase() === 'iterable' ? '(Iterable) ' : ''}
104
- {subEntries.length} {subEntries.length > 1 ? `items` : `item`}
105
- </span>
106
- </button>
107
- {expanded ? (
108
- subEntryPages.length === 1 ? (
109
- <div className={getStyles().subEntries}>
110
- {subEntries.map((entry, index) => handleEntry(entry))}
111
- </div>
112
- ) : (
113
- <div className={getStyles().subEntries}>
114
- {subEntryPages.map((entries, index) => {
115
- return (
116
- <div key={index}>
117
- <div className={getStyles().entry}>
118
- <button
119
- className={cx(getStyles().labelButton, 'labelButton')}
120
- onClick={() =>
121
- setExpandedPages((old) =>
122
- old.includes(index)
123
- ? old.filter((d) => d !== index)
124
- : [...old, index],
125
- )
126
- }
127
- >
128
- <Expander expanded={expandedPages.includes(index)} />{' '}
129
- [{index * pageSize} ...{' '}
130
- {index * pageSize + pageSize - 1}]
131
- </button>
132
- {expandedPages.includes(index) ? (
133
- <div className={getStyles().subEntries}>
134
- {entries.map((entry) => handleEntry(entry))}
135
- </div>
136
- ) : null}
137
- </div>
138
- </div>
139
- )
140
- })}
141
- </div>
142
- )
143
- ) : null}
144
- </>
145
- ) : type === 'function' ? (
146
- <>
147
- <Explorer
148
- renderer={renderer}
149
- label={
150
- <button
151
- onClick={refreshValueSnapshot}
152
- className={getStyles().refreshValueBtn}
153
- >
154
- <span>{label}</span> 🔄{' '}
155
- </button>
156
- }
157
- value={valueSnapshot}
158
- defaultExpanded={{}}
159
- />
160
- </>
161
- ) : (
162
- <>
163
- <span>{label}:</span>{' '}
164
- <span className={getStyles().value}>{displayValue(value)}</span>
165
- </>
166
- )}
167
- </div>
168
- )
169
- }
170
-
171
- type HandleEntryFn = (entry: Entry) => React.ReactNode
172
-
173
- type ExplorerProps = Partial<RendererProps> & {
174
- renderer?: Renderer
175
- defaultExpanded?: true | Record<string, boolean>
176
- }
177
-
178
- type Property = {
179
- defaultExpanded?: boolean | Record<string, boolean>
180
- label: string
181
- value: unknown
182
- }
183
-
184
- function isIterable(x: any): x is Iterable<unknown> {
185
- return Symbol.iterator in x
186
- }
187
-
188
- export default function Explorer({
189
- value,
190
- defaultExpanded,
191
- renderer = DefaultRenderer,
192
- pageSize = 100,
193
- filterSubEntries,
194
- ...rest
195
- }: ExplorerProps) {
196
- const [expanded, setExpanded] = React.useState(Boolean(defaultExpanded))
197
- const toggleExpanded = React.useCallback(() => setExpanded((old) => !old), [])
198
-
199
- let type: string = typeof value
200
- let subEntries: Property[] = []
201
-
202
- const makeProperty = (sub: { label: string; value: unknown }): Property => {
203
- const subDefaultExpanded =
204
- defaultExpanded === true
205
- ? { [sub.label]: true }
206
- : defaultExpanded?.[sub.label]
207
- return {
208
- ...sub,
209
- defaultExpanded: subDefaultExpanded,
210
- }
211
- }
212
-
213
- if (Array.isArray(value)) {
214
- type = 'array'
215
- subEntries = value.map((d, i) =>
216
- makeProperty({
217
- label: i.toString(),
218
- value: d,
219
- }),
220
- )
221
- } else if (
222
- value !== null &&
223
- typeof value === 'object' &&
224
- isIterable(value) &&
225
- typeof value[Symbol.iterator] === 'function'
226
- ) {
227
- type = 'Iterable'
228
- subEntries = Array.from(value, (val, i) =>
229
- makeProperty({
230
- label: i.toString(),
231
- value: val,
232
- }),
233
- )
234
- } else if (typeof value === 'object' && value !== null) {
235
- type = 'object'
236
- subEntries = Object.entries(value).map(([key, val]) =>
237
- makeProperty({
238
- label: key,
239
- value: val,
240
- }),
241
- )
242
- }
243
-
244
- subEntries = filterSubEntries ? filterSubEntries(subEntries) : subEntries
245
-
246
- const subEntryPages = chunkArray(subEntries, pageSize)
247
-
248
- return renderer({
249
- handleEntry: (entry) => (
250
- <Explorer
251
- key={entry.label}
252
- value={value}
253
- renderer={renderer}
254
- filterSubEntries={filterSubEntries}
255
- {...rest}
256
- {...entry}
257
- />
258
- ),
259
- type,
260
- subEntries,
261
- subEntryPages,
262
- value,
263
- expanded,
264
- toggleExpanded,
265
- pageSize,
266
- ...rest,
267
- })
268
- }
269
-
270
- const stylesFactory = () => {
271
- const { colors, font, size, alpha, shadow, border } = tokens
272
- const { fontFamily, lineHeight, size: fontSize } = font
273
-
274
- return {
275
- entry: css`
276
- font-family: ${fontFamily.mono};
277
- font-size: ${fontSize.xs};
278
- line-height: ${lineHeight.sm};
279
- outline: none;
280
- word-break: break-word;
281
- `,
282
- labelButton: css`
283
- cursor: pointer;
284
- color: inherit;
285
- font: inherit;
286
- outline: inherit;
287
- background: transparent;
288
- border: none;
289
- padding: 0;
290
- `,
291
- expander: css`
292
- display: inline-flex;
293
- align-items: center;
294
- justify-content: center;
295
- width: ${size[3]};
296
- height: ${size[3]};
297
- padding-left: 3px;
298
- box-sizing: content-box;
299
- `,
300
- expanderIcon: (expanded: boolean) => {
301
- if (expanded) {
302
- return css`
303
- transform: rotate(90deg);
304
- transition: transform 0.1s ease;
305
- `
306
- }
307
- return css`
308
- transform: rotate(0deg);
309
- transition: transform 0.1s ease;
310
- `
311
- },
312
- expandButton: css`
313
- display: flex;
314
- gap: ${size[1]};
315
- align-items: center;
316
- cursor: pointer;
317
- color: inherit;
318
- font: inherit;
319
- outline: inherit;
320
- background: transparent;
321
- border: none;
322
- padding: 0;
323
- `,
324
- value: css`
325
- color: ${colors.purple[400]};
326
- `,
327
- subEntries: css`
328
- margin-left: ${size[2]};
329
- padding-left: ${size[2]};
330
- border-left: 2px solid ${colors.darkGray[400]};
331
- `,
332
- info: css`
333
- color: ${colors.gray[500]};
334
- font-size: ${fontSize['2xs']};
335
- padding-left: ${size[1]};
336
- `,
337
- refreshValueBtn: css`
338
- appearance: none;
339
- border: 0;
340
- cursor: pointer;
341
- background: transparent;
342
- color: inherit;
343
- padding: 0;
344
- font-family: ${fontFamily.mono};
345
- font-size: ${fontSize.xs};
346
- `,
347
- }
348
- }
349
-
350
- let _styles: ReturnType<typeof stylesFactory> | null = null
351
-
352
- function getStyles() {
353
- if (_styles) return _styles
354
- _styles = stylesFactory()
355
-
356
- return _styles
357
- }