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

fix: make api.md up to date #33599

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
Hotell marked this conversation as resolved.
Show resolved Hide resolved
"type": "none",
"comment": "fix: make api.md up to date",
"packageName": "@fluentui/react-color-picker-preview",
"email": "[email protected]",
"dependentChangeType": "none"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "none",
"comment": "fix: make api.md up to date",
"packageName": "@fluentui/react-motion-components-preview",
"email": "[email protected]",
"dependentChangeType": "none"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "none",
"comment": "fix: make api.md up to date",
"packageName": "@fluentui/react-nav-preview",
"email": "[email protected]",
"dependentChangeType": "none"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "none",
"comment": "docs: fix invalid TSdoc that is causing warnings within generate-api task",
"packageName": "@fluentui/react-tabster",
"email": "[email protected]",
"dependentChangeType": "none"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "none",
"comment": "fix: make api.md up to date",
"packageName": "@fluentui/react-toast",
"email": "[email protected]",
"dependentChangeType": "none"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "none",
"comment": "fix: make api.md up to date",
"packageName": "@fluentui/react-tooltip",
"email": "[email protected]",
"dependentChangeType": "none"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "none",
"comment": "fix: make api.md up to date",
"packageName": "@fluentui/react-virtualizer",
"email": "[email protected]",
"dependentChangeType": "none"
}
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export const ColorArea: ForwardRefComponent<ColorAreaProps>;
export const colorAreaClassNames: SlotClassNames<ColorAreaSlots>;

// @public
export type ColorAreaProps = Omit<ComponentProps<Partial<ColorAreaSlots>>, 'color' | 'onChange'> & {
export type ColorAreaProps = Omit<ComponentProps<Partial<ColorAreaSlots>>, 'color' | 'onChange'> & Pick<ColorPickerProps, 'shape'> & {
color?: HsvColor;
defaultColor?: HsvColor;
onChange?: EventHandler<ColorAreaOnColorChangeData>;
Expand All @@ -50,7 +50,7 @@ export type ColorAreaSlots = {
};

// @public
export type ColorAreaState = ComponentState<Required<ColorAreaSlots>> & Pick<ColorAreaProps, 'color'>;
export type ColorAreaState = ComponentState<Required<ColorAreaSlots>> & Pick<ColorAreaProps, 'color' | 'shape'>;

// @public
export const ColorPicker: ForwardRefComponent<ColorPickerProps>;
Expand All @@ -62,6 +62,7 @@ export const colorPickerClassNames: SlotClassNames<ColorPickerSlots>;
export type ColorPickerProps = Omit<ComponentProps<Partial<ColorPickerSlots>>, 'color'> & {
color: HsvColor;
onColorChange?: EventHandler<ColorPickerOnChangeData>;
shape?: 'rounded' | 'square';
};

// @public (undocumented)
Expand All @@ -79,7 +80,7 @@ export const ColorSlider: ForwardRefComponent<ColorSliderProps>;
export const colorSliderClassNames: SlotClassNames<ColorSliderSlots>;

// @public
export type ColorSliderProps = Omit<ComponentProps<Partial<ColorSliderSlots>, 'input'>, 'defaultValue' | 'onChange' | 'value' | 'color'> & {
export type ColorSliderProps = Omit<ComponentProps<Partial<ColorSliderSlots>, 'input'>, 'defaultValue' | 'onChange' | 'value' | 'color'> & Pick<ColorPickerProps, 'shape'> & {
channel?: string;
onChange?: EventHandler<SliderOnChangeData>;
vertical?: boolean;
Expand All @@ -96,7 +97,7 @@ export type ColorSliderSlots = {
};

// @public
export type ColorSliderState = ComponentState<ColorSliderSlots> & Pick<ColorSliderProps, 'vertical'>;
export type ColorSliderState = ComponentState<ColorSliderSlots> & Pick<ColorSliderProps, 'vertical' | 'shape'>;

// @public
export const renderAlphaSlider_unstable: (state: AlphaSliderState) => JSX.Element;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ export const createCollapsePresence: PresenceMotionFnCreator<CollapseVariantPara
// @public
export const createFadePresence: PresenceMotionCreator<FadeVariantParams>;

// @public
export const createScalePresence: PresenceMotionFnCreator<ScaleVariantParams_unstable, ScaleRuntimeParams_unstable>;

// @public
export const Fade: PresenceComponent< {}>;

Expand All @@ -46,19 +49,13 @@ export const FadeRelaxed: PresenceComponent< {}>;
export const FadeSnappy: PresenceComponent< {}>;

// @public
export const Scale: PresenceComponent< {
animateOpacity?: boolean | undefined;
}>;
export const Scale: PresenceComponent<ScaleRuntimeParams_unstable>;

// @public (undocumented)
export const ScaleRelaxed: PresenceComponent< {
animateOpacity?: boolean | undefined;
}>;
export const ScaleRelaxed: PresenceComponent<ScaleRuntimeParams_unstable>;

// @public (undocumented)
export const ScaleSnappy: PresenceComponent< {
animateOpacity?: boolean | undefined;
}>;
export const ScaleSnappy: PresenceComponent<ScaleRuntimeParams_unstable>;

// (No @packageDocumentation comment for this package)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,9 @@ export type NavDrawerProps = ComponentProps<NavDrawerSlots> & DrawerProps & NavP
export type NavDrawerSlots = DrawerSlots;

// @public
export type NavDrawerState = DrawerState & NavContextValue;
export type NavDrawerState = DrawerState & NavContextValue & {
size?: 'small' | 'medium' | 'large' | 'full';
};

// @public
export const NavItem: ForwardRefComponent<NavItemProps>;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { useKeyborgRef } from './useKeyborgRef';

/**
* Instantiates [keyborg](https://github.com/microsoft/keyborg) and checks if the user is navigating with the keyboard.
* @returns {() => boolean}
* @returns
*/
export function useIsNavigatingWithKeyboard(): () => boolean {
const keyborgRef = useKeyborgRef();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ export type ToastSlots = {
// @public
export type ToastState = ComponentState<ToastSlots> & {
backgroundAppearance: BackgroundAppearanceContextValue;
intent?: ToastIntent | undefined;
};

// @public (undocumented)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ export type TooltipState = ComponentState<TooltipSlots> & Pick<TooltipProps, 'mo
// @public
export type TooltipTriggerProps = {
ref?: React_2.Ref<unknown>;
} & Pick<React_2.HTMLAttributes<HTMLElement>, 'aria-describedby' | 'aria-label' | 'aria-labelledby' | 'onBlur' | 'onFocus' | 'onPointerEnter' | 'onPointerLeave'>;
} & Pick<React_2.HTMLAttributes<HTMLElement>, 'aria-describedby' | 'aria-label' | 'aria-labelledby' | 'onBlur' | 'onFocus' | 'onPointerEnter' | 'onPointerLeave' | 'aria-haspopup' | 'aria-expanded'>;

// @public
export const useTooltip_unstable: (props: TooltipProps) => TooltipState;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,7 @@

import type { ComponentProps } from '@fluentui/react-utilities';
import type { ComponentState } from '@fluentui/react-utilities';
import type { FC } from 'react';
import type { MutableRefObject } from 'react';
import * as React_2 from 'react';
import type { RefObject } from 'react';
import type { Slot } from '@fluentui/react-utilities';
import type { SlotClassNames } from '@fluentui/react-utilities';

Expand Down Expand Up @@ -132,7 +129,7 @@ export const useVirtualizerScrollViewStyles_unstable: (state: VirtualizerScrollV
export const useVirtualizerStyles_unstable: (state: VirtualizerState) => VirtualizerState;

// @public
export const Virtualizer: FC<VirtualizerProps>;
export const Virtualizer: React_2.FC<VirtualizerProps>;

// @public
export type VirtualizerChildRenderFunction = (index: number, isScrolling: boolean) => React_2.ReactNode;
Expand All @@ -152,10 +149,10 @@ export const VirtualizerContextProvider: React_2.Provider<VirtualizerContextProp

// @public (undocumented)
export type VirtualizerDataRef = {
progressiveSizes: RefObject<number[]>;
nodeSizes: RefObject<number[]>;
progressiveSizes: React_2.RefObject<number[]>;
nodeSizes: React_2.RefObject<number[]>;
setFlaggedIndex: (index: number | null) => void;
currentIndex: RefObject<number>;
currentIndex: React_2.RefObject<number>;
};

// @public (undocumented)
Expand Down
Loading