fleet/frontend/components/forms/fields/Dropdown/Dropdown.jsx

213 lines
5.1 KiB
React
Raw Normal View History

import React, { Component } from "react";
import PropTypes from "prop-types";
import classnames from "classnames";
import { noop, pick } from "lodash";
import Select from "react-select";
import dropdownOptionInterface from "interfaces/dropdownOption";
import FormField from "components/forms/FormField";
import Icon from "components/Icon";
2016-12-16 15:54:49 +00:00
const baseClass = "dropdown";
class Dropdown extends Component {
static propTypes = {
className: PropTypes.string,
clearable: PropTypes.bool,
searchable: PropTypes.bool,
2017-01-13 23:27:58 +00:00
disabled: PropTypes.bool,
2016-12-16 15:54:49 +00:00
error: PropTypes.string,
label: PropTypes.oneOfType([PropTypes.array, PropTypes.string]),
labelClassName: PropTypes.string,
multi: PropTypes.bool,
name: PropTypes.string,
onChange: PropTypes.func,
2021-10-26 14:24:16 +00:00
onOpen: PropTypes.func,
onClose: PropTypes.func,
options: PropTypes.arrayOf(dropdownOptionInterface).isRequired,
placeholder: PropTypes.oneOfType([PropTypes.array, PropTypes.string]),
value: PropTypes.oneOfType([
PropTypes.array,
PropTypes.string,
PropTypes.number,
]),
wrapperClassName: PropTypes.string,
parseTarget: PropTypes.bool,
tooltip: PropTypes.string,
2023-01-06 14:25:00 +00:00
autoFocus: PropTypes.bool,
/** Includes styled filter icon */
tableFilterDropdown: PropTypes.bool,
UI – refactor forms and form fields (#16159) ## Addresses #15325 - Define shared global styles for forms (`form` and `.form`s) and `.form-field`s - Sweep through the app, updating each form from being locally styled to first prioritizing the global styles and only defining local styles where needed for custom behavior - Remove lots of unnecessary nesting of elements - Other small bug fixes and improvements ### Samples, before (L) | after (R): **Save query modal** ![Screenshot 2024-01-17 at 11 49 14 AM](https://github.com/fleetdm/fleet/assets/61553566/14f209fb-31db-41ef-8e63-e0d8994698c1) **Edit query form** ![Screenshot 2024-01-17 at 11 50 35 AM](https://github.com/fleetdm/fleet/assets/61553566/b07e70ea-3095-4e4f-be73-95a3c499839b) **Add hosts modal** ![Screenshot 2024-01-17 at 11 51 48 AM](https://github.com/fleetdm/fleet/assets/61553566/4ef1f410-a823-41d1-b2f6-ea8eb5231f93) ## QA Plan: @xpkoala here's the same list from the issue, freshly de-checked for you to use if it's helpful: * Please check error states of each field #### Specified by issue: ##### In "Save query" modal: - [ ] Reduce space between checkboxes and their help text to 8px/0.5rem for the following fields: - [ ] Observers can run - [ ] Discard data - [ ] Update the following checkbox labels to have normal font weight (not bold): - [ ] Discard data ##### On "Edit query" page: - [ ] Update the following checkbox labels to have normal font weight (not bold): - [ ] Observers can run - [ ] Discard data ##### In "Add hosts" modal, for copy text fields: - [ ] match typical form form field styles - [ ] Adjust the positioning of the copy icon to keep it from being too far down ##### Further locations to check - [ ] ChangeEmailForm.jsx - [ ] ChangePasswordForm.jsx - [ ] ConfirmInviteForm.jsx - [ ] ConfirmSSOInviteForm.jsx - [ ] EnrollSecretModal.tsx - [ ] ForgotPasswordForm.jsx - [ ] LoginForm.tsx - [ ] EditPackForm.tsx - [ ] (New)PackForm.tsx - [ ] AdminDetails.jsx - [ ] ConfirmationPage.tsx - [ ] FleetDetails.jsx - [ ] OrgDetails.jsx - [ ] ResetPasswordForm.tsx - [ ] UserSettingsForm.jsx - [ ] EditTeamModal.tsx - [ ] IdpSection.tsx - [ ] DeleteIntegrationModal.tsx - [ ] IntegrationForm.tsx - [ ] EndUserMigrationSection.tsx - [ ] RequestCSRModal.tsx - [ ] Advanced.tsx - [ ] Agents.tsx - [ ] FleetDesktop.tsx - [ ] HostStatusWebhook.tsx front - [ ] Info.tsx - [ ] Smtp.tsx - [ ] Sso.tsx - [ ] Statistics.tsx - [ ] WebAddress.tsx - [ ] CreateTeamModal.tsx - [ ] DeleteTeamModal.tsx - [ ] EditTeamModal.tsx - [ ] AgentOptionsPage.tsx - updated the layout of this page to align with the rest of the forms in the UI – can easily revert if it's not what we want - [ ] AddMemberModal.tsx - [ ] RemoveMemberModal.tsx - [ ] UserForm.tsx - Used by both `EditUserModal` and `CreateUserModal` - A few different conditions that cause different rendering behavior - [ ] DeleteHostModal.tsx - [ ] TransferHostModal.tsx - [ ] LabelForm.tsx - [ ] MacOSTargetForm.tsx - [ ] WindowsTargetForm.tsx - [ ] BootstrapPackageListltem.ts - [ ] EndUserAuthForm.tsx - [ ] PackQueryEditorModal.tsx - [ ] PolicyForm.tsx - [ ] SaveNewPolicyModal.tsx - [ ] ConfirmSaveChangesModal.tsx - [ ] Query automations modal - [ ] Policy automations modal - addresses #16010 - [ ] SoftwareAutomationsModal ## Checklist for submitter - [x] Changes file added for user-visible changes in `changes/` - [x] Manual QA for all new/changed functionality --------- Co-authored-by: Jacob Shandling <jacob@fleetdm.com> Co-authored-by: RachelElysia <71795832+RachelElysia@users.noreply.github.com>
2024-01-18 15:48:44 +00:00
helpText: PropTypes.oneOfType([
PropTypes.string,
PropTypes.arrayOf(PropTypes.string),
PropTypes.object,
]),
};
static defaultProps = {
2016-12-16 15:54:49 +00:00
onChange: noop,
2021-10-26 14:24:16 +00:00
onOpen: noop,
onClose: noop,
clearable: false,
searchable: true,
2017-01-13 23:27:58 +00:00
disabled: false,
multi: false,
name: "targets",
placeholder: "Select one...", // if value undefined
parseTarget: false,
tooltip: "",
2023-01-06 14:25:00 +00:00
autoFocus: false,
tableFilterDropdown: false,
};
2021-10-26 14:24:16 +00:00
onMenuOpen = () => {
const { onOpen } = this.props;
onOpen();
};
onMenuClose = () => {
const { onClose } = this.props;
onClose();
};
handleChange = (selected) => {
const { multi, onChange, clearable, name, parseTarget } = this.props;
if (parseTarget) {
// Returns both name and value
return onChange({ value: selected.value, name });
}
2016-12-16 15:54:49 +00:00
if (clearable && selected === null) {
return onChange(null);
}
if (multi) {
return onChange(selected.map((obj) => obj.value).join(","));
}
return onChange(selected.value);
2016-12-16 15:54:49 +00:00
};
renderLabel = () => {
const { error, label, labelClassName, name } = this.props;
const labelWrapperClasses = classnames(
`${baseClass}__label`,
labelClassName,
{ [`${baseClass}__label--error`]: error }
);
if (!label) {
return false;
}
return (
<label className={labelWrapperClasses} htmlFor={name}>
{error || label}
</label>
);
};
renderOption = (option) => {
return (
<div className={`${baseClass}__option`}>
{option.label}
{option.helpText && (
<span className={`${baseClass}__help-text`}>{option.helpText}</span>
)}
</div>
);
};
renderCustomDropdownArrow = () => {
return (
<div className={`${baseClass}__custom-arrow`}>
<Icon name="chevron-down" className={`${baseClass}__icon`} />
</div>
);
};
// Adds styled filter icon to dropdown
renderCustomTableFilter = () => {
const { options, value } = this.props;
const customLabel = options
.filter((option) => option.value === value)
.map((option) => option.label);
return (
<div className={`${baseClass}__custom-value`}>
<Icon name="filter" className={`${baseClass}__icon`} />
<div className={`${baseClass}__custom-value-label`}>{customLabel}</div>
</div>
);
};
render() {
const {
handleChange,
renderOption,
onMenuOpen,
onMenuClose,
renderCustomDropdownArrow,
renderCustomTableFilter,
} = this;
const {
error,
className,
clearable,
disabled,
multi,
name,
options,
placeholder,
value,
wrapperClassName,
2021-04-14 16:52:15 +00:00
searchable,
2023-01-06 14:25:00 +00:00
autoFocus,
tableFilterDropdown,
} = this.props;
2016-12-16 15:54:49 +00:00
const formFieldProps = pick(this.props, [
UI – refactor forms and form fields (#16159) ## Addresses #15325 - Define shared global styles for forms (`form` and `.form`s) and `.form-field`s - Sweep through the app, updating each form from being locally styled to first prioritizing the global styles and only defining local styles where needed for custom behavior - Remove lots of unnecessary nesting of elements - Other small bug fixes and improvements ### Samples, before (L) | after (R): **Save query modal** ![Screenshot 2024-01-17 at 11 49 14 AM](https://github.com/fleetdm/fleet/assets/61553566/14f209fb-31db-41ef-8e63-e0d8994698c1) **Edit query form** ![Screenshot 2024-01-17 at 11 50 35 AM](https://github.com/fleetdm/fleet/assets/61553566/b07e70ea-3095-4e4f-be73-95a3c499839b) **Add hosts modal** ![Screenshot 2024-01-17 at 11 51 48 AM](https://github.com/fleetdm/fleet/assets/61553566/4ef1f410-a823-41d1-b2f6-ea8eb5231f93) ## QA Plan: @xpkoala here's the same list from the issue, freshly de-checked for you to use if it's helpful: * Please check error states of each field #### Specified by issue: ##### In "Save query" modal: - [ ] Reduce space between checkboxes and their help text to 8px/0.5rem for the following fields: - [ ] Observers can run - [ ] Discard data - [ ] Update the following checkbox labels to have normal font weight (not bold): - [ ] Discard data ##### On "Edit query" page: - [ ] Update the following checkbox labels to have normal font weight (not bold): - [ ] Observers can run - [ ] Discard data ##### In "Add hosts" modal, for copy text fields: - [ ] match typical form form field styles - [ ] Adjust the positioning of the copy icon to keep it from being too far down ##### Further locations to check - [ ] ChangeEmailForm.jsx - [ ] ChangePasswordForm.jsx - [ ] ConfirmInviteForm.jsx - [ ] ConfirmSSOInviteForm.jsx - [ ] EnrollSecretModal.tsx - [ ] ForgotPasswordForm.jsx - [ ] LoginForm.tsx - [ ] EditPackForm.tsx - [ ] (New)PackForm.tsx - [ ] AdminDetails.jsx - [ ] ConfirmationPage.tsx - [ ] FleetDetails.jsx - [ ] OrgDetails.jsx - [ ] ResetPasswordForm.tsx - [ ] UserSettingsForm.jsx - [ ] EditTeamModal.tsx - [ ] IdpSection.tsx - [ ] DeleteIntegrationModal.tsx - [ ] IntegrationForm.tsx - [ ] EndUserMigrationSection.tsx - [ ] RequestCSRModal.tsx - [ ] Advanced.tsx - [ ] Agents.tsx - [ ] FleetDesktop.tsx - [ ] HostStatusWebhook.tsx front - [ ] Info.tsx - [ ] Smtp.tsx - [ ] Sso.tsx - [ ] Statistics.tsx - [ ] WebAddress.tsx - [ ] CreateTeamModal.tsx - [ ] DeleteTeamModal.tsx - [ ] EditTeamModal.tsx - [ ] AgentOptionsPage.tsx - updated the layout of this page to align with the rest of the forms in the UI – can easily revert if it's not what we want - [ ] AddMemberModal.tsx - [ ] RemoveMemberModal.tsx - [ ] UserForm.tsx - Used by both `EditUserModal` and `CreateUserModal` - A few different conditions that cause different rendering behavior - [ ] DeleteHostModal.tsx - [ ] TransferHostModal.tsx - [ ] LabelForm.tsx - [ ] MacOSTargetForm.tsx - [ ] WindowsTargetForm.tsx - [ ] BootstrapPackageListltem.ts - [ ] EndUserAuthForm.tsx - [ ] PackQueryEditorModal.tsx - [ ] PolicyForm.tsx - [ ] SaveNewPolicyModal.tsx - [ ] ConfirmSaveChangesModal.tsx - [ ] Query automations modal - [ ] Policy automations modal - addresses #16010 - [ ] SoftwareAutomationsModal ## Checklist for submitter - [x] Changes file added for user-visible changes in `changes/` - [x] Manual QA for all new/changed functionality --------- Co-authored-by: Jacob Shandling <jacob@fleetdm.com> Co-authored-by: RachelElysia <71795832+RachelElysia@users.noreply.github.com>
2024-01-18 15:48:44 +00:00
"helpText",
"label",
"error",
"name",
"tooltip",
]);
const selectClasses = classnames(className, `${baseClass}__select`, {
[`${baseClass}__select--error`]: error,
});
return (
<FormField
{...formFieldProps}
type="dropdown"
className={wrapperClassName}
>
2016-12-16 15:54:49 +00:00
<Select
className={selectClasses}
clearable={clearable}
2017-01-13 23:27:58 +00:00
disabled={disabled}
multi={multi}
searchable={searchable}
name={`${name}-select`}
2016-12-16 15:54:49 +00:00
onChange={handleChange}
options={options}
optionRenderer={renderOption}
2016-12-16 15:54:49 +00:00
placeholder={placeholder}
value={value}
2021-10-26 14:24:16 +00:00
onOpen={onMenuOpen}
onClose={onMenuClose}
2023-01-06 14:25:00 +00:00
autoFocus={autoFocus}
arrowRenderer={renderCustomDropdownArrow}
valueComponent={
tableFilterDropdown ? renderCustomTableFilter : undefined
}
2016-12-16 15:54:49 +00:00
/>
</FormField>
);
}
}
export default Dropdown;