Skip to content

Input: Use Web Awesome slider component in InputRange #1630

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

Draft
samuel-duhaime wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Input: Use Web Awesome slider component in InputRange #1630

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion packages/evolution-frontend/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
"@deck.gl/react": "^9.1.14",
"@fortawesome/fontawesome-svg-core": "^7.1.0",
"@fortawesome/free-solid-svg-icons": "^7.1.0",
"@awesome.me/webawesome": "3.8.0",
"@fortawesome/react-fontawesome": "^3.1.1",
"@luma.gl/core": "^9.1.9",
"@luma.gl/shadertools": "^9.1.9",
Expand Down Expand Up @@ -63,7 +64,6 @@
"react-datepicker": "^9.1.0",
"react-dom": "^19.2.3",
"react-i18next": "^16.5.3",
"react-input-range": "^1.3.0",
"react-map-gl": "^8.0.4",
"react-markdown": "^10.1.0",
"react-modal": "^3.16.3",
Expand Down
131 changes: 77 additions & 54 deletions packages/evolution-frontend/src/components/inputs/InputRange.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,10 @@
* License text available at https://opensource.org/licenses/MIT
*/
import React from 'react';
// TODO this package hasn't been updated in a while. Consider changing for a more maintained one
import ReactInputRange, { Range } from 'react-input-range';
import '@awesome.me/webawesome/dist/styles/webawesome.css';
import '@awesome.me/webawesome/dist/components/slider/slider.js';
import type WaSliderElement from '@awesome.me/webawesome/dist/components/slider/slider.js';
import { useTranslation } from 'react-i18next';
import defaultClassNames from 'react-input-range/src/js/input-range/default-class-names';
import 'react-input-range/lib/css/index.css';

import { _isBlank } from 'chaire-lib-common/lib/utils/LodashExtensions';
import { InputRangeType } from 'evolution-common/lib/services/questionnaire/types';
Expand All @@ -19,77 +18,78 @@ import InputCheckbox from 'chaire-lib-frontend/lib/components/input/InputCheckbo

export type InputRangeProps = CommonInputProps & {
value?: number | 'na';
inputRef?: React.LegacyRef<ReactInputRange>;
inputRef?: React.Ref<WaSliderElement>;
widgetConfig: InputRangeType;
};

const setSliderRef = (
element: WaSliderElement | null,
inputRef: InputRangeProps['inputRef'],
trackClassName: string | undefined,
valueFormatter?: (value: number, lang: string) => string,
language?: string
) => {
if (typeof inputRef === 'function') {
inputRef(element);
} else if (inputRef) {
(inputRef as React.MutableRefObject<WaSliderElement | null>).current = element;
}

if (!element) {
return;
}

if (trackClassName) {
element.classList.add(trackClassName, 'survey-question__input-range_slider--colored');
}

element.valueFormatter =
valueFormatter !== undefined ? (value) => valueFormatter(value, language || 'en') : (value) => String(value);
};

export const InputRange = (props: InputRangeProps) => {
const [value, setValue] = React.useState<number | Range | undefined | 'na'>(props.value);
const [value, setValue] = React.useState<number | undefined | 'na'>(props.value);
const { t, i18n } = useTranslation();

const labels = props.widgetConfig.labels;
const labelItems = labels
const formatLabelFct = props.widgetConfig.formatLabel;

const maxValue: number = !_isBlank(props.widgetConfig.maxValue) ? props.widgetConfig.maxValue || 100 : 100;
const minValue: number = !_isBlank(props.widgetConfig.minValue) ? props.widgetConfig.minValue || 0 : 0;
const sliderValue = typeof value === 'number' && value >= minValue ? value : minValue;
const isDisabled = typeof value === 'string';
const trackClassName = props.widgetConfig.trackClassName;

const handleInput = (event: Event) => {
setValue((event.target as WaSliderElement).value);
};

const handleChange = (event: Event) => {
const newValue = (event.target as WaSliderElement).value;
if (typeof newValue === 'number' && newValue < minValue) {
props.onValueChange({ target: { value: null } });
} else {
props.onValueChange({ target: { value: newValue } });
}
};

const referenceLabels = labels
? labels.map((label, idx) => {
const labelStr = surveyHelper.translateString(label, i18n, props.interview, props.path, props.user);
return (
<p
key={`inputRange_${props.id}_label_${idx}`}
className={`__input-range_input_container_label${
idx > 0 && idx < labels.length - 1
? ' __input-range_input_container_label_middle'
: idx === labels.length - 1
? ' __input-range_input_container_label_last'
: ''
}`}
>
<span key={`inputRange_${props.id}_label_${idx}`} slot="reference">
{labelStr}
</p>
</span>
);
})
: [];

if (props.widgetConfig.trackClassName) {
defaultClassNames.track = props.widgetConfig.trackClassName;
}

const formatLabelFct = props.widgetConfig.formatLabel;

const maxValue: number = !_isBlank(props.widgetConfig.maxValue) ? props.widgetConfig.maxValue || 100 : 100;
const minValue: number = !_isBlank(props.widgetConfig.minValue) ? props.widgetConfig.minValue || -10 : -10;

return (
<div
className={`survey-question__input-range_input_container_with_labels${
_isBlank(value) ? ' input-blank' : ''
}`}
>
<ReactInputRange
name={props.id}
ariaLabelledby={`${props.id}_label`}
// defaultValue = {_isBlank(this.props.value) ? this.props.widgetConfig.defaultValue : this.props.value }
ref={props.inputRef}
maxValue={maxValue as number | undefined}
minValue={minValue as number | undefined}
formatLabel={
formatLabelFct !== undefined
? (value) => formatLabelFct(value, i18n.language)
: (value) => String(value)
}
value={typeof value === 'number' && value >= minValue ? value : minValue}
classNames={defaultClassNames}
disabled={typeof value === 'string'}
onChange={(value) => setValue(value)}
onChangeComplete={(value) => {
if (typeof value === 'number' && value < minValue) {
props.onValueChange({ target: { value: null } });
} else {
props.onValueChange({ target: { value } });
}
}}
/>
{labelItems.length > 0 && (
<div className={'survey-question__input-range_input_labels_container'}>{labelItems}</div>
)}
{props.widgetConfig.includeNotApplicable === true && (
<InputCheckbox
id={`${props.id}_na`}
Expand Down Expand Up @@ -118,6 +118,29 @@ export const InputRange = (props: InputRangeProps) => {
]}
/>
)}

<wa-slider
ref={(element) => setSliderRef(element, props.inputRef, trackClassName, formatLabelFct, i18n.language)}
name={props.id}
min={minValue}
max={maxValue}
value={sliderValue}
indicatorOffset={minValue}
disabled={isDisabled}
withTooltip={true}
aria-labelledby={`${props.id}_label`}
className={[
'survey-question__input-range_slider',
trackClassName && 'survey-question__input-range_slider--colored',
trackClassName
]
.filter(Boolean)
.join(' ')}
onInput={handleInput}
onChange={handleChange}
>
{referenceLabels}
</wa-slider>
</div>
);
};
Expand Down
Loading
Loading