Skip to content

Commit 759bfcc

Browse files
committed
feat: renames Datepicker components to DatePicker
1 parent 28b5fa6 commit 759bfcc

28 files changed

+218
-218
lines changed

packages/datepickers/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,26 +14,26 @@ npm install react react-dom styled-components @zendeskgarden/react-theming
1414

1515
## Usage
1616

17-
The `<Datepicker>` component allows users to select a
17+
The `<DatePicker>` component allows users to select a
1818
date with a dropdown selection or a variety of localizable
19-
text formats. Internally, the `<Datepicker>` uses [date-fns](https://date-fns.org/)
19+
text formats. Internally, the `<DatePicker>` uses [date-fns](https://date-fns.org/)
2020
for it's date calculations and the [Intl.DateTimeFormat utility](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DateTimeFormat)
2121
for localization support.
2222

2323
```jsx
2424
import { ThemeProvider } from '@zendeskgarden/react-theming';
2525
import { Field, Label, Input } from '@zendeskgarden/react-forms';
26-
import { Datepicker } from '@zendeskgarden/react-datepickers';
26+
import { DatePicker } from '@zendeskgarden/react-datepickers';
2727

2828
/**
2929
* Place a `ThemeProvider` at the root of your React application
3030
*/
3131
<ThemeProvider>
3232
<Field>
3333
<Label>Example datepicker</Label>
34-
<Datepicker value={new Date()} onChange={selectedDate => console.log(selectedDate)}>
34+
<DatePicker value={new Date()} onChange={selectedDate => console.log(selectedDate)}>
3535
<Input />
36-
</Datepicker>
36+
</DatePicker>
3737
</Field>
3838
</ThemeProvider>;
3939
```

packages/datepickers/demo/datepicker.stories.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
import { Meta, ArgsTable, Canvas, Story, Markdown } from '@storybook/addon-docs';
22
import { useArgs } from '@storybook/client-api';
3-
import { Datepicker } from '@zendeskgarden/react-datepickers';
4-
import { DatepickerStory } from './stories/DatepickerStory';
3+
import { DatePicker } from '@zendeskgarden/react-datepickers';
4+
import { DatePickerStory } from './stories/DatePickerStory';
55
import { DATE_STYLE_OPTIONS } from './stories/data';
66
import README from '../README.md';
77

8-
<Meta title="Packages/Datepickers/Datepicker" component={Datepicker} />
8+
<Meta title="Packages/DatePickers/DatePicker" component={DatePicker} />
99

1010
# API
1111

@@ -15,7 +15,7 @@ import README from '../README.md';
1515

1616
<Canvas>
1717
<Story
18-
name="Datepicker"
18+
name="DatePicker"
1919
args={{ dateStyle: DATE_STYLE_OPTIONS[1], isAnimated: true }}
2020
argTypes={{
2121
value: { control: 'date' },
@@ -38,7 +38,7 @@ import README from '../README.md';
3838
{args => {
3939
const updateArgs = useArgs()[1];
4040
const handleChange = value => updateArgs({ value });
41-
return <DatepickerStory {...args} onChange={handleChange} />;
41+
return <DatePickerStory {...args} onChange={handleChange} />;
4242
}}
4343
</Story>
4444
</Canvas>

packages/datepickers/demo/datepickerRange.stories.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
import { Meta, ArgsTable, Canvas, Story, Markdown } from '@storybook/addon-docs';
22
import { useArgs } from '@storybook/client-api';
3-
import { DatepickerRange } from '@zendeskgarden/react-datepickers';
4-
import { DatepickerRangeStory } from './stories/DatepickerRangeStory';
3+
import { DatePickerRange } from '@zendeskgarden/react-datepickers';
4+
import { DatePickerRangeStory } from './stories/DatePickerRangeStory';
55
import { DATE_STYLE_OPTIONS } from './stories/data';
66
import README from '../README.md';
77

88
<Meta
9-
title="Packages/Datepickers/DatepickerRange"
10-
component={DatepickerRange}
9+
title="Packages/DatePickers/DatePickerRange"
10+
component={DatePickerRange}
1111
subcomponents={{
12-
'DatepickerRange.Calendar': DatepickerRange.Calendar,
13-
'DatepickerRange.End': DatepickerRange.End,
14-
'DatepickerRange.Start': DatepickerRange.Start
12+
'DatePickerRange.Calendar': DatePickerRange.Calendar,
13+
'DatePickerRange.End': DatePickerRange.End,
14+
'DatePickerRange.Start': DatePickerRange.Start
1515
}}
1616
/>
1717

@@ -23,7 +23,7 @@ import README from '../README.md';
2323

2424
<Canvas>
2525
<Story
26-
name="DatepickerRange"
26+
name="DatePickerRange"
2727
args={{ dateStyle: DATE_STYLE_OPTIONS[1] }}
2828
argTypes={{
2929
startValue: { control: 'date' },
@@ -47,7 +47,7 @@ import README from '../README.md';
4747
{args => {
4848
const updateArgs = useArgs()[1];
4949
const handleChange = ({ endValue, startValue }) => updateArgs({ endValue, startValue });
50-
return <DatepickerRangeStory {...args} onChange={handleChange} />;
50+
return <DatePickerRangeStory {...args} onChange={handleChange} />;
5151
}}
5252
</Story>
5353
</Canvas>

packages/datepickers/demo/stories/DatepickerRangeStory.tsx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,44 +9,44 @@ import React from 'react';
99
import { Story } from '@storybook/react';
1010
import { Col, Grid, Row } from '@zendeskgarden/react-grid';
1111
import { Field, Input, Label } from '@zendeskgarden/react-forms';
12-
import { DatepickerRange, IDatepickerRangeProps } from '@zendeskgarden/react-datepickers';
12+
import { DatePickerRange, IDatePickerRangeProps } from '@zendeskgarden/react-datepickers';
1313
import { DATE_STYLE } from './types';
1414

15-
interface IArgs extends IDatepickerRangeProps {
15+
interface IArgs extends IDatePickerRangeProps {
1616
dateStyle: DATE_STYLE;
1717
}
1818

19-
export const DatepickerRangeStory: Story<IArgs> = ({ dateStyle, isCompact, ...args }) => {
19+
export const DatePickerRangeStory: Story<IArgs> = ({ dateStyle, isCompact, ...args }) => {
2020
const formatDate = (date: Date) =>
2121
new Intl.DateTimeFormat(args.locale, { dateStyle }).format(date);
2222

2323
return (
24-
<DatepickerRange {...args} formatDate={formatDate} isCompact={isCompact}>
24+
<DatePickerRange {...args} formatDate={formatDate} isCompact={isCompact}>
2525
<Grid>
2626
<Row>
2727
<Col size="auto">
2828
<Field>
29-
<Label hidden>{(DatepickerRange.Start as any).displayName}</Label>
30-
<DatepickerRange.Start>
29+
<Label hidden>{(DatePickerRange.Start as any).displayName}</Label>
30+
<DatePickerRange.Start>
3131
<Input isCompact={isCompact} style={{ width: isCompact ? 224 : 280 }} />
32-
</DatepickerRange.Start>
32+
</DatePickerRange.Start>
3333
</Field>
3434
</Col>
3535
<Col size="auto">
3636
<Field>
37-
<Label hidden>{(DatepickerRange.End as any).displayName}</Label>
38-
<DatepickerRange.End>
37+
<Label hidden>{(DatePickerRange.End as any).displayName}</Label>
38+
<DatePickerRange.End>
3939
<Input isCompact={isCompact} style={{ width: isCompact ? 224 : 280 }} />
40-
</DatepickerRange.End>
40+
</DatePickerRange.End>
4141
</Field>
4242
</Col>
4343
</Row>
4444
<Row>
4545
<Col>
46-
<DatepickerRange.Calendar />
46+
<DatePickerRange.Calendar />
4747
</Col>
4848
</Row>
4949
</Grid>
50-
</DatepickerRange>
50+
</DatePickerRange>
5151
);
5252
};

packages/datepickers/demo/stories/DatepickerStory.tsx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ import React from 'react';
99
import { Story } from '@storybook/react';
1010
import { Col, Grid, Row } from '@zendeskgarden/react-grid';
1111
import { Field, Input, Label } from '@zendeskgarden/react-forms';
12-
import { Datepicker, IDatepickerProps } from '@zendeskgarden/react-datepickers';
12+
import { DatePicker, IDatePickerProps } from '@zendeskgarden/react-datepickers';
1313
import { DATE_STYLE } from './types';
1414

15-
interface IArgs extends IDatepickerProps {
15+
interface IArgs extends IDatePickerProps {
1616
dateStyle: DATE_STYLE;
1717
}
1818

19-
export const DatepickerStory: Story<IArgs> = ({ dateStyle, isCompact, ...args }) => {
19+
export const DatePickerStory: Story<IArgs> = ({ dateStyle, isCompact, ...args }) => {
2020
const formatDate = (date: Date) =>
2121
new Intl.DateTimeFormat(args.locale, { dateStyle }).format(date);
2222

@@ -25,10 +25,10 @@ export const DatepickerStory: Story<IArgs> = ({ dateStyle, isCompact, ...args })
2525
<Row style={{ height: 'calc(100vh - 80px)' }}>
2626
<Col textAlign="center" alignSelf="center">
2727
<Field>
28-
<Label hidden>{Datepicker.displayName}</Label>
29-
<Datepicker {...args} formatDate={formatDate} isCompact={isCompact}>
28+
<Label hidden>{DatePicker.displayName}</Label>
29+
<DatePicker {...args} formatDate={formatDate} isCompact={isCompact}>
3030
<Input isCompact={isCompact} style={{ width: isCompact ? 256 : 320 }} />
31-
</Datepicker>
31+
</DatePicker>
3232
</Field>
3333
</Col>
3434
</Row>

packages/datepickers/src/elements/Datepicker/Datepicker.spec.tsx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,25 @@ import { addDays } from 'date-fns/addDays';
1212
import { subDays } from 'date-fns/subDays';
1313
import mockDate from 'mockdate';
1414
import { KEYS } from '@zendeskgarden/container-utilities';
15-
import { Datepicker } from './Datepicker';
16-
import { IDatepickerProps } from '../../types';
15+
import { DatePicker } from './DatePicker';
16+
import { IDatePickerProps } from '../../types';
1717

1818
const DEFAULT_DATE = new Date(2019, 1, 5);
1919

20-
const Example = (props: Omit<IDatepickerProps, 'children'>) => (
20+
const Example = (props: Omit<IDatePickerProps, 'children'>) => (
2121
<>
2222
<label data-test-id="label" htmlFor="input">
2323
Label
2424
</label>
25-
<Datepicker {...props}>
25+
<DatePicker {...props}>
2626
<input data-test-id="input" id="input" />
27-
</Datepicker>
27+
</DatePicker>
2828
</>
2929
);
3030

3131
jest.useFakeTimers();
3232

33-
describe('Datepicker', () => {
33+
describe('DatePicker', () => {
3434
const user = userEvent.setup({ delay: null });
3535

3636
let onChangeSpy: (date: Date) => void;

packages/datepickers/src/elements/Datepicker/Datepicker.tsx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ import PropTypes from 'prop-types';
1919
import { mergeRefs } from 'react-merge-refs';
2020
import { ThemeContext } from 'styled-components';
2121
import { autoPlacement, autoUpdate, flip, useFloating } from '@floating-ui/react-dom';
22-
import { IDatepickerProps, PLACEMENT, WEEK_STARTS_ON } from '../../types';
22+
import { IDatePickerProps, PLACEMENT, WEEK_STARTS_ON } from '../../types';
2323
import { Calendar } from './components/Calendar';
2424
import { datepickerReducer, retrieveInitialState } from './utils/datepicker-reducer';
25-
import { DatepickerContext } from './utils/useDatepickerContext';
25+
import { DatePickerContext } from './utils/useDatePickerContext';
2626
import { StyledMenu, StyledMenuWrapper } from '../../styled';
2727
import { DEFAULT_THEME, getFloatingPlacements } from '@zendeskgarden/react-theming';
2828
import { Input } from './components/Input';
@@ -32,7 +32,7 @@ const PLACEMENT_DEFAULT = 'bottom-start';
3232
/**
3333
* @extends HTMLAttributes<HTMLDivElement>
3434
*/
35-
export const Datepicker = forwardRef<HTMLDivElement, IDatepickerProps>((props, calendarRef) => {
35+
export const DatePicker = forwardRef<HTMLDivElement, IDatePickerProps>((props, calendarRef) => {
3636
const {
3737
children,
3838
placement: _placement,
@@ -129,7 +129,7 @@ export const Datepicker = forwardRef<HTMLDivElement, IDatepickerProps>((props, c
129129
refKey={refKey!}
130130
ref={mergeRefs([triggerRef, Child.ref ? Child.ref : null])}
131131
/>
132-
<DatepickerContext.Provider value={contextValue}>
132+
<DatePickerContext.Provider value={contextValue}>
133133
<StyledMenuWrapper
134134
ref={floatingRef}
135135
style={{ transform }}
@@ -155,14 +155,14 @@ export const Datepicker = forwardRef<HTMLDivElement, IDatepickerProps>((props, c
155155
</StyledMenu>
156156
)}
157157
</StyledMenuWrapper>
158-
</DatepickerContext.Provider>
158+
</DatePickerContext.Provider>
159159
</>
160160
);
161161
});
162162

163-
Datepicker.displayName = 'Datepicker';
163+
DatePicker.displayName = 'DatePicker';
164164

165-
Datepicker.propTypes = {
165+
DatePicker.propTypes = {
166166
value: PropTypes.any,
167167
onChange: PropTypes.any,
168168
formatDate: PropTypes.func,
@@ -178,7 +178,7 @@ Datepicker.propTypes = {
178178
zIndex: PropTypes.number
179179
};
180180

181-
Datepicker.defaultProps = {
181+
DatePicker.defaultProps = {
182182
placement: PLACEMENT_DEFAULT,
183183
refKey: 'ref',
184184
isAnimated: true,

packages/datepickers/src/elements/Datepicker/components/Calendar.tsx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ import { isBefore } from 'date-fns/isBefore';
1919
import { isAfter } from 'date-fns/isAfter';
2020
import { getDate } from 'date-fns/getDate';
2121
import {
22-
StyledDatepicker,
22+
StyledDatePicker,
2323
StyledCalendar,
2424
StyledCalendarItem,
2525
StyledDayLabel,
2626
StyledDay
2727
} from '../../../styled';
28-
import useDatepickerContext from '../utils/useDatepickerContext';
28+
import useDatePickerContext from '../utils/useDatePickerContext';
2929
import { DateFnsIndex, getStartOfWeek } from '../../../utils/calendar-utils';
3030
import { MonthSelector } from './MonthSelector';
3131

@@ -40,7 +40,7 @@ interface ICalendarProps extends HTMLAttributes<HTMLDivElement> {
4040

4141
export const Calendar = forwardRef<HTMLDivElement, ICalendarProps>(
4242
({ value, minValue, maxValue, isCompact, locale, weekStartsOn }, ref) => {
43-
const { state, dispatch } = useDatepickerContext();
43+
const { state, dispatch } = useDatePickerContext();
4444

4545
const preferredWeekStartsOn = weekStartsOn || getStartOfWeek(locale);
4646
const monthStartDate = startOfMonth(state.previewDate);
@@ -119,7 +119,7 @@ export const Calendar = forwardRef<HTMLDivElement, ICalendarProps>(
119119
});
120120

121121
return (
122-
<StyledDatepicker
122+
<StyledDatePicker
123123
ref={ref}
124124
isCompact={isCompact!}
125125
data-test-id="calendar-wrapper"
@@ -133,7 +133,7 @@ export const Calendar = forwardRef<HTMLDivElement, ICalendarProps>(
133133
{dayLabels}
134134
{items}
135135
</StyledCalendar>
136-
</StyledDatepicker>
136+
</StyledDatePicker>
137137
);
138138
}
139139
);

packages/datepickers/src/elements/Datepicker/components/Input.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77

88
import { Dispatch, ReactElement, RefAttributes, cloneElement, forwardRef, useRef } from 'react';
99
import { KEYS, composeEventHandlers } from '@zendeskgarden/container-utilities';
10-
import { DatepickerAction, IDatepickerState } from '../utils/datepicker-reducer';
10+
import { DatePickerAction, IDatePickerState } from '../utils/datepicker-reducer';
1111

1212
interface IInputProps {
13-
dispatch: Dispatch<DatepickerAction>;
13+
dispatch: Dispatch<DatePickerAction>;
1414
element: ReactElement & RefAttributes<HTMLInputElement>;
1515
refKey: string;
16-
state: IDatepickerState;
16+
state: IDatePickerState;
1717
}
1818

1919
export const Input = forwardRef<HTMLInputElement, IInputProps>(

packages/datepickers/src/elements/Datepicker/components/MonthSelector.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
import React, { useCallback } from 'react';
99
import { StyledHeader, StyledHeaderPaddle, StyledHeaderLabel } from '../../../styled';
10-
import useDatepickerContext from '../utils/useDatepickerContext';
10+
import useDatePickerContext from '../utils/useDatePickerContext';
1111

1212
import ChevronLeftStrokeIcon from '@zendeskgarden/svg-icons/src/16/chevron-left-stroke.svg';
1313
import ChevronRightStrokeIcon from '@zendeskgarden/svg-icons/src/16/chevron-right-stroke.svg';
@@ -21,7 +21,7 @@ export const MonthSelector: React.FunctionComponent<IMonthSelectorProps> = ({
2121
locale,
2222
isCompact
2323
}) => {
24-
const { state, dispatch } = useDatepickerContext();
24+
const { state, dispatch } = useDatePickerContext();
2525

2626
const headerLabelFormatter = useCallback<(date: Date) => string>(
2727
date => {

0 commit comments

Comments
 (0)