Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

Explorer.tsx

261 lines6.2 KB

1import React from 'react'
2​
3import { displayValue, styled } from './utils'
4​
5export const Entry = styled('div', {
6 fontFamily: 'Menlo, monospace',
7 fontSize: '1em',
8 lineHeight: '1.7',
9 outline: 'none',
10 wordBreak: 'break-word',
11})
12​
13export const Label = styled('span', {
14 color: 'white',
15})
16​
17export const LabelButton = styled('button', {
18 cursor: 'pointer',
19 color: 'white',
20})
21​
22export const ExpandButton = styled('button', {
23 cursor: 'pointer',
24 color: 'inherit',
25 font: 'inherit',
26 outline: 'inherit',
27 background: 'transparent',
28 border: 'none',
29 padding: 0,
30})
31​
32export const Value = styled('span', (_props, theme) => ({
33 color: theme.danger,
34}))
35​
36export const SubEntries = styled('div', {
37 marginLeft: '.1em',
38 paddingLeft: '1em',
39 borderLeft: '2px solid rgba(0,0,0,.15)',
40})
41​
42export const Info = styled('span', {
43 color: 'grey',
44 fontSize: '.7em',
45})
46​
47type ExpanderProps = {
48 expanded: boolean
49 style?: React.CSSProperties
51​
52export const Expander = ({ expanded, style = {} }: ExpanderProps) => (
53 <span
54 style={{
55 display: 'inline-block',
56 transition: 'all .1s ease',
57 transform: `rotate(${expanded ? 90 : 0}deg) ${style.transform || ''}`,
58 ...style,
59 }}
60 >
61 β–Ά
62 </span>
64​
65type Entry = {
66 label: string
68​
69type RendererProps = {
70 HandleEntry: HandleEntryComponent
71 label?: string
72 value: unknown
73 subEntries: Entry[]
74 subEntryPages: Entry[][]
75 type: string
76 expanded: boolean
77 toggleExpanded: () => void
78 pageSize: number
80​
81/**
82 * Chunk elements in the array by size
83 *
84 * when the array cannot be chunked evenly by size, the last chunk will be
85 * filled with the remaining elements
86 *
87 * @example
88 * chunkArray(['a','b', 'c', 'd', 'e'], 2) // returns [['a','b'], ['c', 'd'], ['e']]
89 */
90export function chunkArray<T>(array: T[], size: number): T[][] {
91 if (size < 1) return []
92 let i = 0
93 const result: T[][] = []
94 while (i < array.length) {
95 result.push(array.slice(i, i + size))
96 i = i + size
97 }
98 return result
100​
101type Renderer = (props: RendererProps) => JSX.Element
102​
103export const DefaultRenderer: Renderer = ({
104 HandleEntry,
105 label,
106 value,
107 subEntries = [],
108 subEntryPages = [],
109 type,
110 expanded = false,
111 toggleExpanded,
112 pageSize,
113}) => {
114 const [expandedPages, setExpandedPages] = React.useState<number[]>([])
115​
116 return (
117 <Entry key={label}>
118 {subEntryPages?.length ? (
119 <>
120 <ExpandButton onClick={() => toggleExpanded()}>
121 <Expander expanded={expanded} /> {label}{' '}
122 <Info>
123 {String(type).toLowerCase() === 'iterable' ? '(Iterable) ' : ''}
124 {subEntries.length} {subEntries.length > 1 ? `items` : `item`}
125 </Info>
126 </ExpandButton>
127 {expanded ? (
128 subEntryPages.length === 1 ? (
129 <SubEntries>
130 {subEntries.map(entry => (
131 <HandleEntry key={entry.label} entry={entry} />
132 ))}
133 </SubEntries>
134 ) : (
135 <SubEntries>
136 {subEntryPages.map((entries, index) => (
137 <div key={index}>
138 <Entry>
139 <LabelButton
140 onClick={() =>
141 setExpandedPages(old =>
142 old.includes(index)
143 ? old.filter(d => d !== index)
144 : [...old, index]
145 )
146 }
147 >
148 <Expander expanded={expanded} /> [{index * pageSize} ...{' '}
149 {index * pageSize + pageSize - 1}]
150 </LabelButton>
151 {expandedPages.includes(index) ? (
152 <SubEntries>
153 {entries.map(entry => (
154 <HandleEntry key={entry.label} entry={entry} />
155 ))}
156 </SubEntries>
157 ) : null}
158 </Entry>
159 </div>
160 ))}
161 </SubEntries>
162 )
163 ) : null}
164 </>
165 ) : (
166 <>
167 <Label>{label}:</Label> <Value>{displayValue(value)}</Value>
168 </>
169 )}
170 </Entry>
171 )
173​
174type HandleEntryComponent = (props: { entry: Entry }) => JSX.Element
175​
176type ExplorerProps = Partial<RendererProps> & {
177 renderer?: Renderer
178 defaultExpanded?: true | Record<string, boolean>
180​
181type Property = {
182 defaultExpanded?: boolean | Record<string, boolean>
183 label: string
184 value: unknown
186​
187function isIterable(x: any): x is Iterable<unknown> {
188 return Symbol.iterator in x
190​
191export default function Explorer({
192 value,
193 defaultExpanded,
194 renderer = DefaultRenderer,
195 pageSize = 100,
196 ...rest
197}: ExplorerProps) {
198 const [expanded, setExpanded] = React.useState(Boolean(defaultExpanded))
199 const toggleExpanded = React.useCallback(() => setExpanded(old => !old), [])
200​
201 let type: string = typeof value
202 let subEntries: Property[] = []
203​
204 const makeProperty = (sub: { label: string; value: unknown }): Property => {
205 const subDefaultExpanded =
206 defaultExpanded === true
207 ? { [sub.label]: true }
208 : defaultExpanded?.[sub.label]
209 return {
210 ...sub,
211 defaultExpanded: subDefaultExpanded,
212 }
213 }
214​
215 if (Array.isArray(value)) {
216 type = 'array'
217 subEntries = value.map((d, i) =>
218 makeProperty({
219 label: i.toString(),
220 value: d,
221 })
222 )
223 } else if (
224 value !== null &&
225 typeof value === 'object' &&
226 isIterable(value) &&
227 typeof value[Symbol.iterator] === 'function'
228 ) {
229 type = 'Iterable'
230 subEntries = Array.from(value, (val, i) =>
231 makeProperty({
232 label: i.toString(),
233 value: val,
234 })
235 )
236 } else if (typeof value === 'object' && value !== null) {
237 type = 'object'
238 subEntries = Object.entries(value).map(([key, val]) =>
239 makeProperty({
240 label: key,
241 value: val,
242 })
243 )
244 }
245​
246 const subEntryPages = chunkArray(subEntries, pageSize)
247​
248 return renderer({
249 HandleEntry: ({ entry }) => (
250 <Explorer value={value} renderer={renderer} {...rest} {...entry} />
251 ),
252 type,
253 subEntries,
254 subEntryPages,
255 value,
256 expanded,
257 toggleExpanded,
258 pageSize,
259 ...rest,
260 })