feat(date-picker): make locale prop optional

lumapps · Sep 28, 2023 · 5c393c6 · 5c393c6
1 parent d040e53
commit 5c393c6
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 -   `@lumx/react` no long depend on `moment` or `moment-range` to generate the date picker.
 -   Deprecated `@lumx/core/js/date-picker` functions that **will be removed in the next major version** along with `moment` and `moment-range`.
+-   DatePicker & DatePickerField: `locale` prop is now optional (uses browser locale by default)
 
 ## [3.5.3][] - 2023-08-30
 

diff --git a/packages/lumx-react/src/components/date-picker/DatePickerControlled.tsx b/packages/lumx-react/src/components/date-picker/DatePickerControlled.tsx
@@ -7,6 +7,7 @@ import { getMonthCalendar } from '@lumx/react/utils/date/getMonthCalendar';
 import { isSameDay } from '@lumx/react/utils/date/isSameDay';
 import { formatMonthYear } from '@lumx/react/utils/date/formatMonthYear';
 import { formatDayNumber } from '@lumx/react/utils/date/formatDayNumber';
+import { getCurrentLocale } from '@lumx/react/utils/locale/getCurrentLocale';
 import { CLASSNAME } from './constants';
 
 /**
@@ -35,7 +36,7 @@ const COMPONENT_NAME = 'DatePickerControlled';
  */
 export const DatePickerControlled: Comp<DatePickerControlledProps, HTMLDivElement> = forwardRef((props, ref) => {
     const {
-        locale,
+        locale = getCurrentLocale(),
         maxDate,
         minDate,
         nextButtonProps,

diff --git a/packages/lumx-react/src/components/date-picker/DatePickerField.stories.tsx b/packages/lumx-react/src/components/date-picker/DatePickerField.stories.tsx
@@ -8,7 +8,6 @@ export default {
     component: DatePickerField,
     args: {
         ...DatePickerField.defaultProps,
-        locale: 'fr',
         'nextButtonProps.label': 'Next month',
         'previousButtonProps.label': 'Previous month',
     },

diff --git a/packages/lumx-react/src/components/date-picker/DatePickerField.tsx b/packages/lumx-react/src/components/date-picker/DatePickerField.tsx
@@ -5,6 +5,7 @@ import { useFocusTrap } from '@lumx/react/hooks/useFocusTrap';
 import { useFocus } from '@lumx/react/hooks/useFocus';
 import { Comp, GenericProps } from '@lumx/react/utils/type';
 import { formatDate } from '@lumx/react/utils/date/formatDate';
+import { getCurrentLocale } from '@lumx/react/utils/locale/getCurrentLocale';
 
 /**
  * Defines the props of the component.
@@ -15,7 +16,7 @@ export interface DatePickerFieldProps extends GenericProps {
     /** Whether the component is disabled or not. */
     isDisabled?: boolean;
     /** Locale (language or region) to use. */
-    locale: string;
+    locale?: string;
     /** Date after which dates can't be selected. */
     maxDate?: Date;
     /** Date before which dates can't be selected. */
@@ -50,7 +51,7 @@ export const DatePickerField: Comp<DatePickerFieldProps, HTMLDivElement> = forwa
         defaultMonth,
         disabled,
         isDisabled = disabled,
-        locale,
+        locale = getCurrentLocale(),
         maxDate,
         minDate,
         name,

diff --git a/packages/lumx-react/src/components/date-picker/types.ts b/packages/lumx-react/src/components/date-picker/types.ts
@@ -9,7 +9,7 @@ export interface DatePickerProps extends GenericProps {
     /** Default month. */
     defaultMonth?: Date;
     /** Locale (language or region) to use. */
-    locale: string;
+    locale?: string;
     /** Date after which dates can't be selected. */
     maxDate?: Date;
     /** Date before which dates can't be selected. */