From 38c55d291be576e28005a93177815ad24906dbd4 Mon Sep 17 00:00:00 2001 From: Micah Godbolt Date: Thu, 3 Feb 2022 14:47:53 -0800 Subject: [PATCH 01/11] change commons type to be unstable --- .../src/components/Accordion/Accordion.types.ts | 8 ++++---- .../AccordionHeader/AccordionHeader.types.ts | 6 +++--- .../components/AccordionItem/AccordionItem.types.ts | 12 +++++++----- .../src/components/Avatar/Avatar.types.ts | 8 ++++---- .../react-badge/src/components/Badge/Badge.types.ts | 6 +++--- .../components/CounterBadge/CounterBadge.types.ts | 7 ++++--- .../components/PresenceBadge/PresenceBadge.types.ts | 10 +++++----- .../src/components/Button/Button.types.ts | 6 +++--- .../CompoundButton/CompoundButton.types.ts | 4 ++-- .../src/components/MenuButton/MenuButton.types.ts | 4 ++-- .../components/ToggleButton/ToggleButton.types.ts | 6 +++--- .../src/components/Checkbox/Checkbox.types.ts | 6 +++--- .../src/components/Dialog/Dialog.types.ts | 6 +++--- .../src/components/Divider/Divider.types.ts | 6 +++--- .../react-image/src/components/Image/Image.types.ts | 6 +++--- .../react-label/src/components/Label/Label.types.ts | 6 +++--- .../react-link/src/components/Link/Link.types.ts | 6 +++--- .../react-menu/src/components/Menu/Menu.types.ts | 8 ++++---- .../src/components/MenuItem/MenuItem.types.ts | 6 +++--- .../src/components/MenuList/MenuList.types.ts | 6 +++--- .../MenuSplitGroup/MenuSplitGroup.types.ts | 6 +++--- .../src/components/Popover/Popover.types.ts | 6 +++--- .../src/components/Portal/Portal.types.ts | 6 +++--- packages/react-provider/etc/react-provider.api.md | 6 +++--- .../FluentProvider/FluentProvider.types.ts | 6 +++--- .../src/components/RadioItem/RadioItem.types.ts | 6 +++--- .../src/components/Slider/Slider.types.ts | 6 +++--- .../src/components/SpinButton/SpinButton.types.ts | 6 +++--- .../src/components/Spinner/Spinner.types.ts | 6 +++--- .../src/components/Switch/Switch.types.ts | 6 +++--- packages/react-tabs/src/components/Tab/Tab.types.ts | 6 +++--- .../src/components/TabList/TabList.types.ts | 8 ++++---- .../react-text/src/components/Text/Text.types.ts | 6 +++--- .../src/components/Tooltip/Tooltip.types.ts | 8 ++++---- 34 files changed, 112 insertions(+), 109 deletions(-) diff --git a/packages/react-accordion/src/components/Accordion/Accordion.types.ts b/packages/react-accordion/src/components/Accordion/Accordion.types.ts index 9e458c95675db..694a9f0c04d6b 100644 --- a/packages/react-accordion/src/components/Accordion/Accordion.types.ts +++ b/packages/react-accordion/src/components/Accordion/Accordion.types.ts @@ -8,7 +8,7 @@ export type AccordionToggleEvent = React.MouseEvent | React. export type AccordionToggleEventHandler = (event: AccordionToggleEvent, data: AccordionToggleData) => void; -export type AccordionCommons = { +export type AccordionCommonsUnstable = { /** * Indicates if keyboard navigation is available */ @@ -23,7 +23,7 @@ export type AccordionCommons = { collapsible: boolean; }; -export type AccordionContextValue = Omit & { +export type AccordionContextValue = Omit & { /** * The list of opened panels by index */ @@ -48,7 +48,7 @@ export type AccordionToggleData = { }; export type AccordionProps = ComponentProps & - Partial & { + Partial & { /** * Controls the state of the panel */ @@ -60,4 +60,4 @@ export type AccordionProps = ComponentProps & onToggle?: AccordionToggleEventHandler; }; -export type AccordionState = ComponentState & AccordionCommons & AccordionContextValue; +export type AccordionState = ComponentState & AccordionCommonsUnstable & AccordionContextValue; diff --git a/packages/react-accordion/src/components/AccordionHeader/AccordionHeader.types.ts b/packages/react-accordion/src/components/AccordionHeader/AccordionHeader.types.ts index 5219706cb2bd0..b4469b128c36a 100644 --- a/packages/react-accordion/src/components/AccordionHeader/AccordionHeader.types.ts +++ b/packages/react-accordion/src/components/AccordionHeader/AccordionHeader.types.ts @@ -34,7 +34,7 @@ export type AccordionHeaderSlots = { icon?: IntrinsicSlotProps<'div'>; }; -export type AccordionHeaderCommons = { +export type AccordionHeaderCommonsUnstable = { /** * Size of spacing in the heading */ @@ -49,8 +49,8 @@ export type AccordionHeaderCommons = { inline: boolean; }; -export type AccordionHeaderProps = ComponentProps & Partial; +export type AccordionHeaderProps = ComponentProps & Partial; export type AccordionHeaderState = ComponentState & - AccordionHeaderCommons & + AccordionHeaderCommonsUnstable & AccordionHeaderContextValue; diff --git a/packages/react-accordion/src/components/AccordionItem/AccordionItem.types.ts b/packages/react-accordion/src/components/AccordionItem/AccordionItem.types.ts index f45959e6d9ce1..8faa2a6db6013 100644 --- a/packages/react-accordion/src/components/AccordionItem/AccordionItem.types.ts +++ b/packages/react-accordion/src/components/AccordionItem/AccordionItem.types.ts @@ -1,7 +1,7 @@ import * as React from 'react'; import type { ComponentProps, ComponentState, IntrinsicSlotProps } from '@fluentui/react-utilities'; -export type AccordionItemContextValue = Omit & { +export type AccordionItemContextValue = Omit & { open: boolean; onHeaderClick(ev: React.MouseEvent | React.KeyboardEvent): void; }; @@ -14,7 +14,7 @@ export type AccordionItemSlots = { root: IntrinsicSlotProps<'div'>; }; -export type AccordionItemCommons = { +export type AccordionItemCommonsUnstable = { /** * Disables opening/closing of panel */ @@ -26,9 +26,11 @@ export type AccordionItemCommons = { }; export type AccordionItemProps = ComponentProps & - Partial & - Pick; + Partial & + Pick; export type AccordionItemValue = unknown; -export type AccordionItemState = ComponentState & AccordionItemCommons & AccordionItemContextValue; +export type AccordionItemState = ComponentState & + AccordionItemCommonsUnstable & + AccordionItemContextValue; diff --git a/packages/react-avatar/src/components/Avatar/Avatar.types.ts b/packages/react-avatar/src/components/Avatar/Avatar.types.ts index cbcd2cd14dfd2..6429276a38d7e 100644 --- a/packages/react-avatar/src/components/Avatar/Avatar.types.ts +++ b/packages/react-avatar/src/components/Avatar/Avatar.types.ts @@ -40,7 +40,7 @@ export type AvatarSlots = { badge?: ComponentSlotProps; }; -export type AvatarCommons = Omit, 'children'> & { +export type AvatarCommonsUnstable = Omit, 'children'> & { /** * The name of the person or entity represented by this Avatar. This should always be provided if it is available. * @@ -145,7 +145,7 @@ export type AvatarNamedColor = * Properties for Avatar */ export type AvatarProps = Omit, 'image'> & - Partial & { + Partial & { /** * The Avatar's image. Cannot be typed as a normal slot since it should not accept any children * but can accept a children render function. @@ -159,9 +159,9 @@ export type AvatarProps = Omit, 'image'> & * State used in rendering Avatar */ export type AvatarState = ComponentState & - AvatarCommons & { + AvatarCommonsUnstable & { /** * The Avatar's color, with `'colorful'` resolved to a named color */ - color: Exclude; + color: Exclude; }; diff --git a/packages/react-badge/src/components/Badge/Badge.types.ts b/packages/react-badge/src/components/Badge/Badge.types.ts index 9ab6c580b09a1..67776a20d74ba 100644 --- a/packages/react-badge/src/components/Badge/Badge.types.ts +++ b/packages/react-badge/src/components/Badge/Badge.types.ts @@ -7,7 +7,7 @@ export type BadgeSlots = { icon?: IntrinsicSlotProps<'span'>; }; -export type BadgeCommons = { +export type BadgeCommonsUnstable = { /** * A Badge can be filled, outline, ghost, inverted * @defaultvalue filled @@ -39,5 +39,5 @@ export type BadgeCommons = { size: 'tiny' | 'extra-small' | 'small' | 'medium' | 'large' | 'extra-large'; }; -export type BadgeProps = ComponentProps> & Partial; -export type BadgeState = ComponentState & BadgeCommons; +export type BadgeProps = ComponentProps> & Partial; +export type BadgeState = ComponentState & BadgeCommonsUnstable; diff --git a/packages/react-badge/src/components/CounterBadge/CounterBadge.types.ts b/packages/react-badge/src/components/CounterBadge/CounterBadge.types.ts index a80e1ce35bf32..02245fd63b363 100644 --- a/packages/react-badge/src/components/CounterBadge/CounterBadge.types.ts +++ b/packages/react-badge/src/components/CounterBadge/CounterBadge.types.ts @@ -1,6 +1,6 @@ import type { BadgeProps, BadgeState } from '../Badge/index'; -export type CounterBadgeCommons = { +export type CounterBadgeCommonsUnstable = { /** * Max number to be displayed * @default 99 @@ -44,6 +44,7 @@ export type CounterBadgeCommons = { color: Extract; }; -export type CounterBadgeProps = Omit & Partial; +export type CounterBadgeProps = Omit & + Partial; -export type CounterBadgeState = Omit & CounterBadgeCommons; +export type CounterBadgeState = Omit & CounterBadgeCommonsUnstable; diff --git a/packages/react-badge/src/components/PresenceBadge/PresenceBadge.types.ts b/packages/react-badge/src/components/PresenceBadge/PresenceBadge.types.ts index d2dbcb4429541..cf041088a7c40 100644 --- a/packages/react-badge/src/components/PresenceBadge/PresenceBadge.types.ts +++ b/packages/react-badge/src/components/PresenceBadge/PresenceBadge.types.ts @@ -1,9 +1,9 @@ import type { ComponentProps, ComponentState } from '@fluentui/react-utilities'; -import type { BadgeCommons, BadgeSlots } from '../Badge/index'; +import type { BadgeCommonsUnstable, BadgeSlots } from '../Badge/index'; export type PresenceBadgeStatus = 'busy' | 'outOfOffice' | 'away' | 'available' | 'offline' | 'doNotDisturb'; -export type PresenceBadgeCommons = { +export type PresenceBadgeCommonsUnstable = { /** * Represents several status * @default available @@ -15,9 +15,9 @@ export type PresenceBadgeCommons = { * @default false */ outOfOffice: boolean; -} & BadgeCommons; +} & BadgeCommonsUnstable; export type PresenceBadgeProps = ComponentProps>> & - Partial>; + Partial>; -export type PresenceBadgeState = PresenceBadgeCommons & ComponentState; +export type PresenceBadgeState = PresenceBadgeCommonsUnstable & ComponentState; diff --git a/packages/react-button/src/components/Button/Button.types.ts b/packages/react-button/src/components/Button/Button.types.ts index eeb38d3d06352..9d2d93a11a945 100644 --- a/packages/react-button/src/components/Button/Button.types.ts +++ b/packages/react-button/src/components/Button/Button.types.ts @@ -13,7 +13,7 @@ export type ButtonSlots = { icon?: IntrinsicSlotProps<'span'>; }; -export type ButtonCommons = { +export type ButtonCommonsUnstable = { /** * A button can have its content and borders styled for greater emphasis or to be subtle. * - 'primary': Emphasizes the button as a primary action. @@ -62,10 +62,10 @@ export type ButtonCommons = { size: 'small' | 'medium' | 'large'; }; -export type ButtonProps = ComponentProps & Partial; +export type ButtonProps = ComponentProps & Partial; export type ButtonState = ComponentState & - ButtonCommons & { + ButtonCommonsUnstable & { /** * A button can contain only an icon. * @default false diff --git a/packages/react-button/src/components/CompoundButton/CompoundButton.types.ts b/packages/react-button/src/components/CompoundButton/CompoundButton.types.ts index 55295e6207a2b..b7aa25508c4d9 100644 --- a/packages/react-button/src/components/CompoundButton/CompoundButton.types.ts +++ b/packages/react-button/src/components/CompoundButton/CompoundButton.types.ts @@ -1,5 +1,5 @@ import type { ComponentProps, ComponentState, IntrinsicSlotProps } from '@fluentui/react-utilities'; -import type { ButtonCommons, ButtonSlots, ButtonState } from '../Button/Button.types'; +import type { ButtonCommonsUnstable, ButtonSlots, ButtonState } from '../Button/Button.types'; export type CompoundButtonSlots = ButtonSlots & { /** @@ -13,7 +13,7 @@ export type CompoundButtonSlots = ButtonSlots & { contentContainer: IntrinsicSlotProps<'span'>; }; -export type CompoundButtonProps = ComponentProps & Partial; +export type CompoundButtonProps = ComponentProps & Partial; export type CompoundButtonState = ComponentState & Omit; diff --git a/packages/react-button/src/components/MenuButton/MenuButton.types.ts b/packages/react-button/src/components/MenuButton/MenuButton.types.ts index 3abf7b9b48b26..389bbc4b5f6e5 100644 --- a/packages/react-button/src/components/MenuButton/MenuButton.types.ts +++ b/packages/react-button/src/components/MenuButton/MenuButton.types.ts @@ -1,5 +1,5 @@ import type { ComponentProps, ComponentState, IntrinsicSlotProps } from '@fluentui/react-utilities'; -import type { ButtonCommons, ButtonSlots, ButtonState } from '../Button/Button.types'; +import type { ButtonCommonsUnstable, ButtonSlots, ButtonState } from '../Button/Button.types'; export type MenuButtonSlots = ButtonSlots & { /** @@ -8,7 +8,7 @@ export type MenuButtonSlots = ButtonSlots & { menuIcon?: IntrinsicSlotProps<'span'>; }; -export type MenuButtonProps = ComponentProps & Partial>; +export type MenuButtonProps = ComponentProps & Partial>; export type MenuButtonState = ComponentState & Omit; diff --git a/packages/react-button/src/components/ToggleButton/ToggleButton.types.ts b/packages/react-button/src/components/ToggleButton/ToggleButton.types.ts index 1cc3d4cc8a02b..7149ec80b36d7 100644 --- a/packages/react-button/src/components/ToggleButton/ToggleButton.types.ts +++ b/packages/react-button/src/components/ToggleButton/ToggleButton.types.ts @@ -1,6 +1,6 @@ import type { ButtonProps, ButtonState } from '../Button/Button.types'; -export type ToggleButtonCommons = { +export type ToggleButtonCommonsUnstable = { /** * Defines the controlled checked state of the `ToggleButton`. * If passed, `ToggleButton` ignores the `defaultChecked` property. @@ -12,7 +12,7 @@ export type ToggleButtonCommons = { }; export type ToggleButtonProps = ButtonProps & - Partial & { + Partial & { /** * Defines whether the `ToggleButton` is initially in a checked state or not when rendered. * @default false @@ -20,4 +20,4 @@ export type ToggleButtonProps = ButtonProps & defaultChecked?: boolean; }; -export type ToggleButtonState = ButtonState & ToggleButtonCommons; +export type ToggleButtonState = ButtonState & ToggleButtonCommonsUnstable; diff --git a/packages/react-checkbox/src/components/Checkbox/Checkbox.types.ts b/packages/react-checkbox/src/components/Checkbox/Checkbox.types.ts index 5d52d3946da2a..c3a2772283e6c 100644 --- a/packages/react-checkbox/src/components/Checkbox/Checkbox.types.ts +++ b/packages/react-checkbox/src/components/Checkbox/Checkbox.types.ts @@ -2,7 +2,7 @@ import * as React from 'react'; import { Label } from '@fluentui/react-label'; import { ComponentProps, ComponentSlotProps, ComponentState, IntrinsicSlotProps } from '@fluentui/react-utilities'; -export interface CheckboxCommons { +export interface CheckboxCommonsUnstable { /** * Whether to render the checkbox in a circular shape instead of square. * This variant is only recommended to be used in a tasks-style UI (checklist), @@ -72,7 +72,7 @@ export type CheckboxProps = Omit< ComponentProps, 'size' | 'checked' | 'defaultChecked' | 'onChange' > & - Partial & { + Partial & { /** * Checkboxes don't support children. To add a label, use the `label` prop. */ @@ -92,4 +92,4 @@ export type CheckboxProps = Omit< /** * State used in rendering Checkbox */ -export type CheckboxState = ComponentState & CheckboxCommons; +export type CheckboxState = ComponentState & CheckboxCommonsUnstable; diff --git a/packages/react-dialog/src/components/Dialog/Dialog.types.ts b/packages/react-dialog/src/components/Dialog/Dialog.types.ts index f20072aabcfad..ff12229986647 100644 --- a/packages/react-dialog/src/components/Dialog/Dialog.types.ts +++ b/packages/react-dialog/src/components/Dialog/Dialog.types.ts @@ -4,16 +4,16 @@ export type DialogSlots = { root: IntrinsicSlotProps<'div'>; }; -export type DialogCommons = { +export type DialogCommonsUnstable = { // TODO Add things shared between props and state here }; /** * Dialog Props */ -export type DialogProps = ComponentProps & DialogCommons; +export type DialogProps = ComponentProps & DialogCommonsUnstable; /** * State used in rendering Dialog */ -export type DialogState = ComponentState & DialogCommons; +export type DialogState = ComponentState & DialogCommonsUnstable; diff --git a/packages/react-divider/src/components/Divider/Divider.types.ts b/packages/react-divider/src/components/Divider/Divider.types.ts index 1a1ce51f8457e..769aed00c78e1 100644 --- a/packages/react-divider/src/components/Divider/Divider.types.ts +++ b/packages/react-divider/src/components/Divider/Divider.types.ts @@ -12,7 +12,7 @@ export type DividerSlots = { wrapper: IntrinsicSlotProps<'div'>; }; -export type DividerCommons = { +export type DividerCommonsUnstable = { /** * Determines the alignment of the content within the divider. * @defaultvalue 'center' @@ -38,6 +38,6 @@ export type DividerCommons = { vertical: boolean; }; -export type DividerProps = ComponentProps & Partial; +export type DividerProps = ComponentProps & Partial; -export type DividerState = ComponentState & DividerCommons; +export type DividerState = ComponentState & DividerCommonsUnstable; diff --git a/packages/react-image/src/components/Image/Image.types.ts b/packages/react-image/src/components/Image/Image.types.ts index 6b7297cab08d7..c488d40cde974 100644 --- a/packages/react-image/src/components/Image/Image.types.ts +++ b/packages/react-image/src/components/Image/Image.types.ts @@ -4,7 +4,7 @@ export type ImageSlots = { root: IntrinsicSlotProps<'img'>; }; -export type ImageCommons = { +export type ImageCommonsUnstable = { /** * An image can appear with rectangular border. */ @@ -32,6 +32,6 @@ export type ImageCommons = { shadow?: boolean; }; -export type ImageProps = ComponentProps & Partial; +export type ImageProps = ComponentProps & Partial; -export type ImageState = ComponentState & ImageCommons; +export type ImageState = ComponentState & ImageCommonsUnstable; diff --git a/packages/react-label/src/components/Label/Label.types.ts b/packages/react-label/src/components/Label/Label.types.ts index a9cd1f0ae3bc0..32aede0bc0fa5 100644 --- a/packages/react-label/src/components/Label/Label.types.ts +++ b/packages/react-label/src/components/Label/Label.types.ts @@ -1,7 +1,7 @@ import * as React from 'react'; import type { ComponentProps, ComponentState, IntrinsicSlotProps } from '@fluentui/react-utilities'; -export type LabelCommons = { +export type LabelCommonsUnstable = { /** * Renders the label as disabled * @defaultvalue false @@ -29,13 +29,13 @@ export type LabelSlots = { /** * State used in rendering Label */ -export type LabelState = ComponentState & LabelCommons; +export type LabelState = ComponentState & LabelCommonsUnstable; /** * Label Props */ export type LabelProps = Omit, 'required'> & - Partial & { + Partial & { /** * Displays and indicator that the label is for a required field. The required prop can be set to true to display * an asterisk (*). Or it can be set to a string or jsx content to display a different indicator. diff --git a/packages/react-link/src/components/Link/Link.types.ts b/packages/react-link/src/components/Link/Link.types.ts index 4bdd5bc2e552f..53414f5a0a3d7 100644 --- a/packages/react-link/src/components/Link/Link.types.ts +++ b/packages/react-link/src/components/Link/Link.types.ts @@ -7,7 +7,7 @@ export type LinkSlots = { root: IntrinsicSlotProps<'a', 'button'>; }; -export type LinkCommons = { +export type LinkCommonsUnstable = { /** * A link can appear either with its default style or subtle. * If not specified, the link appears with its default styling. @@ -34,6 +34,6 @@ export type LinkCommons = { inline?: boolean; }; -export type LinkProps = ComponentProps & LinkCommons; +export type LinkProps = ComponentProps & LinkCommonsUnstable; -export type LinkState = ComponentState & LinkCommons; +export type LinkState = ComponentState & LinkCommonsUnstable; diff --git a/packages/react-menu/src/components/Menu/Menu.types.ts b/packages/react-menu/src/components/Menu/Menu.types.ts index bb81d39a4804d..3d66b337da91c 100644 --- a/packages/react-menu/src/components/Menu/Menu.types.ts +++ b/packages/react-menu/src/components/Menu/Menu.types.ts @@ -1,10 +1,10 @@ import * as React from 'react'; import { ComponentProps, ComponentState } from '@fluentui/react-utilities'; import { usePopperMouseTarget, PositioningShorthand } from '@fluentui/react-positioning'; -import { MenuListCommons } from '../MenuList/index'; +import { MenuListCommonsUnstable } from '../MenuList/index'; import { MenuContextValue } from '../../contexts/menuContext'; -type MenuCommons = MenuListCommons & { +type MenuCommonsUnstable = MenuListCommonsUnstable & { /** * Whether the popup is open */ @@ -53,7 +53,7 @@ export type MenuSlots = {}; /** * Extends and drills down Menulist props to simplify API */ -export type MenuProps = Partial & +export type MenuProps = Partial & ComponentProps & { /** * Can contain two children including {@link MenuTrigger} and {@link MenuPopover}. @@ -67,7 +67,7 @@ export type MenuProps = Partial & positioning?: PositioningShorthand; }; -export type MenuState = MenuCommons & +export type MenuState = MenuCommonsUnstable & ComponentState & { /** * Callback to open/close the popup diff --git a/packages/react-menu/src/components/MenuItem/MenuItem.types.ts b/packages/react-menu/src/components/MenuItem/MenuItem.types.ts index 694f42e57e051..58ccf4203d6bd 100644 --- a/packages/react-menu/src/components/MenuItem/MenuItem.types.ts +++ b/packages/react-menu/src/components/MenuItem/MenuItem.types.ts @@ -31,7 +31,7 @@ export type MenuItemSlots = { secondaryContent?: IntrinsicSlotProps<'span'>; }; -type MenuItemCommons = { +type MenuItemCommonsUnstable = { /** * If the menu item is a trigger for a submenu */ @@ -48,6 +48,6 @@ type MenuItemCommons = { persistOnClick?: boolean; }; -export type MenuItemProps = ComponentProps> & MenuItemCommons; +export type MenuItemProps = ComponentProps> & MenuItemCommonsUnstable; -export type MenuItemState = ComponentState & MenuItemCommons; +export type MenuItemState = ComponentState & MenuItemCommonsUnstable; diff --git a/packages/react-menu/src/components/MenuList/MenuList.types.ts b/packages/react-menu/src/components/MenuList/MenuList.types.ts index ede7a4152e4c4..2d7a823a2bffb 100644 --- a/packages/react-menu/src/components/MenuList/MenuList.types.ts +++ b/packages/react-menu/src/components/MenuList/MenuList.types.ts @@ -12,7 +12,7 @@ export type MenuCheckedValueChangeData = { checkedItems: string[]; }; -export type MenuListCommons = { +export type MenuListCommonsUnstable = { /** * Callback when checked items change for value with a name * @@ -46,10 +46,10 @@ export type MenuListSlots = { root: IntrinsicSlotProps<'div'>; }; -export type MenuListProps = ComponentProps & Partial; +export type MenuListProps = ComponentProps & Partial; export type MenuListState = ComponentState & - MenuListCommons & { + MenuListCommonsUnstable & { /** * Callback to set focus on the next menu item by first character */ diff --git a/packages/react-menu/src/components/MenuSplitGroup/MenuSplitGroup.types.ts b/packages/react-menu/src/components/MenuSplitGroup/MenuSplitGroup.types.ts index cb8eeab7b594a..178e7f9581691 100644 --- a/packages/react-menu/src/components/MenuSplitGroup/MenuSplitGroup.types.ts +++ b/packages/react-menu/src/components/MenuSplitGroup/MenuSplitGroup.types.ts @@ -4,14 +4,14 @@ export type MenuSplitGroupSlots = { root: IntrinsicSlotProps<'div'>; }; -export type MenuSplitGroupCommons = {}; +export type MenuSplitGroupCommonsUnstable = {}; /** * MenuSplitGroup Props */ -export type MenuSplitGroupProps = ComponentProps & MenuSplitGroupCommons; +export type MenuSplitGroupProps = ComponentProps & MenuSplitGroupCommonsUnstable; /** * State used in rendering MenuSplitGroup */ -export type MenuSplitGroupState = ComponentState & MenuSplitGroupCommons; +export type MenuSplitGroupState = ComponentState & MenuSplitGroupCommonsUnstable; diff --git a/packages/react-popover/src/components/Popover/Popover.types.ts b/packages/react-popover/src/components/Popover/Popover.types.ts index 8343ba7dd40c0..b63668dd19ecc 100644 --- a/packages/react-popover/src/components/Popover/Popover.types.ts +++ b/packages/react-popover/src/components/Popover/Popover.types.ts @@ -7,7 +7,7 @@ import type { PortalProps } from '@fluentui/react-portal'; */ export type PopoverSize = 'small' | 'medium' | 'large'; -export type PopoverCommons = Pick & { +export type PopoverCommonsUnstable = Pick & { /** * Controls the opening of the Popover */ @@ -59,7 +59,7 @@ export type PopoverCommons = Pick & { /** * Popover Props */ -export type PopoverProps = Partial & { +export type PopoverProps = Partial & { /** * Can contain two children including {@link PopoverTrigger} and {@link PopoverSurface}. * Alternatively can only contain {@link PopoverSurface} if using a custom `target`. @@ -70,7 +70,7 @@ export type PopoverProps = Partial & { /** * Popover State */ -export type PopoverState = PopoverCommons & +export type PopoverState = PopoverCommonsUnstable & Pick & { /** * Callback to open/close the Popover diff --git a/packages/react-portal/src/components/Portal/Portal.types.ts b/packages/react-portal/src/components/Portal/Portal.types.ts index 868e1a32a6ffc..17821a0969c5c 100644 --- a/packages/react-portal/src/components/Portal/Portal.types.ts +++ b/packages/react-portal/src/components/Portal/Portal.types.ts @@ -1,6 +1,6 @@ import * as React from 'react'; -export type PortalCommons = { +export type PortalCommonsUnstable = { /** * React children */ @@ -12,9 +12,9 @@ export type PortalCommons = { mountNode: HTMLDivElement | undefined; }; -export type PortalProps = Partial; +export type PortalProps = Partial; -export type PortalState = PortalCommons & { +export type PortalState = PortalCommonsUnstable & { /** Indicates if a Portal should be rendered. */ shouldRender: boolean; diff --git a/packages/react-provider/etc/react-provider.api.md b/packages/react-provider/etc/react-provider.api.md index 45b41154c0577..3a4ca39087a7c 100644 --- a/packages/react-provider/etc/react-provider.api.md +++ b/packages/react-provider/etc/react-provider.api.md @@ -23,7 +23,7 @@ export const FluentProvider: React_2.ForwardRefExoticComponent, 'dir'>, Partial { +export interface FluentProviderProps extends Omit, 'dir'>, Partial { // (undocumented) theme?: PartialTheme; } @@ -52,7 +52,7 @@ export type FluentProviderSlots = { }; // @public (undocumented) -export interface FluentProviderState extends ComponentState, FluentProviderCommons { +export interface FluentProviderState extends ComponentState, FluentProviderCommonsUnstable { // (undocumented) theme: Theme | Partial | undefined; // (undocumented) diff --git a/packages/react-provider/src/components/FluentProvider/FluentProvider.types.ts b/packages/react-provider/src/components/FluentProvider/FluentProvider.types.ts index d660b0a04fe51..05804c31e9fec 100644 --- a/packages/react-provider/src/components/FluentProvider/FluentProvider.types.ts +++ b/packages/react-provider/src/components/FluentProvider/FluentProvider.types.ts @@ -10,7 +10,7 @@ export type FluentProviderSlots = { root: IntrinsicSlotProps<'div'>; }; -export interface FluentProviderCommons { +export interface FluentProviderCommonsUnstable { /** Sets the direction of text & generated styles. */ dir: 'ltr' | 'rtl'; @@ -20,11 +20,11 @@ export interface FluentProviderCommons { export interface FluentProviderProps extends Omit, 'dir'>, - Partial { + Partial { theme?: PartialTheme; } -export interface FluentProviderState extends ComponentState, FluentProviderCommons { +export interface FluentProviderState extends ComponentState, FluentProviderCommonsUnstable { theme: Theme | Partial | undefined; themeClassName: string; } diff --git a/packages/react-radio/src/components/RadioItem/RadioItem.types.ts b/packages/react-radio/src/components/RadioItem/RadioItem.types.ts index 23ed86741f9da..1b72ef85af4bb 100644 --- a/packages/react-radio/src/components/RadioItem/RadioItem.types.ts +++ b/packages/react-radio/src/components/RadioItem/RadioItem.types.ts @@ -26,7 +26,7 @@ export type RadioItemSlots = { subtext?: IntrinsicSlotProps<'span'>; }; -export type RadioItemCommons = InputHTMLAttributes & { +export type RadioItemCommonsUnstable = InputHTMLAttributes & { /** * Determines whether the label should be positioned bellow the indicator or next to it. * @defaultvalue 'inline' @@ -43,7 +43,7 @@ export type RadioItemCommons = InputHTMLAttributes & { * RadioItem Props */ export type RadioItemProps = ComponentProps & - RadioItemCommons & { + RadioItemCommonsUnstable & { /** * ID of the native element that represents the checkbox. */ @@ -53,4 +53,4 @@ export type RadioItemProps = ComponentProps & /** * State used in rendering RadioItem */ -export type RadioItemState = ComponentState & RadioItemCommons; +export type RadioItemState = ComponentState & RadioItemCommonsUnstable; diff --git a/packages/react-slider/src/components/Slider/Slider.types.ts b/packages/react-slider/src/components/Slider/Slider.types.ts index 73bb598c44820..47722b17dd399 100644 --- a/packages/react-slider/src/components/Slider/Slider.types.ts +++ b/packages/react-slider/src/components/Slider/Slider.types.ts @@ -37,7 +37,7 @@ export type SliderSlots = { }; }; -export type SliderCommons = { +export type SliderCommonsUnstable = { /** * The starting value for an uncontrolled Slider. * Mutually exclusive with `value` prop. @@ -110,6 +110,6 @@ export type SliderOnChangeData = { }; export type SliderProps = Omit, 'defaultValue' | 'onChange' | 'size' | 'value'> & - SliderCommons; + SliderCommonsUnstable; -export type SliderState = ComponentState & SliderCommons; +export type SliderState = ComponentState & SliderCommonsUnstable; diff --git a/packages/react-spinbutton/src/components/SpinButton/SpinButton.types.ts b/packages/react-spinbutton/src/components/SpinButton/SpinButton.types.ts index 7a61b15f9aec1..6ca5369c63572 100644 --- a/packages/react-spinbutton/src/components/SpinButton/SpinButton.types.ts +++ b/packages/react-spinbutton/src/components/SpinButton/SpinButton.types.ts @@ -4,16 +4,16 @@ export type SpinButtonSlots = { root: IntrinsicSlotProps<'div'>; }; -export type SpinButtonCommons = { +export type SpinButtonCommonsUnstable = { // TODO Add things shared between props and state here }; /** * SpinButton Props */ -export type SpinButtonProps = ComponentProps & SpinButtonCommons; +export type SpinButtonProps = ComponentProps & SpinButtonCommonsUnstable; /** * State used in rendering SpinButton */ -export type SpinButtonState = ComponentState & SpinButtonCommons; +export type SpinButtonState = ComponentState & SpinButtonCommonsUnstable; diff --git a/packages/react-spinner/src/components/Spinner/Spinner.types.ts b/packages/react-spinner/src/components/Spinner/Spinner.types.ts index bfa63946f1319..3c01c1eecef5b 100644 --- a/packages/react-spinner/src/components/Spinner/Spinner.types.ts +++ b/packages/react-spinner/src/components/Spinner/Spinner.types.ts @@ -4,16 +4,16 @@ export type SpinnerSlots = { root: IntrinsicSlotProps<'div'>; }; -export type SpinnerCommons = { +export type SpinnerCommonsUnstable = { // TODO Add things shared between props and state here }; /** * Spinner Props */ -export type SpinnerProps = ComponentProps & SpinnerCommons; +export type SpinnerProps = ComponentProps & SpinnerCommonsUnstable; /** * State used in rendering Spinner */ -export type SpinnerState = ComponentState & SpinnerCommons; +export type SpinnerState = ComponentState & SpinnerCommonsUnstable; diff --git a/packages/react-switch/src/components/Switch/Switch.types.ts b/packages/react-switch/src/components/Switch/Switch.types.ts index bd14f884e57ee..a1d641ac3a258 100644 --- a/packages/react-switch/src/components/Switch/Switch.types.ts +++ b/packages/react-switch/src/components/Switch/Switch.types.ts @@ -33,7 +33,7 @@ export type SwitchSlots = { activeRail: IntrinsicSlotProps<'div'>; }; -export interface SwitchCommons { +export interface SwitchCommonsUnstable { /** * The starting value for a uncontrolled Switch. If `true` then the Switch will be enabled. * Mutually exclusive with `checked` prop. @@ -66,6 +66,6 @@ export interface SwitchCommons { ) => void; } -export interface SwitchProps extends Omit, 'onChange'>, SwitchCommons {} +export interface SwitchProps extends Omit, 'onChange'>, SwitchCommonsUnstable {} -export interface SwitchState extends ComponentState, SwitchCommons {} +export interface SwitchState extends ComponentState, SwitchCommonsUnstable {} diff --git a/packages/react-tabs/src/components/Tab/Tab.types.ts b/packages/react-tabs/src/components/Tab/Tab.types.ts index e1b7b3bdf0935..6237de4fca5fc 100644 --- a/packages/react-tabs/src/components/Tab/Tab.types.ts +++ b/packages/react-tabs/src/components/Tab/Tab.types.ts @@ -23,7 +23,7 @@ export type TabSlots = { content: IntrinsicSlotProps<'span'>; }; -export type TabCommons = { +export type TabCommonsUnstable = { /** * The value that identifies this tab when selected. */ @@ -33,13 +33,13 @@ export type TabCommons = { /** * Tab Props */ -export type TabProps = ComponentProps & TabCommons; +export type TabProps = ComponentProps & TabCommonsUnstable; /** * State used in rendering Tab */ export type TabState = ComponentState & - TabCommons & { + TabCommonsUnstable & { /** * A tab supports 'transparent' and 'subtle' appearance. */ diff --git a/packages/react-tabs/src/components/TabList/TabList.types.ts b/packages/react-tabs/src/components/TabList/TabList.types.ts index 6b7fa6abc65aa..f849070b11be1 100644 --- a/packages/react-tabs/src/components/TabList/TabList.types.ts +++ b/packages/react-tabs/src/components/TabList/TabList.types.ts @@ -31,7 +31,7 @@ export type TabListSlots = { root: IntrinsicSlotProps<'div'>; }; -export type TabListCommons = { +export type TabListCommonsUnstable = { /** * A tab list can supports 'transparent' and 'subtle' appearance. *- 'subtle': Minimizes emphasis to blend into the background until hovered or focused. @@ -69,7 +69,7 @@ export type TabListCommons = { * TabList Props */ export type TabListProps = ComponentProps & - TabListCommons & { + TabListCommonsUnstable & { /** * The value of the tab to be selected by default. * Typically useful when the selectedValue is uncontrolled. @@ -77,8 +77,8 @@ export type TabListProps = ComponentProps & defaultSelectedValue?: TabValue; }; -export type TabListContextValue = Pick & - Required> & { +export type TabListContextValue = Pick & + Required> & { /** A callback to allow a tab to register itself with the tab list. */ onRegister: RegisterTabEventHandler; diff --git a/packages/react-text/src/components/Text/Text.types.ts b/packages/react-text/src/components/Text/Text.types.ts index cf760dee04ecf..2f2cb5ed147ec 100644 --- a/packages/react-text/src/components/Text/Text.types.ts +++ b/packages/react-text/src/components/Text/Text.types.ts @@ -7,7 +7,7 @@ export type TextSlots = { root: IntrinsicSlotProps<'span', 'p' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'pre'>; }; -export type TextCommons = { +export type TextCommonsUnstable = { /** * Wraps the text content on white spaces. * @@ -82,9 +82,9 @@ export type TextCommons = { /** * Text Props */ -export type TextProps = ComponentProps & Partial; +export type TextProps = ComponentProps & Partial; /** * State used in rendering Text */ -export type TextState = ComponentState & TextCommons; +export type TextState = ComponentState & TextCommonsUnstable; diff --git a/packages/react-tooltip/src/components/Tooltip/Tooltip.types.ts b/packages/react-tooltip/src/components/Tooltip/Tooltip.types.ts index a09ee8e0bc7c0..861a2c8d1f731 100644 --- a/packages/react-tooltip/src/components/Tooltip/Tooltip.types.ts +++ b/packages/react-tooltip/src/components/Tooltip/Tooltip.types.ts @@ -12,7 +12,7 @@ export type TooltipSlots = { /** * Properties and state for Tooltip */ -export type TooltipCommons = { +export type TooltipCommonsUnstable = { /** * The tooltip's visual appearance. * * `normal` - Uses the theme's background and text colors. @@ -102,8 +102,8 @@ export type OnVisibleChangeData = { */ export type TooltipProps = Omit, 'content'> & Required, 'content'>> & - Partial> & - Pick & { + Partial> & + Pick & { children?: | (React.ReactElement & { ref?: React.Ref }) | ((props: TooltipTriggerProps) => React.ReactNode) @@ -114,7 +114,7 @@ export type TooltipProps = Omit, 'content'> & * State used in rendering Tooltip */ export type TooltipState = ComponentState & - TooltipCommons & { + TooltipCommonsUnstable & { children?: React.ReactNode; /** From 4466802209e2a3f4301ec2a9f2d8d51bfa273eb5 Mon Sep 17 00:00:00 2001 From: Micah Godbolt Date: Thu, 3 Feb 2022 14:55:12 -0800 Subject: [PATCH 02/11] new api files --- .../etc/react-accordion.api.md | 22 ++++++++--------- packages/react-avatar/etc/react-avatar.api.md | 8 +++---- packages/react-badge/etc/react-badge.api.md | 20 ++++++++-------- packages/react-button/etc/react-button.api.md | 16 ++++++------- .../react-divider/etc/react-divider.api.md | 6 ++--- packages/react-image/etc/react-image.api.md | 6 ++--- packages/react-label/etc/react-label.api.md | 6 ++--- packages/react-link/etc/react-link.api.md | 6 ++--- packages/react-menu/etc/react-menu.api.md | 24 +++++++++---------- .../react-popover/etc/react-popover.api.md | 6 ++--- packages/react-portal/etc/react-portal.api.md | 6 ++--- packages/react-slider/etc/react-slider.api.md | 6 ++--- packages/react-text/etc/react-text.api.md | 6 ++--- .../react-tooltip/etc/react-tooltip.api.md | 6 ++--- 14 files changed, 72 insertions(+), 72 deletions(-) diff --git a/packages/react-accordion/etc/react-accordion.api.md b/packages/react-accordion/etc/react-accordion.api.md index 0a111dff453c1..9b0babaed9e26 100644 --- a/packages/react-accordion/etc/react-accordion.api.md +++ b/packages/react-accordion/etc/react-accordion.api.md @@ -19,7 +19,7 @@ export const Accordion: ForwardRefComponent; export const accordionClassName = "fui-Accordion"; // @public (undocumented) -export type AccordionCommons = { +export type AccordionCommonsUnstable = { navigable: boolean; multiple: boolean; collapsible: boolean; @@ -29,7 +29,7 @@ export type AccordionCommons = { export const AccordionContext: Context; // @public (undocumented) -export type AccordionContextValue = Omit & { +export type AccordionContextValue = Omit & { openItems: AccordionItemValue[]; requestToggle: (event: AccordionToggleEvent, data: AccordionToggleData) => void; }; @@ -46,7 +46,7 @@ export const AccordionHeader: ForwardRefComponent; export const accordionHeaderClassName = "fui-AccordionHeader"; // @public (undocumented) -export type AccordionHeaderCommons = { +export type AccordionHeaderCommonsUnstable = { size: AccordionHeaderSize; expandIconPosition: AccordionHeaderExpandIconPosition; inline: boolean; @@ -69,7 +69,7 @@ export type AccordionHeaderContextValues = { export type AccordionHeaderExpandIconPosition = 'start' | 'end'; // @public (undocumented) -export type AccordionHeaderProps = ComponentProps & Partial; +export type AccordionHeaderProps = ComponentProps & Partial; // @public (undocumented) export type AccordionHeaderSize = 'small' | 'medium' | 'large' | 'extra-large'; @@ -83,7 +83,7 @@ export type AccordionHeaderSlots = { }; // @public (undocumented) -export type AccordionHeaderState = ComponentState & AccordionHeaderCommons & AccordionHeaderContextValue; +export type AccordionHeaderState = ComponentState & AccordionHeaderCommonsUnstable & AccordionHeaderContextValue; // @public (undocumented) export type AccordionIndex = number | number[]; @@ -95,7 +95,7 @@ export const AccordionItem: ForwardRefComponent; export const accordionItemClassName = "fui-AccordionItem"; // @public (undocumented) -export type AccordionItemCommons = { +export type AccordionItemCommonsUnstable = { disabled: boolean; value: AccordionItemValue; }; @@ -104,7 +104,7 @@ export type AccordionItemCommons = { export const AccordionItemContext: React_2.Context; // @public (undocumented) -export type AccordionItemContextValue = Omit & { +export type AccordionItemContextValue = Omit & { open: boolean; onHeaderClick(ev: React_2.MouseEvent | React_2.KeyboardEvent): void; }; @@ -115,7 +115,7 @@ export type AccordionItemContextValues = { }; // @public (undocumented) -export type AccordionItemProps = ComponentProps & Partial & Pick; +export type AccordionItemProps = ComponentProps & Partial & Pick; // @public (undocumented) export type AccordionItemSlots = { @@ -123,7 +123,7 @@ export type AccordionItemSlots = { }; // @public (undocumented) -export type AccordionItemState = ComponentState & AccordionItemCommons & AccordionItemContextValue; +export type AccordionItemState = ComponentState & AccordionItemCommonsUnstable & AccordionItemContextValue; // @public (undocumented) export type AccordionItemValue = unknown; @@ -148,7 +148,7 @@ export type AccordionPanelState = ComponentState & { }; // @public (undocumented) -export type AccordionProps = ComponentProps & Partial & { +export type AccordionProps = ComponentProps & Partial & { openItems?: AccordionItemValue | AccordionItemValue[]; defaultOpenItems?: AccordionItemValue | AccordionItemValue[]; onToggle?: AccordionToggleEventHandler; @@ -160,7 +160,7 @@ export type AccordionSlots = { }; // @public (undocumented) -export type AccordionState = ComponentState & AccordionCommons & AccordionContextValue; +export type AccordionState = ComponentState & AccordionCommonsUnstable & AccordionContextValue; // @public (undocumented) export type AccordionToggleData = { diff --git a/packages/react-avatar/etc/react-avatar.api.md b/packages/react-avatar/etc/react-avatar.api.md index 8fa0116f1cac0..b020dea9d5c39 100644 --- a/packages/react-avatar/etc/react-avatar.api.md +++ b/packages/react-avatar/etc/react-avatar.api.md @@ -20,7 +20,7 @@ export const Avatar: ForwardRefComponent; export const avatarClassName = "fui-Avatar"; // @public (undocumented) -export type AvatarCommons = Omit, 'children'> & { +export type AvatarCommonsUnstable = Omit, 'children'> & { name?: string; size: 20 | 24 | 28 | 32 | 36 | 40 | 48 | 56 | 64 | 72 | 96 | 120 | 128; shape: 'circular' | 'square'; @@ -34,7 +34,7 @@ export type AvatarCommons = Omit, 'children' export type AvatarNamedColor = 'darkRed' | 'cranberry' | 'red' | 'pumpkin' | 'peach' | 'marigold' | 'gold' | 'brass' | 'brown' | 'forest' | 'seafoam' | 'darkGreen' | 'lightTeal' | 'teal' | 'steel' | 'blue' | 'royalBlue' | 'cornflower' | 'navy' | 'lavender' | 'purple' | 'grape' | 'lilac' | 'pink' | 'magenta' | 'plum' | 'beige' | 'mink' | 'platinum' | 'anchor'; // @public -export type AvatarProps = Omit, 'image'> & Partial & { +export type AvatarProps = Omit, 'image'> & Partial & { image?: Omit, 'children'> & { children?: SlotRenderFunction>; }; @@ -52,8 +52,8 @@ export type AvatarSlots = { }; // @public -export type AvatarState = ComponentState & AvatarCommons & { - color: Exclude; +export type AvatarState = ComponentState & AvatarCommonsUnstable & { + color: Exclude; }; // @public diff --git a/packages/react-badge/etc/react-badge.api.md b/packages/react-badge/etc/react-badge.api.md index 65fcffb3ce9f1..4aeb0e4e9c267 100644 --- a/packages/react-badge/etc/react-badge.api.md +++ b/packages/react-badge/etc/react-badge.api.md @@ -17,7 +17,7 @@ export const Badge: ForwardRefComponent; export const badgeClassName = "fui-Badge"; // @public (undocumented) -export type BadgeCommons = { +export type BadgeCommonsUnstable = { appearance: 'filled' | 'ghost' | 'outline' | 'tint'; color: 'brand' | 'danger' | 'important' | 'informative' | 'severe' | 'subtle' | 'success' | 'warning'; iconPosition: 'before' | 'after'; @@ -26,7 +26,7 @@ export type BadgeCommons = { }; // @public (undocumented) -export type BadgeProps = ComponentProps> & Partial; +export type BadgeProps = ComponentProps> & Partial; // @public (undocumented) export type BadgeSlots = { @@ -35,7 +35,7 @@ export type BadgeSlots = { }; // @public (undocumented) -export type BadgeState = ComponentState & BadgeCommons; +export type BadgeState = ComponentState & BadgeCommonsUnstable; // @public export const CounterBadge: ForwardRefComponent; @@ -44,7 +44,7 @@ export const CounterBadge: ForwardRefComponent; export const counterBadgeClassName = "fui-CounterBadge"; // @public (undocumented) -export type CounterBadgeCommons = { +export type CounterBadgeCommonsUnstable = { overflowCount: number; count: number; showZero: boolean; @@ -55,10 +55,10 @@ export type CounterBadgeCommons = { }; // @public (undocumented) -export type CounterBadgeProps = Omit & Partial; +export type CounterBadgeProps = Omit & Partial; // @public (undocumented) -export type CounterBadgeState = Omit & CounterBadgeCommons; +export type CounterBadgeState = Omit & CounterBadgeCommonsUnstable; // @public export const PresenceBadge: ForwardRefComponent; @@ -67,16 +67,16 @@ export const PresenceBadge: ForwardRefComponent; export const presenceBadgeClassName = "fui-PresenceBadge"; // @public (undocumented) -export type PresenceBadgeCommons = { +export type PresenceBadgeCommonsUnstable = { status: PresenceBadgeStatus; outOfOffice: boolean; -} & BadgeCommons; +} & BadgeCommonsUnstable; // @public (undocumented) -export type PresenceBadgeProps = ComponentProps>> & Partial>; +export type PresenceBadgeProps = ComponentProps>> & Partial>; // @public (undocumented) -export type PresenceBadgeState = PresenceBadgeCommons & ComponentState; +export type PresenceBadgeState = PresenceBadgeCommonsUnstable & ComponentState; // @public (undocumented) export type PresenceBadgeStatus = 'busy' | 'outOfOffice' | 'away' | 'available' | 'offline' | 'doNotDisturb'; diff --git a/packages/react-button/etc/react-button.api.md b/packages/react-button/etc/react-button.api.md index 3d3c53a9adf51..199200f05bea2 100644 --- a/packages/react-button/etc/react-button.api.md +++ b/packages/react-button/etc/react-button.api.md @@ -19,7 +19,7 @@ export const Button: ForwardRefComponent; export const buttonClassName = "fui-Button"; // @public (undocumented) -export type ButtonCommons = { +export type ButtonCommonsUnstable = { appearance?: 'primary' | 'outline' | 'subtle' | 'transparent'; block: boolean; disabledFocusable: boolean; @@ -30,7 +30,7 @@ export type ButtonCommons = { }; // @public (undocumented) -export type ButtonProps = ComponentProps & Partial; +export type ButtonProps = ComponentProps & Partial; // @public (undocumented) export type ButtonSlots = { @@ -39,7 +39,7 @@ export type ButtonSlots = { }; // @public (undocumented) -export type ButtonState = ComponentState & ButtonCommons & { +export type ButtonState = ComponentState & ButtonCommonsUnstable & { iconOnly: boolean; }; @@ -50,7 +50,7 @@ export const CompoundButton: ForwardRefComponent; export const compoundButtonClassName = "fui-CompoundButton"; // @public (undocumented) -export type CompoundButtonProps = ComponentProps & Partial; +export type CompoundButtonProps = ComponentProps & Partial; // @public (undocumented) export type CompoundButtonSlots = ButtonSlots & { @@ -68,7 +68,7 @@ export const MenuButton: ForwardRefComponent; export const menuButtonClassName = "fui-MenuButton"; // @public (undocumented) -export type MenuButtonProps = ComponentProps & Partial>; +export type MenuButtonProps = ComponentProps & Partial>; // @public (undocumented) export type MenuButtonSlots = ButtonSlots & { @@ -118,17 +118,17 @@ export const ToggleButton: ForwardRefComponent; export const toggleButtonClassName = "fui-ToggleButton"; // @public (undocumented) -export type ToggleButtonCommons = { +export type ToggleButtonCommonsUnstable = { checked: boolean; }; // @public (undocumented) -export type ToggleButtonProps = ButtonProps & Partial & { +export type ToggleButtonProps = ButtonProps & Partial & { defaultChecked?: boolean; }; // @public (undocumented) -export type ToggleButtonState = ButtonState & ToggleButtonCommons; +export type ToggleButtonState = ButtonState & ToggleButtonCommonsUnstable; // @public export const useButton_unstable: (props: ButtonProps, ref: React_2.Ref) => ButtonState; diff --git a/packages/react-divider/etc/react-divider.api.md b/packages/react-divider/etc/react-divider.api.md index 4fb3dd0c4c224..4b9b2ca94f23e 100644 --- a/packages/react-divider/etc/react-divider.api.md +++ b/packages/react-divider/etc/react-divider.api.md @@ -17,7 +17,7 @@ export const Divider: ForwardRefComponent; export const dividerClassName = "fui-Divider"; // @public (undocumented) -export type DividerCommons = { +export type DividerCommonsUnstable = { alignContent: 'start' | 'center' | 'end'; appearance?: 'brand' | 'strong' | 'subtle'; inset: boolean; @@ -25,7 +25,7 @@ export type DividerCommons = { }; // @public (undocumented) -export type DividerProps = ComponentProps & Partial; +export type DividerProps = ComponentProps & Partial; // @public (undocumented) export type DividerSlots = { @@ -34,7 +34,7 @@ export type DividerSlots = { }; // @public (undocumented) -export type DividerState = ComponentState & DividerCommons; +export type DividerState = ComponentState & DividerCommonsUnstable; // @public export const renderDivider_unstable: (state: DividerState) => JSX.Element; diff --git a/packages/react-image/etc/react-image.api.md b/packages/react-image/etc/react-image.api.md index 1d776d553d598..2590af7a0f100 100644 --- a/packages/react-image/etc/react-image.api.md +++ b/packages/react-image/etc/react-image.api.md @@ -18,7 +18,7 @@ export { Image_2 as Image } export const imageClassName = "fui-Image"; // @public (undocumented) -export type ImageCommons = { +export type ImageCommonsUnstable = { bordered?: boolean; fit?: 'none' | 'center' | 'contain' | 'cover'; block?: boolean; @@ -27,7 +27,7 @@ export type ImageCommons = { }; // @public (undocumented) -export type ImageProps = ComponentProps & Partial; +export type ImageProps = ComponentProps & Partial; // @public (undocumented) export type ImageSlots = { @@ -35,7 +35,7 @@ export type ImageSlots = { }; // @public (undocumented) -export type ImageState = ComponentState & ImageCommons; +export type ImageState = ComponentState & ImageCommonsUnstable; // @public export const renderImage_unstable: (state: ImageState) => JSX.Element; diff --git a/packages/react-label/etc/react-label.api.md b/packages/react-label/etc/react-label.api.md index e7292dc988b9a..eb38616466ff4 100644 --- a/packages/react-label/etc/react-label.api.md +++ b/packages/react-label/etc/react-label.api.md @@ -17,14 +17,14 @@ export const Label: ForwardRefComponent; export const labelClassName = "fui-Label"; // @public (undocumented) -export type LabelCommons = { +export type LabelCommonsUnstable = { disabled: boolean; size: 'small' | 'medium' | 'large'; strong: boolean; }; // @public -export type LabelProps = Omit, 'required'> & Partial & { +export type LabelProps = Omit, 'required'> & Partial & { required?: boolean | IntrinsicSlotProps<'span'> | React_2.ReactNode; }; @@ -35,7 +35,7 @@ export type LabelSlots = { }; // @public -export type LabelState = ComponentState & LabelCommons; +export type LabelState = ComponentState & LabelCommonsUnstable; // @public export const renderLabel_unstable: (state: LabelState) => JSX.Element; diff --git a/packages/react-link/etc/react-link.api.md b/packages/react-link/etc/react-link.api.md index f1a0559e4fe1a..4e6921e4a3693 100644 --- a/packages/react-link/etc/react-link.api.md +++ b/packages/react-link/etc/react-link.api.md @@ -17,7 +17,7 @@ export const Link: ForwardRefComponent; export const linkClassName = "fui-Link"; // @public (undocumented) -export type LinkCommons = { +export type LinkCommonsUnstable = { appearance?: 'subtle'; disabled?: boolean; disabledFocusable?: boolean; @@ -25,7 +25,7 @@ export type LinkCommons = { }; // @public (undocumented) -export type LinkProps = ComponentProps & LinkCommons; +export type LinkProps = ComponentProps & LinkCommonsUnstable; // @public (undocumented) export type LinkSlots = { @@ -33,7 +33,7 @@ export type LinkSlots = { }; // @public (undocumented) -export type LinkState = ComponentState & LinkCommons; +export type LinkState = ComponentState & LinkCommonsUnstable; // @public export const renderLink_unstable: (state: LinkState) => JSX.Element; diff --git a/packages/react-menu/etc/react-menu.api.md b/packages/react-menu/etc/react-menu.api.md index 01258b5e19620..eb00eace9cf41 100644 --- a/packages/react-menu/etc/react-menu.api.md +++ b/packages/react-menu/etc/react-menu.api.md @@ -125,10 +125,10 @@ export type MenuItemCheckboxState = MenuItemState & MenuItemSelectableState; // @public (undocumented) export const menuItemClassName = "fui-MenuItem"; -// Warning: (ae-forgotten-export) The symbol "MenuItemCommons" needs to be exported by the entry point index.d.ts +// Warning: (ae-forgotten-export) The symbol "MenuItemCommonsUnstable" needs to be exported by the entry point index.d.ts // // @public (undocumented) -export type MenuItemProps = ComponentProps> & MenuItemCommons; +export type MenuItemProps = ComponentProps> & MenuItemCommonsUnstable; // @public export const MenuItemRadio: ForwardRefComponent; @@ -166,7 +166,7 @@ export type MenuItemSlots = { }; // @public (undocumented) -export type MenuItemState = ComponentState & MenuItemCommons; +export type MenuItemState = ComponentState & MenuItemCommonsUnstable; // @public export const MenuList: ForwardRefComponent; @@ -175,7 +175,7 @@ export const MenuList: ForwardRefComponent; export const menuListClassName = "fui-MenuList"; // @public (undocumented) -export type MenuListCommons = { +export type MenuListCommonsUnstable = { onCheckedValueChange?: (e: MenuCheckedValueChangeEvent, data: MenuCheckedValueChangeData) => void; checkedValues: Record; defaultCheckedValues?: Record; @@ -199,7 +199,7 @@ export type MenuListContextValues = { }; // @public (undocumented) -export type MenuListProps = ComponentProps & Partial; +export type MenuListProps = ComponentProps & Partial; // @public (undocumented) export const MenuListProvider: React_2.Provider & React_2.FC>; @@ -210,7 +210,7 @@ export type MenuListSlots = { }; // @public (undocumented) -export type MenuListState = ComponentState & MenuListCommons & { +export type MenuListState = ComponentState & MenuListCommonsUnstable & { setFocusByFirstCharacter: NonNullable; toggleCheckbox: SelectableHandler; selectRadio: SelectableHandler; @@ -245,10 +245,10 @@ export type MenuPopoverState = ComponentState & { inline: boolean; }; -// Warning: (ae-forgotten-export) The symbol "MenuCommons" needs to be exported by the entry point index.d.ts +// Warning: (ae-forgotten-export) The symbol "MenuCommonsUnstable" needs to be exported by the entry point index.d.ts // // @public -export type MenuProps = Partial & ComponentProps & { +export type MenuProps = Partial & ComponentProps & { children: [JSX.Element, JSX.Element] | JSX.Element; positioning?: PositioningShorthand; }; @@ -266,10 +266,10 @@ export const MenuSplitGroup: ForwardRefComponent; export const menuSplitGroupClassName = "fui-MenuSplitGroup"; // @public (undocumented) -export type MenuSplitGroupCommons = {}; +export type MenuSplitGroupCommonsUnstable = {}; // @public -export type MenuSplitGroupProps = ComponentProps & MenuSplitGroupCommons; +export type MenuSplitGroupProps = ComponentProps & MenuSplitGroupCommonsUnstable; // @public (undocumented) export type MenuSplitGroupSlots = { @@ -277,10 +277,10 @@ export type MenuSplitGroupSlots = { }; // @public -export type MenuSplitGroupState = ComponentState & MenuSplitGroupCommons; +export type MenuSplitGroupState = ComponentState & MenuSplitGroupCommonsUnstable; // @public (undocumented) -export type MenuState = MenuCommons & ComponentState & { +export type MenuState = MenuCommonsUnstable & ComponentState & { setOpen: (e: MenuOpenEvents, data: MenuOpenChangeData) => void; menuPopover: React_2.ReactNode; menuTrigger: React_2.ReactNode; diff --git a/packages/react-popover/etc/react-popover.api.md b/packages/react-popover/etc/react-popover.api.md index 43f10279dc9bf..62f474458b6c9 100644 --- a/packages/react-popover/etc/react-popover.api.md +++ b/packages/react-popover/etc/react-popover.api.md @@ -31,7 +31,7 @@ export type OpenPopoverEvents = MouseEvent | TouchEvent | React_2.MouseEvent; // @public (undocumented) -export type PopoverCommons = Pick & { +export type PopoverCommonsUnstable = Pick & { open: boolean; defaultOpen?: boolean; onOpenChange?: (e: OpenPopoverEvents, data: OnOpenChangeData) => void; @@ -51,7 +51,7 @@ export const PopoverContext: Context; export type PopoverContextValue = Pick; // @public -export type PopoverProps = Partial & { +export type PopoverProps = Partial & { children: [JSX.Element, JSX.Element] | JSX.Element; }; @@ -59,7 +59,7 @@ export type PopoverProps = Partial & { export type PopoverSize = 'small' | 'medium' | 'large'; // @public -export type PopoverState = PopoverCommons & Pick & { +export type PopoverState = PopoverCommonsUnstable & Pick & { setOpen: (e: OpenPopoverEvents, open: boolean) => void; triggerRef: React_2.MutableRefObject; contentRef: React_2.MutableRefObject; diff --git a/packages/react-portal/etc/react-portal.api.md b/packages/react-portal/etc/react-portal.api.md index 6b00006826bc8..c615f718e844f 100644 --- a/packages/react-portal/etc/react-portal.api.md +++ b/packages/react-portal/etc/react-portal.api.md @@ -13,16 +13,16 @@ export function elementContains(parent: HTMLElement | null, child: HTMLElement | export const Portal: React_2.FC; // @public (undocumented) -export type PortalCommons = { +export type PortalCommonsUnstable = { children: React_2.ReactNode; mountNode: HTMLDivElement | undefined; }; // @public (undocumented) -export type PortalProps = Partial; +export type PortalProps = Partial; // @public (undocumented) -export type PortalState = PortalCommons & { +export type PortalState = PortalCommonsUnstable & { shouldRender: boolean; virtualParentRootRef: React_2.MutableRefObject; }; diff --git a/packages/react-slider/etc/react-slider.api.md b/packages/react-slider/etc/react-slider.api.md index 6125724eefb2d..850d9888d57ef 100644 --- a/packages/react-slider/etc/react-slider.api.md +++ b/packages/react-slider/etc/react-slider.api.md @@ -20,7 +20,7 @@ export const Slider: ForwardRefComponent; export const sliderClassName = "fui-Slider"; // @public (undocumented) -export type SliderCommons = { +export type SliderCommonsUnstable = { defaultValue?: number; value?: number; min?: number; @@ -40,7 +40,7 @@ export type SliderOnChangeData = { }; // @public (undocumented) -export type SliderProps = Omit, 'defaultValue' | 'onChange' | 'size' | 'value'> & SliderCommons; +export type SliderProps = Omit, 'defaultValue' | 'onChange' | 'size' | 'value'> & SliderCommonsUnstable; // @public (undocumented) export type SliderSlots = { @@ -53,7 +53,7 @@ export type SliderSlots = { }; // @public (undocumented) -export type SliderState = ComponentState & SliderCommons; +export type SliderState = ComponentState & SliderCommonsUnstable; // @public export const useSlider_unstable: (props: SliderProps, ref: React_2.Ref) => SliderState; diff --git a/packages/react-text/etc/react-text.api.md b/packages/react-text/etc/react-text.api.md index 359e34e50cd8c..407b396de85ad 100644 --- a/packages/react-text/etc/react-text.api.md +++ b/packages/react-text/etc/react-text.api.md @@ -61,7 +61,7 @@ export { Text_2 as Text } export const textClassName = "fui-Text"; // @public (undocumented) -export type TextCommons = { +export type TextCommonsUnstable = { wrap: boolean; truncate: boolean; block: boolean; @@ -75,7 +75,7 @@ export type TextCommons = { }; // @public -export type TextProps = ComponentProps & Partial; +export type TextProps = ComponentProps & Partial; // @public export type TextSlots = { @@ -83,7 +83,7 @@ export type TextSlots = { }; // @public -export type TextState = ComponentState & TextCommons; +export type TextState = ComponentState & TextCommonsUnstable; // @public export const Title1: FunctionComponent; diff --git a/packages/react-tooltip/etc/react-tooltip.api.md b/packages/react-tooltip/etc/react-tooltip.api.md index a1fe5590ce969..43c25fe03f780 100644 --- a/packages/react-tooltip/etc/react-tooltip.api.md +++ b/packages/react-tooltip/etc/react-tooltip.api.md @@ -26,7 +26,7 @@ export const Tooltip: React_2.FC & FluentTriggerComponent; export const tooltipClassName = "fui-Tooltip"; // @public -export type TooltipCommons = { +export type TooltipCommonsUnstable = { appearance?: 'normal' | 'inverted'; withArrow?: boolean; positioning?: PositioningShorthand; @@ -38,7 +38,7 @@ export type TooltipCommons = { }; // @public -export type TooltipProps = Omit, 'content'> & Required, 'content'>> & Partial> & Pick & { +export type TooltipProps = Omit, 'content'> & Required, 'content'>> & Partial> & Pick & { children?: (React_2.ReactElement & { ref?: React_2.Ref; }) | ((props: TooltipTriggerProps) => React_2.ReactNode) | null; @@ -50,7 +50,7 @@ export type TooltipSlots = { }; // @public -export type TooltipState = ComponentState & TooltipCommons & { +export type TooltipState = ComponentState & TooltipCommonsUnstable & { children?: React_2.ReactNode; shouldRenderTooltip?: boolean; arrowRef?: React_2.Ref; From d443ecba490a69f6186996c4dd25053e282c937f Mon Sep 17 00:00:00 2001 From: Micah Godbolt Date: Thu, 3 Feb 2022 14:59:39 -0800 Subject: [PATCH 03/11] Change files --- ...act-accordion-1a59af91-1bb6-4e97-b169-0015a2b93628.json | 7 +++++++ ...-react-avatar-9088a763-26b3-4ad1-9e37-2a0fffd1b1b4.json | 7 +++++++ ...i-react-badge-94d0d2da-1a7f-492a-9fea-ea0ec5f3b182.json | 7 +++++++ ...-react-button-d22c5e25-201d-4540-8c8b-821504d7df42.json | 7 +++++++ ...eact-checkbox-c6d4fb86-1d32-47bb-80eb-9d11c00aad98.json | 7 +++++++ ...react-divider-40240833-3285-477a-b8bb-3e3a99bd4738.json | 7 +++++++ ...i-react-image-97e87b47-9e02-424d-bba0-5db2c8a0b9ce.json | 7 +++++++ ...i-react-label-05b9cebc-7e4b-4afa-b5cb-7c948bb6aed7.json | 7 +++++++ ...ui-react-link-03aac507-bd25-478e-99ad-95e63e218d22.json | 7 +++++++ ...ui-react-menu-4c81f78a-ea5e-49f1-af2f-9691b678c645.json | 7 +++++++ ...react-popover-85a5376a-5b6f-45be-8dac-1b4a6918b500.json | 7 +++++++ ...-react-portal-7456b5ce-e7e5-4fa6-b9a9-88b6ba28497c.json | 7 +++++++ ...eact-provider-c0799206-5e00-418c-9b7b-17f8e9372108.json | 7 +++++++ ...-react-slider-a2d53b51-7bc1-4a0b-849e-c28738317560.json | 7 +++++++ ...-react-switch-b4663504-89c2-4e00-9f6f-feabe29233e1.json | 7 +++++++ ...ui-react-text-52ed3ec1-b013-4242-ade7-0bc6c57de13b.json | 7 +++++++ ...react-tooltip-041195b3-16d3-4bd9-8c85-16039adb9cc2.json | 7 +++++++ 17 files changed, 119 insertions(+) create mode 100644 change/@fluentui-react-accordion-1a59af91-1bb6-4e97-b169-0015a2b93628.json create mode 100644 change/@fluentui-react-avatar-9088a763-26b3-4ad1-9e37-2a0fffd1b1b4.json create mode 100644 change/@fluentui-react-badge-94d0d2da-1a7f-492a-9fea-ea0ec5f3b182.json create mode 100644 change/@fluentui-react-button-d22c5e25-201d-4540-8c8b-821504d7df42.json create mode 100644 change/@fluentui-react-checkbox-c6d4fb86-1d32-47bb-80eb-9d11c00aad98.json create mode 100644 change/@fluentui-react-divider-40240833-3285-477a-b8bb-3e3a99bd4738.json create mode 100644 change/@fluentui-react-image-97e87b47-9e02-424d-bba0-5db2c8a0b9ce.json create mode 100644 change/@fluentui-react-label-05b9cebc-7e4b-4afa-b5cb-7c948bb6aed7.json create mode 100644 change/@fluentui-react-link-03aac507-bd25-478e-99ad-95e63e218d22.json create mode 100644 change/@fluentui-react-menu-4c81f78a-ea5e-49f1-af2f-9691b678c645.json create mode 100644 change/@fluentui-react-popover-85a5376a-5b6f-45be-8dac-1b4a6918b500.json create mode 100644 change/@fluentui-react-portal-7456b5ce-e7e5-4fa6-b9a9-88b6ba28497c.json create mode 100644 change/@fluentui-react-provider-c0799206-5e00-418c-9b7b-17f8e9372108.json create mode 100644 change/@fluentui-react-slider-a2d53b51-7bc1-4a0b-849e-c28738317560.json create mode 100644 change/@fluentui-react-switch-b4663504-89c2-4e00-9f6f-feabe29233e1.json create mode 100644 change/@fluentui-react-text-52ed3ec1-b013-4242-ade7-0bc6c57de13b.json create mode 100644 change/@fluentui-react-tooltip-041195b3-16d3-4bd9-8c85-16039adb9cc2.json diff --git a/change/@fluentui-react-accordion-1a59af91-1bb6-4e97-b169-0015a2b93628.json b/change/@fluentui-react-accordion-1a59af91-1bb6-4e97-b169-0015a2b93628.json new file mode 100644 index 0000000000000..2fedf08dc8ffb --- /dev/null +++ b/change/@fluentui-react-accordion-1a59af91-1bb6-4e97-b169-0015a2b93628.json @@ -0,0 +1,7 @@ +{ + "type": "prerelease", + "comment": "change commons type to be unstable", + "packageName": "@fluentui/react-accordion", + "email": "mgodbolt@microsoft.com", + "dependentChangeType": "patch" +} diff --git a/change/@fluentui-react-avatar-9088a763-26b3-4ad1-9e37-2a0fffd1b1b4.json b/change/@fluentui-react-avatar-9088a763-26b3-4ad1-9e37-2a0fffd1b1b4.json new file mode 100644 index 0000000000000..36d21d5429509 --- /dev/null +++ b/change/@fluentui-react-avatar-9088a763-26b3-4ad1-9e37-2a0fffd1b1b4.json @@ -0,0 +1,7 @@ +{ + "type": "prerelease", + "comment": "change commons type to be unstable", + "packageName": "@fluentui/react-avatar", + "email": "mgodbolt@microsoft.com", + "dependentChangeType": "patch" +} diff --git a/change/@fluentui-react-badge-94d0d2da-1a7f-492a-9fea-ea0ec5f3b182.json b/change/@fluentui-react-badge-94d0d2da-1a7f-492a-9fea-ea0ec5f3b182.json new file mode 100644 index 0000000000000..bc2fdc0e7b4ac --- /dev/null +++ b/change/@fluentui-react-badge-94d0d2da-1a7f-492a-9fea-ea0ec5f3b182.json @@ -0,0 +1,7 @@ +{ + "type": "prerelease", + "comment": "change commons type to be unstable", + "packageName": "@fluentui/react-badge", + "email": "mgodbolt@microsoft.com", + "dependentChangeType": "patch" +} diff --git a/change/@fluentui-react-button-d22c5e25-201d-4540-8c8b-821504d7df42.json b/change/@fluentui-react-button-d22c5e25-201d-4540-8c8b-821504d7df42.json new file mode 100644 index 0000000000000..cc4a0161b4c9e --- /dev/null +++ b/change/@fluentui-react-button-d22c5e25-201d-4540-8c8b-821504d7df42.json @@ -0,0 +1,7 @@ +{ + "type": "prerelease", + "comment": "change commons type to be unstable", + "packageName": "@fluentui/react-button", + "email": "mgodbolt@microsoft.com", + "dependentChangeType": "patch" +} diff --git a/change/@fluentui-react-checkbox-c6d4fb86-1d32-47bb-80eb-9d11c00aad98.json b/change/@fluentui-react-checkbox-c6d4fb86-1d32-47bb-80eb-9d11c00aad98.json new file mode 100644 index 0000000000000..3678362468cf4 --- /dev/null +++ b/change/@fluentui-react-checkbox-c6d4fb86-1d32-47bb-80eb-9d11c00aad98.json @@ -0,0 +1,7 @@ +{ + "type": "prerelease", + "comment": "change commons type to be unstable", + "packageName": "@fluentui/react-checkbox", + "email": "mgodbolt@microsoft.com", + "dependentChangeType": "patch" +} diff --git a/change/@fluentui-react-divider-40240833-3285-477a-b8bb-3e3a99bd4738.json b/change/@fluentui-react-divider-40240833-3285-477a-b8bb-3e3a99bd4738.json new file mode 100644 index 0000000000000..4591760d3b25c --- /dev/null +++ b/change/@fluentui-react-divider-40240833-3285-477a-b8bb-3e3a99bd4738.json @@ -0,0 +1,7 @@ +{ + "type": "prerelease", + "comment": "change commons type to be unstable", + "packageName": "@fluentui/react-divider", + "email": "mgodbolt@microsoft.com", + "dependentChangeType": "patch" +} diff --git a/change/@fluentui-react-image-97e87b47-9e02-424d-bba0-5db2c8a0b9ce.json b/change/@fluentui-react-image-97e87b47-9e02-424d-bba0-5db2c8a0b9ce.json new file mode 100644 index 0000000000000..a1ddced8ee8c5 --- /dev/null +++ b/change/@fluentui-react-image-97e87b47-9e02-424d-bba0-5db2c8a0b9ce.json @@ -0,0 +1,7 @@ +{ + "type": "prerelease", + "comment": "change commons type to be unstable", + "packageName": "@fluentui/react-image", + "email": "mgodbolt@microsoft.com", + "dependentChangeType": "patch" +} diff --git a/change/@fluentui-react-label-05b9cebc-7e4b-4afa-b5cb-7c948bb6aed7.json b/change/@fluentui-react-label-05b9cebc-7e4b-4afa-b5cb-7c948bb6aed7.json new file mode 100644 index 0000000000000..94a04bfa1780b --- /dev/null +++ b/change/@fluentui-react-label-05b9cebc-7e4b-4afa-b5cb-7c948bb6aed7.json @@ -0,0 +1,7 @@ +{ + "type": "prerelease", + "comment": "change commons type to be unstable", + "packageName": "@fluentui/react-label", + "email": "mgodbolt@microsoft.com", + "dependentChangeType": "patch" +} diff --git a/change/@fluentui-react-link-03aac507-bd25-478e-99ad-95e63e218d22.json b/change/@fluentui-react-link-03aac507-bd25-478e-99ad-95e63e218d22.json new file mode 100644 index 0000000000000..233ccb9f1bf3e --- /dev/null +++ b/change/@fluentui-react-link-03aac507-bd25-478e-99ad-95e63e218d22.json @@ -0,0 +1,7 @@ +{ + "type": "prerelease", + "comment": "change commons type to be unstable", + "packageName": "@fluentui/react-link", + "email": "mgodbolt@microsoft.com", + "dependentChangeType": "patch" +} diff --git a/change/@fluentui-react-menu-4c81f78a-ea5e-49f1-af2f-9691b678c645.json b/change/@fluentui-react-menu-4c81f78a-ea5e-49f1-af2f-9691b678c645.json new file mode 100644 index 0000000000000..29beda7a94f50 --- /dev/null +++ b/change/@fluentui-react-menu-4c81f78a-ea5e-49f1-af2f-9691b678c645.json @@ -0,0 +1,7 @@ +{ + "type": "prerelease", + "comment": "change commons type to be unstable", + "packageName": "@fluentui/react-menu", + "email": "mgodbolt@microsoft.com", + "dependentChangeType": "patch" +} diff --git a/change/@fluentui-react-popover-85a5376a-5b6f-45be-8dac-1b4a6918b500.json b/change/@fluentui-react-popover-85a5376a-5b6f-45be-8dac-1b4a6918b500.json new file mode 100644 index 0000000000000..dc9bd7fcc4630 --- /dev/null +++ b/change/@fluentui-react-popover-85a5376a-5b6f-45be-8dac-1b4a6918b500.json @@ -0,0 +1,7 @@ +{ + "type": "prerelease", + "comment": "change commons type to be unstable", + "packageName": "@fluentui/react-popover", + "email": "mgodbolt@microsoft.com", + "dependentChangeType": "patch" +} diff --git a/change/@fluentui-react-portal-7456b5ce-e7e5-4fa6-b9a9-88b6ba28497c.json b/change/@fluentui-react-portal-7456b5ce-e7e5-4fa6-b9a9-88b6ba28497c.json new file mode 100644 index 0000000000000..ab8620d108a75 --- /dev/null +++ b/change/@fluentui-react-portal-7456b5ce-e7e5-4fa6-b9a9-88b6ba28497c.json @@ -0,0 +1,7 @@ +{ + "type": "prerelease", + "comment": "change commons type to be unstable", + "packageName": "@fluentui/react-portal", + "email": "mgodbolt@microsoft.com", + "dependentChangeType": "patch" +} diff --git a/change/@fluentui-react-provider-c0799206-5e00-418c-9b7b-17f8e9372108.json b/change/@fluentui-react-provider-c0799206-5e00-418c-9b7b-17f8e9372108.json new file mode 100644 index 0000000000000..f8edb1853c285 --- /dev/null +++ b/change/@fluentui-react-provider-c0799206-5e00-418c-9b7b-17f8e9372108.json @@ -0,0 +1,7 @@ +{ + "type": "prerelease", + "comment": "change commons type to be unstable", + "packageName": "@fluentui/react-provider", + "email": "mgodbolt@microsoft.com", + "dependentChangeType": "patch" +} diff --git a/change/@fluentui-react-slider-a2d53b51-7bc1-4a0b-849e-c28738317560.json b/change/@fluentui-react-slider-a2d53b51-7bc1-4a0b-849e-c28738317560.json new file mode 100644 index 0000000000000..6de4453b5d4ea --- /dev/null +++ b/change/@fluentui-react-slider-a2d53b51-7bc1-4a0b-849e-c28738317560.json @@ -0,0 +1,7 @@ +{ + "type": "prerelease", + "comment": "change commons type to be unstable", + "packageName": "@fluentui/react-slider", + "email": "mgodbolt@microsoft.com", + "dependentChangeType": "patch" +} diff --git a/change/@fluentui-react-switch-b4663504-89c2-4e00-9f6f-feabe29233e1.json b/change/@fluentui-react-switch-b4663504-89c2-4e00-9f6f-feabe29233e1.json new file mode 100644 index 0000000000000..60fabfff76f77 --- /dev/null +++ b/change/@fluentui-react-switch-b4663504-89c2-4e00-9f6f-feabe29233e1.json @@ -0,0 +1,7 @@ +{ + "type": "prerelease", + "comment": "change commons type to be unstable", + "packageName": "@fluentui/react-switch", + "email": "mgodbolt@microsoft.com", + "dependentChangeType": "patch" +} diff --git a/change/@fluentui-react-text-52ed3ec1-b013-4242-ade7-0bc6c57de13b.json b/change/@fluentui-react-text-52ed3ec1-b013-4242-ade7-0bc6c57de13b.json new file mode 100644 index 0000000000000..af4094955c264 --- /dev/null +++ b/change/@fluentui-react-text-52ed3ec1-b013-4242-ade7-0bc6c57de13b.json @@ -0,0 +1,7 @@ +{ + "type": "prerelease", + "comment": "change commons type to be unstable", + "packageName": "@fluentui/react-text", + "email": "mgodbolt@microsoft.com", + "dependentChangeType": "patch" +} diff --git a/change/@fluentui-react-tooltip-041195b3-16d3-4bd9-8c85-16039adb9cc2.json b/change/@fluentui-react-tooltip-041195b3-16d3-4bd9-8c85-16039adb9cc2.json new file mode 100644 index 0000000000000..47684e68866c3 --- /dev/null +++ b/change/@fluentui-react-tooltip-041195b3-16d3-4bd9-8c85-16039adb9cc2.json @@ -0,0 +1,7 @@ +{ + "type": "prerelease", + "comment": "change commons type to be unstable", + "packageName": "@fluentui/react-tooltip", + "email": "mgodbolt@microsoft.com", + "dependentChangeType": "patch" +} From 2fd2ffa72cbdf23accb69bc00d17782643607cde Mon Sep 17 00:00:00 2001 From: Micah Godbolt Date: Thu, 3 Feb 2022 15:16:15 -0800 Subject: [PATCH 04/11] upate dialog api --- packages/react-dialog/etc/react-dialog.api.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/react-dialog/etc/react-dialog.api.md b/packages/react-dialog/etc/react-dialog.api.md index 8d5a7340ad18a..7f8b2aeebc775 100644 --- a/packages/react-dialog/etc/react-dialog.api.md +++ b/packages/react-dialog/etc/react-dialog.api.md @@ -17,10 +17,10 @@ export const Dialog: ForwardRefComponent; export const dialogClassName = "fui-Dialog"; // @public (undocumented) -export type DialogCommons = {}; +export type DialogCommonsUnstable = {}; // @public -export type DialogProps = ComponentProps & DialogCommons; +export type DialogProps = ComponentProps & DialogCommonsUnstable; // @public (undocumented) export type DialogSlots = { @@ -28,7 +28,7 @@ export type DialogSlots = { }; // @public -export type DialogState = ComponentState & DialogCommons; +export type DialogState = ComponentState & DialogCommonsUnstable; // @public export const renderDialog_unstable: (state: DialogState) => JSX.Element; From 0aff87e20d26015d3d355b21adc3389ecf0c35e8 Mon Sep 17 00:00:00 2001 From: Micah Godbolt Date: Fri, 4 Feb 2022 08:32:04 -0800 Subject: [PATCH 05/11] spin api --- packages/react-spinbutton/etc/react-spinbutton.api.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/react-spinbutton/etc/react-spinbutton.api.md b/packages/react-spinbutton/etc/react-spinbutton.api.md index f8fb841235f53..410fd0e0fd638 100644 --- a/packages/react-spinbutton/etc/react-spinbutton.api.md +++ b/packages/react-spinbutton/etc/react-spinbutton.api.md @@ -20,10 +20,10 @@ export const SpinButton: ForwardRefComponent; export const spinButtonClassName = "fui-SpinButton"; // @public (undocumented) -export type SpinButtonCommons = {}; +export type SpinButtonCommonsUnstable = {}; // @public -export type SpinButtonProps = ComponentProps & SpinButtonCommons; +export type SpinButtonProps = ComponentProps & SpinButtonCommonsUnstable; // @public (undocumented) export type SpinButtonSlots = { @@ -31,7 +31,7 @@ export type SpinButtonSlots = { }; // @public -export type SpinButtonState = ComponentState & SpinButtonCommons; +export type SpinButtonState = ComponentState & SpinButtonCommonsUnstable; // @public export const useSpinButton_unstable: (props: SpinButtonProps, ref: React_2.Ref) => SpinButtonState; From b33e775d88731676f6451308fc06fd581a543593 Mon Sep 17 00:00:00 2001 From: Micah Godbolt Date: Fri, 4 Feb 2022 08:36:40 -0800 Subject: [PATCH 06/11] all the apis --- packages/react-checkbox/etc/react-checkbox.api.md | 6 +++--- packages/react-switch/etc/react-switch.api.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/react-checkbox/etc/react-checkbox.api.md b/packages/react-checkbox/etc/react-checkbox.api.md index 962cc82e29548..2bef428ae6af6 100644 --- a/packages/react-checkbox/etc/react-checkbox.api.md +++ b/packages/react-checkbox/etc/react-checkbox.api.md @@ -19,7 +19,7 @@ export const Checkbox: ForwardRefComponent; export const checkboxClassName = "fui-Checkbox"; // @public (undocumented) -export interface CheckboxCommons { +export interface CheckboxCommonsUnstable { checked: 'mixed' | boolean; circular: boolean; labelPosition: 'before' | 'after'; @@ -33,7 +33,7 @@ export interface CheckboxOnChangeData { } // @public -export type CheckboxProps = Omit, 'size' | 'checked' | 'defaultChecked' | 'onChange'> & Partial & { +export type CheckboxProps = Omit, 'size' | 'checked' | 'defaultChecked' | 'onChange'> & Partial & { children?: never; onChange?: (ev: React_2.FormEvent, data: CheckboxOnChangeData) => void; defaultChecked?: 'mixed' | boolean; @@ -48,7 +48,7 @@ export type CheckboxSlots = { }; // @public -export type CheckboxState = ComponentState & CheckboxCommons; +export type CheckboxState = ComponentState & CheckboxCommonsUnstable; // @public (undocumented) export const renderCheckbox_unstable: (state: CheckboxState) => JSX.Element; diff --git a/packages/react-switch/etc/react-switch.api.md b/packages/react-switch/etc/react-switch.api.md index 58faa86585436..e5ba09574baf8 100644 --- a/packages/react-switch/etc/react-switch.api.md +++ b/packages/react-switch/etc/react-switch.api.md @@ -20,7 +20,7 @@ export const Switch: ForwardRefComponent; export const switchClassName = "fui-Switch"; // @public (undocumented) -export interface SwitchCommons { +export interface SwitchCommonsUnstable { checked?: boolean; defaultChecked?: boolean; disabled?: boolean; @@ -30,7 +30,7 @@ export interface SwitchCommons { } // @public (undocumented) -export interface SwitchProps extends Omit, 'onChange'>, SwitchCommons { +export interface SwitchProps extends Omit, 'onChange'>, SwitchCommonsUnstable { } // @public (undocumented) @@ -44,7 +44,7 @@ export type SwitchSlots = { }; // @public (undocumented) -export interface SwitchState extends ComponentState, SwitchCommons { +export interface SwitchState extends ComponentState, SwitchCommonsUnstable { } // @public From 5d541e50ae6668d49f1b93cbdf586983ce2837de Mon Sep 17 00:00:00 2001 From: Micah Godbolt Date: Fri, 4 Feb 2022 08:54:55 -0800 Subject: [PATCH 07/11] api for spinner --- packages/react-spinner/etc/react-spinner.api.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/react-spinner/etc/react-spinner.api.md b/packages/react-spinner/etc/react-spinner.api.md index d138a78547aff..fc86ad076fc06 100644 --- a/packages/react-spinner/etc/react-spinner.api.md +++ b/packages/react-spinner/etc/react-spinner.api.md @@ -20,10 +20,10 @@ export const Spinner: ForwardRefComponent; export const spinnerClassName = "fui-Spinner"; // @public (undocumented) -export type SpinnerCommons = {}; +export type SpinnerCommonsUnstable = {}; // @public -export type SpinnerProps = ComponentProps & SpinnerCommons; +export type SpinnerProps = ComponentProps & SpinnerCommonsUnstable; // @public (undocumented) export type SpinnerSlots = { @@ -31,7 +31,7 @@ export type SpinnerSlots = { }; // @public -export type SpinnerState = ComponentState & SpinnerCommons; +export type SpinnerState = ComponentState & SpinnerCommonsUnstable; // @public export const useSpinner_unstable: (props: SpinnerProps, ref: React_2.Ref) => SpinnerState; From 3eb3cf4b17b641fac7416378b68e546dbefd49b3 Mon Sep 17 00:00:00 2001 From: Micah Godbolt Date: Fri, 4 Feb 2022 09:02:54 -0800 Subject: [PATCH 08/11] add radio --- packages/react-radio/etc/react-radio.api.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/react-radio/etc/react-radio.api.md b/packages/react-radio/etc/react-radio.api.md index f754718bb5b1b..498693acef658 100644 --- a/packages/react-radio/etc/react-radio.api.md +++ b/packages/react-radio/etc/react-radio.api.md @@ -26,13 +26,13 @@ export const RadioItem: ForwardRefComponent; export const radioItemClassName = "fui-RadioItem"; // @public (undocumented) -export type RadioItemCommons = InputHTMLAttributes & { +export type RadioItemCommonsUnstable = InputHTMLAttributes & { labelPosition?: 'bottom' | 'inline'; containerClassName?: string; }; // @public -export type RadioItemProps = ComponentProps & RadioItemCommons & { +export type RadioItemProps = ComponentProps & RadioItemCommonsUnstable & { id?: string; }; @@ -46,7 +46,7 @@ export type RadioItemSlots = { }; // @public -export type RadioItemState = ComponentState & RadioItemCommons; +export type RadioItemState = ComponentState & RadioItemCommonsUnstable; // @public export type RadioProps = ComponentProps; From f1949d9b4a281897683ff2f3e649128fd1035f9f Mon Sep 17 00:00:00 2001 From: Micah Godbolt Date: Fri, 4 Feb 2022 09:10:57 -0800 Subject: [PATCH 09/11] tabs --- packages/react-tabs/etc/react-tabs.api.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/react-tabs/etc/react-tabs.api.md b/packages/react-tabs/etc/react-tabs.api.md index a229f5321d6e8..12c2abeda4f3e 100644 --- a/packages/react-tabs/etc/react-tabs.api.md +++ b/packages/react-tabs/etc/react-tabs.api.md @@ -49,7 +49,7 @@ export const Tab: ForwardRefComponent; export const tabClassName = "fui-Tab"; // @public (undocumented) -export type TabCommons = { +export type TabCommonsUnstable = { value: TabValue; }; @@ -68,7 +68,7 @@ export const TabList: ForwardRefComponent; export const tabListClassName = "fui-TabList"; // @public (undocumented) -export type TabListCommons = { +export type TabListCommonsUnstable = { appearance?: 'transparent' | 'subtle'; onTabSelect?: SelectTabEventHandler; selectedValue?: TabValue; @@ -77,7 +77,7 @@ export type TabListCommons = { }; // @public (undocumented) -export type TabListContextValue = Pick & Required> & { +export type TabListContextValue = Pick & Required> & { onRegister: RegisterTabEventHandler; onUnregister: RegisterTabEventHandler; onSelect: SelectTabEventHandler; @@ -89,7 +89,7 @@ export type TabListContextValues = { }; // @public -export type TabListProps = ComponentProps & TabListCommons & { +export type TabListProps = ComponentProps & TabListCommonsUnstable & { defaultSelectedValue?: TabValue; }; @@ -107,7 +107,7 @@ export type TabListState = ComponentState> & TabListConte }; // @public -export type TabProps = ComponentProps & TabCommons; +export type TabProps = ComponentProps & TabCommonsUnstable; // @public (undocumented) export type TabSlots = { @@ -117,7 +117,7 @@ export type TabSlots = { }; // @public -export type TabState = ComponentState & TabCommons & { +export type TabState = ComponentState & TabCommonsUnstable & { appearance?: string; selected?: boolean; size: 'small' | 'medium'; From 51c45b95bcf9539b3bc671413b1dd7a10a89762e Mon Sep 17 00:00:00 2001 From: Micah Godbolt Date: Fri, 4 Feb 2022 09:25:32 -0800 Subject: [PATCH 10/11] change story using commons --- apps/vr-tests/src/stories/Badge.stories.tsx | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/apps/vr-tests/src/stories/Badge.stories.tsx b/apps/vr-tests/src/stories/Badge.stories.tsx index a644df8fb0bb9..37fcf97348685 100644 --- a/apps/vr-tests/src/stories/Badge.stories.tsx +++ b/apps/vr-tests/src/stories/Badge.stories.tsx @@ -1,11 +1,11 @@ import { storiesOf } from '@storybook/react'; import * as React from 'react'; -import { Badge, BadgeCommons } from '@fluentui/react-badge'; +import { Badge, BadgeCommonsUnstable } from '@fluentui/react-badge'; import { CircleRegular } from '@fluentui/react-icons'; import { mergeClasses, makeStyles, shorthands } from '@griffel/react'; import { tokens } from '@fluentui/react-theme'; -const badgeColors: BadgeCommons['color'][] = [ +const badgeColors: BadgeCommonsUnstable['color'][] = [ 'brand', 'danger', 'important', @@ -16,7 +16,12 @@ const badgeColors: BadgeCommons['color'][] = [ 'warning', ]; -const badgeAppearances: BadgeCommons['appearance'][] = ['filled', 'outline', 'tint', 'ghost']; +const badgeAppearances: BadgeCommonsUnstable['appearance'][] = [ + 'filled', + 'outline', + 'tint', + 'ghost', +]; const useStyles = makeStyles({ container: { @@ -40,12 +45,12 @@ const useStyles = makeStyles({ }, }); -const BadgeAppearanceTemplate: React.FC<{ appearance: BadgeCommons['appearance'] }> = ({ +const BadgeAppearanceTemplate: React.FC<{ appearance: BadgeCommonsUnstable['appearance'] }> = ({ appearance, }) => { const styles = useStyles(); - const badges = new Map(); + const badges = new Map(); badges.set('brand', []); badges.set('danger', []); badges.set('severe', []); @@ -109,7 +114,7 @@ const BadgeAppearanceTemplate: React.FC<{ appearance: BadgeCommons['appearance'] return (
- {Array.from(badges.keys()).map((color: BadgeCommons['color'], i) => ( + {Array.from(badges.keys()).map((color: BadgeCommonsUnstable['color'], i) => (
( + ] as BadgeCommonsUnstable['size'][]).map(size => ( ))}
From 0b8c83e55c6c6508e76b7fcfea87e6bc21d21e79 Mon Sep 17 00:00:00 2001 From: Micah Godbolt Date: Mon, 7 Feb 2022 07:50:03 -0800 Subject: [PATCH 11/11] tabs api update --- packages/react-tabs/etc/react-tabs.api.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/packages/react-tabs/etc/react-tabs.api.md b/packages/react-tabs/etc/react-tabs.api.md index 9a44ccbb52750..a4f05a65cc3a1 100644 --- a/packages/react-tabs/etc/react-tabs.api.md +++ b/packages/react-tabs/etc/react-tabs.api.md @@ -107,11 +107,7 @@ export type TabListState = ComponentState> & TabListConte }; // @public -<<<<<<< HEAD -export type TabProps = ComponentProps & TabCommonsUnstable; -======= -export type TabProps = ComponentProps> & TabCommons; ->>>>>>> master +export type TabProps = ComponentProps> & TabCommonsUnstable; // @public (undocumented) export type TabSlots = {