@bsol-oss/react-datatable5 12.0.0-beta.91 → 12.0.0-beta.93

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. package/README.md +17 -0
  2. package/dist/index.d.ts +12 -6
  3. package/dist/index.js +490 -287
  4. package/dist/index.mjs +490 -288
  5. package/dist/types/components/DataTable/context/useDataTableServerContext.d.ts +1 -1
  6. package/dist/types/components/DataTable/controls/ReloadButton.d.ts +1 -1
  7. package/dist/types/components/DataTable/display/RecordDisplay.d.ts +2 -2
  8. package/dist/types/components/Form/SchemaFormContext.d.ts +2 -1
  9. package/dist/types/components/Form/components/core/FormRoot.d.ts +3 -4
  10. package/dist/types/components/Form/components/fields/ArrayRenderer.d.ts +1 -1
  11. package/dist/types/components/Form/components/fields/StringInputField.d.ts +0 -1
  12. package/dist/types/components/Form/components/fields/TextAreaInput.d.ts +0 -5
  13. package/dist/types/components/Form/components/types/CustomJSONSchema7.d.ts +8 -0
  14. package/dist/types/components/Form/components/viewers/ArrayViewer.d.ts +1 -1
  15. package/dist/types/components/Form/components/viewers/BooleanViewer.d.ts +1 -1
  16. package/dist/types/components/Form/components/viewers/DateTimeViewer.d.ts +1 -1
  17. package/dist/types/components/Form/components/viewers/DateViewer.d.ts +1 -1
  18. package/dist/types/components/Form/components/viewers/IdViewer.d.ts +1 -1
  19. package/dist/types/components/Form/components/viewers/ObjectViewer.d.ts +1 -1
  20. package/dist/types/components/Form/components/viewers/RecordViewer.d.ts +2 -2
  21. package/dist/types/components/Form/components/viewers/StringViewer.d.ts +1 -6
  22. package/dist/types/components/Form/components/viewers/TextAreaViewer.d.ts +1 -6
  23. package/dist/types/components/Form/components/viewers/TimeViewer.d.ts +1 -1
  24. package/dist/types/components/Form/utils/useFormI18n.d.ts +5 -3
  25. package/dist/types/components/ui/pagination.d.ts +10 -7
  26. package/package.json +4 -4
package/README.md CHANGED
@@ -297,6 +297,23 @@ All validation types are fully supported across all languages with culturally ap
297
297
 
298
298
  For more details of props and examples, please review the stories in storybook platform.
299
299
 
300
+ ## Documentation
301
+
302
+ Additional documentation is available in the `docs/` directory:
303
+
304
+ ### General Guides
305
+
306
+ - **[DataTable Server Usage](./docs/DATATABLE_SERVER_USAGE.md)** - Server-side DataTable integration guide
307
+ - **[DefaultForm Usage](./docs/DEFAULTFORM_USAGE.md)** - Comprehensive form component guide
308
+ - **[Validation & i18n](./docs/VALIDATION_I18N.md)** - Validation and internationalization setup
309
+ - **[Deployment Guide](./docs/deployment.md)** - Deployment instructions
310
+
311
+ ### IdPicker Customization
312
+
313
+ - **[IdPicker Quick Reference](./docs/IDPICKER_QUICK_REFERENCE.md)** - ⚡ Quick guide to IdPicker customization
314
+ - **[IdPicker Custom Display](./docs/IDPICKER_CUSTOM_DISPLAY.md)** - Customize how items appear in the combobox
315
+ - **[IdPicker Labels](./docs/IDPICKER_LABELS.md)** - Customize UI labels (buttons, placeholders, messages)
316
+
300
317
  ## Development
301
318
 
302
319
  ```
package/dist/index.d.ts CHANGED
@@ -108,7 +108,7 @@ declare const ViewDialog: ({ icon }: EditViewButtonProps) => react_jsx_runtime.J
108
108
  interface ReloadButtonProps {
109
109
  variant?: string;
110
110
  }
111
- declare const ReloadButton: ({ variant, }: ReloadButtonProps) => react_jsx_runtime.JSX.Element;
111
+ declare const ReloadButton: ({ variant }: ReloadButtonProps) => react_jsx_runtime.JSX.Element;
112
112
 
113
113
  declare const GlobalFilter: () => react_jsx_runtime.JSX.Element;
114
114
 
@@ -522,7 +522,6 @@ type CustomQueryFn = (params: CustomQueryFnParams) => Promise<CustomQueryFnRespo
522
522
  interface ForeignKeyProps {
523
523
  column: string;
524
524
  table: string;
525
- display_column: string;
526
525
  customQueryFn?: CustomQueryFn;
527
526
  }
528
527
 
@@ -791,6 +790,13 @@ interface FilePickerLabels {
791
790
  uploading?: string;
792
791
  uploadFailed?: string;
793
792
  }
793
+ interface FormButtonLabels {
794
+ submit?: string;
795
+ reset?: string;
796
+ cancel?: string;
797
+ confirm?: string;
798
+ submitAgain?: string;
799
+ }
794
800
  interface CustomJSONSchema7 extends JSONSchema7 {
795
801
  gridColumn?: string;
796
802
  gridRow?: string;
@@ -819,6 +825,7 @@ interface CustomJSONSchema7 extends JSONSchema7 {
819
825
  errorMessages?: Partial<Record<ValidationErrorType | string, string>>;
820
826
  filePicker?: FilePickerProps;
821
827
  }
828
+ declare const defaultRenderDisplay: (item: unknown) => ReactNode;
822
829
  interface TagPickerProps {
823
830
  column: string;
824
831
  schema: CustomJSONSchema7;
@@ -868,13 +875,13 @@ interface FormRootProps<TData extends FieldValues> {
868
875
  idPickerLabels?: IdPickerLabels;
869
876
  enumPickerLabels?: EnumPickerLabels;
870
877
  filePickerLabels?: FilePickerLabels;
878
+ formButtonLabels?: FormButtonLabels;
871
879
  insideDialog?: boolean;
872
880
  }
873
881
  interface CustomJSONSchema7Definition extends JSONSchema7 {
874
882
  variant: string;
875
883
  in_table: string;
876
884
  column_ref: string;
877
- display_column: string;
878
885
  gridColumn: string;
879
886
  gridRow: string;
880
887
  foreign_key: ForeignKeyProps$1;
@@ -883,9 +890,8 @@ interface CustomJSONSchema7Definition extends JSONSchema7 {
883
890
  declare const idPickerSanityCheck: (column: string, foreign_key?: {
884
891
  table?: string | undefined;
885
892
  column?: string | undefined;
886
- display_column?: string | undefined;
887
893
  } | undefined) => void;
888
- declare const FormRoot: <TData extends FieldValues>({ schema, idMap, setIdMap, form, serverUrl, translate, children, order, ignore, include, onSubmit, rowNumber, requestOptions, getUpdatedData, customErrorRenderer, customSuccessRenderer, displayConfig, requireConfirmation, dateTimePickerLabels, idPickerLabels, enumPickerLabels, filePickerLabels, insideDialog, }: FormRootProps<TData>) => react_jsx_runtime.JSX.Element;
894
+ declare const FormRoot: <TData extends FieldValues>({ schema, idMap, setIdMap, form, serverUrl, translate, children, order, ignore, include, onSubmit, rowNumber, requestOptions, getUpdatedData, customErrorRenderer, customSuccessRenderer, displayConfig, requireConfirmation, dateTimePickerLabels, idPickerLabels, enumPickerLabels, filePickerLabels, formButtonLabels, insideDialog, }: FormRootProps<TData>) => react_jsx_runtime.JSX.Element;
889
895
 
890
896
  interface DefaultFormProps<TData extends FieldValues> {
891
897
  formConfig: Omit<FormRootProps<TData>, "children">;
@@ -1255,4 +1261,4 @@ declare module '@tanstack/react-table' {
1255
1261
  }
1256
1262
  }
1257
1263
 
1258
- export { type CalendarProps, CardHeader, type CardHeaderProps, type CustomJSONSchema7, type CustomJSONSchema7Definition, DataDisplay, type DataDisplayProps, type DataResponse, DataTable, type DataTableDefaultState, type DataTableProps, DataTableServer, type DataTableServerProps, DatePickerInput, type DatePickerInputProps, type DatePickerLabels, type DatePickerProps, type DateTimePickerLabels, DefaultCardTitle, DefaultForm, type DefaultFormProps, DefaultTable, type DefaultTableProps, DefaultTableServer, type DefaultTableServerProps, DensityToggleButton, type DensityToggleButtonProps, type EditFilterButtonProps, EditSortingButton, type EditSortingButtonProps, type EditViewButtonProps, EmptyState, type EmptyStateProps, type EnumPickerLabels, ErrorAlert, type ErrorAlertProps, type ErrorMessageConfig, type ErrorMessageResult, type FieldErrorConfig, type FilePickerLabels, type FilePickerMediaFile, type FilePickerProps, FilterDialog, FormBody, FormRoot, type FormRootProps, FormTitle, type GetColumnsConfigs, type GetDateColorProps, type GetMultiDatesProps, type GetRangeDatesProps, type GetStyleProps, type GetVariantProps, GlobalFilter, type IdPickerLabels, MediaLibraryBrowser, type MediaLibraryBrowserProps, PageSizeControl, type PageSizeControlProps, Pagination, type QueryParams, type RangeCalendarProps, type RangeDatePickerLabels, type RangeDatePickerProps, RecordDisplay, type RecordDisplayProps, ReloadButton, type ReloadButtonProps, ResetFilteringButton, ResetSelectionButton, ResetSortingButton, type Result, RowCountText, SelectAllRowsToggle, type SelectAllRowsToggleProps, Table, TableBody, type TableBodyProps, TableCardContainer, type TableCardContainerProps, TableCards, type TableCardsProps, TableComponent, TableControls, type TableControlsProps, TableDataDisplay, type TableDataDisplayProps, TableFilter, TableFilterTags, TableFooter, type TableFooterProps, TableHeader, type TableHeaderProps, type TableHeaderTexts, TableLoadingComponent, type TableLoadingComponentProps, type TableProps, type TableRendererProps, type TableRowSelectorProps, TableSelector, TableSorter, TableViewer, type TagPickerProps, TextCell, type TextCellProps, type UseDataTableProps, type UseDataTableReturn, type UseDataTableServerProps, type UseDataTableServerReturn, type UseFormProps, type ValidationErrorType, ViewDialog, buildErrorMessages, buildFieldErrors, buildRequiredErrors, convertToAjvErrorsFormat, createErrorMessage, getColumns, getMultiDates, getRangeDates, idPickerSanityCheck, useDataTable, useDataTableContext, useDataTableServer, useForm, widthSanityCheck };
1264
+ export { type CalendarProps, CardHeader, type CardHeaderProps, type CustomJSONSchema7, type CustomJSONSchema7Definition, DataDisplay, type DataDisplayProps, type DataResponse, DataTable, type DataTableDefaultState, type DataTableProps, DataTableServer, type DataTableServerProps, DatePickerInput, type DatePickerInputProps, type DatePickerLabels, type DatePickerProps, type DateTimePickerLabels, DefaultCardTitle, DefaultForm, type DefaultFormProps, DefaultTable, type DefaultTableProps, DefaultTableServer, type DefaultTableServerProps, DensityToggleButton, type DensityToggleButtonProps, type EditFilterButtonProps, EditSortingButton, type EditSortingButtonProps, type EditViewButtonProps, EmptyState, type EmptyStateProps, type EnumPickerLabels, ErrorAlert, type ErrorAlertProps, type ErrorMessageConfig, type ErrorMessageResult, type FieldErrorConfig, type FilePickerLabels, type FilePickerMediaFile, type FilePickerProps, FilterDialog, FormBody, type FormButtonLabels, FormRoot, type FormRootProps, FormTitle, type GetColumnsConfigs, type GetDateColorProps, type GetMultiDatesProps, type GetRangeDatesProps, type GetStyleProps, type GetVariantProps, GlobalFilter, type IdPickerLabels, MediaLibraryBrowser, type MediaLibraryBrowserProps, PageSizeControl, type PageSizeControlProps, Pagination, type QueryParams, type RangeCalendarProps, type RangeDatePickerLabels, type RangeDatePickerProps, RecordDisplay, type RecordDisplayProps, ReloadButton, type ReloadButtonProps, ResetFilteringButton, ResetSelectionButton, ResetSortingButton, type Result, RowCountText, SelectAllRowsToggle, type SelectAllRowsToggleProps, Table, TableBody, type TableBodyProps, TableCardContainer, type TableCardContainerProps, TableCards, type TableCardsProps, TableComponent, TableControls, type TableControlsProps, TableDataDisplay, type TableDataDisplayProps, TableFilter, TableFilterTags, TableFooter, type TableFooterProps, TableHeader, type TableHeaderProps, type TableHeaderTexts, TableLoadingComponent, type TableLoadingComponentProps, type TableProps, type TableRendererProps, type TableRowSelectorProps, TableSelector, TableSorter, TableViewer, type TagPickerProps, TextCell, type TextCellProps, type UseDataTableProps, type UseDataTableReturn, type UseDataTableServerProps, type UseDataTableServerReturn, type UseFormProps, type ValidationErrorType, ViewDialog, buildErrorMessages, buildFieldErrors, buildRequiredErrors, convertToAjvErrorsFormat, createErrorMessage, defaultRenderDisplay, getColumns, getMultiDates, getRangeDates, idPickerSanityCheck, useDataTable, useDataTableContext, useDataTableServer, useForm, widthSanityCheck };