Skip to content

fix(react-shared-contexts): exposes internal leaks used in the API surface #25405

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.

Sign up for GitHub

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

Merged
bsunderhus merged 1 commit into from
Oct 28, 2022
Merged

fix(react-shared-contexts): exposes internal leaks used in the API surface #25405

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions change/@fluentui-react-shared-contexts-625a6ac7-63ff-4172-a2fd-a4f60b9eff2e.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "minor",
"comment": "exposes internal methods and types that are used in the API surface",
"packageName": "@fluentui/react-shared-contexts",
"email": "[email protected]",
"dependentChangeType": "patch"
}
8 changes: 4 additions & 4 deletions packages/react-components/react-shared-contexts/etc/react-shared-contexts.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ export const ThemeClassNameProvider_unstable: React_2.Provider<string>;
// @internal (undocumented)
export const ThemeContext_unstable: React_2.Context<ThemeContextValue_unstable>;

// @internal (undocumented)
// @public (undocumented)
export type ThemeContextValue_unstable = Theme | Partial<Theme> | undefined;

// @internal (undocumented)
export const ThemeProvider_unstable: React_2.Provider<ThemeContextValue_unstable>;

// @internal
// @public
export type TooltipVisibilityContextValue_unstable = {
visibleTooltip?: {
hide: () => void;
Expand All @@ -44,10 +44,10 @@ export const TooltipVisibilityProvider_unstable: React_2.Provider<TooltipVisibil
// @public (undocumented)
export function useFluent_unstable(): ProviderContextValue_unstable;

// @internal (undocumented)
// @public (undocumented)
export function useThemeClassName_unstable(): ThemeClassNameContextValue_unstable;

// @internal (undocumented)
// @public (undocumented)
export function useTooltipVisibility_unstable(): TooltipVisibilityContextValue_unstable;

// (No @packageDocumentation comment for this package)
Expand Down
1 change: 0 additions & 1 deletion ...react-components/react-shared-contexts/src/ThemeClassNameContext/ThemeClassNameContext.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ const themeClassNameContextDefaultVaue = '';
export const ThemeClassNameProvider = ThemeClassNameContext.Provider;

/**
* @internal
* @returns CSS class that applies css variables
*/
export function useThemeClassName(): ThemeClassNameContextValue {
Expand Down
3 changes: 0 additions & 3 deletions packages/react-components/react-shared-contexts/src/ThemeContext/ThemeContext.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
import * as React from 'react';
import type { Theme } from '@fluentui/react-theme';

/**
* @internal
*/
export type ThemeContextValue = Theme | Partial<Theme> | undefined;

/**
Expand Down
4 changes: 0 additions & 4 deletions ...ges/react-components/react-shared-contexts/src/TooltipVisibilityContext/TooltipContext.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import * as React from 'react';

/**
* @internal
* The context provided by TooltipProvider
*/
export type TooltipVisibilityContextValue = {
Expand Down Expand Up @@ -29,9 +28,6 @@ const tooltipVisibilityContextDefaultValue: TooltipVisibilityContextValue = {};
*/
export const TooltipVisibilityProvider = TooltipVisibilityContext.Provider;

/**
* @internal
*/
export function useTooltipVisibility(): TooltipVisibilityContextValue {
return React.useContext(TooltipVisibilityContext) ?? tooltipVisibilityContextDefaultValue;
}