@openmrs/esm-framework 6.2.1-pre.2909 → 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.
- package/.turbo/turbo-build.log +2 -2
- package/dist/openmrs-esm-framework.js +1 -1
- package/dist/openmrs-esm-framework.js.map +1 -1
- package/docs/API.md +28 -1
- 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)
|
|
@@ -1761,7 +1762,7 @@ ___
|
|
|
1761
1762
|
|
|
1762
1763
|
#### Defined in
|
|
1763
1764
|
|
|
1764
|
-
[packages/framework/esm-styleguide/src/location-picker/location-picker.component.tsx:
|
|
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
|
|
|
@@ -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/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openmrs/esm-framework",
|
|
3
|
-
"version": "6.2.1-pre.
|
|
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.
|
|
41
|
-
"@openmrs/esm-config": "6.2.1-pre.
|
|
42
|
-
"@openmrs/esm-context": "6.2.1-pre.
|
|
43
|
-
"@openmrs/esm-dynamic-loading": "6.2.1-pre.
|
|
44
|
-
"@openmrs/esm-error-handling": "6.2.1-pre.
|
|
45
|
-
"@openmrs/esm-expression-evaluator": "6.2.1-pre.
|
|
46
|
-
"@openmrs/esm-extensions": "6.2.1-pre.
|
|
47
|
-
"@openmrs/esm-feature-flags": "6.2.1-pre.
|
|
48
|
-
"@openmrs/esm-globals": "6.2.1-pre.
|
|
49
|
-
"@openmrs/esm-navigation": "6.2.1-pre.
|
|
50
|
-
"@openmrs/esm-offline": "6.2.1-pre.
|
|
51
|
-
"@openmrs/esm-react-utils": "6.2.1-pre.
|
|
52
|
-
"@openmrs/esm-routes": "6.2.1-pre.
|
|
53
|
-
"@openmrs/esm-state": "6.2.1-pre.
|
|
54
|
-
"@openmrs/esm-styleguide": "6.2.1-pre.
|
|
55
|
-
"@openmrs/esm-translations": "6.2.1-pre.
|
|
56
|
-
"@openmrs/esm-utils": "6.2.1-pre.
|
|
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": {
|