-
-
Notifications
You must be signed in to change notification settings - Fork 31.7k
/
useSlot.ts
167 lines (154 loc) · 5.34 KB
/
useSlot.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
import * as React from 'react';
import { ClassValue } from 'clsx';
import { unstable_useForkRef as useForkRef } from '@mui/utils';
import { appendOwnerState, resolveComponentProps, mergeSlotProps } from '@mui/base/utils';
export type WithCommonProps<T> = T & {
className?: string;
style?: React.CSSProperties;
ref?: React.Ref<any>;
};
type EventHandlers = Record<string, React.EventHandler<any>>;
type ExtractComponentProps<P> = P extends infer T | ((ownerState: any) => infer T) ? T : never;
/**
* An internal function to create a Joy UI slot.
*
* This is an advanced version of MUI Base `useSlotProps` because Joy UI allows leaf component to be customized via `component` prop
* while MUI Base does not need to support leaf component customization.
*
* @param {string} name: name of the slot
* @param {object} parameters
* @returns {[Slot, slotProps]} The slot's React component and the slot's props
*
* Note: the returned slot's props
* - will never contain `component` prop.
* - might contain `as` prop.
*/
export default function useSlot<
T extends string,
ElementType extends React.ElementType,
SlotProps,
OwnerState extends {},
ExternalSlotProps extends { component?: React.ElementType },
ExternalForwardedProps extends {
component?: React.ElementType;
slots?: { [k in T]?: React.ElementType };
slotProps?: {
[k in T]?:
| WithCommonProps<ExternalSlotProps>
| ((ownerState: OwnerState) => WithCommonProps<ExternalSlotProps>);
};
},
AdditionalProps,
SlotOwnerState extends {},
>(
/**
* The slot's name. All Joy UI components should have `root` slot.
*
* If the name is `root`, the logic behaves differently from other slots,
* e.g. the `externalForwardedProps` are spread to `root` slot but not other slots.
*/
name: T,
parameters: (T extends 'root' // root slot must pass a `ref` as a parameter
? { ref: React.ForwardedRef<any> }
: { ref?: React.ForwardedRef<any> }) & {
/**
* The slot's className
*/
className: ClassValue | ClassValue[];
/**
* The slot's default styled-component
*/
elementType: ElementType;
/**
* The component's ownerState
*/
ownerState: OwnerState;
/**
* The `other` props from the consumer. It has to contain `component`, `slots`, and `slotProps`.
* The function will use those props to calculate the final rendered element and the returned props.
*
* If the slot is not `root`, the rest of the `externalForwardedProps` are neglected.
*/
externalForwardedProps: ExternalForwardedProps;
getSlotProps?: (other: EventHandlers) => WithCommonProps<SlotProps>;
additionalProps?: WithCommonProps<AdditionalProps>;
// Joy UI specifics
/**
* For overriding the component's ownerState for the slot.
* This is required for some components that need styling via `ownerState`.
*
* It is a function because `slotProps.{slot}` can be a function which has to be resolved first.
*/
getSlotOwnerState?: (
mergedProps: AdditionalProps &
SlotProps &
ExternalSlotProps &
ExtractComponentProps<
Exclude<Exclude<ExternalForwardedProps['slotProps'], undefined>[T], undefined>
>,
) => SlotOwnerState;
/**
* props forward to `T` only if the `slotProps.*.component` is not provided.
* e.g. Autocomplete's listbox uses PopperUnstyled + StyledComponent
*/
internalForwardedProps?: any;
},
) {
const {
className,
elementType: initialElementType,
ownerState,
externalForwardedProps,
getSlotOwnerState,
internalForwardedProps,
...useSlotPropsParams
} = parameters;
const {
component: rootComponent,
slots = { [name]: undefined },
slotProps = { [name]: undefined },
...other
} = externalForwardedProps;
const elementType = slots[name] || initialElementType;
// `slotProps[name]` can be a callback that receives the component's ownerState.
// `resolvedComponentsProps` is always a plain object.
const resolvedComponentsProps = resolveComponentProps(slotProps[name], ownerState);
const {
props: { component: slotComponent, ...mergedProps },
internalRef,
} = mergeSlotProps({
className,
...useSlotPropsParams,
externalForwardedProps: name === 'root' ? other : undefined,
externalSlotProps: resolvedComponentsProps,
});
const ref = useForkRef(internalRef, resolvedComponentsProps?.ref, parameters.ref);
const finalOwnerState = getSlotOwnerState
? { ...ownerState, ...getSlotOwnerState(mergedProps as any) }
: ownerState;
const LeafComponent = (name === 'root' ? slotComponent || rootComponent : slotComponent) as
| React.ElementType
| undefined;
const props = appendOwnerState(
elementType,
{
...(name === 'root' && !rootComponent && !slots[name] && internalForwardedProps),
...(name !== 'root' && !slots[name] && internalForwardedProps),
...mergedProps,
...(LeafComponent && {
as: LeafComponent,
}),
ref,
},
finalOwnerState as OwnerState & SlotOwnerState,
);
return [elementType, props] as [
ElementType,
{ className: string; ownerState: OwnerState & SlotOwnerState } & AdditionalProps &
SlotProps &
ExternalSlotProps &
ExtractComponentProps<
Exclude<Exclude<ExternalForwardedProps['slotProps'], undefined>[T], undefined>
>,
];
}