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

utils.ts

141 lines3.5 KB

1import React from 'react'
2import { DefaultGenerics, RouteMatch } from '@tanstack/react-location'
3​
4import { Theme, useTheme } from './theme'
5import useMediaQuery from './useMediaQuery'
6​
7export const isServer = typeof window === 'undefined'
8​
9type StyledComponent<T> = T extends 'button'
10 ? React.DetailedHTMLProps<
11 React.ButtonHTMLAttributes<HTMLButtonElement>,
12 HTMLButtonElement
13 >
14 : T extends 'input'
15 ? React.DetailedHTMLProps<
16 React.InputHTMLAttributes<HTMLInputElement>,
17 HTMLInputElement
18 >
19 : T extends 'select'
20 ? React.DetailedHTMLProps<
21 React.SelectHTMLAttributes<HTMLSelectElement>,
22 HTMLSelectElement
23 >
24 : T extends keyof HTMLElementTagNameMap
25 ? React.HTMLAttributes<HTMLElementTagNameMap[T]>
26 : never
27​
28export function getStatusColor(
29 match: RouteMatch<DefaultGenerics>,
30 theme: Theme,
31) {
32 return match.isLoading
33 ? theme.active
34 : match.status === 'rejected'
35 ? theme.danger
36 : match.status === 'pending'
37 ? theme.warning
38 : theme.success
40​
41// export function getQueryStatusLabel(query: Query) {
42// return query.state.isFetching
43// ? 'fetching'
44// : !query.getObserversCount()
45// ? 'inactive'
46// : query.isStale()
47// ? 'stale'
48// : 'fresh'
49// }
50​
51type Styles =
52 | React.CSSProperties
53 | ((props: Record<string, any>, theme: Theme) => React.CSSProperties)
54​
55export function styled<T extends keyof HTMLElementTagNameMap>(
56 type: T,
57 newStyles: Styles,
58 queries: Record<string, Styles> = {},
59) {
60 return React.forwardRef<HTMLElementTagNameMap[T], StyledComponent<T>>(
61 ({ style, ...rest }, ref) => {
62 const theme = useTheme()
63​
64 const mediaStyles = Object.entries(queries).reduce(
65 (current, [key, value]) => {
66 // eslint-disable-next-line react-hooks/rules-of-hooks
67 return useMediaQuery(key)
68 ? {
69 ...current,
70 ...(typeof value === 'function' ? value(rest, theme) : value),
71 }
72 : current
73 },
74 {},
75 )
76​
77 return React.createElement(type, {
78 ...rest,
79 style: {
80 ...(typeof newStyles === 'function'
81 ? newStyles(rest, theme)
82 : newStyles),
83 ...style,
84 ...mediaStyles,
85 },
86 ref,
87 })
88 },
89 )
91​
92export function useIsMounted() {
93 const mountedRef = React.useRef(false)
94 const isMounted = React.useCallback(() => mountedRef.current, [])
95​
96 React[isServer ? 'useEffect' : 'useLayoutEffect'](() => {
97 mountedRef.current = true
98 return () => {
99 mountedRef.current = false
100 }
101 }, [])
102​
103 return isMounted
105​
106/**
107 * This hook is a safe useState version which schedules state updates in microtasks
108 * to prevent updating a component state while React is rendering different components
109 * or when the component is not mounted anymore.
110 */
111export function useSafeState<T>(initialState: T): [T, (value: T) => void] {
112 const isMounted = useIsMounted()
113 const [state, setState] = React.useState(initialState)
114​
115 const safeSetState = React.useCallback(
116 (value: T) => {
117 scheduleMicrotask(() => {
118 if (isMounted()) {
119 setState(value)
120 }
121 })
122 },
123 [isMounted],
124 )
125​
126 return [state, safeSetState]
128​
129/**
130 * Schedules a microtask.
131 * This can be useful to schedule state updates after rendering.
132 */
133function scheduleMicrotask(callback: () => void) {
134 Promise.resolve()
135 .then(callback)
136 .catch((error) =>
137 setTimeout(() => {
138 throw error
139 }),
140 )