@openmrs/esm-framework 6.2.1-pre.2884 → 6.2.1-pre.2917

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 (7) hide show
  1. package/.turbo/turbo-build.log +3 -6
  2. package/dist/openmrs-esm-framework.js +1 -1
  3. package/dist/openmrs-esm-framework.js.LICENSE.txt +10 -0
  4. package/dist/openmrs-esm-framework.js.map +1 -1
  5. package/docs/API.md +30 -3
  6. package/docs/interfaces/OpenmrsDatePickerProps.md +20 -20
  7. package/package.json +18 -18
package/docs/API.md CHANGED
@@ -233,6 +233,7 @@
233
233
  - [useLayoutType](API.md#uselayouttype)
234
234
  - [useLeftNavStore](API.md#useleftnavstore)
235
235
  - [useOnClickOutside](API.md#useonclickoutside)
236
+ - [useOnVisible](API.md#useonvisible)
236
237
  - [useOpenmrsFetchAll](API.md#useopenmrsfetchall)
237
238
  - [useOpenmrsInfinite](API.md#useopenmrsinfinite)
238
239
  - [useOpenmrsPagination](API.md#useopenmrspagination)
@@ -544,7 +545,7 @@ A type for any of the acceptable date formats
544
545
 
545
546
  #### Defined in
546
547
 
547
- [packages/framework/esm-styleguide/src/datepicker/index.tsx:93](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L93)
548
+ [packages/framework/esm-styleguide/src/datepicker/index.tsx:94](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L94)
548
549
 
549
550
  ___
550
551
 
@@ -1761,7 +1762,7 @@ ___
1761
1762
 
1762
1763
  #### Defined in
1763
1764
 
1764
- [packages/framework/esm-styleguide/src/location-picker/location-picker.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/location-picker/location-picker.component.tsx#L15)
1765
+ [packages/framework/esm-styleguide/src/location-picker/location-picker.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/location-picker/location-picker.component.tsx#L16)
1765
1766
 
1766
1767
  ___
1767
1768
 
@@ -1891,7 +1892,7 @@ A date picker component to select a single date. Based on React Aria, but styled
1891
1892
 
1892
1893
  #### Defined in
1893
1894
 
1894
- [packages/framework/esm-styleguide/src/datepicker/index.tsx:598](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L598)
1895
+ [packages/framework/esm-styleguide/src/datepicker/index.tsx:603](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L603)
1895
1896
 
1896
1897
  ___
1897
1898
 
@@ -7558,6 +7559,32 @@ ___
7558
7559
 
7559
7560
  ___
7560
7561
 
7562
+ ### useOnVisible
7563
+
7564
+ ▸ **useOnVisible**(`callBack`): `MutableRefObject`<`HTMLElement`\>
7565
+
7566
+ Returns a ref that can be used on a HTML component to trigger
7567
+ an action when the component is scrolled into visible view,
7568
+ This is particularly useful for infinite scrolling UIs to load data on demand.
7569
+
7570
+ #### Parameters
7571
+
7572
+ | Name | Type | Description |
7573
+ | :------ | :------ | :------ |
7574
+ | `callBack` | () => `void` | The callback to run when the component is scrolled into visible view. Care should be taken with this param. The callback should be cached across re-renders (via useCallback) and it should have logic to avoid doing work multiple times while scrolling. |
7575
+
7576
+ #### Returns
7577
+
7578
+ `MutableRefObject`<`HTMLElement`\>
7579
+
7580
+ a ref that can be passed to an HTML Element
7581
+
7582
+ #### Defined in
7583
+
7584
+ [packages/framework/esm-react-utils/src/useOnVisible.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOnVisible.ts#L15)
7585
+
7586
+ ___
7587
+
7561
7588
  ### useOpenmrsFetchAll
7562
7589
 
7563
7590
  ▸ **useOpenmrsFetchAll**<`T`\>(`url`, `options?`): `UseServerInfiniteReturnObject`<`T`, `OpenMRSPaginatedResponse`<`T`\>\>
package/docs/interfaces/OpenmrsDatePickerProps.md CHANGED
@@ -145,7 +145,7 @@ Omit.autoFocus
145
145
 
146
146
  #### Defined in
147
147
 
148
- node_modules/@react-types/shared/src/events.d.ts:120
148
+ node_modules/@react-types/shared/src/events.d.ts:128
149
149
 
150
150
  ___
151
151
 
@@ -173,7 +173,7 @@ Any CSS classes to add to the outer div of the date picker
173
173
 
174
174
  #### Defined in
175
175
 
176
- [packages/framework/esm-styleguide/src/datepicker/index.tsx:102](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L102)
176
+ [packages/framework/esm-styleguide/src/datepicker/index.tsx:103](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L103)
177
177
 
178
178
  ___
179
179
 
@@ -201,7 +201,7 @@ The default value (uncontrolled)
201
201
 
202
202
  #### Defined in
203
203
 
204
- [packages/framework/esm-styleguide/src/datepicker/index.tsx:104](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L104)
204
+ [packages/framework/esm-styleguide/src/datepicker/index.tsx:105](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L105)
205
205
 
206
206
  ___
207
207
 
@@ -295,7 +295,7 @@ Whether the input value is invalid.
295
295
 
296
296
  #### Defined in
297
297
 
298
- [packages/framework/esm-styleguide/src/datepicker/index.tsx:106](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L106)
298
+ [packages/framework/esm-styleguide/src/datepicker/index.tsx:107](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L107)
299
299
 
300
300
  ___
301
301
 
@@ -307,7 +307,7 @@ Text to show if the input is invalid e.g. an error message
307
307
 
308
308
  #### Defined in
309
309
 
310
- [packages/framework/esm-styleguide/src/datepicker/index.tsx:108](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L108)
310
+ [packages/framework/esm-styleguide/src/datepicker/index.tsx:109](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L109)
311
311
 
312
312
  ___
313
313
 
@@ -401,7 +401,7 @@ The label for this DatePicker element
401
401
 
402
402
  #### Defined in
403
403
 
404
- [packages/framework/esm-styleguide/src/datepicker/index.tsx:113](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L113)
404
+ [packages/framework/esm-styleguide/src/datepicker/index.tsx:114](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L114)
405
405
 
406
406
  ___
407
407
 
@@ -413,7 +413,7 @@ The label for this DatePicker element.
413
413
 
414
414
  #### Defined in
415
415
 
416
- [packages/framework/esm-styleguide/src/datepicker/index.tsx:115](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L115)
416
+ [packages/framework/esm-styleguide/src/datepicker/index.tsx:116](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L116)
417
417
 
418
418
  ___
419
419
 
@@ -425,7 +425,7 @@ ___
425
425
 
426
426
  #### Defined in
427
427
 
428
- [packages/framework/esm-styleguide/src/datepicker/index.tsx:117](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L117)
428
+ [packages/framework/esm-styleguide/src/datepicker/index.tsx:118](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L118)
429
429
 
430
430
  ___
431
431
 
@@ -437,7 +437,7 @@ The latest date it is possible to select
437
437
 
438
438
  #### Defined in
439
439
 
440
- [packages/framework/esm-styleguide/src/datepicker/index.tsx:119](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L119)
440
+ [packages/framework/esm-styleguide/src/datepicker/index.tsx:120](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L120)
441
441
 
442
442
  ___
443
443
 
@@ -465,7 +465,7 @@ The earliest date it is possible to select
465
465
 
466
466
  #### Defined in
467
467
 
468
- [packages/framework/esm-styleguide/src/datepicker/index.tsx:121](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L121)
468
+ [packages/framework/esm-styleguide/src/datepicker/index.tsx:122](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L122)
469
469
 
470
470
  ___
471
471
 
@@ -543,7 +543,7 @@ ___
543
543
 
544
544
  #### Defined in
545
545
 
546
- [packages/framework/esm-styleguide/src/datepicker/index.tsx:129](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L129)
546
+ [packages/framework/esm-styleguide/src/datepicker/index.tsx:130](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L130)
547
547
 
548
548
  ___
549
549
 
@@ -590,7 +590,7 @@ Specifies the size of the input. Currently supports either `sm`, `md`, or `lg` a
590
590
 
591
591
  #### Defined in
592
592
 
593
- [packages/framework/esm-styleguide/src/datepicker/index.tsx:127](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L127)
593
+ [packages/framework/esm-styleguide/src/datepicker/index.tsx:128](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L128)
594
594
 
595
595
  ___
596
596
 
@@ -655,7 +655,7 @@ The value (controlled)
655
655
 
656
656
  #### Defined in
657
657
 
658
- [packages/framework/esm-styleguide/src/datepicker/index.tsx:131](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L131)
658
+ [packages/framework/esm-styleguide/src/datepicker/index.tsx:132](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L132)
659
659
 
660
660
  ## Methods
661
661
 
@@ -707,7 +707,7 @@ Omit.onBlur
707
707
 
708
708
  #### Defined in
709
709
 
710
- node_modules/@react-types/shared/src/events.d.ts:85
710
+ node_modules/@react-types/shared/src/events.d.ts:87
711
711
 
712
712
  ___
713
713
 
@@ -729,7 +729,7 @@ Handler that is called when the value changes.
729
729
 
730
730
  #### Defined in
731
731
 
732
- [packages/framework/esm-styleguide/src/datepicker/index.tsx:123](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L123)
732
+ [packages/framework/esm-styleguide/src/datepicker/index.tsx:124](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L124)
733
733
 
734
734
  ___
735
735
 
@@ -751,7 +751,7 @@ Handler that is called when the value changes. Note that this provides types fro
751
751
 
752
752
  #### Defined in
753
753
 
754
- [packages/framework/esm-styleguide/src/datepicker/index.tsx:125](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L125)
754
+ [packages/framework/esm-styleguide/src/datepicker/index.tsx:126](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/index.tsx#L126)
755
755
 
756
756
  ___
757
757
 
@@ -777,7 +777,7 @@ Omit.onFocus
777
777
 
778
778
  #### Defined in
779
779
 
780
- node_modules/@react-types/shared/src/events.d.ts:83
780
+ node_modules/@react-types/shared/src/events.d.ts:85
781
781
 
782
782
  ___
783
783
 
@@ -803,7 +803,7 @@ Omit.onFocusChange
803
803
 
804
804
  #### Defined in
805
805
 
806
- node_modules/@react-types/shared/src/events.d.ts:87
806
+ node_modules/@react-types/shared/src/events.d.ts:89
807
807
 
808
808
  ___
809
809
 
@@ -829,7 +829,7 @@ Omit.onKeyDown
829
829
 
830
830
  #### Defined in
831
831
 
832
- node_modules/@react-types/shared/src/events.d.ts:76
832
+ node_modules/@react-types/shared/src/events.d.ts:78
833
833
 
834
834
  ___
835
835
 
@@ -855,7 +855,7 @@ Omit.onKeyUp
855
855
 
856
856
  #### Defined in
857
857
 
858
- node_modules/@react-types/shared/src/events.d.ts:78
858
+ node_modules/@react-types/shared/src/events.d.ts:80
859
859
 
860
860
  ___
861
861
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openmrs/esm-framework",
3
- "version": "6.2.1-pre.2884",
3
+ "version": "6.2.1-pre.2917",
4
4
  "license": "MPL-2.0",
5
5
  "browser": "dist/openmrs-esm-framework.js",
6
6
  "main": "src/index.ts",
@@ -37,23 +37,23 @@
37
37
  "access": "public"
38
38
  },
39
39
  "dependencies": {
40
- "@openmrs/esm-api": "6.2.1-pre.2884",
41
- "@openmrs/esm-config": "6.2.1-pre.2884",
42
- "@openmrs/esm-context": "6.2.1-pre.2884",
43
- "@openmrs/esm-dynamic-loading": "6.2.1-pre.2884",
44
- "@openmrs/esm-error-handling": "6.2.1-pre.2884",
45
- "@openmrs/esm-expression-evaluator": "6.2.1-pre.2884",
46
- "@openmrs/esm-extensions": "6.2.1-pre.2884",
47
- "@openmrs/esm-feature-flags": "6.2.1-pre.2884",
48
- "@openmrs/esm-globals": "6.2.1-pre.2884",
49
- "@openmrs/esm-navigation": "6.2.1-pre.2884",
50
- "@openmrs/esm-offline": "6.2.1-pre.2884",
51
- "@openmrs/esm-react-utils": "6.2.1-pre.2884",
52
- "@openmrs/esm-routes": "6.2.1-pre.2884",
53
- "@openmrs/esm-state": "6.2.1-pre.2884",
54
- "@openmrs/esm-styleguide": "6.2.1-pre.2884",
55
- "@openmrs/esm-translations": "6.2.1-pre.2884",
56
- "@openmrs/esm-utils": "6.2.1-pre.2884",
40
+ "@openmrs/esm-api": "6.2.1-pre.2917",
41
+ "@openmrs/esm-config": "6.2.1-pre.2917",
42
+ "@openmrs/esm-context": "6.2.1-pre.2917",
43
+ "@openmrs/esm-dynamic-loading": "6.2.1-pre.2917",
44
+ "@openmrs/esm-error-handling": "6.2.1-pre.2917",
45
+ "@openmrs/esm-expression-evaluator": "6.2.1-pre.2917",
46
+ "@openmrs/esm-extensions": "6.2.1-pre.2917",
47
+ "@openmrs/esm-feature-flags": "6.2.1-pre.2917",
48
+ "@openmrs/esm-globals": "6.2.1-pre.2917",
49
+ "@openmrs/esm-navigation": "6.2.1-pre.2917",
50
+ "@openmrs/esm-offline": "6.2.1-pre.2917",
51
+ "@openmrs/esm-react-utils": "6.2.1-pre.2917",
52
+ "@openmrs/esm-routes": "6.2.1-pre.2917",
53
+ "@openmrs/esm-state": "6.2.1-pre.2917",
54
+ "@openmrs/esm-styleguide": "6.2.1-pre.2917",
55
+ "@openmrs/esm-translations": "6.2.1-pre.2917",
56
+ "@openmrs/esm-utils": "6.2.1-pre.2917",
57
57
  "dayjs": "^1.10.7"
58
58
  },
59
59
  "peerDependencies": {