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

Jump to bottom

Settings: Metric Configuration: Refactor & Clean Up (5/n) #91

Merged
merged 10 commits into from
Oct 20, 2022
Merged

Settings: Metric Configuration: Refactor & Clean Up (5/n) #91

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
15ceea0
Major clean up - separate components into their own files
Oct 18, 2022
7571c39
Fix dimension bug
Oct 18, 2022
c627a95
Fix switch agency bug
Oct 18, 2022
e263691
Minor clean up
Oct 18, 2022
b4b27e3
Merge types with existing types and update all connected components
Oct 18, 2022
c4798d7
Clean up
Oct 18, 2022
e0495ec
Handle cases when settings array is empty or non-existent
Oct 18, 2022
fb5c536
Handle cases when settings array is empty or non-existent
Oct 18, 2022
da25792
Styling adjustments per prev feedback
Oct 19, 2022
6c85f6f
Recreate MetricsView Component for Data Visualization (#101)
mxosman Oct 20, 2022
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
257 changes: 257 additions & 0 deletions publisher/src/components/MetricConfiguration/Configuration.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,257 @@
// Recidiviz - a data platform for criminal justice reform
// Copyright (C) 2022 Recidiviz, Inc.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
// =============================================================================

import React, { useEffect, useState } from "react";

import { Metric, MetricDisaggregationDimensions } from "../../shared/types";
import { removeSnakeCase } from "../../utils";
import blueCheck from "../assets/status-check-icon.png";
import { BinaryRadioButton } from "../Forms";
import { TabbedBar, TabbedItem, TabbedOptions } from "../Reports";
import {
BlueCheckIcon,
BreakdownHeader,
Checkbox,
CheckboxWrapper,
Dimension,
DimensionTitle,
DimensionTitleWrapper,
Disaggregation,
DisaggregationTab,
Header,
MetricConfigurationContainer,
MetricDisaggregations,
MetricOnOffWrapper,
MetricSettings,
RadioButtonGroupWrapper,
Subheader,
} from ".";

type MetricConfigurationProps = {
activeMetricKey: string;
filteredMetricSettings: { [key: string]: Metric };
saveAndUpdateMetricSettings: (
typeOfUpdate: "METRIC" | "DISAGGREGATION" | "DIMENSION" | "CONTEXT",
updatedSetting: MetricSettings,
debounce?: boolean
) => void;
setActiveDimension: React.Dispatch<
React.SetStateAction<MetricDisaggregationDimensions | undefined>
>;
};

export const Configuration: React.FC<MetricConfigurationProps> = ({
Copy link
Contributor Author

Choose a reason for hiding this comment

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

No changes to this component except for a bug fix in L91. Would love to know if naming this file Configuration is confusing or if there is a better name to specify this as the actual configuration portion of the MetricConfiguration component. 😅

activeMetricKey,
filteredMetricSettings,
saveAndUpdateMetricSettings,
setActiveDimension,
}): JSX.Element => {
const [activeDisaggregation, setActiveDisaggregation] = useState(
filteredMetricSettings[activeMetricKey]?.disaggregations?.[0]
);
const metricDisplayName =
filteredMetricSettings[activeMetricKey]?.display_name;
const metricEnabled = Boolean(
filteredMetricSettings[activeMetricKey]?.enabled
);

useEffect(
() => {
const updatedDisaggregation =
activeDisaggregation &&
filteredMetricSettings[activeMetricKey]?.disaggregations?.find(
(disaggregation) => disaggregation.key === activeDisaggregation.key
);

if (updatedDisaggregation)
return setActiveDisaggregation(updatedDisaggregation);
setActiveDisaggregation(
filteredMetricSettings[activeMetricKey]?.disaggregations?.[0]
);
},
// eslint-disable-next-line react-hooks/exhaustive-deps
[filteredMetricSettings]
);

useEffect(
() => setActiveDimension(undefined),
// eslint-disable-next-line react-hooks/exhaustive-deps
[activeMetricKey]
);

return (
<MetricConfigurationContainer>
<MetricOnOffWrapper>
<Header>
Are you currently able to report any part of this metric?
</Header>
<Subheader>
Answering “No” means that {metricDisplayName} will not appear on
automatically generated reports from here on out. You can change this
later.
</Subheader>
<RadioButtonGroupWrapper>
<BinaryRadioButton
type="radio"
id="yes"
name="metric-config"
label="Yes"
value="yes"
checked={metricEnabled}
onChange={() =>
saveAndUpdateMetricSettings("METRIC", {
key: activeMetricKey,
enabled: true,
})
}
/>
<BinaryRadioButton
type="radio"
id="no"
name="metric-config"
label="No"
value="no"
checked={!metricEnabled}
onChange={() =>
saveAndUpdateMetricSettings("METRIC", {
key: activeMetricKey,
enabled: false,
})
}
/>
</RadioButtonGroupWrapper>
</MetricOnOffWrapper>

{filteredMetricSettings[activeMetricKey]?.disaggregations.length > 0 && (
<MetricDisaggregations enabled={metricEnabled}>
<BreakdownHeader>Breakdowns</BreakdownHeader>
<Subheader>
Mark (using the checkmark) each of the breakdowns below that your
agency will be able to report. Click the arrow to edit the
definition for each metric.
</Subheader>

<TabbedBar noPadding>
<TabbedOptions>
{activeDisaggregation &&
filteredMetricSettings[activeMetricKey]?.disaggregations?.map(
(disaggregation) => (
<TabbedItem
key={disaggregation.key}
onClick={() => {
setActiveDimension(disaggregation.dimensions[0]);
setActiveDisaggregation(disaggregation);
}}
selected={disaggregation.key === activeDisaggregation.key}
capitalize
>
<DisaggregationTab>
<span>
{removeSnakeCase(
disaggregation.display_name.toLowerCase()
)}
</span>

<CheckboxWrapper>
<Checkbox
type="checkbox"
checked={disaggregation.enabled}
onChange={() =>
saveAndUpdateMetricSettings("DISAGGREGATION", {
key: activeMetricKey,
disaggregations: [
{
key: disaggregation.key,
enabled: !disaggregation.enabled,
},
],
})
}
/>
<BlueCheckIcon
src={blueCheck}
alt=""
enabled={disaggregation.enabled}
/>
</CheckboxWrapper>
</DisaggregationTab>
</TabbedItem>
)
)}
</TabbedOptions>
</TabbedBar>

<Disaggregation>
{activeDisaggregation?.dimensions.map((dimension) => {
return (
<Dimension
key={dimension.key}
enabled={!metricEnabled || activeDisaggregation.enabled}
onClick={() => setActiveDimension(dimension)}
>
<CheckboxWrapper>
<Checkbox
type="checkbox"
checked={
activeDisaggregation.enabled && dimension.enabled
}
onChange={() => {
if (activeDisaggregation.enabled) {
saveAndUpdateMetricSettings("DIMENSION", {
key: activeMetricKey,
disaggregations: [
{
key: activeDisaggregation.key,
dimensions: [
{
key: dimension.key,
enabled: !dimension.enabled,
},
],
},
],
});
}
}}
/>
<BlueCheckIcon
src={blueCheck}
alt=""
enabled={
activeDisaggregation.enabled && dimension.enabled
}
/>
</CheckboxWrapper>

<DimensionTitleWrapper>
<DimensionTitle
enabled={
activeDisaggregation.enabled && dimension.enabled
}
>
{dimension.label}
</DimensionTitle>
</DimensionTitleWrapper>
</Dimension>
);
})}
</Disaggregation>
</MetricDisaggregations>
)}
</MetricConfigurationContainer>
);
};
Loading