Skip to content

Add className prop to FormControl#4824

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
joshblack merged 2 commits into from
Aug 7, 2024
Merged

Add className prop to FormControl#4824

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
dfed9f9
Add `className` prop to `FormControl`
iansan5653 Aug 7, 2024
f5d6fce
Changeset
iansan5653 Aug 7, 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/tall-wasps-end.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@primer/react': minor
---

Adds new `className` prop to `FormControl` component
12 changes: 10 additions & 2 deletions packages/react/src/FormControl/FormControl.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,10 +38,11 @@ export type FormControlProps = {
* Vertical layout is used by default, and horizontal layout is used for checkbox and radio inputs.
*/
layout?: 'horizontal' | 'vertical'
className?: string
} & SxProp

const FormControl = React.forwardRef<HTMLDivElement, FormControlProps>(
({children, disabled: disabledProp, layout = 'vertical', id: idProp, required, sx}, ref) => {
({children, disabled: disabledProp, layout = 'vertical', id: idProp, required, sx, className}, ref) => {
const [slots, childrenWithoutSlots] = useSlots(children, {
caption: FormControlCaption,
label: FormControlLabel,
Expand DownExpand Up@@ -124,7 +125,13 @@ const FormControl = React.forwardRef<HTMLDivElement, FormControlProps>(
}}
>
{isChoiceInput || layout === 'horizontal' ? (
<Box ref={ref} display="flex" alignItems={slots.leadingVisual ? 'center' : undefined} sx={sx}>
<Box
ref={ref}
display="flex"
alignItems={slots.leadingVisual ? 'center' : undefined}
sx={sx}
className={className}
>
<Box sx={{'> input': {marginLeft: 0, marginRight: 0}}}>
{React.isValidElement(InputComponent) &&
React.cloneElement(
Expand DownExpand Up@@ -179,6 +186,7 @@ const FormControl = React.forwardRef<HTMLDivElement, FormControlProps>(
flexDirection="column"
alignItems="flex-start"
sx={{...(isLabelHidden ? {'> *:not(label) + *': {marginTop: 1}} : {'> * + *': {marginTop: 1}}), ...sx}}
className={className}
>
{slots.label}
{React.isValidElement(InputComponent) &&
Expand Down