Skip to content

Instantly share code, notes, and snippets.

@ilkou
Created March 26, 2024 13:54
Show Gist options
  • Save ilkou/7bf2dbd42a7faf70053b43034fc4b5a4 to your computer and use it in GitHub Desktop.
Save ilkou/7bf2dbd42a7faf70053b43034fc4b5a4 to your computer and use it in GitHub Desktop.
react-select with shadcn/ui
/* ----------- simple-select.js ----------- */
import * as React from 'react';
import Select from 'react-select';
import type { Props } from 'react-select';
import { defaultClassNames, defaultStyles } from './helper';
import {
ClearIndicator,
DropdownIndicator,
MultiValueRemove,
Option
} from './components';
const SimpleSelect = React.forwardRef((props: Props, ref) => {
const {
value,
onChange,
options = [],
styles = defaultStyles,
classNames = defaultClassNames,
components = {},
...rest
} = props;
return (
<Select
ref={ref}
value={value}
onChange={onChange}
options={options}
unstyled
components={{
DropdownIndicator,
ClearIndicator,
MultiValueRemove,
Option,
...components
}}
styles={styles}
classNames={classNames}
{...rest}
/>
);
});
export default SimpleSelect;
/* ----------- helper.js ----------- */
import { cn } from 'lib/utils';
/**
* styles that aligns with shadcn/ui
*/
const controlStyles = {
base: 'flex !min-h-9 w-full rounded-md border border-input bg-transparent pl-3 py-1 pr-1 gap-1 text-sm shadow-sm transition-colors hover:cursor-pointer',
focus: 'outline-none ring-1 ring-ring',
disabled: 'cursor-not-allowed opacity-50'
};
const placeholderStyles = 'text-sm text-muted-foreground';
const valueContainerStyles = 'gap-1';
const multiValueStyles =
'inline-flex items-center gap-2 rounded-md border border-transparent bg-secondary text-secondary-foreground hover:bg-secondary/80 px-1.5 py-0.5 text-xs font-semibold transition-colors focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2';
const indicatorsContainerStyles = 'gap-1';
const clearIndicatorStyles = 'p-1 rounded-md';
const indicatorSeparatorStyles = 'bg-border';
const dropdownIndicatorStyles = 'p-1 rounded-md';
const menuStyles =
'p-1 mt-1 border bg-popover shadow-md rounded-md text-popover-foreground';
const groupHeadingStyles =
'py-2 px-1 text-secondary-foreground text-sm font-semibold';
const optionStyles = {
base: 'hover:cursor-pointer hover:bg-accent hover:text-accent-foreground px-2 py-1.5 rounded-sm !text-sm !cursor-default !select-none !outline-none font-sans',
focus: 'active:bg-accent/90 bg-accent text-accent-foreground',
disabled: 'pointer-events-none opacity-50',
selected: ''
};
const noOptionsMessageStyles =
'text-accent-foreground p-2 bg-accent border border-dashed border-border rounded-sm';
const loadingIndicatorStyles =
'flex items-center justify-center h-4 w-4 opacity-50';
const loadingMessageStyles = 'text-accent-foreground p-2 bg-accent';
/**
* This factory method is used to build custom classNames configuration
*/
export const createClassNames = (classNames) => {
return {
clearIndicator: (state) =>
cn(clearIndicatorStyles, classNames?.clearIndicator?.(state)),
container: (state) => cn(classNames?.container?.(state)),
control: (state) =>
cn(
controlStyles.base,
state.isDisabled && controlStyles.disabled,
state.isFocused && controlStyles.focus,
classNames?.control?.(state)
),
dropdownIndicator: (state) =>
cn(dropdownIndicatorStyles, classNames?.dropdownIndicator?.(state)),
group: (state) => cn(classNames?.group?.(state)),
groupHeading: (state) =>
cn(groupHeadingStyles, classNames?.groupHeading?.(state)),
indicatorsContainer: (state) =>
cn(indicatorsContainerStyles, classNames?.indicatorsContainer?.(state)),
indicatorSeparator: (state) =>
cn(indicatorSeparatorStyles, classNames?.indicatorSeparator?.(state)),
input: (state) => cn(classNames?.input?.(state)),
loadingIndicator: (state) =>
cn(loadingIndicatorStyles, classNames?.loadingIndicator?.(state)),
loadingMessage: (state) =>
cn(loadingMessageStyles, classNames?.loadingMessage?.(state)),
menu: (state) => cn(menuStyles, classNames?.menu?.(state)),
menuList: (state) => cn(classNames?.menuList?.(state)),
menuPortal: (state) => cn(classNames?.menuPortal?.(state)),
multiValue: (state) =>
cn(multiValueStyles, classNames?.multiValue?.(state)),
multiValueLabel: (state) => cn(classNames?.multiValueLabel?.(state)),
multiValueRemove: (state) => cn(classNames?.multiValueRemove?.(state)),
noOptionsMessage: (state) =>
cn(noOptionsMessageStyles, classNames?.noOptionsMessage?.(state)),
option: (state) =>
cn(
optionStyles.base,
state.isFocused && optionStyles.focus,
state.isDisabled && optionStyles.disabled,
state.isSelected && optionStyles.selected,
classNames?.option?.(state)
),
placeholder: (state) =>
cn(placeholderStyles, classNames?.placeholder?.(state)),
singleValue: (state) => cn(classNames?.singleValue?.(state)),
valueContainer: (state) =>
cn(valueContainerStyles, classNames?.valueContainer?.(state))
};
};
export const defaultClassNames = createClassNames({});
export const defaultStyles = {
input: (base) => ({
...base,
'input:focus': {
boxShadow: 'none'
}
}),
multiValueLabel: (base) => ({
...base,
whiteSpace: 'normal',
overflow: 'visible'
}),
control: (base) => ({
...base,
transition: 'none'
// minHeight: '2.25rem', // we used !min-h-9 instead
}),
menuList: (base) => ({
...base,
'::-webkit-scrollbar': {
background: 'transparent'
},
'::-webkit-scrollbar-track': {
background: 'transparent'
},
'::-webkit-scrollbar-thumb': {
background: 'hsl(var(--border))'
},
'::-webkit-scrollbar-thumb:hover': {
background: 'transparent'
}
})
};
/* ----------- components.jsx ----------- */
import * as React from 'react';
import type {
ClearIndicatorProps,
DropdownIndicatorProps,
MultiValueRemoveProps,
OptionProps
} from 'react-select';
import { components } from 'react-select';
import {
CaretSortIcon,
CheckIcon,
Cross2Icon as CloseIcon
} from '@radix-ui/react-icons';
export const DropdownIndicator = (props: DropdownIndicatorProps) => {
return (
<components.DropdownIndicator {...props}>
<CaretSortIcon className={'h-4 w-4 opacity-50'} />
</components.DropdownIndicator>
);
};
export const ClearIndicator = (props: ClearIndicatorProps) => {
return (
<components.ClearIndicator {...props}>
<CloseIcon className={'h-3.5 w-3.5 opacity-50'} />
</components.ClearIndicator>
);
};
export const MultiValueRemove = (props: MultiValueRemoveProps) => {
return (
<components.MultiValueRemove {...props}>
<CloseIcon className={'h-3 w-3 opacity-50'} />
</components.MultiValueRemove>
);
};
export const Option = (props: OptionProps) => {
return (
<components.Option {...props}>
<div className="flex items-center justify-between">
<div>{props.data.label}</div>
{props.isSelected && <CheckIcon />}
</div>
</components.Option>
);
};
/* ----------- async-select.jsx ----------- */
import * as React from 'react';
import Async from 'react-select/async';
import type { Props } from 'react-select/async';
import { defaultClassNames, defaultStyles } from './helper';
import {
ClearIndicator,
DropdownIndicator,
MultiValueRemove,
Option
} from './components';
const AsyncSelect = React.forwardRef((props: Props, ref) => {
const {
value,
onChange,
styles = defaultStyles,
classNames = defaultClassNames,
components = {},
...rest
} = props;
return (
<Async
ref={ref}
value={value}
onChange={onChange}
unstyled
components={{
DropdownIndicator,
ClearIndicator,
MultiValueRemove,
Option,
...components
}}
styles={styles}
classNames={classNames}
{...rest}
/>
);
});
export default AsyncSelect;
/* ----------- hooks.jsx ----------- */
/**
* This hook could be added to your select component if needed:
* const formatters = useFormatters()
* <Select
* // other props
* {...formatters}
* />
*/
export const useFormatters = () => {
// useful for CreatableSelect
const formatCreateLabel = (label) => (
<span className={'text-sm'}>
Add
<span className={'font-semibold'}>{` "${label}"`}</span>
</span>
);
// useful for GroupedOptions
const formatGroupLabel = (data) => (
<div className={'flex justify-between items-center'}>
<span>{data.label}</span>
<span
className={
'rounded-md text-xs font-normal text-secondary-foreground bg-secondary shadow-sm px-1'
}
>
{data.options.length}
</span>
</div>
);
return {
formatCreateLabel,
formatGroupLabel
};
};
@Nfinished
Copy link

Small react19 update to the default export based on to @fitimbytyqi's work (replacing deprecated React.LegacyRef with RefAttributes<T>['ref'])

export default React.forwardRef(BaseSelect) as <
  IsMulti extends boolean = false,
>(
  p: Props<OptionType, IsMulti> & {
    ref?: React.RefAttributes<
      SelectInstance<OptionType, IsMulti, GroupBase<OptionType>>
    >['ref']

    isMulti?: IsMulti
  },
) => ReactElement

@allohamora
Copy link

allohamora commented Feb 11, 2025

If you're looking for an implementation based on react-select, you can find it here:
shadcn-ui/ui#927 (comment)

@kirubz
Copy link

kirubz commented Aug 31, 2025

Any idea why mouse wheel scrolling is not working while using inside the Shadcn Sheet component?

@H7ioo
Copy link

H7ioo commented Aug 31, 2025

Any idea why mouse wheel scrolling is not working while using inside the Shadcn Sheet component?

Does it work outside the sheet?

@kirubz
Copy link

kirubz commented Sep 25, 2025

Any idea why mouse wheel scrolling is not working while using inside the Shadcn Sheet component?

Does it work outside the sheet?

Yes, it is working outside the sheet. While using in Sheet scrolling with mouse wheel is not working. we need to drag the scroller to scroll to the dropdown list

@H7ioo
Copy link

H7ioo commented Sep 25, 2025

@kirubz could you please reproduce?
It could be a modal issue try setting the modal to false

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment