Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(react-provider): Updating FluentProvider types to avoid implicit import in API definition #33590

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
Copy link
Collaborator

@fabricteam fabricteam Jan 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🕵🏾‍♀️ visual regressions to review in the fluentuiv9 Visual Regression Report

Avatar Converged 2 screenshots
Image Name Diff(in Pixels) Image Type
Avatar Converged.Badge Mask RTL.chromium.png 4 Changed
Avatar Converged.badgeMask.chromium.png 41 Changed
Drawer 2 screenshots
Image Name Diff(in Pixels) Image Type
Drawer.Full Overlay High Contrast.chromium.png 2247 Changed
Drawer.Full Overlay RTL.chromium.png 1167 Changed

"type": "minor",
"comment": "chore: Updating FluentProvider types to avoid implicit import in API definition.",
"packageName": "@fluentui/react-provider",
"email": "[email protected]",
"dependentChangeType": "patch"
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@

```ts

import { ComponentProps } from '@fluentui/react-utilities';
import type { ComponentProps } from '@fluentui/react-utilities';
import type { ComponentState } from '@fluentui/react-utilities';
import type { CustomStyleHooksContextValue_unstable } from '@fluentui/react-shared-contexts';
import { ForwardRefComponent } from '@fluentui/react-utilities';
import type { IconDirectionContextValue } from '@fluentui/react-icons/lib/providers';
import { OverridesContextValue_unstable } from '@fluentui/react-shared-contexts';
import type { OverridesContextValue_unstable } from '@fluentui/react-shared-contexts';
import type { PartialTheme } from '@fluentui/react-theme';
import type { ProviderContextValue_unstable } from '@fluentui/react-shared-contexts';
import * as React_2 from 'react';
import type { Slot } from '@fluentui/react-utilities';
import { SlotClassNames } from '@fluentui/react-utilities';
import { Theme } from '@fluentui/tokens';
import type { ThemeClassNameContextValue_unstable } from '@fluentui/react-shared-contexts';
import type { ThemeContextValue_unstable } from '@fluentui/react-shared-contexts';
import type { TooltipVisibilityContextValue_unstable } from '@fluentui/react-shared-contexts';
Expand All @@ -23,160 +23,7 @@ import type { TooltipVisibilityContextValue_unstable } from '@fluentui/react-sha
export function createCSSRuleFromTheme(selector: string, theme: PartialTheme | undefined): string;

// @public (undocumented)
export const FluentProvider: React_2.ForwardRefExoticComponent<Omit<ComponentProps<FluentProviderSlots>, "dir"> & {
applyStylesToPortals?: boolean | undefined;
customStyleHooks_unstable?: Partial<{
useAccordionHeaderStyles_unstable: (state: unknown) => void;
useAccordionItemStyles_unstable: (state: unknown) => void;
useAccordionPanelStyles_unstable: (state: unknown) => void;
useAccordionStyles_unstable: (state: unknown) => void;
useAvatarStyles_unstable: (state: unknown) => void;
useAvatarGroupStyles_unstable: (state: unknown) => void;
useAvatarGroupItemStyles_unstable: (state: unknown) => void;
useAvatarGroupPopoverStyles_unstable: (state: unknown) => void;
useBadgeStyles_unstable: (state: unknown) => void;
useCounterBadgeStyles_unstable: (state: unknown) => void;
useCardHeaderStyles_unstable: (state: unknown) => void;
useCardStyles_unstable: (state: unknown) => void;
useCardFooterStyles_unstable: (state: unknown) => void;
useCardPreviewStyles_unstable: (state: unknown) => void;
usePresenceBadgeStyles_unstable: (state: unknown) => void;
useButtonStyles_unstable: (state: unknown) => void;
useCompoundButtonStyles_unstable: (state: unknown) => void;
useMenuButtonStyles_unstable: (state: unknown) => void;
useSplitButtonStyles_unstable: (state: unknown) => void;
useToggleButtonStyles_unstable: (state: unknown) => void;
useCheckboxStyles_unstable: (state: unknown) => void;
useComboboxStyles_unstable: (state: unknown) => void;
useDropdownStyles_unstable: (state: unknown) => void;
useListboxStyles_unstable: (state: unknown) => void;
useListStyles_unstable: (state: unknown) => void;
useListItemStyles_unstable: (state: unknown) => void;
useListItemButtonStyles_unstable: (state: unknown) => void;
useOptionStyles_unstable: (state: unknown) => void;
useOptionGroupStyles_unstable: (state: unknown) => void;
useDividerStyles_unstable: (state: unknown) => void;
useInputStyles_unstable: (state: unknown) => void;
useImageStyles_unstable: (state: unknown) => void;
useLabelStyles_unstable: (state: unknown) => void;
useLinkStyles_unstable: (state: unknown) => void;
useMenuDividerStyles_unstable: (state: unknown) => void;
useMenuGroupHeaderStyles_unstable: (state: unknown) => void;
useMenuGroupStyles_unstable: (state: unknown) => void;
useMenuItemCheckboxStyles_unstable: (state: unknown) => void;
useMenuItemSwitchStyles_unstable: (state: unknown) => void;
useMenuItemRadioStyles_unstable: (state: unknown) => void;
useMenuItemStyles_unstable: (state: unknown) => void;
useMenuItemLinkStyles_unstable: (state: unknown) => void;
useMenuListStyles_unstable: (state: unknown) => void;
useMenuPopoverStyles_unstable: (state: unknown) => void;
useMenuSplitGroupStyles_unstable: (state: unknown) => void;
usePersonaStyles_unstable: (state: unknown) => void;
usePopoverSurfaceStyles_unstable: (state: unknown) => void;
useRadioGroupStyles_unstable: (state: unknown) => void;
useRadioStyles_unstable: (state: unknown) => void;
useSelectStyles_unstable: (state: unknown) => void;
useSliderStyles_unstable: (state: unknown) => void;
useSpinButtonStyles_unstable: (state: unknown) => void;
useSpinnerStyles_unstable: (state: unknown) => void;
useSwitchStyles_unstable: (state: unknown) => void;
useTabStyles_unstable: (state: unknown) => void;
useTabListStyles_unstable: (state: unknown) => void;
useTextStyles_unstable: (state: unknown) => void;
useTextareaStyles_unstable: (state: unknown) => void;
useTooltipStyles_unstable: (state: unknown) => void;
useDialogTitleStyles_unstable: (state: unknown) => void;
useDialogBodyStyles_unstable: (state: unknown) => void;
useDialogActionsStyles_unstable: (state: unknown) => void;
useDialogSurfaceStyles_unstable: (state: unknown) => void;
useDialogContentStyles_unstable: (state: unknown) => void;
useProgressBarStyles_unstable: (state: unknown) => void;
useToolbarButtonStyles_unstable: (state: unknown) => void;
useToolbarRadioButtonStyles_unstable: (state: unknown) => void;
useToolbarGroupStyles_unstable: (state: unknown) => void;
useToolbarToggleButtonStyles_unstable: (state: unknown) => void;
useToolbarDividerStyles_unstable: (state: unknown) => void;
useToolbarStyles_unstable: (state: unknown) => void;
useTableCellStyles_unstable: (state: unknown) => void;
useTableRowStyles_unstable: (state: unknown) => void;
useTableBodyStyles_unstable: (state: unknown) => void;
useTableStyles_unstable: (state: unknown) => void;
useTableHeaderStyles_unstable: (state: unknown) => void;
useTableHeaderCellStyles_unstable: (state: unknown) => void;
useTableResizeHandleStyles_unstable: (state: unknown) => void;
useTableSelectionCellStyles_unstable: (state: unknown) => void;
useTableCellActionsStyles_unstable: (state: unknown) => void;
useTableCellLayoutStyles_unstable: (state: unknown) => void;
useDataGridCellStyles_unstable: (state: unknown) => void;
useDataGridRowStyles_unstable: (state: unknown) => void;
useDataGridBodyStyles_unstable: (state: unknown) => void;
useDataGridStyles_unstable: (state: unknown) => void;
useDataGridHeaderStyles_unstable: (state: unknown) => void;
useDataGridHeaderCellStyles_unstable: (state: unknown) => void;
useDataGridSelectionCellStyles_unstable: (state: unknown) => void;
useDrawerStyles_unstable: (state: unknown) => void;
useDrawerInlineStyles_unstable: (state: unknown) => void;
useDrawerOverlayStyles_unstable: (state: unknown) => void;
useInlineDrawerStyles_unstable: (state: unknown) => void;
useOverlayDrawerStyles_unstable: (state: unknown) => void;
useDrawerHeaderStyles_unstable: (state: unknown) => void;
useDrawerHeaderNavigationStyles_unstable: (state: unknown) => void;
useDrawerHeaderTitleStyles_unstable: (state: unknown) => void;
useDrawerBodyStyles_unstable: (state: unknown) => void;
useDrawerFooterStyles_unstable: (state: unknown) => void;
useInteractionTagStyles_unstable: (state: unknown) => void;
useInteractionTagPrimaryStyles_unstable: (state: unknown) => void;
useInteractionTagSecondaryStyles_unstable: (state: unknown) => void;
useTagStyles_unstable: (state: unknown) => void;
useTagGroupStyles_unstable: (state: unknown) => void;
useBreadcrumbStyles_unstable: (state: unknown) => void;
useBreadcrumbButtonStyles_unstable: (state: unknown) => void;
useBreadcrumbItemStyles_unstable: (state: unknown) => void;
useBreadcrumbDividerStyles_unstable: (state: unknown) => void;
useMessageBarStyles_unstable: (state: unknown) => void;
useMessageBarBodyStyles_unstable: (state: unknown) => void;
useMessageBarTitleStyles_unstable: (state: unknown) => void;
useMessageBarActionsStyles_unstable: (state: unknown) => void;
useMessageBarGroupStyles_unstable: (state: unknown) => void;
useToasterStyles_unstable: (state: unknown) => void;
useTeachingPopoverStyles_unstable: (state: unknown) => void;
useTeachingPopoverActionsStyles_unstable: (state: unknown) => void;
useTeachingPopoverBodyStyles_unstable: (state: unknown) => void;
useTeachingPopoverButtonStyles_unstable: (state: unknown) => void;
useTeachingPopoverCarouselStyles_unstable: (state: unknown) => void;
useTeachingPopoverHeaderStyles_unstable: (state: unknown) => void;
useTeachingPopoverPageCountStyles_unstable: (state: unknown) => void;
useTeachingPopoverSurfaceStyles_unstable: (state: unknown) => void;
useTeachingPopoverTitleStyles_unstable: (state: unknown) => void;
useTimePickerCompatStyles_unstable: (state: unknown) => void;
useTagPickerInputStyles_unstable: (state: unknown) => void;
useTagPickerButtonStyles_unstable: (state: unknown) => void;
useTagPickerControlStyles_unstable: (state: unknown) => void;
useTagPickerGroupStyles_unstable: (state: unknown) => void;
useTagPickerListStyles_unstable: (state: unknown) => void;
useTagPickerOptionStyles_unstable: (state: unknown) => void;
useTagPickerOptionGroupStyles_unstable: (state: unknown) => void;
useColorSwatchStyles_unstable: (state: unknown) => void;
useImageSwatchStyles_unstable: (state: unknown) => void;
useEmptySwatchStyles_unstable: (state: unknown) => void;
useSwatchPickerRowStyles_unstable: (state: unknown) => void;
useSwatchPickerStyles_unstable: (state: unknown) => void;
useCarouselViewportStyles_unstable: (state: unknown) => void;
useCarouselSliderStyles_unstable: (state: unknown) => void;
useCarouselStyles_unstable: (state: unknown) => void;
useCarouselAutoplayButtonStyles_unstable: (state: unknown) => void;
useCarouselButtonStyles_unstable: (state: unknown) => void;
useCarouselCardStyles_unstable: (state: unknown) => void;
useCarouselNavStyles_unstable: (state: unknown) => void;
useCarouselNavButtonStyles_unstable: (state: unknown) => void;
useCarouselNavContainerStyles_unstable: (state: unknown) => void;
useCarouselNavImageButtonStyles_unstable: (state: unknown) => void;
}> | undefined;
dir?: "ltr" | "rtl" | undefined;
targetDocument?: Document | undefined;
theme?: Partial<Theme> | undefined;
overrides_unstable?: OverridesContextValue_unstable | undefined;
} & React_2.RefAttributes<HTMLElement>>;
export const FluentProvider: ForwardRefComponent<FluentProviderProps>;

// @public (undocumented)
export const fluentProviderClassNames: SlotClassNames<FluentProviderSlots>;
Expand Down Expand Up @@ -222,7 +69,7 @@ export type FluentProviderState = ComponentState<FluentProviderSlots> & Pick<Flu
export const renderFluentProvider_unstable: (state: FluentProviderState, contextValues: FluentProviderContextValues) => JSX.Element;

// @public
export const useFluentProvider_unstable: (props: FluentProviderProps, ref: React_2.Ref<HTMLElement>) => FluentProviderState;
export const useFluentProvider_unstable: (props: FluentProviderProps, ref: React_2.Ref<HTMLDivElement>) => FluentProviderState;

// @public (undocumented)
export function useFluentProviderContextValues_unstable(state: FluentProviderState): FluentProviderContextValues;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
import * as React from 'react';
import { ForwardRefComponent } from '@fluentui/react-utilities';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
import { ForwardRefComponent } from '@fluentui/react-utilities';
import type { ForwardRefComponent } from '@fluentui/react-utilities';

import { renderFluentProvider_unstable } from './renderFluentProvider';
import { useFluentProvider_unstable } from './useFluentProvider';
import { useFluentProviderStyles_unstable } from './useFluentProviderStyles.styles';
import { useFluentProviderContextValues_unstable } from './useFluentProviderContextValues';
import type { FluentProviderProps } from './FluentProvider.types';

export const FluentProvider = React.forwardRef<HTMLElement, FluentProviderProps>((props, ref) => {
export const FluentProvider: ForwardRefComponent<FluentProviderProps> = React.forwardRef<
HTMLDivElement,
FluentProviderProps
>((props, ref) => {
const state = useFluentProvider_unstable(props, ref);
useFluentProviderStyles_unstable(state);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ const DEFAULT_RENDERER_ATTRIBUTES = {};
*/
export const useFluentProvider_unstable = (
props: FluentProviderProps,
ref: React.Ref<HTMLElement>,
ref: React.Ref<HTMLDivElement>,
): FluentProviderState => {
'use no memo';

Expand Down
Loading