@fluentui/react-utilities 0.0.0-nightly-20240610-0407.1 → 0.0.0-nightly-20240610-0945.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.
- package/CHANGELOG.md +6 -6
- package/dist/index.d.ts +116 -42
- package/lib/compose/assertSlots.js +4 -0
- package/lib/compose/assertSlots.js.map +1 -1
- package/lib/compose/deprecated/getSlots.js +8 -3
- package/lib/compose/deprecated/getSlots.js.map +1 -1
- package/lib/compose/deprecated/getSlotsNext.js +8 -3
- package/lib/compose/deprecated/getSlotsNext.js.map +1 -1
- package/lib/compose/deprecated/resolveShorthand.js +1 -1
- package/lib/compose/deprecated/resolveShorthand.js.map +1 -1
- package/lib/compose/getIntrinsicElementProps.js.map +1 -1
- package/lib/compose/isResolvedShorthand.js.map +1 -1
- package/lib/compose/slot.js +2 -1
- package/lib/compose/slot.js.map +1 -1
- package/lib/compose/types.js.map +1 -1
- package/lib/hooks/useMergedRefs.js +10 -1
- package/lib/hooks/useMergedRefs.js.map +1 -1
- package/lib/index.js.map +1 -1
- package/lib/trigger/applyTriggerPropsToChildren.js.map +1 -1
- package/lib/utils/types.js +1 -21
- package/lib/utils/types.js.map +1 -1
- package/lib-commonjs/compose/assertSlots.js +4 -0
- package/lib-commonjs/compose/assertSlots.js.map +1 -1
- package/lib-commonjs/compose/deprecated/getSlots.js +8 -3
- package/lib-commonjs/compose/deprecated/getSlots.js.map +1 -1
- package/lib-commonjs/compose/deprecated/getSlotsNext.js +8 -3
- package/lib-commonjs/compose/deprecated/getSlotsNext.js.map +1 -1
- package/lib-commonjs/compose/deprecated/resolveShorthand.js.map +1 -1
- package/lib-commonjs/compose/slot.js +2 -1
- package/lib-commonjs/compose/slot.js.map +1 -1
- package/lib-commonjs/hooks/useMergedRefs.js +8 -0
- package/lib-commonjs/hooks/useMergedRefs.js.map +1 -1
- package/lib-commonjs/utils/types.js +2 -20
- package/lib-commonjs/utils/types.js.map +1 -1
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
@@ -1,19 +1,19 @@
|
|
1
1
|
# Change Log - @fluentui/react-utilities
|
2
2
|
|
3
|
-
This log was last generated on Mon, 10 Jun 2024
|
3
|
+
This log was last generated on Mon, 10 Jun 2024 10:03:58 GMT and should not be manually modified.
|
4
4
|
|
5
5
|
<!-- Start content -->
|
6
6
|
|
7
|
-
## [0.0.0-nightly-20240610-
|
7
|
+
## [0.0.0-nightly-20240610-0945.1](https://github.com/microsoft/fluentui/tree/@fluentui/react-utilities_v0.0.0-nightly-20240610-0945.1)
|
8
8
|
|
9
|
-
Mon, 10 Jun 2024
|
10
|
-
[Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-utilities_v9.18.10..@fluentui/react-utilities_v0.0.0-nightly-20240610-
|
9
|
+
Mon, 10 Jun 2024 10:03:58 GMT
|
10
|
+
[Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-utilities_v9.18.10..@fluentui/react-utilities_v0.0.0-nightly-20240610-0945.1)
|
11
11
|
|
12
12
|
### Changes
|
13
13
|
|
14
14
|
- Release nightly v9 ([commit](https://github.com/microsoft/fluentui/commit/not available) by fluentui-internal@service.microsoft.com)
|
15
|
-
- Bump @fluentui/keyboard-keys to v0.0.0-nightly-20240610-
|
16
|
-
- Bump @fluentui/react-shared-contexts to v0.0.0-nightly-20240610-
|
15
|
+
- Bump @fluentui/keyboard-keys to v0.0.0-nightly-20240610-0945.1 ([commit](https://github.com/microsoft/fluentui/commit/1ee1b563223767c589678be98ff0f9fa55554361) by beachball)
|
16
|
+
- Bump @fluentui/react-shared-contexts to v0.0.0-nightly-20240610-0945.1 ([commit](https://github.com/microsoft/fluentui/commit/1ee1b563223767c589678be98ff0f9fa55554361) by beachball)
|
17
17
|
|
18
18
|
## [9.18.10](https://github.com/microsoft/fluentui/tree/@fluentui/react-utilities_v9.18.10)
|
19
19
|
|
package/dist/index.d.ts
CHANGED
@@ -9,7 +9,7 @@ import * as React_2 from 'react';
|
|
9
9
|
* * `elementType` - the base element type of a slot, defaults to `'div'`
|
10
10
|
* * `defaultProps` - similar to a React component declaration, you can provide a slot default properties to be merged with the shorthand/properties provided.
|
11
11
|
*/
|
12
|
-
declare function always<Props extends
|
12
|
+
declare function always<Props extends SlotPropsDataType>(value: Props | SlotShorthandValue | undefined, options: SlotOptions<Props>): SlotComponentType<Props>;
|
13
13
|
|
14
14
|
/**
|
15
15
|
* @internal
|
@@ -65,23 +65,47 @@ export declare function canUseDOM(): boolean;
|
|
65
65
|
*/
|
66
66
|
export declare const clamp: (value: number, min: number, max: number) => number;
|
67
67
|
|
68
|
+
/**
|
69
|
+
* @internal
|
70
|
+
* **THIS TYPE IS INTERNAL AND SHOULD NEVER BE EXPOSED**
|
71
|
+
*/
|
72
|
+
declare interface ComponentClass<P = {}, S = React_2.ComponentState> extends React_2.StaticLifecycle<P, S> {
|
73
|
+
new (props: P): React_2.Component<P, S>;
|
74
|
+
}
|
75
|
+
|
68
76
|
/**
|
69
77
|
* Defines the Props type for a component given its slots and the definition of which one is the primary slot,
|
70
78
|
* defaulting to root if one is not provided.
|
71
79
|
*/
|
72
|
-
export declare type ComponentProps<Slots extends SlotPropsRecord, Primary extends keyof Slots = 'root'> = Omit<Slots, Primary & 'root'> & PropsWithoutRef<ExtractSlotProps<Slots[Primary]
|
80
|
+
export declare type ComponentProps<Slots extends SlotPropsRecord, Primary extends keyof Slots = 'root'> = Omit<Slots, Primary & 'root'> & PropsWithoutRef<WithoutSlotRenderFunction<ExtractSlotProps<Slots[Primary]>>>;
|
73
81
|
|
74
82
|
/**
|
75
83
|
* Defines the State object of a component given its slots.
|
76
84
|
*/
|
77
85
|
export declare type ComponentState<Slots extends SlotPropsRecord> = {
|
86
|
+
/**
|
87
|
+
* @deprecated
|
88
|
+
* The base element type for each slot.
|
89
|
+
* This property is deprecated and will be removed in a future version.
|
90
|
+
* The slot base element type is declared through `slot.*(slotShorthand, {elementType: ElementType})` instead.
|
91
|
+
*/
|
78
92
|
components: {
|
79
|
-
[Key in keyof Slots]-?: React_2.
|
93
|
+
[Key in keyof Slots]-?: React_2.ElementType;
|
80
94
|
};
|
81
95
|
} & {
|
82
|
-
[Key in keyof Slots]: ReplaceNullWithUndefined<Exclude<Slots[Key], SlotShorthandValue | (Key extends 'root' ? null : never)
|
96
|
+
[Key in keyof Slots]: ReplaceNullWithUndefined<WithoutSlotRenderFunction<Exclude<Slots[Key], SlotShorthandValue | (Key extends 'root' ? null : never)>>>;
|
83
97
|
};
|
84
98
|
|
99
|
+
/**
|
100
|
+
* @internal
|
101
|
+
* With react 18, our `children` type starts leaking everywhere and that causes conflicts on component declaration, specially in the `propTypes` property of
|
102
|
+
* both `ComponentClass` and `FunctionComponent`.
|
103
|
+
*
|
104
|
+
* This type substitutes `React.ComponentType` only keeping the function signature, it omits `propTypes`, `displayName` and other properties that are not
|
105
|
+
* required for the inference.
|
106
|
+
*/
|
107
|
+
declare type ComponentType<P = {}> = ComponentClass<P> | FunctionComponent<P>;
|
108
|
+
|
85
109
|
/**
|
86
110
|
* @internal
|
87
111
|
* @param compare - comparison function for items
|
@@ -170,8 +194,32 @@ export declare type FluentTriggerComponent = {
|
|
170
194
|
|
171
195
|
/**
|
172
196
|
* Return type for `React.forwardRef`, including inference of the proper typing for the ref.
|
197
|
+
*
|
198
|
+
* Note: {@link React.RefAttributes} is {@link https://github.com/DefinitelyTyped/DefinitelyTyped/discussions/69756 | leaking string references} into forwardRef components, forwardRef component do not support string refs.
|
173
199
|
*/
|
174
|
-
export declare type ForwardRefComponent<Props> =
|
200
|
+
export declare type ForwardRefComponent<Props> = FunctionComponent<Props & React_2.RefAttributes<InferredElementRefType<Props>>>;
|
201
|
+
|
202
|
+
/**
|
203
|
+
* @internal
|
204
|
+
*
|
205
|
+
* On types/react 18 there are two types being delivered,
|
206
|
+
* they rely on the typescript version to decide which will be consumed {@link https://github.com/DefinitelyTyped/DefinitelyTyped/blob/b59dc3ac1e2770fbd6cdbb90ba52abe04c168196/types/react/package.json#L10}
|
207
|
+
*
|
208
|
+
* If TS is higher than 5.0 then the `FunctionComponent` will be returning ReactNode (which we don't support)
|
209
|
+
* If TS is below or equal to 5.0 then the `FunctionComponent` will be returning ReactElement | null (which we support)
|
210
|
+
*
|
211
|
+
* Since it's not possible to have a single type that works for both cases
|
212
|
+
* (as ReactNode is more specific, and this will break while evaluating functions),
|
213
|
+
* we need to create our own `FunctionComponent` type
|
214
|
+
* that will work for both cases.
|
215
|
+
*
|
216
|
+
* **THIS TYPE IS INTERNAL AND SHOULD NEVER BE EXPOSED**
|
217
|
+
*/
|
218
|
+
declare interface FunctionComponent<P> {
|
219
|
+
(props: P): any;
|
220
|
+
defaultProps?: Partial<P>;
|
221
|
+
displayName?: string;
|
222
|
+
}
|
175
223
|
|
176
224
|
/**
|
177
225
|
* Returns an object with clientX, clientY for TouchOrMouseEvent.
|
@@ -188,7 +236,7 @@ export declare function getEventClientCoords(event: TouchOrMouseEvent): {
|
|
188
236
|
*
|
189
237
|
* Equivalent to {@link getNativeElementProps}, but more type-safe.
|
190
238
|
*/
|
191
|
-
export declare const getIntrinsicElementProps: <Props extends
|
239
|
+
export declare const getIntrinsicElementProps: <Props extends SlotPropsDataType, ExcludedPropKeys extends Extract<keyof Props, string> = never>(tagName: NonNullable<Props["as"]>, props: Props & React_2.RefAttributes<InferredElementRefType<Props>>, excludedPropNames?: ExcludedPropKeys[] | undefined) => DistributiveOmit<Props, ExcludedPropKeys | Exclude<keyof Props, "slot" | "style" | "title" | "as" | "children" | "className" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "id" | "lang" | "placeholder" | "spellCheck" | "tabIndex" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "color" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture">>;
|
192
240
|
|
193
241
|
/**
|
194
242
|
* Given an element tagname and user props, filters the props to only allowed props for the given
|
@@ -264,7 +312,7 @@ export declare const getRTLSafeKey: (key: string, dir: 'ltr' | 'rtl') => string;
|
|
264
312
|
* @param state - State including slot definitions
|
265
313
|
* @returns An object containing the `slots` map and `slotProps` map.
|
266
314
|
*/
|
267
|
-
export declare function getSlots<R extends SlotPropsRecord>(state:
|
315
|
+
export declare function getSlots<R extends SlotPropsRecord>(state: unknown): {
|
268
316
|
slots: Slots<R>;
|
269
317
|
slotProps: ObjectSlotProps<R>;
|
270
318
|
};
|
@@ -279,7 +327,7 @@ export declare function getSlots<R extends SlotPropsRecord>(state: ComponentStat
|
|
279
327
|
*
|
280
328
|
* @deprecated use slot.always or slot.optional combined with assertSlots instead
|
281
329
|
*/
|
282
|
-
export declare function getSlotsNext<R extends SlotPropsRecord>(state:
|
330
|
+
export declare function getSlotsNext<R extends SlotPropsRecord>(state: unknown): {
|
283
331
|
slots: Slots<R>;
|
284
332
|
slotProps: ObjectSlotProps<R>;
|
285
333
|
};
|
@@ -310,8 +358,6 @@ export declare function getTriggerChild<TriggerChildProps>(children: TriggerProp
|
|
310
358
|
ref?: React_2.Ref<any>;
|
311
359
|
}) | null;
|
312
360
|
|
313
|
-
declare type HTMLAttributes = React_2.HTMLAttributes<any>;
|
314
|
-
|
315
361
|
/**
|
316
362
|
* @internal
|
317
363
|
*/
|
@@ -405,7 +451,7 @@ export declare function isMouseEvent(event: TouchOrMouseEvent): event is MouseEv
|
|
405
451
|
* })
|
406
452
|
* ```
|
407
453
|
*/
|
408
|
-
export declare function isResolvedShorthand<Shorthand extends Slot<
|
454
|
+
export declare function isResolvedShorthand<Shorthand extends Slot<SlotPropsDataType>>(shorthand?: Shorthand): shorthand is ExtractSlotProps<Shorthand>;
|
409
455
|
|
410
456
|
/**
|
411
457
|
* Evaluates to true if the given type contains exactly one string, or false if it is a union of strings.
|
@@ -461,7 +507,7 @@ export declare type NativeTouchOrMouseEvent = MouseEvent | TouchEvent;
|
|
461
507
|
* @deprecated - use slot.always or slot.optional combined with assertSlots instead
|
462
508
|
*/
|
463
509
|
declare type ObjectSlotProps<S extends SlotPropsRecord> = {
|
464
|
-
[K in keyof S]-?:
|
510
|
+
[K in keyof S]-?: any;
|
465
511
|
};
|
466
512
|
|
467
513
|
/**
|
@@ -512,7 +558,7 @@ export declare type OnSelectionChangeData = {
|
|
512
558
|
* with the values provided by `options.defaultProps` (or `{}`). This is useful for cases such as providing a default content
|
513
559
|
* in case no shorthand is provided, like the case of the `expandIcon` slot for the `AccordionHeader`
|
514
560
|
*/
|
515
|
-
declare function optional<Props extends
|
561
|
+
declare function optional<Props extends SlotPropsDataType>(value: Props | SlotShorthandValue | undefined | null, options: {
|
516
562
|
renderByDefault?: boolean;
|
517
563
|
} & SlotOptions<Props>): SlotComponentType<Props> | undefined;
|
518
564
|
|
@@ -553,6 +599,18 @@ declare type PropsWithoutChildren<P> = 'children' extends keyof P ? Distributive
|
|
553
599
|
*/
|
554
600
|
declare type PropsWithoutRef<P> = 'ref' extends keyof P ? DistributiveOmit<P, 'ref'> : P;
|
555
601
|
|
602
|
+
/**
|
603
|
+
* @internal
|
604
|
+
*
|
605
|
+
* on types/react 18 ReactNode becomes a more strict type, which is not compatible with our current implementation. to avoid any issues we are creating our own ReactNode type which allows anything.
|
606
|
+
*
|
607
|
+
* This type should only be used for inference purposes, and should never be exposed.
|
608
|
+
*
|
609
|
+
* **THIS TYPE IS INTERNAL AND SHOULD NEVER BE EXPOSED**
|
610
|
+
*
|
611
|
+
*/
|
612
|
+
declare type ReactNode = any;
|
613
|
+
|
556
614
|
export declare type ReactTouchOrMouseEvent = React_2.MouseEvent | React_2.TouchEvent;
|
557
615
|
|
558
616
|
/**
|
@@ -579,23 +637,23 @@ export declare function resetIdsForTests(): void;
|
|
579
637
|
* @param value - the base shorthand props
|
580
638
|
* @param options - options to resolve shorthand props
|
581
639
|
*
|
582
|
-
* @deprecated use slot.always
|
640
|
+
* @deprecated use slot.always, slot.optional, slot.resolveShorthand combined with assertSlots instead
|
583
641
|
*/
|
584
|
-
export declare const resolveShorthand: ResolveShorthandFunction<
|
642
|
+
export declare const resolveShorthand: ResolveShorthandFunction<SlotPropsDataType>;
|
585
643
|
|
586
644
|
/**
|
587
645
|
* Helper function that converts a slot shorthand or properties to a slot properties object
|
588
646
|
* The main difference between this function and `slot` is that this function does not return the metadata required for a slot to be considered a properly renderable slot, it only converts the value to a slot properties object
|
589
647
|
* @param value - the value of the slot, it can be a slot shorthand or a slot properties object
|
590
648
|
*/
|
591
|
-
declare function resolveShorthand_2<Props extends
|
649
|
+
declare function resolveShorthand_2<Props extends SlotPropsDataType | null | undefined>(value: Props | SlotShorthandValue): Props;
|
592
650
|
|
593
651
|
/**
|
594
652
|
* @deprecated use slot.always or slot.optional combined with assertSlots instead
|
595
653
|
*/
|
596
|
-
export declare type ResolveShorthandFunction<Props extends
|
597
|
-
<P extends Props>(value: P | SlotShorthandValue | undefined, options: ResolveShorthandOptions<P, true>): P
|
598
|
-
<P extends Props>(value: P | SlotShorthandValue | null | undefined, options?: ResolveShorthandOptions<P, boolean>): P | undefined;
|
654
|
+
export declare type ResolveShorthandFunction<Props extends SlotPropsDataType = SlotPropsDataType> = {
|
655
|
+
<P extends Props>(value: P | SlotShorthandValue | undefined, options: ResolveShorthandOptions<P, true>): WithoutSlotRenderFunction<P>;
|
656
|
+
<P extends Props>(value: P | SlotShorthandValue | null | undefined, options?: ResolveShorthandOptions<P, boolean>): WithoutSlotRenderFunction<P> | undefined;
|
599
657
|
};
|
600
658
|
|
601
659
|
/**
|
@@ -670,13 +728,11 @@ export declare function setVirtualParent(child: Node, parent?: Node): void;
|
|
670
728
|
* NonNullable<Slot<typeof Label>> // Slot is a Label and will always be rendered (can't be set to null by the user)
|
671
729
|
* ```
|
672
730
|
*/
|
673
|
-
export declare type Slot<Type extends keyof JSX.IntrinsicElements |
|
731
|
+
export declare type Slot<Type extends keyof JSX.IntrinsicElements | ComponentType<any> | SlotPropsDataType, AlternateAs extends keyof JSX.IntrinsicElements = never> = IsSingleton<Extract<Type, string>> extends true ? WithSlotShorthandValue<Type extends keyof JSX.IntrinsicElements ? {
|
674
732
|
as?: Type;
|
675
|
-
} & WithSlotRenderFunction<IntrinsicElementProps<Type>> : Type extends
|
676
|
-
|
677
|
-
|
678
|
-
} & WithSlotRenderFunction<IntrinsicElementProps<As>>;
|
679
|
-
}[AlternateAs] | null : 'Error: First parameter to Slot must not be not a union of types. See documentation of Slot type.';
|
733
|
+
} & WithSlotRenderFunction<IntrinsicElementProps<Type>> : Type extends ComponentType<infer Props> ? Props extends SlotPropsDataType ? Props : WithSlotRenderFunction<Props> : Type> | (AlternateAs extends unknown ? {
|
734
|
+
as: AlternateAs;
|
735
|
+
} & WithSlotRenderFunction<IntrinsicElementProps<AlternateAs>> : never) | null : 'Error: First parameter to Slot must not be not a union of types. See documentation of Slot type.';
|
680
736
|
|
681
737
|
declare namespace slot {
|
682
738
|
export {
|
@@ -715,11 +771,9 @@ declare type SlotComponents<Slots extends SlotPropsRecord> = {
|
|
715
771
|
* A definition of a slot, as a component, very similar to how a React component is declared,
|
716
772
|
* but with some additional metadata that is used to determine how to render the slot.
|
717
773
|
*/
|
718
|
-
export declare type SlotComponentType<Props extends
|
719
|
-
|
720
|
-
|
721
|
-
*/
|
722
|
-
(props: React_2.PropsWithChildren<{}>): React_2.ReactElement | null;
|
774
|
+
export declare type SlotComponentType<Props extends SlotPropsDataType> = WithoutSlotRenderFunction<Props> & FunctionComponent<{
|
775
|
+
children?: ReactNode;
|
776
|
+
}> & {
|
723
777
|
/**
|
724
778
|
* @internal
|
725
779
|
*/
|
@@ -727,12 +781,25 @@ export declare type SlotComponentType<Props extends UnknownSlotProps> = Props &
|
|
727
781
|
/**
|
728
782
|
* @internal
|
729
783
|
*/
|
730
|
-
[SLOT_ELEMENT_TYPE_SYMBOL]:
|
784
|
+
[SLOT_ELEMENT_TYPE_SYMBOL]: ComponentType<Props> | (Props extends AsIntrinsicElement<infer As> ? As : keyof JSX.IntrinsicElements);
|
731
785
|
};
|
732
786
|
|
733
|
-
export declare type SlotOptions<Props extends
|
787
|
+
export declare type SlotOptions<Props extends SlotPropsDataType> = {
|
734
788
|
elementType: React_2.ComponentType<Props> | (Props extends AsIntrinsicElement<infer As> ? As : keyof JSX.IntrinsicElements);
|
735
|
-
defaultProps?: Partial<Props
|
789
|
+
defaultProps?: Partial<Props & {
|
790
|
+
ref?: React_2.Ref<InferredElementRefType<Props>>;
|
791
|
+
}>;
|
792
|
+
};
|
793
|
+
|
794
|
+
/**
|
795
|
+
* @internal
|
796
|
+
*
|
797
|
+
* This should ONLY be used in type templates as in `extends SlotPropsDataType`;
|
798
|
+
* it shouldn't be used as a component's Slot props type.
|
799
|
+
*/
|
800
|
+
declare type SlotPropsDataType = {
|
801
|
+
as?: keyof JSX.IntrinsicElements;
|
802
|
+
children?: ReactNode;
|
736
803
|
};
|
737
804
|
|
738
805
|
/**
|
@@ -741,21 +808,21 @@ export declare type SlotOptions<Props extends UnknownSlotProps> = {
|
|
741
808
|
* This should ONLY be used in type templates as in `extends SlotPropsRecord`;
|
742
809
|
* it shouldn't be used as a component's Slots type.
|
743
810
|
*/
|
744
|
-
export declare type SlotPropsRecord = Record<string,
|
811
|
+
export declare type SlotPropsRecord = Record<string, SlotPropsDataType | SlotShorthandValue | null | undefined>;
|
745
812
|
|
746
|
-
export declare type SlotRenderFunction<Props> = (Component: React_2.ElementType<Props>, props: Omit<Props, 'as'>) =>
|
813
|
+
export declare type SlotRenderFunction<Props> = (Component: React_2.ElementType<Props>, props: Omit<Props, 'as'>) => ReactNode;
|
747
814
|
|
748
815
|
/**
|
749
816
|
* @deprecated - use slot.always or slot.optional combined with assertSlots instead
|
750
817
|
*/
|
751
818
|
export declare type Slots<S extends SlotPropsRecord> = {
|
752
|
-
[K in keyof S]:
|
819
|
+
[K in keyof S]: React_2.ElementType<any>;
|
753
820
|
};
|
754
821
|
|
755
822
|
/**
|
756
823
|
* The shorthand value of a slot allows specifying its child
|
757
824
|
*/
|
758
|
-
export declare type SlotShorthandValue = React_2.
|
825
|
+
export declare type SlotShorthandValue = React_2.ReactElement | string | number | Iterable<ReactNode> | React_2.ReactPortal;
|
759
826
|
|
760
827
|
/**
|
761
828
|
* When using SSR with Fluent UI, applications must be wrapped in an SSRProvider. This ensures that auto generated ids
|
@@ -785,6 +852,7 @@ export declare type TriggerProps<TriggerChildProps = unknown> = {
|
|
785
852
|
export declare type UnionToIntersection<U> = (U extends unknown ? (x: U) => U : never) extends (x: infer I) => U ? I : never;
|
786
853
|
|
787
854
|
/**
|
855
|
+
* @deprecated - SlotPropsDataType instead
|
788
856
|
* Matches any slot props type.
|
789
857
|
*
|
790
858
|
* This should ONLY be used in type templates as in `extends UnknownSlotProps`;
|
@@ -909,7 +977,7 @@ export declare function useIsSSR(): boolean;
|
|
909
977
|
* @param refs - Refs to collectively update with one ref value.
|
910
978
|
* @returns A function with an attached "current" prop, so that it can be treated like a RefObject.
|
911
979
|
*/
|
912
|
-
export declare function useMergedRefs<T>(...refs: (React_2.
|
980
|
+
export declare function useMergedRefs<T>(...refs: (React_2.LegacyRef<T> | undefined)[]): RefObjectFunction<T>;
|
913
981
|
|
914
982
|
/**
|
915
983
|
* @internal
|
@@ -990,13 +1058,19 @@ export declare function useSelection(params: SelectionHookParams): readonly [Set
|
|
990
1058
|
export declare function useTimeout(): readonly [(fn: () => void, delay?: number | undefined) => number, () => void];
|
991
1059
|
|
992
1060
|
/**
|
1061
|
+
* @internal
|
1062
|
+
*/
|
1063
|
+
declare type WithoutSlotRenderFunction<Props> = Props extends unknown ? 'children' extends keyof Props ? Omit<Props, 'children'> & {
|
1064
|
+
children?: Exclude<Props['children'], Function>;
|
1065
|
+
} : Props : never;
|
1066
|
+
|
1067
|
+
/**
|
1068
|
+
* @internal
|
993
1069
|
* Helper type for {@link Slot}. Takes the props we want to support for a slot and adds the ability for `children`
|
994
1070
|
* to be a render function that takes those props.
|
995
1071
|
*/
|
996
|
-
declare type WithSlotRenderFunction<Props> = Props & {
|
997
|
-
children?: (
|
998
|
-
children?: unknown;
|
999
|
-
} ? Props['children'] : never) | SlotRenderFunction<Props>;
|
1072
|
+
declare type WithSlotRenderFunction<Props> = Omit<Props, 'children'> & {
|
1073
|
+
children?: ('children' extends keyof Props ? Props['children'] : never) | SlotRenderFunction<Props>;
|
1000
1074
|
};
|
1001
1075
|
|
1002
1076
|
/**
|
@@ -26,6 +26,7 @@ import * as slot from './slot';
|
|
26
26
|
* as we're verifying static properties that will not change between environments
|
27
27
|
*/ if (process.env.NODE_ENV !== 'production') {
|
28
28
|
const typedState = state;
|
29
|
+
// eslint-disable-next-line deprecation/deprecation
|
29
30
|
for (const slotName of Object.keys(typedState.components)){
|
30
31
|
const slotElement = typedState[slotName];
|
31
32
|
if (slotElement === undefined) {
|
@@ -36,6 +37,7 @@ import * as slot from './slot';
|
|
36
37
|
// FIXME: this slot will still fail to support child render function scenario
|
37
38
|
if (!isSlot(slotElement)) {
|
38
39
|
typedState[slotName] = slot.always(slotElement, {
|
40
|
+
// eslint-disable-next-line deprecation/deprecation
|
39
41
|
elementType: typedState.components[slotName]
|
40
42
|
});
|
41
43
|
// eslint-disable-next-line no-console
|
@@ -46,7 +48,9 @@ Be sure to create slots properly by using "slot.always" or "slot.optional".`);
|
|
46
48
|
// This means a slot is being declared by using resolveShorthand on the state hook,
|
47
49
|
// but the render method is using the new `assertSlots` method. That scenario can be solved by simply updating the slot element with the proper element type
|
48
50
|
const { [SLOT_ELEMENT_TYPE_SYMBOL]: elementType } = slotElement;
|
51
|
+
// eslint-disable-next-line deprecation/deprecation
|
49
52
|
if (elementType !== typedState.components[slotName]) {
|
53
|
+
// eslint-disable-next-line deprecation/deprecation
|
50
54
|
slotElement[SLOT_ELEMENT_TYPE_SYMBOL] = typedState.components[slotName];
|
51
55
|
// eslint-disable-next-line no-console
|
52
56
|
console.warn(`@fluentui/react-utilities [${assertSlots.name}]:
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"sources":["assertSlots.ts"],"sourcesContent":["import * as React from 'react';\nimport { SLOT_ELEMENT_TYPE_SYMBOL } from './constants';\nimport { isSlot } from './isSlot';\nimport { ComponentState, ExtractSlotProps, SlotComponentType, SlotPropsRecord } from './types';\nimport * as slot from './slot';\n\ntype SlotComponents<Slots extends SlotPropsRecord> = {\n [K in keyof Slots]: SlotComponentType<ExtractSlotProps<Slots[K]>>;\n};\n\n/**\n * @internal\n * Assertion method to ensure state slots properties are properly declared.\n * A properly declared slot must be declared by using the `slot` method.\n *\n * @example\n * ```tsx\n * export const renderInput_unstable = (state: InputState) => {\n assertSlots<InputSlots>(state);\n return (\n <state.root>\n {state.contentBefore && <state.contentBefore />}\n <state.input />\n {state.contentAfter && <state.contentAfter />}\n </state.root>\n );\n };\n * ```\n */\nexport function assertSlots<Slots extends SlotPropsRecord>(state: unknown): asserts state is SlotComponents<Slots> {\n /**\n * This verification is not necessary in production\n * as we're verifying static properties that will not change between environments\n */\n if (process.env.NODE_ENV !== 'production') {\n const typedState = state as ComponentState<Slots>;\n for (const slotName of Object.keys(typedState.components)) {\n const slotElement = typedState[slotName];\n if (slotElement === undefined) {\n continue;\n }\n // this means a slot is being declared without using, slot.always or slot.optional or even resolveShorthand on the state hook,\n // but the render method is using the new `assertSlots` method. That scenario can be solved by simply updating the slot element with the proper element type\n // FIXME: this slot will still fail to support child render function scenario\n if (!isSlot(slotElement)) {\n typedState[slotName as keyof ComponentState<Slots>] = slot.always(slotElement, {\n elementType: typedState.components[slotName] as React.ComponentType<{}>,\n }) as ComponentState<Slots>[keyof ComponentState<Slots>];\n // eslint-disable-next-line no-console\n console.warn(/** #__DE-INDENT__ */ `\n @fluentui/react-utilities [${assertSlots.name}]:\n \"state.${slotName}\" is not a slot!\n Be sure to create slots properly by using \"slot.always\" or \"slot.optional\".\n `);\n } else {\n // This means a slot is being declared by using resolveShorthand on the state hook,\n // but the render method is using the new `assertSlots` method. That scenario can be solved by simply updating the slot element with the proper element type\n const { [SLOT_ELEMENT_TYPE_SYMBOL]: elementType } = slotElement;\n if (elementType !== typedState.components[slotName]) {\n slotElement[SLOT_ELEMENT_TYPE_SYMBOL] = typedState.components[slotName] as React.ComponentType<{}>;\n // eslint-disable-next-line no-console\n console.warn(/** #__DE-INDENT__ */ `\n @fluentui/react-utilities [${assertSlots.name}]:\n \"state.${slotName}\" element type differs from \"state.components.${slotName}\",\n ${elementType} !== ${typedState.components[slotName]}.\n Be sure to create slots properly by using \"slot.always\" or \"slot.optional\" with the correct elementType.\n `);\n }\n }\n }\n }\n}\n"],"names":["React","SLOT_ELEMENT_TYPE_SYMBOL","isSlot","slot","assertSlots","state","process","env","NODE_ENV","typedState","slotName","Object","keys","components","slotElement","undefined","always","elementType","console","warn","name"],"mappings":"AAAA,YAAYA,WAAW,QAAQ;AAC/B,SAASC,wBAAwB,QAAQ,cAAc;AACvD,SAASC,MAAM,QAAQ,WAAW;AAElC,YAAYC,UAAU,SAAS;AAM/B;;;;;;;;;;;;;;;;;;CAkBC,GACD,OAAO,SAASC,YAA2CC,KAAc;IACvE;;;GAGC,GACD,IAAIC,QAAQC,GAAG,CAACC,QAAQ,KAAK,cAAc;QACzC,MAAMC,aAAaJ;QACnB,KAAK,MAAMK,YAAYC,OAAOC,IAAI,CAACH,WAAWI,UAAU,EAAG;YACzD,MAAMC,cAAcL,UAAU,CAACC,SAAS;YACxC,IAAII,gBAAgBC,WAAW;gBAC7B;YACF;YACA,8HAA8H;YAC9H,4JAA4J;YAC5J,6EAA6E;YAC7E,IAAI,CAACb,OAAOY,cAAc;gBACxBL,UAAU,CAACC,SAAwC,GAAGP,KAAKa,MAAM,CAACF,aAAa;
|
1
|
+
{"version":3,"sources":["assertSlots.ts"],"sourcesContent":["import * as React from 'react';\nimport { SLOT_ELEMENT_TYPE_SYMBOL } from './constants';\nimport { isSlot } from './isSlot';\nimport { ComponentState, ExtractSlotProps, SlotComponentType, SlotPropsRecord } from './types';\nimport * as slot from './slot';\n\ntype SlotComponents<Slots extends SlotPropsRecord> = {\n [K in keyof Slots]: SlotComponentType<ExtractSlotProps<Slots[K]>>;\n};\n\n/**\n * @internal\n * Assertion method to ensure state slots properties are properly declared.\n * A properly declared slot must be declared by using the `slot` method.\n *\n * @example\n * ```tsx\n * export const renderInput_unstable = (state: InputState) => {\n assertSlots<InputSlots>(state);\n return (\n <state.root>\n {state.contentBefore && <state.contentBefore />}\n <state.input />\n {state.contentAfter && <state.contentAfter />}\n </state.root>\n );\n };\n * ```\n */\nexport function assertSlots<Slots extends SlotPropsRecord>(state: unknown): asserts state is SlotComponents<Slots> {\n /**\n * This verification is not necessary in production\n * as we're verifying static properties that will not change between environments\n */\n if (process.env.NODE_ENV !== 'production') {\n const typedState = state as ComponentState<Slots>;\n // eslint-disable-next-line deprecation/deprecation\n for (const slotName of Object.keys(typedState.components)) {\n const slotElement = typedState[slotName];\n if (slotElement === undefined) {\n continue;\n }\n // this means a slot is being declared without using, slot.always or slot.optional or even resolveShorthand on the state hook,\n // but the render method is using the new `assertSlots` method. That scenario can be solved by simply updating the slot element with the proper element type\n // FIXME: this slot will still fail to support child render function scenario\n if (!isSlot(slotElement)) {\n typedState[slotName as keyof ComponentState<Slots>] = slot.always(slotElement, {\n // eslint-disable-next-line deprecation/deprecation\n elementType: typedState.components[slotName] as React.ComponentType<{}>,\n }) as ComponentState<Slots>[keyof ComponentState<Slots>];\n // eslint-disable-next-line no-console\n console.warn(/** #__DE-INDENT__ */ `\n @fluentui/react-utilities [${assertSlots.name}]:\n \"state.${slotName}\" is not a slot!\n Be sure to create slots properly by using \"slot.always\" or \"slot.optional\".\n `);\n } else {\n // This means a slot is being declared by using resolveShorthand on the state hook,\n // but the render method is using the new `assertSlots` method. That scenario can be solved by simply updating the slot element with the proper element type\n const { [SLOT_ELEMENT_TYPE_SYMBOL]: elementType } = slotElement;\n // eslint-disable-next-line deprecation/deprecation\n if (elementType !== typedState.components[slotName]) {\n // eslint-disable-next-line deprecation/deprecation\n slotElement[SLOT_ELEMENT_TYPE_SYMBOL] = typedState.components[slotName] as React.ComponentType<{}>;\n // eslint-disable-next-line no-console\n console.warn(/** #__DE-INDENT__ */ `\n @fluentui/react-utilities [${assertSlots.name}]:\n \"state.${slotName}\" element type differs from \"state.components.${slotName}\",\n ${elementType} !== ${typedState.components[slotName] /* eslint-disable-line deprecation/deprecation */}.\n Be sure to create slots properly by using \"slot.always\" or \"slot.optional\" with the correct elementType.\n `);\n }\n }\n }\n }\n}\n"],"names":["React","SLOT_ELEMENT_TYPE_SYMBOL","isSlot","slot","assertSlots","state","process","env","NODE_ENV","typedState","slotName","Object","keys","components","slotElement","undefined","always","elementType","console","warn","name"],"mappings":"AAAA,YAAYA,WAAW,QAAQ;AAC/B,SAASC,wBAAwB,QAAQ,cAAc;AACvD,SAASC,MAAM,QAAQ,WAAW;AAElC,YAAYC,UAAU,SAAS;AAM/B;;;;;;;;;;;;;;;;;;CAkBC,GACD,OAAO,SAASC,YAA2CC,KAAc;IACvE;;;GAGC,GACD,IAAIC,QAAQC,GAAG,CAACC,QAAQ,KAAK,cAAc;QACzC,MAAMC,aAAaJ;QACnB,mDAAmD;QACnD,KAAK,MAAMK,YAAYC,OAAOC,IAAI,CAACH,WAAWI,UAAU,EAAG;YACzD,MAAMC,cAAcL,UAAU,CAACC,SAAS;YACxC,IAAII,gBAAgBC,WAAW;gBAC7B;YACF;YACA,8HAA8H;YAC9H,4JAA4J;YAC5J,6EAA6E;YAC7E,IAAI,CAACb,OAAOY,cAAc;gBACxBL,UAAU,CAACC,SAAwC,GAAGP,KAAKa,MAAM,CAACF,aAAa;oBAC7E,mDAAmD;oBACnDG,aAAaR,WAAWI,UAAU,CAACH,SAAS;gBAC9C;gBACA,sCAAsC;gBACtCQ,QAAQC,IAAI,CAAuB,CAAC,2BACP,EAAEf,YAAYgB,IAAI,CAAC;OACvC,EAAEV,SAAS;2EAEpB,CAAC;YACH,OAAO;gBACL,mFAAmF;gBACnF,4JAA4J;gBAC5J,MAAM,EAAE,CAACT,yBAAyB,EAAEgB,WAAW,EAAE,GAAGH;gBACpD,mDAAmD;gBACnD,IAAIG,gBAAgBR,WAAWI,UAAU,CAACH,SAAS,EAAE;oBACnD,mDAAmD;oBACnDI,WAAW,CAACb,yBAAyB,GAAGQ,WAAWI,UAAU,CAACH,SAAS;oBACvE,sCAAsC;oBACtCQ,QAAQC,IAAI,CAAuB,CAAC,2BACP,EAAEf,YAAYgB,IAAI,CAAC;OACvC,EAAEV,SAAS,8CAA8C,EAAEA,SAAS;AAC3E,EAAEO,YAAY,KAAK,EAAER,WAAWI,UAAU,CAACH,SAAS,CAAmD;wGAEzG,CAAC;gBACH;YACF;QACF;IACF;AACF"}
|
@@ -21,12 +21,14 @@ import { SLOT_RENDER_FUNCTION_SYMBOL } from '../constants';
|
|
21
21
|
* @param state - State including slot definitions
|
22
22
|
* @returns An object containing the `slots` map and `slotProps` map.
|
23
23
|
*/ export function getSlots(state) {
|
24
|
+
const typeState = state;
|
24
25
|
// eslint-disable-next-line deprecation/deprecation
|
25
26
|
const slots = {};
|
26
27
|
const slotProps = {};
|
27
|
-
|
28
|
+
// eslint-disable-next-line deprecation/deprecation
|
29
|
+
const slotNames = Object.keys(typeState.components);
|
28
30
|
for (const slotName of slotNames){
|
29
|
-
const [slot, props] = getSlot(
|
31
|
+
const [slot, props] = getSlot(typeState, slotName);
|
30
32
|
// eslint-disable-next-line deprecation/deprecation
|
31
33
|
slots[slotName] = slot;
|
32
34
|
slotProps[slotName] = props;
|
@@ -49,7 +51,9 @@ function getSlot(state, slotName) {
|
|
49
51
|
// TS Error: Property 'as' does not exist on type 'UnknownSlotProps | undefined'.ts(2339)
|
50
52
|
const { as: asProp, children, ...rest } = props;
|
51
53
|
const renderFunction = isSlot(props) ? props[SLOT_RENDER_FUNCTION_SYMBOL] : undefined;
|
52
|
-
const slot = ((_state_components = state.components) === null || _state_components === void 0 ? void 0 : _state_components[slotName]) === undefined ||
|
54
|
+
const slot = ((_state_components = state.components) === null || _state_components === void 0 ? void 0 : _state_components[slotName]) === undefined || // eslint-disable-line deprecation/deprecation
|
55
|
+
// eslint-disable-next-line deprecation/deprecation
|
56
|
+
typeof state.components[slotName] === 'string' ? asProp || ((_state_components1 = state.components) === null || _state_components1 === void 0 ? void 0 : _state_components1[slotName]) || 'div' : state.components[slotName];
|
53
57
|
if (renderFunction || typeof children === 'function') {
|
54
58
|
const render = renderFunction || children;
|
55
59
|
return [
|
@@ -60,6 +64,7 @@ function getSlot(state, slotName) {
|
|
60
64
|
];
|
61
65
|
}
|
62
66
|
const shouldOmitAsProp = typeof slot === 'string' && asProp;
|
67
|
+
// eslint-disable-next-line deprecation/deprecation
|
63
68
|
const slotProps = shouldOmitAsProp ? omit(props, [
|
64
69
|
'as'
|
65
70
|
]) : props;
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"sources":["getSlots.ts"],"sourcesContent":["import * as React from 'react';\nimport { omit } from '../../utils/omit';\nimport type {
|
1
|
+
{"version":3,"sources":["getSlots.ts"],"sourcesContent":["import * as React from 'react';\nimport { omit } from '../../utils/omit';\nimport type { ComponentState, SlotPropsRecord, SlotRenderFunction, UnknownSlotProps } from '../types';\nimport { isSlot } from '../isSlot';\nimport { SLOT_RENDER_FUNCTION_SYMBOL } from '../constants';\n\n/**\n * @deprecated - use slot.always or slot.optional combined with assertSlots instead\n */\nexport type Slots<S extends SlotPropsRecord> = {\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [K in keyof S]: React.ElementType<any>;\n};\n\n/**\n * @deprecated - use slot.always or slot.optional combined with assertSlots instead\n */\nexport type ObjectSlotProps<S extends SlotPropsRecord> = {\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [K in keyof S]-?: any; // Slot<ButtonProps>\n};\n\n/**\n * Given the state and an array of slot names, will break out `slots` and `slotProps`\n * collections.\n *\n * The root is derived from a mix of `components` props and `as` prop.\n *\n * Slots will render as null if they are rendered as primitives with undefined children.\n *\n * The slotProps will always omit the `as` prop within them, and for slots that are string\n * primitives, the props will be filtered according to the slot type by the type system.\n * For example, if the slot is rendered `as: 'a'`, the props will be filtered for acceptable\n * anchor props. Note that this is only enforced at build time by Typescript -- there is no\n * runtime code filtering props in this function.\n *\n * @deprecated use slot.always or slot.optional combined with assertSlots instead\n *\n * @param state - State including slot definitions\n * @returns An object containing the `slots` map and `slotProps` map.\n */\nexport function getSlots<R extends SlotPropsRecord>(\n state: unknown,\n): {\n // eslint-disable-next-line deprecation/deprecation\n slots: Slots<R>;\n // eslint-disable-next-line deprecation/deprecation\n slotProps: ObjectSlotProps<R>;\n} {\n const typeState = state as ComponentState<R>;\n // eslint-disable-next-line deprecation/deprecation\n const slots = {} as Slots<R>;\n const slotProps = {} as R;\n\n // eslint-disable-next-line deprecation/deprecation\n const slotNames: (keyof R)[] = Object.keys(typeState.components);\n for (const slotName of slotNames) {\n const [slot, props] = getSlot(typeState, slotName);\n // eslint-disable-next-line deprecation/deprecation\n slots[slotName] = slot as Slots<R>[typeof slotName];\n slotProps[slotName] = props;\n }\n // eslint-disable-next-line deprecation/deprecation\n return { slots, slotProps: slotProps as unknown as ObjectSlotProps<R> };\n}\n\nfunction getSlot<R extends SlotPropsRecord, K extends keyof R>(\n state: ComponentState<R>,\n slotName: K,\n): readonly [React.ElementType<R[K]> | null, R[K]] {\n const props = state[slotName];\n\n if (props === undefined) {\n return [null, undefined as R[K]];\n }\n\n type NonUndefined<T> = T extends undefined ? never : T;\n // TS Error: Property 'as' does not exist on type 'UnknownSlotProps | undefined'.ts(2339)\n const { as: asProp, children, ...rest } = props as NonUndefined<typeof props>;\n\n const renderFunction = isSlot(props) ? props[SLOT_RENDER_FUNCTION_SYMBOL] : undefined;\n\n const slot = (\n state.components?.[slotName] === undefined || // eslint-disable-line deprecation/deprecation\n // eslint-disable-next-line deprecation/deprecation\n typeof state.components[slotName] === 'string'\n ? // eslint-disable-next-line deprecation/deprecation\n asProp || state.components?.[slotName] || 'div'\n : // eslint-disable-next-line deprecation/deprecation\n state.components[slotName]\n ) as React.ElementType<R[K]>;\n\n if (renderFunction || typeof children === 'function') {\n const render = (renderFunction || children) as SlotRenderFunction<R[K]>;\n return [\n React.Fragment as React.ElementType<R[K]>,\n {\n children: render(slot, rest as Omit<R[K], 'as'>),\n } as unknown as R[K],\n ];\n }\n\n const shouldOmitAsProp = typeof slot === 'string' && asProp;\n // eslint-disable-next-line deprecation/deprecation\n const slotProps = (shouldOmitAsProp ? omit(props, ['as']) : (props as UnknownSlotProps)) as R[K];\n return [slot, slotProps];\n}\n"],"names":["React","omit","isSlot","SLOT_RENDER_FUNCTION_SYMBOL","getSlots","state","typeState","slots","slotProps","slotNames","Object","keys","components","slotName","slot","props","getSlot","undefined","as","asProp","children","rest","renderFunction","render","Fragment","shouldOmitAsProp"],"mappings":"AAAA,YAAYA,WAAW,QAAQ;AAC/B,SAASC,IAAI,QAAQ,mBAAmB;AAExC,SAASC,MAAM,QAAQ,YAAY;AACnC,SAASC,2BAA2B,QAAQ,eAAe;AAkB3D;;;;;;;;;;;;;;;;;;CAkBC,GACD,OAAO,SAASC,SACdC,KAAc;IAOd,MAAMC,YAAYD;IAClB,mDAAmD;IACnD,MAAME,QAAQ,CAAC;IACf,MAAMC,YAAY,CAAC;IAEnB,mDAAmD;IACnD,MAAMC,YAAyBC,OAAOC,IAAI,CAACL,UAAUM,UAAU;IAC/D,KAAK,MAAMC,YAAYJ,UAAW;QAChC,MAAM,CAACK,MAAMC,MAAM,GAAGC,QAAQV,WAAWO;QACzC,mDAAmD;QACnDN,KAAK,CAACM,SAAS,GAAGC;QAClBN,SAAS,CAACK,SAAS,GAAGE;IACxB;IACA,mDAAmD;IACnD,OAAO;QAAER;QAAOC,WAAWA;IAA2C;AACxE;AAEA,SAASQ,QACPX,KAAwB,EACxBQ,QAAW;QAeTR,mBAIcA;IAjBhB,MAAMU,QAAQV,KAAK,CAACQ,SAAS;IAE7B,IAAIE,UAAUE,WAAW;QACvB,OAAO;YAAC;YAAMA;SAAkB;IAClC;IAGA,yFAAyF;IACzF,MAAM,EAAEC,IAAIC,MAAM,EAAEC,QAAQ,EAAE,GAAGC,MAAM,GAAGN;IAE1C,MAAMO,iBAAiBpB,OAAOa,SAASA,KAAK,CAACZ,4BAA4B,GAAGc;IAE5E,MAAMH,OACJT,EAAAA,oBAAAA,MAAMO,UAAU,cAAhBP,wCAAAA,iBAAkB,CAACQ,SAAS,MAAKI,aAAa,8CAA8C;IAC5F,mDAAmD;IACnD,OAAOZ,MAAMO,UAAU,CAACC,SAAS,KAAK,WAElCM,YAAUd,qBAAAA,MAAMO,UAAU,cAAhBP,yCAAAA,kBAAkB,CAACQ,SAAS,KAAI,QAE1CR,MAAMO,UAAU,CAACC,SAAS;IAGhC,IAAIS,kBAAkB,OAAOF,aAAa,YAAY;QACpD,MAAMG,SAAUD,kBAAkBF;QAClC,OAAO;YACLpB,MAAMwB,QAAQ;YACd;gBACEJ,UAAUG,OAAOT,MAAMO;YACzB;SACD;IACH;IAEA,MAAMI,mBAAmB,OAAOX,SAAS,YAAYK;IACrD,mDAAmD;IACnD,MAAMX,YAAaiB,mBAAmBxB,KAAKc,OAAO;QAAC;KAAK,IAAKA;IAC7D,OAAO;QAACD;QAAMN;KAAU;AAC1B"}
|
@@ -9,13 +9,15 @@ import * as React from 'react';
|
|
9
9
|
*
|
10
10
|
* @deprecated use slot.always or slot.optional combined with assertSlots instead
|
11
11
|
*/ export function getSlotsNext(state) {
|
12
|
+
const typedState = state;
|
12
13
|
// eslint-disable-next-line deprecation/deprecation
|
13
14
|
const slots = {};
|
14
15
|
const slotProps = {};
|
15
|
-
|
16
|
+
// eslint-disable-next-line deprecation/deprecation
|
17
|
+
const slotNames = Object.keys(typedState.components);
|
16
18
|
for (const slotName of slotNames){
|
17
19
|
// eslint-disable-next-line deprecation/deprecation
|
18
|
-
const [slot, props] = getSlotNext(
|
20
|
+
const [slot, props] = getSlotNext(typedState, slotName);
|
19
21
|
// eslint-disable-next-line deprecation/deprecation
|
20
22
|
slots[slotName] = slot;
|
21
23
|
slotProps[slotName] = props;
|
@@ -39,8 +41,11 @@ import * as React from 'react';
|
|
39
41
|
}
|
40
42
|
// TS Error: Property 'as' does not exist on type 'UnknownSlotProps | undefined'.ts(2339)
|
41
43
|
const { as: asProp, ...propsWithoutAs } = props;
|
42
|
-
const slot = ((_state_components = state.components) === null || _state_components === void 0 ? void 0 : _state_components[slotName]) === undefined ||
|
44
|
+
const slot = ((_state_components = state.components) === null || _state_components === void 0 ? void 0 : _state_components[slotName]) === undefined || // eslint-disable-line deprecation/deprecation
|
45
|
+
// eslint-disable-next-line deprecation/deprecation
|
46
|
+
typeof state.components[slotName] === 'string' ? asProp || ((_state_components1 = state.components) === null || _state_components1 === void 0 ? void 0 : _state_components1[slotName]) || 'div' : state.components[slotName];
|
43
47
|
const shouldOmitAsProp = typeof slot === 'string' && asProp;
|
48
|
+
// eslint-disable-next-line deprecation/deprecation
|
44
49
|
const slotProps = shouldOmitAsProp ? propsWithoutAs : props;
|
45
50
|
return [
|
46
51
|
slot,
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"sources":["getSlotsNext.ts"],"sourcesContent":["import * as React from 'react';\nimport type { ComponentState, SlotPropsRecord, UnknownSlotProps } from '../types';\nimport { ObjectSlotProps, Slots } from './getSlots';\n\n/**\n * Similar to `getSlots`, main difference is that it's compatible with new custom jsx pragma\n *\n * @internal\n * This is an internal temporary method, this method will cease to exist eventually!\n *\n * * ❗️❗️ **DO NOT USE IT EXTERNALLY** ❗️❗️\n *\n * @deprecated use slot.always or slot.optional combined with assertSlots instead\n */\nexport function getSlotsNext<R extends SlotPropsRecord>(\n state:
|
1
|
+
{"version":3,"sources":["getSlotsNext.ts"],"sourcesContent":["import * as React from 'react';\nimport type { ComponentState, SlotPropsRecord, UnknownSlotProps } from '../types';\nimport { ObjectSlotProps, Slots } from './getSlots';\n\n/**\n * Similar to `getSlots`, main difference is that it's compatible with new custom jsx pragma\n *\n * @internal\n * This is an internal temporary method, this method will cease to exist eventually!\n *\n * * ❗️❗️ **DO NOT USE IT EXTERNALLY** ❗️❗️\n *\n * @deprecated use slot.always or slot.optional combined with assertSlots instead\n */\nexport function getSlotsNext<R extends SlotPropsRecord>(\n state: unknown,\n): {\n // eslint-disable-next-line deprecation/deprecation\n slots: Slots<R>;\n // eslint-disable-next-line deprecation/deprecation\n slotProps: ObjectSlotProps<R>;\n} {\n const typedState = state as ComponentState<R>;\n // eslint-disable-next-line deprecation/deprecation\n const slots = {} as Slots<R>;\n const slotProps = {} as R;\n\n // eslint-disable-next-line deprecation/deprecation\n const slotNames: (keyof R)[] = Object.keys(typedState.components);\n for (const slotName of slotNames) {\n // eslint-disable-next-line deprecation/deprecation\n const [slot, props] = getSlotNext(typedState, slotName);\n // eslint-disable-next-line deprecation/deprecation\n slots[slotName] = slot as Slots<R>[typeof slotName];\n slotProps[slotName] = props;\n }\n // eslint-disable-next-line deprecation/deprecation\n return { slots, slotProps: slotProps as unknown as ObjectSlotProps<R> };\n}\n\n/**\n * @deprecated use slot.always or slot.optional combined with assertSlots instead\n */\nfunction getSlotNext<R extends SlotPropsRecord, K extends keyof R>(\n state: ComponentState<R>,\n slotName: K,\n): readonly [React.ElementType<R[K]> | null, R[K]] {\n const props = state[slotName];\n\n if (props === undefined) {\n return [null, undefined as R[K]];\n }\n\n type NonUndefined<T> = T extends undefined ? never : T;\n // TS Error: Property 'as' does not exist on type 'UnknownSlotProps | undefined'.ts(2339)\n const { as: asProp, ...propsWithoutAs } = props as NonUndefined<typeof props>;\n\n const slot = (\n state.components?.[slotName] === undefined || // eslint-disable-line deprecation/deprecation\n // eslint-disable-next-line deprecation/deprecation\n typeof state.components[slotName] === 'string'\n ? // eslint-disable-next-line deprecation/deprecation\n asProp || state.components?.[slotName] || 'div'\n : // eslint-disable-next-line deprecation/deprecation\n state.components[slotName]\n ) as React.ElementType<R[K]>;\n\n const shouldOmitAsProp = typeof slot === 'string' && asProp;\n // eslint-disable-next-line deprecation/deprecation\n const slotProps: UnknownSlotProps = shouldOmitAsProp ? propsWithoutAs : props;\n\n return [slot, slotProps as R[K]];\n}\n"],"names":["React","getSlotsNext","state","typedState","slots","slotProps","slotNames","Object","keys","components","slotName","slot","props","getSlotNext","undefined","as","asProp","propsWithoutAs","shouldOmitAsProp"],"mappings":"AAAA,YAAYA,WAAW,QAAQ;AAI/B;;;;;;;;;CASC,GACD,OAAO,SAASC,aACdC,KAAc;IAOd,MAAMC,aAAaD;IACnB,mDAAmD;IACnD,MAAME,QAAQ,CAAC;IACf,MAAMC,YAAY,CAAC;IAEnB,mDAAmD;IACnD,MAAMC,YAAyBC,OAAOC,IAAI,CAACL,WAAWM,UAAU;IAChE,KAAK,MAAMC,YAAYJ,UAAW;QAChC,mDAAmD;QACnD,MAAM,CAACK,MAAMC,MAAM,GAAGC,YAAYV,YAAYO;QAC9C,mDAAmD;QACnDN,KAAK,CAACM,SAAS,GAAGC;QAClBN,SAAS,CAACK,SAAS,GAAGE;IACxB;IACA,mDAAmD;IACnD,OAAO;QAAER;QAAOC,WAAWA;IAA2C;AACxE;AAEA;;CAEC,GACD,SAASQ,YACPX,KAAwB,EACxBQ,QAAW;QAaTR,mBAIcA;IAfhB,MAAMU,QAAQV,KAAK,CAACQ,SAAS;IAE7B,IAAIE,UAAUE,WAAW;QACvB,OAAO;YAAC;YAAMA;SAAkB;IAClC;IAGA,yFAAyF;IACzF,MAAM,EAAEC,IAAIC,MAAM,EAAE,GAAGC,gBAAgB,GAAGL;IAE1C,MAAMD,OACJT,EAAAA,oBAAAA,MAAMO,UAAU,cAAhBP,wCAAAA,iBAAkB,CAACQ,SAAS,MAAKI,aAAa,8CAA8C;IAC5F,mDAAmD;IACnD,OAAOZ,MAAMO,UAAU,CAACC,SAAS,KAAK,WAElCM,YAAUd,qBAAAA,MAAMO,UAAU,cAAhBP,yCAAAA,kBAAkB,CAACQ,SAAS,KAAI,QAE1CR,MAAMO,UAAU,CAACC,SAAS;IAGhC,MAAMQ,mBAAmB,OAAOP,SAAS,YAAYK;IACrD,mDAAmD;IACnD,MAAMX,YAA8Ba,mBAAmBD,iBAAiBL;IAExE,OAAO;QAACD;QAAMN;KAAkB;AAClC"}
|
@@ -6,7 +6,7 @@ import * as slot from '../slot';
|
|
6
6
|
* @param value - the base shorthand props
|
7
7
|
* @param options - options to resolve shorthand props
|
8
8
|
*
|
9
|
-
* @deprecated use slot.always
|
9
|
+
* @deprecated use slot.always, slot.optional, slot.resolveShorthand combined with assertSlots instead
|
10
10
|
*/ // eslint-disable-next-line deprecation/deprecation
|
11
11
|
export const resolveShorthand = (value, options)=>slot.optional(value, {
|
12
12
|
...options,
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"sources":["resolveShorthand.ts"],"sourcesContent":["import * as slot from '../slot';\nimport type { SlotShorthandValue,
|
1
|
+
{"version":3,"sources":["resolveShorthand.ts"],"sourcesContent":["import * as slot from '../slot';\nimport type { SlotPropsDataType, SlotShorthandValue, WithoutSlotRenderFunction } from '../types';\n\n/**\n * @deprecated - use slot.always or slot.optional combined with assertSlots instead\n */\nexport type ResolveShorthandOptions<Props, Required extends boolean = false> = Required extends true\n ? { required: true; defaultProps?: Props }\n : { required?: Required; defaultProps?: Props };\n\n/**\n * @deprecated use slot.always or slot.optional combined with assertSlots instead\n */\nexport type ResolveShorthandFunction<Props extends SlotPropsDataType = SlotPropsDataType> = {\n <P extends Props>(\n value: P | SlotShorthandValue | undefined,\n // eslint-disable-next-line deprecation/deprecation\n options: ResolveShorthandOptions<P, true>,\n ): WithoutSlotRenderFunction<P>;\n // eslint-disable-next-line deprecation/deprecation\n <P extends Props>(value: P | SlotShorthandValue | null | undefined, options?: ResolveShorthandOptions<P, boolean>):\n | WithoutSlotRenderFunction<P>\n | undefined;\n};\n\n/**\n *\n * Resolves shorthands into slot props, to ensure normalization of the signature\n * being passed down to getSlots method\n * @param value - the base shorthand props\n * @param options - options to resolve shorthand props\n *\n * @deprecated use slot.always, slot.optional, slot.resolveShorthand combined with assertSlots instead\n */\n// eslint-disable-next-line deprecation/deprecation\nexport const resolveShorthand: ResolveShorthandFunction<SlotPropsDataType> = (value, options) =>\n slot.optional<SlotPropsDataType>(value, {\n ...options,\n renderByDefault: options?.required,\n // elementType as undefined is the way to identify between a slot and a resolveShorthand call\n // in the case elementType is undefined assertSlots will fail, ensuring it'll only work with slot method.\n elementType: undefined!,\n }) as WithoutSlotRenderFunction<SlotPropsDataType>;\n"],"names":["slot","resolveShorthand","value","options","optional","renderByDefault","required","elementType","undefined"],"mappings":"AAAA,YAAYA,UAAU,UAAU;AAyBhC;;;;;;;;CAQC,GACD,mDAAmD;AACnD,OAAO,MAAMC,mBAAgE,CAACC,OAAOC,UACnFH,KAAKI,QAAQ,CAAoBF,OAAO;QACtC,GAAGC,OAAO;QACVE,eAAe,EAAEF,oBAAAA,8BAAAA,QAASG,QAAQ;QAClC,6FAA6F;QAC7F,yGAAyG;QACzGC,aAAaC;IACf,GAAmD"}
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"sources":["getIntrinsicElementProps.ts"],"sourcesContent":["import * as React from 'react';\nimport { getNativeElementProps } from '../utils/getNativeElementProps';\nimport type { InferredElementRefType,
|
1
|
+
{"version":3,"sources":["getIntrinsicElementProps.ts"],"sourcesContent":["import * as React from 'react';\nimport { getNativeElementProps } from '../utils/getNativeElementProps';\nimport type { InferredElementRefType, SlotPropsDataType } from './types';\nimport type { DistributiveOmit } from '../utils/types';\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype HTMLAttributes = React.HTMLAttributes<any>;\n\n/**\n * Given an element tagname and user props, filters the props to only allowed props for the given\n * element type.\n *\n * Equivalent to {@link getNativeElementProps}, but more type-safe.\n */\nexport const getIntrinsicElementProps = <\n Props extends SlotPropsDataType,\n ExcludedPropKeys extends Extract<keyof Props, string> = never,\n>(\n /** The slot's default element type (e.g. 'div') */\n tagName: NonNullable<Props['as']>,\n /** The component's props object */\n props: Props & React.RefAttributes<InferredElementRefType<Props>>,\n /** List of native props to exclude from the returned value */\n excludedPropNames?: ExcludedPropKeys[],\n) => {\n // eslint-disable-next-line deprecation/deprecation\n return getNativeElementProps<\n DistributiveOmit<Props, Exclude<keyof Props, keyof HTMLAttributes | keyof SlotPropsDataType> | ExcludedPropKeys>\n >(props.as ?? tagName, props, excludedPropNames);\n};\n"],"names":["React","getNativeElementProps","getIntrinsicElementProps","tagName","props","excludedPropNames","as"],"mappings":"AAAA,YAAYA,WAAW,QAAQ;AAC/B,SAASC,qBAAqB,QAAQ,iCAAiC;AAOvE;;;;;CAKC,GACD,OAAO,MAAMC,2BAA2B,CAItC,iDAAiD,GACjDC,SACA,iCAAiC,GACjCC,OACA,4DAA4D,GAC5DC;QAKED;IAHF,mDAAmD;IACnD,OAAOH,sBAELG,CAAAA,YAAAA,MAAME,EAAE,cAARF,uBAAAA,YAAYD,SAASC,OAAOC;AAChC,EAAE"}
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"sources":["isResolvedShorthand.ts"],"sourcesContent":["import { isValidElement } from 'react';\nimport type { ExtractSlotProps, Slot,
|
1
|
+
{"version":3,"sources":["isResolvedShorthand.ts"],"sourcesContent":["import { isValidElement } from 'react';\nimport type { ExtractSlotProps, Slot, SlotPropsDataType } from './types';\n\n/**\n * Guard method that validates if a shorthand is a slot\n * can be used to extends properties provided by a slot\n *\n * @example\n * ```\n * const backdropSlot = resolveShorthand(backdrop, {\n * defaultProps: {\n * onClick: useEventCallback(event => {\n * if (isResolvedShorthand(backdrop)) {\n * backdrop.onClick?.(event)\n * }\n * // do something after passing click down the line\n * }),\n * },\n * })\n * ```\n * @example\n * ```\n * const handleBackDropClick = (event) => {\n * // do your thing\n * }\n * const backdropSlot = resolveShorthand(backdrop, {\n * defaultProps: {\n * onClick: useEventCallback(\n * mergeCallbacks(isResolvedShorthand(backdrop) ? backdrop.onClick : undefined, handleBackdropClick)\n * )\n * })\n * ```\n */\nexport function isResolvedShorthand<Shorthand extends Slot<SlotPropsDataType>>(\n shorthand?: Shorthand,\n): shorthand is ExtractSlotProps<Shorthand> {\n return shorthand !== null && typeof shorthand === 'object' && !Array.isArray(shorthand) && !isValidElement(shorthand);\n}\n"],"names":["isValidElement","isResolvedShorthand","shorthand","Array","isArray"],"mappings":"AAAA,SAASA,cAAc,QAAQ,QAAQ;AAGvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6BC,GACD,OAAO,SAASC,oBACdC,SAAqB;IAErB,OAAOA,cAAc,QAAQ,OAAOA,cAAc,YAAY,CAACC,MAAMC,OAAO,CAACF,cAAc,CAACF,eAAeE;AAC7G"}
|