Skip to content

feat(react-button): expose button base hooks and types #35890

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
dmytrokirpa merged 1 commit into from
Mar 23, 2026
+35 −8
Merged

feat(react-button): expose button base hooks and types #35890

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

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions change/@fluentui-react-button-fcb6154c-d0ed-4f2f-8e4a-19d591664e5c.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "minor",
"comment": "feat: expose button base hooks and types",
"packageName": "@fluentui/react-button",
"email": "dmytrokirpa@microsoft.com",
"dependentChangeType": "patch"
}
19 changes: 19 additions & 0 deletions packages/react-components/react-button/library/etc/react-button.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
import type { ARIAButtonSlotProps } from '@fluentui/react-aria';
import type { ComponentProps } from '@fluentui/react-utilities';
import type { ComponentState } from '@fluentui/react-utilities';
import type { DistributiveOmit } from '@fluentui/react-utilities';
import { ForwardRefComponent } from '@fluentui/react-utilities';
import type { JSXElement } from '@fluentui/react-utilities';
import * as React_2 from 'react';
Expand All @@ -16,6 +17,12 @@ import type { SlotClassNames } from '@fluentui/react-utilities';
// @public
export const Button: ForwardRefComponent<ButtonProps>;

// @public (undocumented)
export type ButtonBaseProps = DistributiveOmit<ButtonProps, 'appearance' | 'size' | 'shape'>;

// @public (undocumented)
export type ButtonBaseState = DistributiveOmit<ButtonState, 'appearance' | 'size' | 'shape'>;

// @public (undocumented)
export const buttonClassNames: SlotClassNames<ButtonSlots>;

Expand Down Expand Up @@ -120,6 +127,12 @@ export type SplitButtonState = ComponentState<SplitButtonSlots> & Omit<ButtonSta
// @public
export const ToggleButton: ForwardRefComponent<ToggleButtonProps>;

// @public (undocumented)
export type ToggleButtonBaseProps = ButtonBaseProps & Pick<ToggleButtonProps, 'defaultChecked' | 'checked' | 'isAccessible'>;

// @public (undocumented)
export type ToggleButtonBaseState = ButtonBaseState & Required<Pick<ToggleButtonProps, 'checked' | 'isAccessible'>>;

// @public (undocumented)
export const toggleButtonClassNames: SlotClassNames<ButtonSlots>;

Expand All @@ -136,6 +149,9 @@ export type ToggleButtonState = ButtonState & Required<Pick<ToggleButtonProps, '
// @public
export const useButton_unstable: (props: ButtonProps, ref: React_2.Ref<HTMLButtonElement | HTMLAnchorElement>) => ButtonState;

// @public
export const useButtonBase_unstable: (props: ButtonBaseProps, ref?: React_2.Ref<HTMLButtonElement | HTMLAnchorElement>) => ButtonBaseState;

// @internal
export const useButtonContext: () => ButtonContextValue;

Expand Down Expand Up @@ -163,6 +179,9 @@ export const useSplitButtonStyles_unstable: (state: SplitButtonState) => SplitBu
// @public
export const useToggleButton_unstable: (props: ToggleButtonProps, ref: React_2.Ref<HTMLButtonElement | HTMLAnchorElement>) => ToggleButtonState;

// @public
export const useToggleButtonBase_unstable: (props: ToggleButtonProps, ref?: React_2.Ref<HTMLButtonElement | HTMLAnchorElement>) => ToggleButtonBaseState;

// @public (undocumented)
export const useToggleButtonStyles_unstable: (state: ToggleButtonState) => ToggleButtonState;

Expand Down
17 changes: 9 additions & 8 deletions packages/react-components/react-button/library/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ export {
renderButton_unstable,
useButtonStyles_unstable,
useButton_unstable,
useButtonBase_unstable,
} from './Button';
export type { ButtonProps, ButtonSlots, ButtonState } from './Button';
export type { ButtonProps, ButtonSlots, ButtonState, ButtonBaseProps, ButtonBaseState } from './Button';
export {
CompoundButton,
compoundButtonClassNames,
Expand Down Expand Up @@ -36,16 +37,16 @@ export {
toggleButtonClassNames,
useToggleButtonStyles_unstable,
useToggleButton_unstable,
useToggleButtonBase_unstable,
} from './ToggleButton';
export type {
ToggleButtonProps,
ToggleButtonState,
ToggleButtonBaseProps,
ToggleButtonBaseState,
} from './ToggleButton';
export type { ToggleButtonProps, ToggleButtonState } from './ToggleButton';

export { useToggleState } from './utils/index';

export { ButtonContextProvider, useButtonContext } from './contexts/index';
export type { ButtonContextValue } from './contexts/index';

// Experimental APIs - will be uncommented in the experimental release branch
// export { useButtonBase_unstable } from './Button';
// export type { ButtonBaseProps, ButtonBaseState } from './Button';
// export { useToggleButtonBase_unstable } from './ToggleButton';
// export type { ToggleButtonBaseProps, ToggleButtonBaseState } from './ToggleButton';
Loading