Skip to content

feat(react-drawer): dialog slot to be only used by internal composition API #29279

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

Closed
marcosmoura wants to merge 2 commits into from
Closed

feat(react-drawer): dialog slot to be only used by internal composition API #29279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8af5416
feat(react-drawer): make dialog slot to be used for composition only
marcosmoura Sep 25, 2023
322eb4b
fix: change type
marcosmoura Sep 25, 2023
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-drawer-840c300d-046b-4ec7-b733-f88067df7dea.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "prerelease",
"comment": "feat: make dialog slot internal to be used for composition only",
"packageName": "@fluentui/react-drawer",
"email": "marcosvmmoura@gmail.com",
"dependentChangeType": "patch"

@ValentinaKozlova ValentinaKozlova Sep 29, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Don't forget to update in to feature

}
7 changes: 3 additions & 4 deletions packages/react-components/react-drawer/etc/react-drawer.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,19 +131,18 @@ export type DrawerInlineState = Required<ComponentState<DrawerInlineSlots> & Dra
export const DrawerOverlay: ForwardRefComponent<DrawerOverlayProps>;

// @public (undocumented)
export const drawerOverlayClassNames: Omit<SlotClassNames<DrawerOverlaySlots>, 'dialog'>;
export const drawerOverlayClassNames: SlotClassNames<DrawerOverlaySlots>;

// @public
export type DrawerOverlayProps = ComponentProps<DrawerOverlaySlots> & Pick<DialogProps, 'modalType' | 'onOpenChange' | 'inertTrapFocus' | 'defaultOpen'> & DrawerBaseProps;

// @public (undocumented)
// @public
export type DrawerOverlaySlots = DialogSurfaceSlots & {
root: Slot<DialogSurfaceProps>;
dialog?: Slot<DialogProps>;
};

// @public
export type DrawerOverlayState = Omit<ComponentState<DrawerOverlaySlots>, 'backdrop'> & Required<DrawerBaseState & {
export type DrawerOverlayState = Omit<ComponentState<DrawerOverlayInternalSlots>, 'backdrop'> & Required<DrawerBaseState & {
backdropMotion: MotionState<HTMLDivElement>;
}>;

Expand Down
15 changes: 13 additions & 2 deletions packages/react-components/react-drawer/src/components/DrawerOverlay/DrawerOverlay.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,24 @@ import type { MotionState } from '@fluentui/react-motion-preview';

import type { DrawerBaseProps, DrawerBaseState } from '../../shared/DrawerBase.types';

/**
* DrawerOverlay slots
*/
export type DrawerOverlaySlots = DialogSurfaceSlots & {
/**
* Slot for the root element.
*/
root: Slot<DialogSurfaceProps>;
};

/**
* DrawerOverlay internal slots for when using with composition API
*/
export type DrawerOverlayInternalSlots = DrawerOverlaySlots & {
/**
* Slot for the dialog component that wraps the drawer.
*/
dialog?: Slot<DialogProps>;
dialog: Slot<DialogProps>;
};

/**
Expand All @@ -23,7 +34,7 @@ export type DrawerOverlayProps = ComponentProps<DrawerOverlaySlots> &
/**
* State used in rendering DrawerOverlay
*/
export type DrawerOverlayState = Omit<ComponentState<DrawerOverlaySlots>, 'backdrop'> &
export type DrawerOverlayState = Omit<ComponentState<DrawerOverlayInternalSlots>, 'backdrop'> &
Required<
DrawerBaseState & {
backdropMotion: MotionState<HTMLDivElement>;
Expand Down
4 changes: 2 additions & 2 deletions packages/react-components/react-drawer/src/components/DrawerOverlay/renderDrawerOverlay.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/** @jsxImportSource @fluentui/react-jsx-runtime */
import { assertSlots } from '@fluentui/react-utilities';

import type { DrawerOverlayState, DrawerOverlaySlots } from './DrawerOverlay.types';
import type { DrawerOverlayState, DrawerOverlayInternalSlots } from './DrawerOverlay.types';

/**
* Render the final JSX of DrawerOverlay
Expand All @@ -12,7 +12,7 @@ export const renderDrawerOverlay_unstable = (state: DrawerOverlayState) => {
return null;
}

assertSlots<DrawerOverlaySlots>(state);
assertSlots<DrawerOverlayInternalSlots>(state);

return (
<state.dialog>
Expand Down
16 changes: 11 additions & 5 deletions packages/react-components/react-drawer/src/components/DrawerOverlay/useDrawerOverlay.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,17 +46,23 @@ export const useDrawerOverlay_unstable = (
},
);

const dialog = slot.optional(props.dialog, {
elementType: Dialog,
renderByDefault: true,
defaultProps: {
const dialog = slot.always(
{
open: true,
defaultOpen,
onOpenChange,
inertTrapFocus,
modalType,
/*
* children is not needed here because we construct the children in the render function,
* but it's required by DialogProps
*/
children: null as unknown as JSX.Element,
},
{
elementType: Dialog,
},
});
);

return {
components: {
Expand Down
2 changes: 1 addition & 1 deletion ...act-components/react-drawer/src/components/DrawerOverlay/useDrawerOverlayStyles.styles.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import {
useDrawerDurationStyles,
} from '../../shared/useDrawerBaseStyles.styles';

export const drawerOverlayClassNames: Omit<SlotClassNames<DrawerOverlaySlots>, 'dialog'> = {
export const drawerOverlayClassNames: SlotClassNames<DrawerOverlaySlots> = {
root: 'fui-DrawerOverlay',
backdrop: 'fui-DrawerOverlay__backdrop',
};
Expand Down