Skip to content

Commit 489c100

Browse files
cee-chencee-chen
committed
[PR feedback] naming: final_FINAL_v4.docx
1 parent 64b0fab commit 489c100

8 files changed

Lines changed: 23 additions & 23 deletions

File tree

‎changelogs/upcoming/7502.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
- Updated `EuiSuperDatePicker` with a new `preferLargerRelativeUnits` prop, which defaults to true (current behavior). To preserve displaying the unit that users select, set this to false.
1+
- Updated `EuiSuperDatePicker` with a new `canRoundRelativeUnits` prop, which defaults to true (current behavior). To preserve displaying the unit that users select for relative time, set this to false.

‎src-docs/src/views/super_date_picker/playground.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ export const superDatePickerConfig = () => {
3232
value: true,
3333
};
3434

35-
propsToUse.preferLargerRelativeUnits = {
36-
...propsToUse.preferLargerRelativeUnits,
35+
propsToUse.canRoundRelativeUnits = {
36+
...propsToUse.canRoundRelativeUnits,
3737
type: PropTypes.Boolean,
3838
defaultValue: true,
3939
value: true,

‎src/components/date_picker/super_date_picker/date_popover/date_popover_button.tsx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export interface EuiDatePopoverButtonProps {
3838
onPopoverClose: EuiPopoverProps['closePopover'];
3939
onPopoverToggle: MouseEventHandler<HTMLButtonElement>;
4040
position: 'start' | 'end';
41-
preferLargerRelativeUnits?: boolean;
41+
canRoundRelativeUnits?: boolean;
4242
roundUp?: boolean;
4343
timeFormat: string;
4444
value: string;
@@ -57,7 +57,7 @@ export const EuiDatePopoverButton: FunctionComponent<
5757
needsUpdating,
5858
value,
5959
buttonProps,
60-
preferLargerRelativeUnits,
60+
canRoundRelativeUnits,
6161
roundUp,
6262
onChange,
6363
locale,
@@ -87,7 +87,7 @@ export const EuiDatePopoverButton: FunctionComponent<
8787
const formattedValue = useFormatTimeString(value, dateFormat, {
8888
roundUp,
8989
locale,
90-
preferLargerRelativeUnits,
90+
canRoundRelativeUnits,
9191
});
9292
let title = formattedValue;
9393

@@ -134,7 +134,7 @@ export const EuiDatePopoverButton: FunctionComponent<
134134
<EuiDatePopoverContent
135135
value={value}
136136
roundUp={roundUp}
137-
preferLargerRelativeUnits={preferLargerRelativeUnits}
137+
canRoundRelativeUnits={canRoundRelativeUnits}
138138
onChange={onChange}
139139
dateFormat={dateFormat}
140140
timeFormat={timeFormat}

‎src/components/date_picker/super_date_picker/date_popover/date_popover_content.tsx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import { LocaleSpecifier } from 'moment'; // eslint-disable-line import/named
2828
export interface EuiDatePopoverContentProps {
2929
value: string;
3030
onChange: (date: string) => void;
31-
preferLargerRelativeUnits?: boolean;
31+
canRoundRelativeUnits?: boolean;
3232
roundUp?: boolean;
3333
dateFormat: string;
3434
timeFormat: string;
@@ -42,7 +42,7 @@ export const EuiDatePopoverContent: FunctionComponent<
4242
EuiDatePopoverContentProps
4343
> = ({
4444
value,
45-
preferLargerRelativeUnits = true,
45+
canRoundRelativeUnits = true,
4646
roundUp = false,
4747
onChange,
4848
dateFormat,
@@ -111,7 +111,7 @@ export const EuiDatePopoverContent: FunctionComponent<
111111
dateFormat={dateFormat}
112112
locale={locale}
113113
value={
114-
preferLargerRelativeUnits ? toAbsoluteString(value, roundUp) : value
114+
canRoundRelativeUnits ? toAbsoluteString(value, roundUp) : value
115115
}
116116
onChange={onChange}
117117
roundUp={roundUp}

‎src/components/date_picker/super_date_picker/pretty_duration.test.tsx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,8 +154,8 @@ describe('useFormatTimeString', () => {
154154
).toBe('~ 15分後');
155155
});
156156

157-
describe('preferLargerRelativeUnits', () => {
158-
const option = { preferLargerRelativeUnits: false };
157+
describe('canRoundRelativeUnits', () => {
158+
const option = { canRoundRelativeUnits: false };
159159

160160
it("allows skipping moment.fromNow()'s default rounding", () => {
161161
expect(

‎src/components/date_picker/super_date_picker/pretty_duration.tsx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -149,13 +149,13 @@ export const useFormatTimeString = (
149149
options?: {
150150
locale?: LocaleSpecifier;
151151
roundUp?: boolean;
152-
preferLargerRelativeUnits?: boolean;
152+
canRoundRelativeUnits?: boolean;
153153
}
154154
): string => {
155155
const {
156156
locale = 'en',
157157
roundUp = false,
158-
preferLargerRelativeUnits = true,
158+
canRoundRelativeUnits = true,
159159
} = options || {};
160160

161161
// i18n'd strings
@@ -180,7 +180,7 @@ export const useFormatTimeString = (
180180
}
181181

182182
if (moment.isMoment(tryParse)) {
183-
if (preferLargerRelativeUnits) {
183+
if (canRoundRelativeUnits) {
184184
return `~ ${tryParse.locale(locale).fromNow()}`;
185185
} else {
186186
// To force a specific unit to be used, we need to skip moment.fromNow()

‎src/components/date_picker/super_date_picker/super_date_picker.test.tsx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ describe('EuiSuperDatePicker', () => {
320320
});
321321
});
322322

323-
describe('preferLargerRelativeUnits', () => {
323+
describe('canRoundRelativeUnits', () => {
324324
const props = {
325325
onTimeChange: noop,
326326
start: 'now-300m',
@@ -329,7 +329,7 @@ describe('EuiSuperDatePicker', () => {
329329

330330
it('defaults to true, which will round relative units up to the next largest unit', () => {
331331
const { getByTestSubject } = render(
332-
<EuiSuperDatePicker {...props} preferLargerRelativeUnits={true} />
332+
<EuiSuperDatePicker {...props} canRoundRelativeUnits={true} />
333333
);
334334
fireEvent.click(getByTestSubject('superDatePickerShowDatesButton'));
335335

@@ -355,7 +355,7 @@ describe('EuiSuperDatePicker', () => {
355355

356356
it('when false, allows preserving the unit set in the start/end time timestamp', () => {
357357
const { getByTestSubject } = render(
358-
<EuiSuperDatePicker {...props} preferLargerRelativeUnits={false} />
358+
<EuiSuperDatePicker {...props} canRoundRelativeUnits={false} />
359359
);
360360
fireEvent.click(getByTestSubject('superDatePickerShowDatesButton'));
361361

‎src/components/date_picker/super_date_picker/super_date_picker.tsx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ export type EuiSuperDatePickerProps = CommonProps & {
187187
* If you do not want this behavior and instead wish to keep the exact units
188188
* input by the user, set this flag to `false`.
189189
*/
190-
preferLargerRelativeUnits?: boolean;
190+
canRoundRelativeUnits?: boolean;
191191
};
192192

193193
type EuiSuperDatePickerInternalProps = EuiSuperDatePickerProps & {
@@ -250,7 +250,7 @@ export class EuiSuperDatePickerInternal extends Component<
250250
recentlyUsedRanges: [],
251251
refreshInterval: 1000,
252252
showUpdateButton: true,
253-
preferLargerRelativeUnits: true,
253+
canRoundRelativeUnits: true,
254254
start: 'now-15m',
255255
timeFormat: 'HH:mm',
256256
width: 'restricted',
@@ -478,7 +478,7 @@ export class EuiSuperDatePickerInternal extends Component<
478478
isQuickSelectOnly,
479479
showUpdateButton,
480480
commonlyUsedRanges,
481-
preferLargerRelativeUnits,
481+
canRoundRelativeUnits,
482482
timeOptions,
483483
dateFormat,
484484
refreshInterval,
@@ -573,7 +573,7 @@ export class EuiSuperDatePickerInternal extends Component<
573573
utcOffset={utcOffset}
574574
timeFormat={timeFormat}
575575
locale={locale || contextLocale}
576-
preferLargerRelativeUnits={preferLargerRelativeUnits}
576+
canRoundRelativeUnits={canRoundRelativeUnits}
577577
isOpen={this.state.isStartDatePopoverOpen}
578578
onPopoverToggle={this.onStartDatePopoverToggle}
579579
onPopoverClose={this.onStartDatePopoverClose}
@@ -594,7 +594,7 @@ export class EuiSuperDatePickerInternal extends Component<
594594
utcOffset={utcOffset}
595595
timeFormat={timeFormat}
596596
locale={locale || contextLocale}
597-
preferLargerRelativeUnits={preferLargerRelativeUnits}
597+
canRoundRelativeUnits={canRoundRelativeUnits}
598598
roundUp
599599
isOpen={this.state.isEndDatePopoverOpen}
600600
onPopoverToggle={this.onEndDatePopoverToggle}

0 commit comments

Comments
 (0)