Skip to content

[STRIPES-971] Add missing timepicker props #82

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
ncovercash merged 2 commits into from
Mar 25, 2025
Merged

[STRIPES-971] Add missing timepicker props #82

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
19d7fcb
[STRIPES-971] Add missing timepicker props
ncovercash Mar 25, 2025
09f59a2
.
ncovercash Mar 25, 2025
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
11 changes: 9 additions & 2 deletions components/lib/Timepicker/Timepicker.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
import { AriaAttributes, ComponentType, ReactNode, Ref } from 'react';
import { IntlShape } from 'react-intl';
import { PopperModifiers, PopperPlacement } from '../Popper';
import { TextFieldProps } from '../TextField';

export interface TimepickerProps extends AriaAttributes {
export interface TimepickerProps
extends AriaAttributes,
Omit<TextFieldProps<string>, 'inputRef' | 'onChange'> {
Copy link
Member Author

@ncovercash ncovercash Mar 25, 2025

Choose a reason for hiding this comment

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

inputRef and onChange conflict with our definitions below (and we yank them out of what gets spread to TextField), so we don't want to include those here

Copy link
Member

@zburke zburke Mar 25, 2025

Choose a reason for hiding this comment

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

This is helpful commentary, @ncovercash . Maybe it belongs as a comment in the source rather than just a comment on the PR?

/** If the field should auto-focus on mount */
autoFocus?: boolean;
/** Disables the input field */
Expand All @@ -20,7 +23,9 @@ export interface TimepickerProps extends AriaAttributes {
/** Popper modifiers */
modifiers?: PopperModifiers;
/** Fired anytime internal state changes */
onChange?: (e: Event, standardizedTime?: string) => void;
onChange?: (e: Event, standardizedTime: string, inputValue: string) => void;
/** If the user-visible (formatted) output should be passed on change events, or the standard HH:MM:00Z */
outputBackendValue?: boolean;
/** Format a UTC value into the specified timezone */
outputFormatter?: (props: {
value: string | undefined;
Expand All @@ -47,6 +52,8 @@ export interface TimepickerProps extends AriaAttributes {
showTimepicker?: boolean;
/** Override the default timezone */
timeZone?: string;
/** Outputs values to onChange as seen directly in the input box */
useInput?: boolean;
/** Render to the global overlay, if the dropdown may be cut off due to some containing elements's overflow */
usePortal?: boolean;
/** The field's value */
Expand Down
Loading