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

#174 Added an edit button that can transition the component from view to the edit state #175

Merged
merged 1 commit into from
Oct 8, 2023
Merged

#174 Added an edit button that can transition the component from view to the edit state #175

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
16 changes: 12 additions & 4 deletions src/demo/App.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,23 @@ class App extends Component {
<header className="App-header">
<div>
<h1>React Easy Edit</h1>
<h3>Only show buttons on hover</h3>
<h3>Show Edit button</h3>
<EasyEdit
type={Types.TEXT}
onSave={App.onTest}
instructions="Custom instructions"
onValidate={value => {return value != null}}
onlyShowButtonsOnHover={true}
hideEditButton={false}
editButtonLabel={"Look Ma, an edit button!"}
editButtonStyle={"test-class"}
/>

<h3>Only show buttons on hover</h3>
<EasyEdit
type={Types.TEXT}
onSave={App.onTest}
instructions="Custom instructions"
onValidate={value => {return value != null}}
onlyShowButtonsOnHover={true}
/>
<div>
<h3>Toggle edit mode</h3>
<button onClick={() => {this.setState({editMode: !this.state.editMode})}}>Toggle</button>
Expand Down
4 changes: 4 additions & 0 deletions src/lib/EasyEdit.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,7 @@
.easy-edit-validation-error {
color: red;
}
.easy-edit-view-button-wrapper {
display: inline;
padding-left: 4px;
}
66 changes: 47 additions & 19 deletions src/lib/EasyEdit.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ export default class EasyEdit extends React.Component {
};

this.saveButton = React.createRef();
this.editButton = React.createRef();
this.cancelButton = React.createRef();
this.deleteButton = React.createRef();
}
Expand Down Expand Up @@ -107,6 +108,10 @@ export default class EasyEdit extends React.Component {
this.setState({ editing: false, tempValue: value, hover: false, isHidden: true }, () => onDelete());
};

_editing = () => {
this.setState({ editing: true});
}

onChange = e => {
this.setState({ tempValue: e.target ? e.target.value : e });
};
Expand Down Expand Up @@ -338,22 +343,23 @@ export default class EasyEdit extends React.Component {
}

renderPlaceholder() {
const { type, placeholder, displayComponent, viewAttributes, cssClassPrefix } = this.props;
const { type, placeholder, displayComponent, viewAttributes, cssClassPrefix, hideEditButton, editButtonLabel, editButtonStyle } = this.props;
this.cullAttributes();
const cssWrapperClass = cssClassPrefix + 'easy-edit-wrapper';

if (React.isValidElement(displayComponent)) {
return (
<div
{...viewAttributes}
className={this.setCssClasses(cssWrapperClass)}
onClick={this.onClick}
onMouseEnter={this.hoverOn}
onMouseLeave={this.hoverOff}
{...viewAttributes}
className={this.setCssClasses(cssWrapperClass)}
onClick={this.onClick}
onMouseEnter={this.hoverOn}
onMouseLeave={this.hoverOff}
>
{!this.isNullOrUndefinedOrEmpty(this.state.value) ?
React.cloneElement(displayComponent, { value: this.state.value }) :
placeholder}
React.cloneElement(displayComponent, {value: this.state.value}) :
placeholder}
{this.generateEditButton(cssClassPrefix, hideEditButton, editButtonLabel, editButtonStyle)}
</div>
);
}
Expand All @@ -376,13 +382,15 @@ export default class EasyEdit extends React.Component {
case Types.PASSWORD: {
return (
<div
{...viewAttributes}
className={this.setCssClasses(cssWrapperClass)}
onClick={this.onClick}
onMouseEnter={this.hoverOn}
onMouseLeave={this.hoverOff}
{...viewAttributes}
className={this.setCssClasses(cssWrapperClass)}
onClick={this.onClick}
onMouseEnter={this.hoverOn}
onMouseLeave={this.hoverOff}
>
{!this.isNullOrUndefinedOrEmpty(this.state.value) ? (type === Types.PASSWORD ? "••••••••" : this.state.value) : placeholder}
{!this.isNullOrUndefinedOrEmpty(this.state.value) ? (type
=== Types.PASSWORD ? "••••••••" : this.state.value) : placeholder}
{this.generateEditButton(cssClassPrefix, hideEditButton, editButtonLabel, editButtonStyle)}
</div>
);
}
Expand All @@ -391,13 +399,15 @@ export default class EasyEdit extends React.Component {
case Types.SELECT: {
return (
<div
{...viewAttributes}
className={this.setCssClasses(cssWrapperClass)}
onClick={this.onClick}
onMouseEnter={this.hoverOn}
onMouseLeave={this.hoverOff}
{...viewAttributes}
className={this.setCssClasses(cssWrapperClass)}
onClick={this.onClick}
onMouseEnter={this.hoverOn}
onMouseLeave={this.hoverOff}
>
{this.renderComplexView()}
{this.generateEditButton(cssClassPrefix, hideEditButton, editButtonLabel,
editButtonStyle)}
</div>
);
}
Expand All @@ -418,6 +428,15 @@ export default class EasyEdit extends React.Component {
}
}

generateEditButton(cssClassPrefix, hideEditButton, editButtonLabel, editButtonStyle) {
return <div className={cssClassPrefix + "easy-edit-view-button-wrapper"}>
{!hideEditButton && EasyEdit.generateButton(this.editButton,
this._editing, editButtonLabel,
(editButtonStyle === null ? cssClassPrefix
+ Globals.DEFAULT_BUTTON_CSS_CLASS : editButtonStyle), "edit")}
</div>;
}

renderComplexView() {
const { placeholder, options, type } = this.props;

Expand Down Expand Up @@ -525,6 +544,11 @@ EasyEdit.propTypes = {
PropTypes.element
]),
deleteButtonStyle: PropTypes.string,
editButtonLabel: PropTypes.oneOfType([
PropTypes.string,
PropTypes.element
]),
editButtonStyle: PropTypes.string,
buttonsPosition: PropTypes.oneOf(['after', 'before']),
placeholder: PropTypes.oneOfType([
PropTypes.string,
Expand All @@ -549,6 +573,7 @@ EasyEdit.propTypes = {
hideSaveButton: PropTypes.bool,
hideCancelButton: PropTypes.bool,
hideDeleteButton: PropTypes.bool,
hideEditButton: PropTypes.bool,
onHoverCssClass: PropTypes.string,
saveOnBlur: PropTypes.bool,
cancelOnBlur: PropTypes.bool,
Expand All @@ -564,6 +589,8 @@ EasyEdit.defaultProps = {
cancelButtonStyle: null,
deleteButtonLabel: Globals.DEFAULT_DELETE_BUTTON_LABEL,
deleteButtonStyle: null,
editButtonLabel: Globals.DEFAULT_EDIT_BUTTON_LABEL,
editButtonStyle: null,
buttonsPosition: Globals.POSITION_AFTER,
placeholder: Globals.DEFAULT_PLACEHOLDER,
allowEdit: true,
Expand All @@ -584,6 +611,7 @@ EasyEdit.defaultProps = {
hideSaveButton: false,
hideCancelButton: false,
hideDeleteButton: true,
hideEditButton: true,
onHoverCssClass: Globals.DEFAULT_ON_HOVER_CSS_CLASS,
saveOnBlur: false,
cancelOnBlur: false,
Expand Down
46 changes: 46 additions & 0 deletions src/lib/EasyEdit.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -530,4 +530,50 @@ describe('EasyEdit', () => {
expect(cancelButton).toBeInTheDocument();
});
});

describe('generateEditButton function', () => {
const cssClassPrefix = 'test-prefix';
const editButtonLabel = 'Edit button';
const editButtonStyle = "custom-style";

it('renders the edit button when hideEditButton is false, applies custom label and style', () => {
const { getByText } = render(
<EasyEdit
type="text"
cssClassPrefix={cssClassPrefix}
hideEditButton={false}
editButtonLabel={editButtonLabel}
editButtonStyle={editButtonStyle}
onSave={saveFn}
onCancel={cancelFn}
placeholder={<span>test</span>}
value={"Test"}
/>
);

const editButton = getByText('Edit button');
expect(editButton).toBeInTheDocument();
expect(editButton).toHaveClass("custom-style");
});

it('does not render the edit button when hideEditButton is true', () => {
const { queryByText } = render(
<EasyEdit
type="text"
cssClassPrefix={cssClassPrefix}
hideEditButton={true}
editButtonLabel={editButtonLabel}
editButtonStyle={editButtonStyle}
onSave={saveFn}
onCancel={cancelFn}
placeholder={<span>test</span>}
value={"Test"}
/>
);

const editButton = queryByText('Edit button'); // Change this to match the expected text of your edit button
expect(editButton).toBeNull();
});
});

});
1 change: 1 addition & 0 deletions src/lib/globals.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ const Globals = {
DEFAULT_SAVE_BUTTON_LABEL: 'Save',
DEFAULT_CANCEL_BUTTON_LABEL: 'Cancel',
DEFAULT_DELETE_BUTTON_LABEL: 'Delete',
DEFAULT_EDIT_BUTTON_LABEL: 'Delete',
DEFAULT_BUTTON_CSS_CLASS: 'easy-edit-button',
DEFAULT_ON_HOVER_CSS_CLASS: 'easy-edit-hover-on',
ERROR_UNSUPPORTED_TYPE: 'Unsupported component type, please review documentation for supported HTML component types',
Expand Down