Skip to content

Commit

Permalink
style: Rename atTypeValues to categoryValues
Browse files Browse the repository at this point in the history
Deprecated atTypeValues (but still in place anyway. Use categoryValues instead
  • Loading branch information
EthanFreestone committed Oct 21, 2024
1 parent 620caab commit abb83ee
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 14 deletions.
16 changes: 12 additions & 4 deletions lib/DocumentFilter/DocumentFilter.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,21 @@ import DocumentFilterForm from './DocumentFilterForm';

const DocumentFilter = ({
activeFilters,
atTypeValues = [],
atTypeValues = [], // DEPRECATED

Check failure on line 19 in lib/DocumentFilter/DocumentFilter.js

View workflow job for this annotation

GitHub Actions / ui / Install and lint / Install and lint

'atTypeValues' is missing in props validation
categoryValues = [], // Use this instead of atTypeValues
filterLabel,

Check failure on line 21 in lib/DocumentFilter/DocumentFilter.js

View workflow job for this annotation

GitHub Actions / ui / Install and lint / Install and lint

'filterLabel' is missing in props validation
filterModalProps = {},

Check failure on line 22 in lib/DocumentFilter/DocumentFilter.js

View workflow job for this annotation

GitHub Actions / ui / Install and lint / Install and lint

'filterModalProps' is missing in props validation
filterHandlers,
filterName = 'docs'

Check failure on line 24 in lib/DocumentFilter/DocumentFilter.js

View workflow job for this annotation

GitHub Actions / ui / Install and lint / Install and lint

'filterName' is missing in props validation
}) => {
// atTypeValues are only passed for SupplementaryDocumentFilter
let categoryValuesToUse = categoryValues;
if (categoryValuesToUse.length === 0 && atTypeValues.length !== 0) {
// eslint-disable-next-line no-console
console.error('atTypeValues have been deprecated from Ramsons. Use categoryValues instead');
categoryValuesToUse = atTypeValues;
}

// categoryValues are only passed for SupplementaryDocumentFilter
const [editingFilters, setEditingFilters] = useState(false);
const openEditModal = () => setEditingFilters(true);
const closeEditModal = () => setEditingFilters(false);
Expand Down Expand Up @@ -120,7 +128,7 @@ const DocumentFilter = ({
</Layout>
)}
<DocumentFilterForm
atTypeValues={atTypeValues}
categoryValues={categoryValuesToUse}
editingFilters={editingFilters}
filterModalProps={filterModalProps}
filterName={filterName}
Expand All @@ -137,7 +145,7 @@ const DocumentFilter = ({

DocumentFilter.propTypes = {
activeFilters: PropTypes.object,
atTypeValues: PropTypes.arrayOf(PropTypes.object),
categoryValues: PropTypes.arrayOf(PropTypes.object),
filterHandlers: PropTypes.object,
};

Expand Down
4 changes: 2 additions & 2 deletions lib/DocumentFilter/DocumentFilterField.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { FormattedMessage } from 'react-intl';
import DocumentFilterRule from './DocumentFilterRule';

const DocumentFilterField = ({
atTypeValues,
categoryValues,

Check failure on line 9 in lib/DocumentFilter/DocumentFilterField.js

View workflow job for this annotation

GitHub Actions / ui / Install and lint / Install and lint

'categoryValues' is missing in props validation
filterName,

Check failure on line 10 in lib/DocumentFilter/DocumentFilterField.js

View workflow job for this annotation

GitHub Actions / ui / Install and lint / Install and lint

'filterName' is missing in props validation
index,
name
Expand All @@ -20,7 +20,7 @@ const DocumentFilterField = ({
<DocumentFilterRule
key={ruleFieldName}
ariaLabelledby={`selected-document-item-name-${index}`}
atTypeValues={atTypeValues}
categoryValues={categoryValues}
filterName={filterName}
index={ruleFieldIndex}
name={ruleFieldName}
Expand Down
6 changes: 3 additions & 3 deletions lib/DocumentFilter/DocumentFilterFieldArray.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ import { FormattedMessage } from 'react-intl';
import DocumentFilterField from './DocumentFilterField';

const propTypes = {
atTypeValues: PropTypes.arrayOf(PropTypes.object),
categoryValues: PropTypes.arrayOf(PropTypes.object),
};

const DocumentFilterFieldArray = ({
atTypeValues,
categoryValues,
filterName

Check failure on line 21 in lib/DocumentFilter/DocumentFilterFieldArray.js

View workflow job for this annotation

GitHub Actions / ui / Install and lint / Install and lint

'filterName' is missing in props validation
}) => {
const {
Expand Down Expand Up @@ -66,7 +66,7 @@ const DocumentFilterFieldArray = ({
marginBottom0={index !== fields.length - 1}
>
<DocumentFilterField
atTypeValues={atTypeValues}
categoryValues={categoryValues}
fields={fields}
filterName={filterName}
index={index}
Expand Down
6 changes: 3 additions & 3 deletions lib/DocumentFilter/DocumentFilterForm.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { FormattedMessage } from 'react-intl';
import DocumentFilterFieldArray from './DocumentFilterFieldArray';

const DocumentFilterForm = ({
atTypeValues,
categoryValues,
editingFilters,
filterModalProps,
filterName,
Expand Down Expand Up @@ -36,7 +36,7 @@ const DocumentFilterForm = ({
onSubmit={onSubmit}
>
<DocumentFilterFieldArray
atTypeValues={atTypeValues}
categoryValues={categoryValues}
filterName={filterName}
/>
</FormModal>
Expand All @@ -45,7 +45,7 @@ const DocumentFilterForm = ({
};

DocumentFilterForm.propTypes = {
atTypeValues: PropTypes.arrayOf(PropTypes.object),
categoryValues: PropTypes.arrayOf(PropTypes.object),
editingFilters: PropTypes.bool,
filterModalProps: PropTypes.object.isRequired,
filterName: PropTypes.string.isRequired,
Expand Down
4 changes: 2 additions & 2 deletions lib/DocumentFilter/DocumentFilterRule.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import DocumentFilterRuleConstants from './DocumentFilterRuleConstants';

const DocumentFilterRule = ({
ariaLabelledby,
atTypeValues,
categoryValues,
filterName,
index,
name,
Expand All @@ -28,7 +28,7 @@ const DocumentFilterRule = ({

const { operators, attributes } = DocumentFilterRuleConstants({
filterName,
ifCategory: atTypeValues.length > 0
ifCategory: categoryValues.length > 0
});

return (
Expand Down

0 comments on commit abb83ee

Please sign in to comment.