Skip to content
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

Fix: Datepicker: Unable to enter date manually #3036

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix: Datepicker: Unable to enter date manually #3036

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
124 changes: 124 additions & 0 deletions components/date-picker/__tests__/date-picker.browser-test.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,6 +431,130 @@ describe('SLDSDatepicker', function describeFunction() {
input.simulate('change', { target: { value: '1/1/2020' } });
expect(wrapper.find('.slds-datepicker').length).to.equal(0);
});

it('typing partial date resets after pressing enter', function () {
const handleChangeSpy = sinon.spy();
wrapper = mount(
<DemoComponent menuPosition="relative" onChange={handleChangeSpy} />
);

// Calendar is closed
expect(wrapper.find('.slds-datepicker').length).to.equal(0);

// Click on input to open the calendar
const trigger = wrapper.find(triggerClassSelector);
trigger.simulate('click', {});
expect(wrapper.find('.slds-datepicker').length).to.equal(1);

// Changing input value closes the calendar
const input = wrapper.find('input#sample-datepicker');

input.simulate('change', { target: { value: '' } });
input.simulate('click', {});
input.simulate('keyDown', { key: '9', keyCode: 49, which: 49 });
input.simulate('keyDown', { key: '/', keyCode: 191, which: 191 });
input.simulate('change', { target: { value: '9/' } });
expect(input.instance().value).to.equal('9/');
input.simulate('keyDown', {
key: 'Enter',
keyCode: KEYS.ENTER,
which: KEYS.ENTER,
});
expect(input.instance().value).to.equal('1/6/2007');
expect(handleChangeSpy.calledOnce).to.equal(true);
});

it('typing partial date resets after pressing escape', function () {
const handleChangeSpy = sinon.spy();
wrapper = mount(
<DemoComponent menuPosition="relative" onChange={handleChangeSpy} />
);

// Calendar is closed
expect(wrapper.find('.slds-datepicker').length).to.equal(0);

// Click on input to open the calendar
const trigger = wrapper.find(triggerClassSelector);
trigger.simulate('click', {});
expect(wrapper.find('.slds-datepicker').length).to.equal(1);

// Changing input value closes the calendar
const input = wrapper.find('input#sample-datepicker');

input.simulate('change', { target: { value: '' } });
input.simulate('click', {});
input.simulate('keyDown', { key: '9', keyCode: 49, which: 49 });
input.simulate('keyDown', { key: '/', keyCode: 191, which: 191 });
input.simulate('change', { target: { value: '9/' } });
input.simulate('change', { target: { value: '9/' } });
expect(input.instance().value).to.equal('9/');
input.simulate('keyDown', {
key: 'Escape',
keyCode: KEYS.ESCAPE,
which: KEYS.ESCAPE,
});
expect(input.instance().value).to.equal('1/6/2007');
expect(handleChangeSpy.calledOnce).to.equal(false);
});

it('typing complete date resets after pressing escape', function () {
const handleChangeSpy = sinon.spy();
wrapper = mount(
<DemoComponent menuPosition="relative" onChange={handleChangeSpy} />
);

// Calendar is closed
expect(wrapper.find('.slds-datepicker').length).to.equal(0);

// Click on input to open the calendar
const trigger = wrapper.find(triggerClassSelector);
trigger.simulate('click', {});
expect(wrapper.find('.slds-datepicker').length).to.equal(1);

// Changing input value closes the calendar
const input = wrapper.find('input#sample-datepicker');

input.simulate('change', { target: { value: '' } });
input.simulate('click', {});
input.simulate('change', { target: { value: '12/31/2007' } });
expect(input.instance().value).to.equal('12/31/2007');
input.simulate('keyDown', {
key: 'Escape',
keyCode: KEYS.ESCAPE,
which: KEYS.ESCAPE,
});
expect(input.instance().value).to.equal('1/6/2007');
expect(handleChangeSpy.calledOnce).to.equal(false);
});

it('typing complete date saves after pressing enter', function () {
const handleChangeSpy = sinon.spy();
wrapper = mount(
<DemoComponent menuPosition="relative" onChange={handleChangeSpy} />
);

// Calendar is closed
expect(wrapper.find('.slds-datepicker').length).to.equal(0);

// Click on input to open the calendar
const trigger = wrapper.find(triggerClassSelector);
trigger.simulate('click', {});
expect(wrapper.find('.slds-datepicker').length).to.equal(1);

// Changing input value closes the calendar
const input = wrapper.find('input#sample-datepicker');

input.simulate('change', { target: { value: '' } });
input.simulate('click', {});
input.simulate('change', { target: { value: '12/31/2007' } });
expect(input.instance().value).to.equal('12/31/2007');
input.simulate('keyDown', {
key: 'Enter',
keyCode: KEYS.ENTER,
which: KEYS.ENTER,
});
expect(handleChangeSpy.calledOnce).to.equal(true);
});
});
});

Expand Down
69 changes: 44 additions & 25 deletions components/date-picker/date-picker.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,17 +260,9 @@ const defaultProps = {
class Datepicker extends React.Component {
constructor(props) {
super(props);
// Please remove `strValue` on the next breaking change.
const formattedValue = props.formattedValue || props.strValue; // eslint-disable-line react/prop-types
const dateString = props.formatter(props.value);
const initDate = props.value ? dateString : formattedValue;

this.state = {
isOpen: false,
isOpenFromIcon: false,
value: props.value,
formattedValue: initDate || '',
inputValue: initDate || '',
};

this.generatedId = shortid.generate();
Expand All @@ -279,6 +271,22 @@ class Datepicker extends React.Component {
checkProps(DATE_PICKER, props, componentDoc);
}

static getDerivedStateFromProps(props, state) {
if (props.value !== state.value) {
const formattedValue = props.formattedValue || props.strValue; // eslint-disable-line react/prop-types
const dateString = props.formatter(props.value);
const initDate = props.value ? dateString : formattedValue;
return {
isOpen: false,
isOpenFromIcon: false,
value: props.value,
formattedValue: initDate || '',
inputValue: initDate || '',
};
}
return state;
}

getDatePicker = ({ labels, assistiveText }) => {
let date;
// Use props if present. Otherwise, use state.
Expand Down Expand Up @@ -416,9 +424,7 @@ class Datepicker extends React.Component {
this.openDialog();
},
onKeyDown: this.handleKeyDown,
value: this.props.value
? this.props.formatter(this.props.value)
: this.state.inputValue,
value: this.state.inputValue,
};

// eslint-disable react/prop-types
Expand Down Expand Up @@ -512,16 +518,6 @@ class Datepicker extends React.Component {
formattedValue: event.target.value,
inputValue: event.target.value,
});

const date = this.props.parser(event.target.value);

if (this.props.onChange) {
this.props.onChange(event, {
date,
formattedDate: event.target.value,
timezoneOffset: date.getTimezoneOffset(),
});
}
};

handleKeyDown = (event) => {
Expand All @@ -535,9 +531,31 @@ class Datepicker extends React.Component {
this.setState({ isOpen: true });
}

if (event.keyCode === KEYS.ESCAPE || event.keyCode === KEYS.ENTER) {
if (event.keyCode === KEYS.ESCAPE) {
EventUtil.trapEvent(event);
this.setState({ isOpen: false });
this.setState(Datepicker.getDerivedStateFromProps(this.props, {}));
}

if (event.keyCode === KEYS.ENTER || event.keyCode === KEYS.TAB) {
const date = this.props.parser(event.target.value);
const formattedDate = this.props.formatter(date);
if (formattedDate !== 'Invalid date') {
this.setState({
value: date,
formattedValue: formattedDate,
inputValue: formattedDate,
isOpen: false,
});
if (this.props.onChange) {
this.props.onChange(event, {
date,
formattedDate,
timezoneOffset: date.getTimezoneOffset(),
});
}
} else {
this.setState(Datepicker.getDerivedStateFromProps(this.props, {}));
}
}

// Please remove `onKeyDown` on the next breaking change.
Expand All @@ -563,9 +581,10 @@ class Datepicker extends React.Component {
this.props.onRequestClose();
}

if (this.getIsOpen()) {
this.setState({ isOpen: false, isOpenFromIcon: false });
const wasOpen = this.getIsOpen();
this.setState(Datepicker.getDerivedStateFromProps(this.props, {}));

if (wasOpen) {
if (this.inputRef) {
this.inputRef.focus();
}
Expand Down