Skip to content

Add prop to mark field as required #154

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

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

Add prop to mark field as required #154

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
51a7c26
Add prop to mark field as required
mfrazie2 Oct 22, 2021
8e37324
Add SubmitTemplate for testing
mfrazie2 Oct 22, 2021
b8b868d
Remove required attribute on input field
mfrazie2 Oct 22, 2021
81d52b4
Add note about form validation on the field
mfrazie2 Oct 25, 2021
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
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ onRemove(selectedList, removedItem) {
| `showArrow` | `bool` | `false` | For multiselect dropdown by default arrow wont show at the end, If required based on flag we can display
| `keepSearchTerm` | `bool` | `false` | Whether or not to keep the search value after selecting or removing an item
| `customCloseIcon` | `ReactNode or string` | `undefined` | Custom close icon and can be string or react component(Check demo for reference)
| `required` | `boolean` | `false` | Marks the input field as required to prevent form submission with missing values
----


Expand Down
3 changes: 2 additions & 1 deletion src/multiselect/interface.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,6 @@ export interface IMultiselectProps {
hidePlaceholder?: boolean,
showArrow?: boolean,
keepSearchTerm?: boolean,
customCloseIcon?: React.ReactNode | string
customCloseIcon?: React.ReactNode | string,
required?: boolean
}
8 changes: 5 additions & 3 deletions src/multiselect/multiselect.component.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ const closeIconTypes = {
};

export class Multiselect extends React.Component<IMultiselectProps, any> {
static defaultProps: { options: never[]; disablePreSelectedValues: boolean; selectedValues: never[]; isObject: boolean; displayValue: string; showCheckbox: boolean; selectionLimit: number; placeholder: string; groupBy: string; style: {}; emptyRecordMsg: string; onSelect: () => void; onRemove: () => void; closeIcon: string; singleSelect: boolean; caseSensitiveSearch: boolean; id: string; closeOnSelect: boolean; avoidHighlightFirstOption: boolean; hidePlaceholder: boolean; showArrow: boolean; keepSearchTerm: boolean; };
static defaultProps: { options: never[]; disablePreSelectedValues: boolean; selectedValues: never[]; isObject: boolean; displayValue: string; showCheckbox: boolean; selectionLimit: number; placeholder: string; groupBy: string; style: {}; emptyRecordMsg: string; onSelect: () => void; onRemove: () => void; closeIcon: string; singleSelect: boolean; caseSensitiveSearch: boolean; id: string; closeOnSelect: boolean; avoidHighlightFirstOption: boolean; hidePlaceholder: boolean; showArrow: boolean; keepSearchTerm: boolean; required: boolean; };
constructor(props) {
super(props);
this.state = {
Expand Down Expand Up @@ -505,7 +505,7 @@ export class Multiselect extends React.Component<IMultiselectProps, any> {

renderMultiselectContainer() {
const { inputValue, toggleOptionsList, selectedValues } = this.state;
const { placeholder, style, singleSelect, id, hidePlaceholder, disable, showArrow} = this.props;
const { placeholder, style, singleSelect, id, hidePlaceholder, disable, showArrow, required} = this.props;
return (
<div className={`multiselect-container multiSelectContainer ${disable ? `disable_ms` : ''}`} id={id || 'multiselectContainerReact'} style={style['multiselectContainer']}>
<div className={`search-wrapper searchWrapper ${singleSelect ? 'singleSelect' : ''}`}
Expand All @@ -527,6 +527,7 @@ export class Multiselect extends React.Component<IMultiselectProps, any> {
style={style['inputField']}
autoComplete="off"
disabled={singleSelect || disable}
required={required}
Copy link
Owner

@srigar srigar Oct 22, 2021

Choose a reason for hiding this comment

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

Adding required in input doesn't help I believe, because input field will always be empty, after selecting any option we will clear the input field value. So it will always throw error.

Copy link
Author

@mfrazie2 mfrazie2 Oct 22, 2021

Choose a reason for hiding this comment

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

🤦 Oh right. I jumped in without looking. I'll pull this back to a draft state and work on a different solution.

/>
{(singleSelect || showArrow) && <img
src={DownArrow}
Expand Down Expand Up @@ -572,5 +573,6 @@ Multiselect.defaultProps = {
hidePlaceholder: false,
showArrow: false,
keepSearchTerm: false,
customCloseIcon: ''
customCloseIcon: '',
required: false
};
20 changes: 19 additions & 1 deletion stories/basic.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,16 @@ export default {
} as Meta;

const Template: Story<IMultiselectProps> = (args) => <MultiSelect {...args} />;
const SubmitTemplate: Story<IMultiselectProps> = args => {
return (
<>
<form>
<MultiSelect {...args} />
<input type="submit" onSubmit={() => {}} />
</form>
</>
)
}

export const FlatArray = Template.bind({});
FlatArray.args = {
Expand Down Expand Up @@ -106,4 +116,12 @@ CustomCloseIcon.args = {
displayValue: 'key',
customCloseIcon: <>🍑</>,
selectedValues
};
};

export const RequiredField = SubmitTemplate.bind({});
RequiredField.args = {
options,
displayValue: 'key',
selectedValues,
required: true,
};