Skip to content

feat(Dialog) add className prop #5115

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
merged 4 commits into from
Oct 15, 2024
Merged

feat(Dialog) add className prop #5115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a5302ab
add className prop to Dialog component
randall-krauskopf Oct 11, 2024
d7dab22
add changeset and remove accidental classname
randall-krauskopf Oct 11, 2024
c7f85a8
add prop to docs.json
randall-krauskopf Oct 15, 2024
beb092d
Merge branch 'main' into dialog-class-name
randall-krauskopf Oct 15, 2024
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
5 changes: 5 additions & 0 deletions .changeset/thin-keys-move.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/react': minor
---

Add 'className' prop to `Dialog` component
8 changes: 7 additions & 1 deletion packages/react/src/Dialog/Dialog.docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,13 @@
"name": "initialFocusRef",
"type": "React.RefObject<HTMLElement>",
"description": "Focus this element when the Dialog opens"
},
{
"name": "className",
"type": "string | undefined",
"defaultValue": "",
"description": "CSS string"
}
],
"subcomponents": []
}
}
7 changes: 7 additions & 0 deletions packages/react/src/Dialog/Dialog.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,11 @@ export interface DialogProps extends SxProp {
* The element to focus when the Dialog opens
*/
initialFocusRef?: React.RefObject<HTMLElement>

/**
* Additional class names to apply to the dialog
*/
className?: string
}

/**
Expand Down Expand Up @@ -409,6 +414,7 @@ const _Dialog = React.forwardRef<HTMLDivElement, React.PropsWithChildren<DialogP
returnFocusRef,
initialFocusRef,
sx,
className,
} = props
const dialogLabelId = useId()
const dialogDescriptionId = useId()
Expand Down Expand Up @@ -497,6 +503,7 @@ const _Dialog = React.forwardRef<HTMLDivElement, React.PropsWithChildren<DialogP
aria-modal
{...positionDataAttributes}
sx={sx}
className={className}
>
{header}
<ScrollableRegion aria-labelledby={dialogLabelId} className="DialogOverflowWrapper">
Expand Down
Loading