-
Notifications
You must be signed in to change notification settings - Fork 178
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(app): add input screen for ODD numerical runtime parameters (#14858
- Loading branch information
Showing
15 changed files
with
299 additions
and
219 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
164 changes: 164 additions & 0 deletions
164
app/src/organisms/ProtocolSetupParameters/ChooseNumber.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| import * as React from 'react' | ||
| import { useTranslation } from 'react-i18next' | ||
| import { | ||
| ALIGN_CENTER, | ||
| DIRECTION_COLUMN, | ||
| Flex, | ||
| SPACING, | ||
| StyledText, | ||
| TYPOGRAPHY, | ||
| } from '@opentrons/components' | ||
| import { InputField } from '../../atoms/InputField' | ||
| import { useToaster } from '../ToasterOven' | ||
| import { ChildNavigation } from '../ChildNavigation' | ||
| import { NumericalKeyboard } from '../../atoms/SoftwareKeyboard' | ||
| import type { NumberParameter } from '@opentrons/shared-data' | ||
|
|
||
| interface ChooseNumberProps { | ||
| handleGoBack: () => void | ||
| parameter: NumberParameter | ||
| setParameter: (value: number, variableName: string) => void | ||
| } | ||
|
|
||
| export function ChooseNumber({ | ||
| handleGoBack, | ||
| parameter, | ||
| setParameter, | ||
| }: ChooseNumberProps): JSX.Element | null { | ||
| const { makeSnackbar } = useToaster() | ||
|
|
||
| const { i18n, t } = useTranslation(['protocol_setup', 'shared']) | ||
| const keyboardRef = React.useRef(null) | ||
| const [paramValue, setParamValue] = React.useState<string>( | ||
| String(parameter.value) | ||
| ) | ||
|
|
||
| // We need to arbitrarily set the value of the keyboard to a string the | ||
| // same length as the initial parameter value (as string) when the component mounts | ||
| // so that the delete button operates properly on the exisiting input field value. | ||
| const [prevKeyboardValue, setPrevKeyboardValue] = React.useState<string>('') | ||
| React.useEffect(() => { | ||
| const arbitraryInput = new Array(paramValue).join('*') | ||
| // @ts-expect-error keyboard should expose for `setInput` method | ||
| keyboardRef.current?.setInput(arbitraryInput) | ||
| setPrevKeyboardValue(arbitraryInput) | ||
| }, []) | ||
|
|
||
| if (parameter.type !== 'int' && parameter.type !== 'float') { | ||
| console.log(`Incorrect parameter type: ${parameter.type}`) | ||
| return null | ||
| } | ||
| const handleClickGoBack = (newValue: number): void => { | ||
| if (error != null) { | ||
| makeSnackbar(t('value_out_of_range_generic')) | ||
| } else { | ||
| setParameter(newValue, parameter.variableName) | ||
| handleGoBack() | ||
| } | ||
| } | ||
|
|
||
| const handleKeyboardInput = (e: string): void => { | ||
| if (prevKeyboardValue.length < e.length) { | ||
| const lastDigit = e.slice(-1) | ||
| if ( | ||
| !'.-'.includes(lastDigit) || | ||
| (lastDigit === '.' && !paramValue.includes('.')) || | ||
| (lastDigit === '-' && paramValue.length === 0) | ||
| ) { | ||
| setParamValue(paramValue + lastDigit) | ||
| } | ||
| } else { | ||
| setParamValue(paramValue.slice(0, paramValue.length - 1)) | ||
| } | ||
| setPrevKeyboardValue(e) | ||
| } | ||
|
|
||
| const paramValueAsNumber = Number(paramValue) | ||
| const resetValueDisabled = parameter.default === paramValueAsNumber | ||
| const { min, max } = parameter | ||
| const error = | ||
| paramValue === '' || | ||
| Number.isNaN(paramValueAsNumber) || | ||
| paramValueAsNumber < min || | ||
| paramValueAsNumber > max | ||
| ? t(`value_out_of_range`, { | ||
| min: parameter.type === 'int' ? min : min.toFixed(1), | ||
| max: parameter.type === 'int' ? max : max.toFixed(1), | ||
| }) | ||
| : null | ||
|
|
||
| return ( | ||
| <> | ||
| <ChildNavigation | ||
| header={i18n.format(parameter.displayName, 'sentenceCase')} | ||
| onClickBack={() => { | ||
| handleClickGoBack(paramValueAsNumber) | ||
| }} | ||
| buttonType="tertiaryLowLight" | ||
| buttonText={t('restore_default')} | ||
| onClickButton={() => | ||
| resetValueDisabled | ||
| ? makeSnackbar(t('no_custom_values')) | ||
| : setParamValue(String(parameter.default)) | ||
| } | ||
| /> | ||
| <Flex | ||
| alignSelf={ALIGN_CENTER} | ||
| gridGap={SPACING.spacing48} | ||
| paddingX={SPACING.spacing40} | ||
| padding={`${SPACING.spacing16} ${SPACING.spacing40} ${SPACING.spacing40}`} | ||
| marginTop="7.75rem" // using margin rather than justify due to content moving with error message | ||
| alignItems={ALIGN_CENTER} | ||
| height="22rem" | ||
| > | ||
| <Flex | ||
| width="30.5rem" | ||
| height="100%" | ||
| gridGap={SPACING.spacing24} | ||
| flexDirection={DIRECTION_COLUMN} | ||
| marginTop="7.75rem" | ||
| > | ||
| <StyledText as="h4" textAlign={TYPOGRAPHY.textAlignLeft}> | ||
| {parameter.description} | ||
| </StyledText> | ||
| <InputField | ||
| type="text" | ||
| units={parameter.suffix} | ||
| placeholder={parameter.default.toString()} | ||
| value={paramValue} | ||
| title={parameter.displayName} | ||
| caption={ | ||
| parameter.type === 'int' | ||
| ? `${parameter.min}-${parameter.max}` | ||
| : `${parameter.min.toFixed(1)}-${parameter.max.toFixed(1)}` | ||
| } | ||
| error={error} | ||
| onChange={e => { | ||
| const updatedValue = | ||
| parameter.type === 'int' | ||
| ? Math.round(e.target.valueAsNumber) | ||
| : e.target.valueAsNumber | ||
| setParamValue( | ||
| Number.isNaN(updatedValue) ? '' : String(updatedValue) | ||
| ) | ||
| }} | ||
| /> | ||
| </Flex> | ||
| <Flex | ||
| paddingX={SPACING.spacing24} | ||
| height="21.25rem" | ||
| marginTop="7.75rem" | ||
| > | ||
| <NumericalKeyboard | ||
| keyboardRef={keyboardRef} | ||
| isDecimal={parameter.type === 'float'} | ||
| hasHyphen | ||
| onChange={e => { | ||
| handleKeyboardInput(e) | ||
| }} | ||
| /> | ||
| </Flex> | ||
| </Flex> | ||
| </> | ||
| ) | ||
| } |
Oops, something went wrong.