@aehrc/smart-forms-renderer 0.7.2 → 0.8.1

package/src/components/FormComponents/ChoiceItems/ChoiceCheckboxAnswerValueSetFields.tsx

@@ -0,0 +1,79 @@
+/*
+ * Copyright 2023 Commonwealth Scientific and Industrial Research
+ * Organisation (CSIRO) ABN 41 687 119 230.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import React from 'react';
+import { ChoiceItemOrientation } from '../../../interfaces/choice.enum';
+import type { Coding, QuestionnaireResponseItemAnswer } from 'fhir/r4';
+import CheckboxSingle from '../ItemParts/CheckboxSingle';
+import { StyledFormGroup } from '../Item.styles';
+import { StyledAlert } from '../../Alert.styles';
+import ErrorOutlineIcon from '@mui/icons-material/ErrorOutline';
+import Typography from '@mui/material/Typography';
+
+interface ChoiceCheckboxAnswerValueSetFieldsProps {
+  codings: Coding[];
+  answers: QuestionnaireResponseItemAnswer[];
+  orientation: ChoiceItemOrientation;
+  readOnly: boolean;
+  serverError: Error | null;
+  onCheckedChange: (newValue: string) => void;
+}
+
+function ChoiceCheckboxAnswerValueSetFields(props: ChoiceCheckboxAnswerValueSetFieldsProps) {
+  const { codings, answers, orientation, readOnly, serverError, onCheckedChange } = props;
+
+  if (codings.length > 0) {
+    return (
+      <StyledFormGroup row={orientation === ChoiceItemOrientation.Horizontal}>
+        {codings.map((coding) => (
+          <CheckboxSingle
+            key={coding.code ?? ''}
+            value={coding.code ?? ''}
+            label={coding.display ?? `${coding.code}`}
+            readOnly={readOnly}
+            isChecked={answers.some(
+              (answer) => JSON.stringify(answer.valueCoding) === JSON.stringify(coding)
+            )}
+            onCheckedChange={onCheckedChange}
+          />
+        ))}
+      </StyledFormGroup>
+    );
+  }
+
+  if (serverError) {
+    return (
+      <StyledAlert color="error">
+        <ErrorOutlineIcon color="error" sx={{ pr: 0.75 }} />
+        <Typography variant="subtitle2">
+          There was an error fetching options from the terminology server
+        </Typography>
+      </StyledAlert>
+    );
+  }
+
+  return (
+    <StyledAlert color="error">
+      <ErrorOutlineIcon color="error" sx={{ pr: 0.75 }} />
+      <Typography variant="subtitle2">
+        Unable to fetch options from the questionnaire or launch context
+      </Typography>
+    </StyledAlert>
+  );
+}
+
+export default ChoiceCheckboxAnswerValueSetFields;

package/src/components/FormComponents/ChoiceItems/ChoiceCheckboxAnswerValueSetItem.tsx

@@ -17,43 +17,52 @@
 
 import React from 'react';
 import Grid from '@mui/material/Grid';
-import Typography from '@mui/material/Typography';
-
 import type { QuestionnaireItem, QuestionnaireResponseItem } from 'fhir/r4';
 import { createEmptyQrItem } from '../../../utils/qrItem';
 import useValueSetCodings from '../../../hooks/useValueSetCodings';
-import { ChoiceItemOrientation } from '../../../interfaces/choice.enum';
+import type { ChoiceItemOrientation } from '../../../interfaces/choice.enum';
 import { mapCodingsToOptions, updateQrCheckboxAnswers } from '../../../utils/choice';
-import CheckboxSingle from '../ItemParts/CheckboxSingle';
-import { QFormGroup } from '../Item.styles';
 import { FullWidthFormComponentBox } from '../../Box.styles';
 import useRenderingExtensions from '../../../hooks/useRenderingExtensions';
-import ErrorOutlineIcon from '@mui/icons-material/ErrorOutline';
 import type {
   PropsWithIsRepeatedAttribute,
-  PropsWithQrItemChangeHandler
+  PropsWithParentIsReadOnlyAttribute,
+  PropsWithQrItemChangeHandler,
+  PropsWithTextShownAttribute
 } from '../../../interfaces/renderProps.interface';
-import { StyledAlert } from '../../Alert.styles';
 import DisplayInstructions from '../DisplayItem/DisplayInstructions';
 import LabelWrapper from '../ItemParts/ItemLabelWrapper';
+import ChoiceCheckboxAnswerValueSetFields from './ChoiceCheckboxAnswerValueSetFields';
+import useReadOnly from '../../../hooks/useReadOnly';
 
 interface ChoiceCheckboxAnswerValueSetItemProps
   extends PropsWithQrItemChangeHandler<QuestionnaireResponseItem>,
-    PropsWithIsRepeatedAttribute {
+    PropsWithIsRepeatedAttribute,
+    PropsWithTextShownAttribute,
+    PropsWithParentIsReadOnlyAttribute {
   qItem: QuestionnaireItem;
   qrItem: QuestionnaireResponseItem;
   orientation: ChoiceItemOrientation;
+  showText?: boolean;
 }
 
 function ChoiceCheckboxAnswerValueSetItem(props: ChoiceCheckboxAnswerValueSetItemProps) {
-  const { qItem, qrItem, isRepeated, onQrItemChange, orientation } = props;
+  const {
+    qItem,
+    qrItem,
+    orientation,
+    isRepeated,
+    textShown = true,
+    parentIsReadOnly,
+    onQrItemChange
+  } = props;
 
   // Init input value
   const qrChoiceCheckbox = qrItem ?? createEmptyQrItem(qItem);
   const answers = qrChoiceCheckbox.answer ? qrChoiceCheckbox.answer : [];
 
-  // Get additional rendering extensions
-  const { displayInstructions, readOnly } = useRenderingExtensions(qItem);
+  const readOnly = useReadOnly(qItem, parentIsReadOnly);
+  const { displayInstructions } = useRenderingExtensions(qItem);
 
   // Get codings/options from valueSet
   const { codings, serverError } = useValueSetCodings(qItem);
@@ -75,52 +84,41 @@ function ChoiceCheckboxAnswerValueSetItem(props: ChoiceCheckboxAnswerValueSetIte
     }
   }
 
-  const choiceCheckbox =
-    codings.length > 0 ? (
-      <QFormGroup row={orientation === ChoiceItemOrientation.Horizontal}>
-        {codings.map((coding) => {
-          return (
-            <CheckboxSingle
-              key={coding.code ?? ''}
-              value={coding.code ?? ''}
-              label={coding.display ?? `${coding.code}`}
+  if (textShown) {
+    return (
+      <FullWidthFormComponentBox data-test="q-item-choice-checkbox-answer-value-set-box">
+        <Grid container columnSpacing={6}>
+          <Grid item xs={5}>
+            <LabelWrapper qItem={qItem} readOnly={readOnly} />
+          </Grid>
+          <Grid item xs={7}>
+            <ChoiceCheckboxAnswerValueSetFields
+              codings={codings}
+              answers={answers}
+              orientation={orientation}
               readOnly={readOnly}
-              isChecked={answers.some(
-                (answer) => JSON.stringify(answer.valueCoding) === JSON.stringify(coding)
-              )}
+              serverError={serverError}
               onCheckedChange={handleCheckedChange}
             />
-          );
-        })}
-      </QFormGroup>
-    ) : serverError ? (
-      <StyledAlert color="error">
-        <ErrorOutlineIcon color="error" sx={{ pr: 0.75 }} />
-        <Typography variant="subtitle2">
-          There was an error fetching options from the terminology server
-        </Typography>
-      </StyledAlert>
-    ) : (
-      <StyledAlert color="error">
-        <ErrorOutlineIcon color="error" sx={{ pr: 0.75 }} />
-        <Typography variant="subtitle2">
-          Unable to fetch options from the questionnaire or launch context
-        </Typography>
-      </StyledAlert>
+            <DisplayInstructions displayInstructions={displayInstructions} readOnly={readOnly} />
+          </Grid>
+        </Grid>
+      </FullWidthFormComponentBox>
     );
+  }
 
   return (
-    <FullWidthFormComponentBox data-test="q-item-choice-checkbox-answer-value-set-box">
-      <Grid container columnSpacing={6}>
-        <Grid item xs={5}>
-          <LabelWrapper qItem={qItem} />
-        </Grid>
-        <Grid item xs={7}>
-          {choiceCheckbox}
-          <DisplayInstructions displayInstructions={displayInstructions} />
-        </Grid>
-      </Grid>
-    </FullWidthFormComponentBox>
+    <>
+      <ChoiceCheckboxAnswerValueSetFields
+        codings={codings}
+        answers={answers}
+        orientation={orientation}
+        readOnly={readOnly}
+        serverError={serverError}
+        onCheckedChange={handleCheckedChange}
+      />
+      <DisplayInstructions displayInstructions={displayInstructions} readOnly={readOnly} />
+    </>
   );
 }
 

package/src/components/FormComponents/ChoiceItems/ChoiceItemSwitcher.tsx

@@ -29,19 +29,25 @@ import ChoiceCheckboxAnswerValueSetItem from './ChoiceCheckboxAnswerValueSetItem
 import type {
   PropsWithIsRepeatedAttribute,
   PropsWithIsTabledAttribute,
-  PropsWithQrItemChangeHandler
+  PropsWithQrItemChangeHandler,
+  PropsWithTextShownAttribute
 } from '../../../interfaces/renderProps.interface';
+import type { PropsWithParentIsReadOnlyAttribute } from '../../../interfaces/renderProps.interface';
 
 interface ChoiceItemSwitcherProps
   extends PropsWithQrItemChangeHandler<QuestionnaireResponseItem>,
     PropsWithIsRepeatedAttribute,
-    PropsWithIsTabledAttribute {
+    PropsWithIsTabledAttribute,
+    PropsWithTextShownAttribute,
+    PropsWithParentIsReadOnlyAttribute {
   qItem: QuestionnaireItem;
   qrItem: QuestionnaireResponseItem;
 }
 
 function ChoiceItemSwitcher(props: ChoiceItemSwitcherProps) {
-  const { qItem, qrItem, isRepeated, isTabled, onQrItemChange } = props;
+  const { qItem, qrItem, isRepeated, isTabled, textShown, parentIsReadOnly, onQrItemChange } =
+    props;
+
   const orientation = getChoiceOrientation(qItem);
   const choiceControlType = getChoiceControlType(qItem);
 
@@ -52,9 +58,10 @@ function ChoiceItemSwitcher(props: ChoiceItemSwitcherProps) {
           <ChoiceRadioAnswerOptionItem
             qItem={qItem}
             qrItem={qrItem}
+            orientation={orientation}
             isRepeated={isRepeated}
+            parentIsReadOnly={parentIsReadOnly}
             onQrItemChange={onQrItemChange}
-            orientation={orientation}
           />
         );
       } else {
@@ -62,9 +69,10 @@ function ChoiceItemSwitcher(props: ChoiceItemSwitcherProps) {
           <ChoiceRadioAnswerValueSetItem
             qItem={qItem}
             qrItem={qrItem}
+            orientation={orientation}
             isRepeated={isRepeated}
+            parentIsReadOnly={parentIsReadOnly}
             onQrItemChange={onQrItemChange}
-            orientation={orientation}
           />
         );
       }
@@ -74,9 +82,11 @@ function ChoiceItemSwitcher(props: ChoiceItemSwitcherProps) {
           <ChoiceCheckboxAnswerOptionItem
             qItem={qItem}
             qrItem={qrItem}
-            isRepeated={qItem['repeats'] ?? false}
-            onQrItemChange={onQrItemChange}
             orientation={orientation}
+            isRepeated={qItem.repeats ?? false}
+            textShown={textShown}
+            parentIsReadOnly={parentIsReadOnly}
+            onQrItemChange={onQrItemChange}
           />
         );
       } else {
@@ -84,9 +94,11 @@ function ChoiceItemSwitcher(props: ChoiceItemSwitcherProps) {
           <ChoiceCheckboxAnswerValueSetItem
             qItem={qItem}
             qrItem={qrItem}
-            isRepeated={qItem['repeats'] ?? false}
-            onQrItemChange={onQrItemChange}
+            isRepeated={qItem.repeats ?? false}
             orientation={orientation}
+            textShown={textShown}
+            parentIsReadOnly={parentIsReadOnly}
+            onQrItemChange={onQrItemChange}
           />
         );
       }
@@ -97,6 +109,7 @@ function ChoiceItemSwitcher(props: ChoiceItemSwitcherProps) {
           qrItem={qrItem}
           isRepeated={isRepeated}
           isTabled={isTabled}
+          parentIsReadOnly={parentIsReadOnly}
           onQrItemChange={onQrItemChange}
         />
       );
@@ -108,6 +121,7 @@ function ChoiceItemSwitcher(props: ChoiceItemSwitcherProps) {
             qrItem={qrItem}
             isRepeated={isRepeated}
             isTabled={isTabled}
+            parentIsReadOnly={parentIsReadOnly}
             onQrItemChange={onQrItemChange}
           />
         );
@@ -118,6 +132,7 @@ function ChoiceItemSwitcher(props: ChoiceItemSwitcherProps) {
             qrItem={qrItem}
             isRepeated={isRepeated}
             isTabled={isTabled}
+            parentIsReadOnly={parentIsReadOnly}
             onQrItemChange={onQrItemChange}
           />
         );

package/src/components/FormComponents/ChoiceItems/ChoiceRadioAnswerOptionFields.tsx

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2023 Commonwealth Scientific and Industrial Research
+ * Organisation (CSIRO) ABN 41 687 119 230.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import React from 'react';
+import { ChoiceItemOrientation } from '../../../interfaces/choice.enum';
+import type { QuestionnaireItem } from 'fhir/r4';
+import RadioAnswerOptionButtons from '../ItemParts/RadioAnswerOptionButtons';
+import { StyledRadioGroup } from '../Item.styles';
+
+interface ChoiceRadioAnswerOptionFieldsProps {
+  qItem: QuestionnaireItem;
+  valueRadio: string | null;
+  orientation: ChoiceItemOrientation;
+  readOnly: boolean;
+  onCheckedChange: (newValue: string) => void;
+}
+
+function ChoiceRadioAnswerOptionFields(props: ChoiceRadioAnswerOptionFieldsProps) {
+  const { qItem, valueRadio, orientation, readOnly, onCheckedChange } = props;
+
+  return (
+    <StyledRadioGroup
+      row={orientation === ChoiceItemOrientation.Horizontal}
+      name={qItem.text}
+      id={qItem.id}
+      onChange={(e) => onCheckedChange(e.target.value)}
+      value={valueRadio}
+      data-test="q-item-radio-group">
+      <RadioAnswerOptionButtons qItem={qItem} readOnly={readOnly} />
+    </StyledRadioGroup>
+  );
+}
+
+export default ChoiceRadioAnswerOptionFields;

package/src/components/FormComponents/ChoiceItems/ChoiceRadioAnswerOptionItem.tsx

@@ -15,111 +15,84 @@
  * limitations under the License.
  */
 
-import type { ChangeEvent } from 'react';
 import React from 'react';
 import Grid from '@mui/material/Grid';
-import { ChoiceItemOrientation } from '../../../interfaces/choice.enum';
+import type { ChoiceItemOrientation } from '../../../interfaces/choice.enum';
 import type { QuestionnaireItem, QuestionnaireResponseItem } from 'fhir/r4';
 import { findInAnswerOptions, getQrChoiceValue } from '../../../utils/choice';
-import ChoiceRadioSingle from './ChoiceRadioSingle';
 import { createEmptyQrItem } from '../../../utils/qrItem';
-import { QRadioGroup } from '../Item.styles';
 import { FullWidthFormComponentBox } from '../../Box.styles';
 import useRenderingExtensions from '../../../hooks/useRenderingExtensions';
 import type {
   PropsWithIsRepeatedAttribute,
+  PropsWithParentIsReadOnlyAttribute,
   PropsWithQrItemChangeHandler
 } from '../../../interfaces/renderProps.interface';
 import DisplayInstructions from '../DisplayItem/DisplayInstructions';
 import LabelWrapper from '../ItemParts/ItemLabelWrapper';
+import ChoiceRadioAnswerOptionFields from './ChoiceRadioAnswerOptionFields';
+import useReadOnly from '../../../hooks/useReadOnly';
 
 interface ChoiceRadioAnswerOptionItemProps
   extends PropsWithQrItemChangeHandler<QuestionnaireResponseItem>,
-    PropsWithIsRepeatedAttribute {
+    PropsWithIsRepeatedAttribute,
+    PropsWithParentIsReadOnlyAttribute {
   qItem: QuestionnaireItem;
   qrItem: QuestionnaireResponseItem;
   orientation: ChoiceItemOrientation;
 }
 
 function ChoiceRadioAnswerOptionItem(props: ChoiceRadioAnswerOptionItemProps) {
-  const { qItem, qrItem, isRepeated, onQrItemChange, orientation } = props;
+  const { qItem, qrItem, orientation, isRepeated, parentIsReadOnly, onQrItemChange } = props;
 
   // Init input value
   const qrChoiceRadio = qrItem ?? createEmptyQrItem(qItem);
   const valueRadio = getQrChoiceValue(qrChoiceRadio);
 
-  // Get additional rendering extensions
-  const { displayInstructions, readOnly } = useRenderingExtensions(qItem);
+  const readOnly = useReadOnly(qItem, parentIsReadOnly);
+  const { displayInstructions } = useRenderingExtensions(qItem);
 
   // Event handlers
-  function handleChange(e: ChangeEvent<HTMLInputElement>) {
+  function handleChange(newValue: string) {
     if (qItem.answerOption) {
-      const qrAnswer = findInAnswerOptions(qItem.answerOption, e.target.value);
+      const qrAnswer = findInAnswerOptions(qItem.answerOption, newValue);
       if (qrAnswer) {
         onQrItemChange({ ...createEmptyQrItem(qItem), answer: [qrAnswer] });
       }
     }
   }
 
-  const choiceRadio = (
-    <QRadioGroup
-      row={orientation === ChoiceItemOrientation.Horizontal}
-      name={qItem.text}
-      id={qItem.id}
-      onChange={handleChange}
-      value={valueRadio}
-      data-test="q-item-radio-group">
-      {qItem.answerOption?.map((option) => {
-        if (option['valueCoding']) {
-          return (
-            <ChoiceRadioSingle
-              key={option.valueCoding.code ?? ''}
-              value={option.valueCoding.code ?? ''}
-              label={option.valueCoding.display ?? `${option.valueCoding.code}`}
-              readOnly={readOnly}
-            />
-          );
-        } else if (option['valueString']) {
-          return (
-            <ChoiceRadioSingle
-              key={option.valueString}
-              value={option.valueString}
-              label={option.valueString}
-              readOnly={readOnly}
-            />
-          );
-        } else if (option['valueInteger']) {
-          return (
-            <ChoiceRadioSingle
-              key={option.valueInteger}
-              value={option.valueInteger.toString()}
-              label={option.valueInteger.toString()}
-              readOnly={readOnly}
-            />
-          );
-        } else {
-          return null;
-        }
-      })}
-    </QRadioGroup>
-  );
+  if (isRepeated) {
+    return (
+      <ChoiceRadioAnswerOptionFields
+        qItem={qItem}
+        valueRadio={valueRadio}
+        orientation={orientation}
+        readOnly={readOnly}
+        onCheckedChange={handleChange}
+      />
+    );
+  }
 
-  const renderQItemChoiceRadio = isRepeated ? (
-    <>{choiceRadio}</>
-  ) : (
+  return (
     <FullWidthFormComponentBox data-test="q-item-choice-radio-answer-option-box">
       <Grid container columnSpacing={6}>
         <Grid item xs={5}>
-          <LabelWrapper qItem={qItem} />
+          <LabelWrapper qItem={qItem} readOnly={readOnly} />
         </Grid>
         <Grid item xs={7}>
-          {choiceRadio}
-          <DisplayInstructions displayInstructions={displayInstructions} />
+          <ChoiceRadioAnswerOptionFields
+            qItem={qItem}
+            valueRadio={valueRadio}
+            orientation={orientation}
+            readOnly={readOnly}
+            onCheckedChange={handleChange}
+          />
+          <DisplayInstructions displayInstructions={displayInstructions} readOnly={readOnly} />
         </Grid>
       </Grid>
     </FullWidthFormComponentBox>
   );
-  return <>{renderQItemChoiceRadio}</>;
 }
 
 export default ChoiceRadioAnswerOptionItem;

package/src/components/FormComponents/ChoiceItems/ChoiceRadioAnswerValueSetFields.tsx

@@ -0,0 +1,83 @@
+/*
+ * Copyright 2023 Commonwealth Scientific and Industrial Research
+ * Organisation (CSIRO) ABN 41 687 119 230.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import React from 'react';
+import Typography from '@mui/material/Typography';
+import { ChoiceItemOrientation } from '../../../interfaces/choice.enum';
+import type { Coding, QuestionnaireItem } from 'fhir/r4';
+import ChoiceRadioSingle from './ChoiceRadioSingle';
+import { StyledRadioGroup } from '../Item.styles';
+import ErrorOutlineIcon from '@mui/icons-material/ErrorOutline';
+import { StyledAlert } from '../../Alert.styles';
+
+interface ChoiceRadioAnswerValueSetFieldsProps {
+  qItem: QuestionnaireItem;
+  codings: Coding[];
+  valueRadio: string | null;
+  orientation: ChoiceItemOrientation;
+  readOnly: boolean;
+  serverError: Error | null;
+  onCheckedChange: (newValue: string) => void;
+}
+
+function ChoiceRadioAnswerValueSetFields(props: ChoiceRadioAnswerValueSetFieldsProps) {
+  const { qItem, codings, valueRadio, orientation, readOnly, serverError, onCheckedChange } = props;
+
+  if (codings.length > 0) {
+    return (
+      <StyledRadioGroup
+        row={orientation === ChoiceItemOrientation.Horizontal}
+        name={qItem.text}
+        id={qItem.id}
+        onChange={(e) => onCheckedChange(e.target.value)}
+        value={valueRadio ?? null}>
+        {codings.map((coding: Coding) => {
+          return (
+            <ChoiceRadioSingle
+              key={coding.code ?? ''}
+              value={coding.code ?? ''}
+              label={coding.display ?? `${coding.code}`}
+              readOnly={readOnly}
+            />
+          );
+        })}
+      </StyledRadioGroup>
+    );
+  }
+
+  if (serverError) {
+    return (
+      <StyledAlert color="error">
+        <ErrorOutlineIcon color="error" sx={{ pr: 0.75 }} />
+        <Typography variant="subtitle2">
+          There was an error fetching options from the terminology server
+        </Typography>
+      </StyledAlert>
+    );
+  }
+
+  return (
+    <StyledAlert color="error">
+      <ErrorOutlineIcon color="error" sx={{ pr: 0.75 }} />
+      <Typography variant="subtitle2">
+        Unable to fetch options from the questionnaire or launch context
+      </Typography>
+    </StyledAlert>
+  );
+}
+
+export default ChoiceRadioAnswerValueSetFields;