TypeScript
The library is written in TypeScript and ships its own declarations. No @types package is needed.
Generic values
WheelPicker, Select, SelectList, WheelPickerSheet and WheelPickerField infer T from items / options:
type Plan = 'free' | 'pro' | 'team';
const plans: SelectOption<Plan>[] = [
{ label: 'Free', value: 'free' },
{ label: 'Pro', value: 'pro' },
];
const [plan, setPlan] = useState<Plan | null>(null);
<Select options={plans} value={plan} onValueChange={setPlan} />; // onValueChange: (value: Plan, option: SelectOption<Plan>) => void
Or pass it explicitly: <WheelPicker<number> items={…} />.
Discriminated selection modes
mode narrows value and onValueChange:
<DatePicker value={date} onValueChange={(d) => d} /> // d: Date
<DatePicker mode="range" value={range} onValueChange={(r) => r} /> // r: DateRange
<DatePicker mode="multiple" value={dates} onValueChange={(ds) => ds} /> // ds: Date[]
<DatePicker mode="ranges" value={ranges} onValueChange={(rs) => rs} /> // rs: DateRange[]
<Select multiple options={o} value={tags} onValueChange={(values, options) => {}} /> // values: T[]
DatePickerSheet and DatePickerField narrow value and onConfirm the same way:
<DatePickerField mode="range" value={range} onConfirm={(r) => r} /> // r: DateRange
Passing a DateRange without mode="range" is a type error.
Exported types
import type {
// theme
Theme, DeepPartial, PatineProviderProps, ThemableProps, SlotStyles, Design, DesignPreference, Locale,
// wheel
WheelPickerProps, WheelItem, WheelItemInput, WheelPickerSlot, WheelRenderItemInfo,
MultiWheelPickerProps, WheelColumn, MultiWheelSlot,
// time / date
TimePickerProps, TimeRange, TimeRangePickerProps,
DatePickerProps, CalendarProps, CalendarBaseProps, CalendarSelectionProps, CalendarSlot,
DateRange, DateRangePreset, RangePresetsListProps, MarkedDate, DayState, DateWheelPickerProps, DatePart,
DateTimePickerProps, DateTimeCalendarProps, DateTimeDisplay, TimePosition,
WeekStripProps, DurationPickerProps, DurationLabels, MonthPickerProps, MonthPickerSlot, MonthDisplay,
// country, phone, time zone
CountryPickerProps, Country, CountryCode, CountryListOptions,
PhoneFieldProps, PhoneFieldSlot, ParsedPhone, PhoneDetails,
TimeZonePickerProps, TimeZone, TimeZoneListOptions,
// color
ColorPickerProps, ColorPickerSlot, ColorOption, ColorDisplay, ColorLabels,
// slider
SliderProps, SingleSliderProps, RangeSliderProps, SliderRange, SliderSlot, SliderMarkInput, SliderValueLabel,
// rating
RatingProps, RatingSlot, RatingIconInfo,
// otp
InputOTPProps, InputOTPSlot, OtpInputMode,
// select
SelectProps, SelectListProps, SelectListBaseProps, SelectValueProps,
SelectOption, SelectSlot, SelectTriggerSlot, SelectTriggerInfo, SelectRenderOptionInfo, SelectChevronInfo,
// horizontal list
ChoiceProps, ChoiceItem, ChoiceIconInfo, ChoiceIconPosition, ChoiceVariant,
ChoiceArrowPosition, ChoiceArrowSide,
ChoiceSlot, ChoiceRenderItemInfo,
// emoji
EmojiPickerProps, EmojiPickerSlot, Emoji, EmojiCategory, SkinTone,
// sheets
ActionSheetProps, ActionSheetAction, ActionSheetSlot, ActionSheetOptions, ActionSheetController,
DropdownMenuProps, DropdownMenuAction, DropdownMenuAlign, DropdownMenuPresentation, DropdownMenuSlot, DropdownMenuTriggerInfo,
BottomSheetProps, BottomSheetSlot, SheetChromeProps, SheetPresentation, SelectPresentation, PickerSheetProps,
DatePickerSheetProps, TimePickerSheetProps, TimeRangePickerSheetProps, DateTimePickerSheetProps, WheelPickerSheetProps, EmojiPickerSheetProps,
DurationPickerSheetProps, MonthPickerSheetProps, ColorPickerSheetProps,
// fields
PickerFieldProps, PickerFieldBaseProps, PickerFieldSlot, PickerFieldTriggerInfo, ChevronInfo, WithPickerField,
FieldPresentation, FieldError, FieldStatusProps,
DatePickerFieldProps, TimePickerFieldProps, TimeRangePickerFieldProps, DateTimePickerFieldProps, WheelPickerFieldProps, EmojiPickerFieldProps,
DurationPickerFieldProps, MonthPickerFieldProps, ColorPickerFieldProps,
} from 'patine-ui';
Wrapping components
Extend the prop types to build your own pre-configured pickers:
import { DatePicker } from 'patine-ui';
import type { CalendarBaseProps, DateRange } from 'patine-ui';
type StayPickerProps = Omit<CalendarBaseProps, 'minDate'> & {
value: DateRange;
onValueChange: (r: DateRange) => void;
};
export function StayPicker(props: StayPickerProps) {
return <DatePicker mode="range" minDate={new Date()} minRangeDays={1} {...props} />;
}