-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Feature #2717: dcc.DateRangeSlider and dcc.DateSlider #3802
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.
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
base: dev
Are you sure you want to change the base?
Changes from 4 commits
2e324e3
b7fd4e5
dcda40d
d573c44
28e7678
0bbb325
fed4f06
090700a
bb4b689
cf6a111
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| import React, {lazy, Suspense} from 'react'; | ||
| import {PersistedProps, PersistenceTypes, DateRangeSliderProps} from '../types'; | ||
| import dateRangeSlider from '../utils/LazyLoader/dateRangeSlider'; | ||
|
|
||
| import './css/sliders.css'; | ||
|
|
||
| const RealDateRangeSlider = lazy(dateRangeSlider); | ||
|
|
||
| /** | ||
| * A date range slider component. | ||
| * Used for specifying a range of dates with optional disabled date indicators | ||
| * and calendar-aware stepping. | ||
| */ | ||
| export default function DateRangeSlider({ | ||
| updatemode = 'mouseup', | ||
| // eslint-disable-next-line @typescript-eslint/no-unused-vars | ||
| persisted_props = [PersistedProps.value], | ||
| // eslint-disable-next-line @typescript-eslint/no-unused-vars | ||
| persistence_type = PersistenceTypes.local, | ||
| // eslint-disable-next-line no-magic-numbers | ||
| verticalHeight = 400, | ||
| allow_direct_input = true, | ||
| disabled_dates_indicator = true, | ||
| ...props | ||
| }: DateRangeSliderProps) { | ||
|
Check warning on line 25 in components/dash-core-components/src/components/DateRangeSlider.tsx
|
||
| return ( | ||
| <Suspense fallback={null}> | ||
| <RealDateRangeSlider | ||
| updatemode={updatemode} | ||
| verticalHeight={verticalHeight} | ||
| allow_direct_input={allow_direct_input} | ||
| disabled_dates_indicator={disabled_dates_indicator} | ||
| {...props} | ||
| /> | ||
| </Suspense> | ||
| ); | ||
| } | ||
|
|
||
| DateRangeSlider.dashPersistence = { | ||
| persisted_props: [PersistedProps.value], | ||
| persistence_type: PersistenceTypes.local, | ||
| }; | ||
| Original file line number | Diff line number | Diff line change | ||
|---|---|---|---|---|
| @@ -0,0 +1,134 @@ | ||||
| import React, {lazy, Suspense, useCallback, useMemo, useState} from 'react'; | ||||
| import {omit} from 'ramda'; | ||||
| import DatePickerSingle from '../components/DatePickerSingle'; | ||||
| import { | ||||
| PersistedProps, | ||||
| PersistenceTypes, | ||||
| DateSliderProps, | ||||
| DateRangeSliderProps, | ||||
| } from '../types'; | ||||
| import dateRangeSlider from '../utils/LazyLoader/dateRangeSlider'; | ||||
| import './css/sliders.css'; | ||||
|
|
||||
| const RealSlider = lazy(dateRangeSlider); | ||||
|
|
||||
| /** | ||||
| * A slider component for selecting a single date. | ||||
| * This is a wrapper around DateRangeSlider that handles date values. | ||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Best to remove the comment about the wrapper since it doesn't add value when users see the docstring |
||||
| */ | ||||
| export default function DateSlider({ | ||||
| updatemode = 'mouseup', | ||||
| // eslint-disable-next-line @typescript-eslint/no-unused-vars | ||||
| persisted_props = [PersistedProps.value], | ||||
| // eslint-disable-next-line @typescript-eslint/no-unused-vars | ||||
| persistence_type = PersistenceTypes.local, | ||||
| // eslint-disable-next-line no-magic-numbers | ||||
| verticalHeight = 400, | ||||
| allow_direct_input = true, | ||||
| setProps, | ||||
| value, | ||||
| drag_value, | ||||
| id, | ||||
| vertical = false, | ||||
| min, | ||||
| max, | ||||
| display_format, | ||||
| ...props | ||||
| }: DateSliderProps) { | ||||
|
Check warning on line 37 in components/dash-core-components/src/components/DateSlider.tsx
|
||||
| const [resetKey, setResetKey] = useState(0); | ||||
|
|
||||
| // Convert single date value to array for DateRangeSlider | ||||
| const mappedValue: DateRangeSliderProps['value'] = useMemo(() => { | ||||
| return value ? [value] : value; | ||||
| }, [value]); | ||||
|
|
||||
| // Convert single date drag value to array for DateRangeSlider | ||||
| const mappedDragValue: DateRangeSliderProps['drag_value'] = useMemo(() => { | ||||
| return drag_value ? [drag_value] : undefined; | ||||
| }, [drag_value]); | ||||
|
|
||||
| const mappedSetProps: DateRangeSliderProps['setProps'] = useCallback( | ||||
| newProps => { | ||||
| const {value, drag_value} = newProps; | ||||
| const mappedProps: Partial<DateSliderProps> = omit( | ||||
| ['value', 'drag_value', 'setProps'], | ||||
| newProps | ||||
| ); | ||||
| if ('value' in newProps) { | ||||
| mappedProps.value = value ? value[0] : value; | ||||
| } | ||||
| if ('drag_value' in newProps) { | ||||
| mappedProps.drag_value = drag_value | ||||
| ? drag_value[0] | ||||
| : drag_value; | ||||
| } | ||||
| setProps(mappedProps); | ||||
| }, | ||||
| [setProps] | ||||
| ); | ||||
|
|
||||
| const handleDateInputChange = useCallback( | ||||
| (dateStr: `${string}-${string}-${string}` | undefined) => { | ||||
| if (!dateStr) { | ||||
| setProps({ | ||||
| value: | ||||
| (min as `${string}-${string}-${string}`) ?? undefined, | ||||
| }); | ||||
| return; | ||||
| } | ||||
| const hasNoChange = value === dateStr; | ||||
| if (hasNoChange) { | ||||
| setResetKey(k => k + 1); | ||||
| } else { | ||||
| setProps({value: dateStr}); | ||||
| } | ||||
| }, | ||||
| [value, setProps, min] | ||||
| ); | ||||
|
|
||||
| return ( | ||||
| <div | ||||
| style={{ | ||||
| display: 'flex', | ||||
| flexDirection: vertical ? 'column' : 'row', | ||||
| gap: '10px', | ||||
| }} | ||||
| > | ||||
| {allow_direct_input && ( | ||||
| <DatePickerSingle | ||||
| key={`date-input-${resetKey}`} | ||||
| className="dash-range-slider-input" | ||||
| date={value ?? undefined} | ||||
| setProps={({date}) => handleDateInputChange(date)} | ||||
| min_date_allowed={min} | ||||
| max_date_allowed={max} | ||||
| display_format={display_format} | ||||
| /> | ||||
| )} | ||||
| <div style={{flex: 1, minWidth: 0}}> | ||||
| <Suspense fallback={null}> | ||||
| <RealSlider | ||||
| key={resetKey} | ||||
| id={id} | ||||
| updatemode={updatemode} | ||||
| verticalHeight={verticalHeight} | ||||
| allow_direct_input={false} | ||||
| vertical={vertical} | ||||
| min={min} | ||||
| max={max} | ||||
| display_format={display_format} | ||||
| value={mappedValue} | ||||
| drag_value={mappedDragValue} | ||||
| setProps={mappedSetProps} | ||||
| {...props} | ||||
| /> | ||||
| </Suspense> | ||||
| </div> | ||||
| </div> | ||||
| ); | ||||
| } | ||||
|
|
||||
| DateSlider.dashPersistence = { | ||||
| persisted_props: [PersistedProps.value], | ||||
| persistence_type: PersistenceTypes.local, | ||||
| }; | ||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.