Merge pull request #127 from UgnisSoftware/UGN-361

chore UGN-361 - update docs and set parseRaw: true as default

Author: JulitorK

README.md

@@ -181,9 +181,10 @@ import { ReactSpreadsheetImport, StepType } from "react-spreadsheet-import";
 ### Dates and time
 
 Excel stores dates and times as numbers - offsets from an epoch. When reading xlsx files SheetJS provides date formatting helpers.
-**Default date import format** is `yyyy-mm-dd`. This format can be changed using **dateFormat** property.
+**Default date import format** is `yyyy-mm-dd`. Date parsing with SheetJS sometimes yields unexpected results, therefore thorough date validations are recommended.
 
-- **dateFormat** - can be used to format dates when importing sheet data.
+- **dateFormat** - sets SheetJS `dateNF` option. Can be used to format dates when importing sheet data.
+- **parseRaw** - sets SheetJS `raw` option. If `true`, date formatting will be applied to XLSX date fields only. Default is `true`
 
 Common date-time formats can be viewed [here](https://docs.sheetjs.com/docs/csf/features/dates/#date-and-time-number-formats).
 

src/ReactSpreadsheetImport.tsx

@@ -18,7 +18,7 @@ export const defaultRSIProps: Partial<RsiProps<any>> = {
   selectHeaderStepHook: async (headerValues, data) => ({ headerValues, data }),
   matchColumnsStepHook: async (table) => table,
   dateFormat: "yyyy-mm-dd", // ISO 8601,
-  parseRaw: false,
+  parseRaw: true,
 } as const
 
 export const ReactSpreadsheetImport = <T extends string>(props: RsiProps<T>) => {

src/types.ts

@@ -39,9 +39,9 @@ export type RsiProps<T extends string> = {
   autoMapDistance?: number
   // Initial Step state to be rendered on load
   initialStepState?: StepState
-  // Date format to use e.g. "yyyy-mm-dd hh:mm:ss", "m/d/yy h:mm", 'mmm-yy', etc.
+  // Sets SheetJS dateNF option. If date parsing is applied, date will be formatted e.g. "yyyy-mm-dd hh:mm:ss", "m/d/yy h:mm", 'mmm-yy', etc.
   dateFormat?: string
-  //Skips parsing of values e.g. date
+  // Sets SheetJS "raw" option. If true, parsing will only be applied to xlsx date fields.
   parseRaw?: boolean
 }