@openmrs/esm-framework 3.4.1-pre.156 → 3.4.1-pre.159

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 (10) hide show
  1. package/.turbo/turbo-build.log +9 -9
  2. package/dist/openmrs-esm-framework.js +1 -1
  3. package/dist/openmrs-esm-framework.js.LICENSE.txt +0 -9
  4. package/dist/openmrs-esm-framework.js.map +1 -1
  5. package/docs/API.md +61 -16
  6. package/docs/interfaces/ExtensionProps.md +4 -2
  7. package/docs/interfaces/ExtensionSlotBaseProps.md +4 -4
  8. package/docs/interfaces/OldExtensionSlotBaseProps.md +4 -4
  9. package/mock.tsx +0 -6
  10. package/package.json +13 -13
package/docs/API.md CHANGED
@@ -140,6 +140,10 @@
140
140
  - [syncOfflinePatientData](API.md#syncofflinepatientdata)
141
141
  - [useConnectivity](API.md#useconnectivity)
142
142
 
143
+ ### Other Functions
144
+
145
+ - [ExtensionSlot](API.md#extensionslot)
146
+
143
147
  ### Store Functions
144
148
 
145
149
  - [createGlobalStore](API.md#createglobalstore)
@@ -388,11 +392,11 @@ ___
388
392
 
389
393
  ### ExtensionSlotProps
390
394
 
391
- Ƭ **ExtensionSlotProps**: [`OldExtensionSlotBaseProps`](interfaces/OldExtensionSlotBaseProps.md) \| [`ExtensionSlotBaseProps`](interfaces/ExtensionSlotBaseProps.md) & `React.HTMLAttributes`<`HTMLDivElement`\>
395
+ Ƭ **ExtensionSlotProps**: [`OldExtensionSlotBaseProps`](interfaces/OldExtensionSlotBaseProps.md) \| [`ExtensionSlotBaseProps`](interfaces/ExtensionSlotBaseProps.md) & `React.HTMLAttributes`<`HTMLDivElement`\> & { `children?`: `React.ReactNode` \| (`extension`: [`ConnectedExtension`](interfaces/ConnectedExtension.md)) => `React.ReactNode` }
392
396
 
393
397
  #### Defined in
394
398
 
395
- [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:58](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L58)
399
+ [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L23)
396
400
 
397
401
  ___
398
402
 
@@ -704,17 +708,7 @@ and *must* only be used once within that `<ExtensionSlot>`.
704
708
 
705
709
  #### Defined in
706
710
 
707
- [packages/framework/esm-react-utils/src/Extension.tsx:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L23)
708
-
709
- ___
710
-
711
- ### ExtensionSlot
712
-
713
- • **ExtensionSlot**: `React.FC`<[`ExtensionSlotProps`](API.md#extensionslotprops)\>
714
-
715
- #### Defined in
716
-
717
- [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:68](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L68)
711
+ [packages/framework/esm-react-utils/src/Extension.tsx:31](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L31)
718
712
 
719
713
  ___
720
714
 
@@ -2307,7 +2301,7 @@ ___
2307
2301
 
2308
2302
  ### renderExtension
2309
2303
 
2310
- ▸ **renderExtension**(`domElement`, `extensionSlotName`, `extensionSlotModuleName`, `extensionId`, `renderFunction?`, `additionalProps?`): [`CancelLoading`](interfaces/CancelLoading.md)
2304
+ ▸ **renderExtension**(`domElement`, `extensionSlotName`, `extensionSlotModuleName`, `extensionId`, `renderFunction?`, `additionalProps?`): `Parcel` \| ``null``
2311
2305
 
2312
2306
  Mounts into a DOM node (representing an extension slot)
2313
2307
  a lazy-loaded component from *any* frontend module
@@ -2326,7 +2320,7 @@ that registered an extension component for this slot.
2326
2320
 
2327
2321
  #### Returns
2328
2322
 
2329
- [`CancelLoading`](interfaces/CancelLoading.md)
2323
+ `Parcel` \| ``null``
2330
2324
 
2331
2325
  #### Defined in
2332
2326
 
@@ -3428,6 +3422,57 @@ ___
3428
3422
 
3429
3423
  ___
3430
3424
 
3425
+ ## Other Functions
3426
+
3427
+ ### ExtensionSlot
3428
+
3429
+ ▸ **ExtensionSlot**(`__namedParameters`): `Element`
3430
+
3431
+ An [extension slot](https://o3-dev.docs.openmrs.org/#/main/extensions).
3432
+ A place with a name. Extensions that get connected to that name
3433
+ will be rendered into this.
3434
+
3435
+ **`example`**
3436
+ Passing a react node as children
3437
+
3438
+ ```tsx
3439
+ <ExtensionSlot name="Foo">
3440
+ <div style={{ width: 10rem }}>
3441
+ <Extension />
3442
+ </div>
3443
+ </ExtensionSlot>
3444
+ ```
3445
+
3446
+ **`example`**
3447
+ Passing a function as children
3448
+
3449
+ ```tsx
3450
+ <ExtensionSlot name="Bar">
3451
+ {(extension) => (
3452
+ <h1>{extension.name}</h1>
3453
+ <div style={{ color: extension.meta.color }}>
3454
+ <Extension />
3455
+ </div>
3456
+ )}
3457
+ </ExtensionSlot>
3458
+ ```
3459
+
3460
+ #### Parameters
3461
+
3462
+ | Name | Type |
3463
+ | :------ | :------ |
3464
+ | `__namedParameters` | [`ExtensionSlotProps`](API.md#extensionslotprops) |
3465
+
3466
+ #### Returns
3467
+
3468
+ `Element`
3469
+
3470
+ #### Defined in
3471
+
3472
+ [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:85](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L85)
3473
+
3474
+ ___
3475
+
3431
3476
  ## Store Functions
3432
3477
 
3433
3478
  ### createGlobalStore
@@ -3774,7 +3819,7 @@ The dispose function to force closing the modal dialog.
3774
3819
 
3775
3820
  #### Defined in
3776
3821
 
3777
- [packages/framework/esm-styleguide/src/modals/index.tsx:164](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/modals/index.tsx#L164)
3822
+ [packages/framework/esm-styleguide/src/modals/index.tsx:165](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/modals/index.tsx#L165)
3778
3823
 
3779
3824
  ___
3780
3825
 
package/docs/interfaces/ExtensionProps.md CHANGED
@@ -20,7 +20,7 @@
20
20
 
21
21
  #### Defined in
22
22
 
23
- [packages/framework/esm-react-utils/src/Extension.tsx:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L7)
23
+ [packages/framework/esm-react-utils/src/Extension.tsx:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L14)
24
24
 
25
25
  ## Methods
26
26
 
@@ -28,6 +28,8 @@
28
28
 
29
29
  ▸ `Optional` **wrap**(`slot`, `extension`): ``null`` \| `ReactElement`<`any`, `any`\>
30
30
 
31
+ **`deprecated`** Pass a function as the child of `ExtensionSlot` instead.
32
+
31
33
  #### Parameters
32
34
 
33
35
  | Name | Type |
@@ -41,4 +43,4 @@
41
43
 
42
44
  #### Defined in
43
45
 
44
- [packages/framework/esm-react-utils/src/Extension.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L8)
46
+ [packages/framework/esm-react-utils/src/Extension.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L16)
package/docs/interfaces/ExtensionSlotBaseProps.md CHANGED
@@ -24,7 +24,7 @@
24
24
 
25
25
  #### Defined in
26
26
 
27
- [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:45](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L45)
27
+ [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L10)
28
28
 
29
29
  ___
30
30
 
@@ -34,7 +34,7 @@ ___
34
34
 
35
35
  #### Defined in
36
36
 
37
- [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:43](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L43)
37
+ [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L8)
38
38
 
39
39
  ___
40
40
 
@@ -44,7 +44,7 @@ ___
44
44
 
45
45
  #### Defined in
46
46
 
47
- [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:47](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L47)
47
+ [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L12)
48
48
 
49
49
  ## Methods
50
50
 
@@ -64,4 +64,4 @@ ___
64
64
 
65
65
  #### Defined in
66
66
 
67
- [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:46](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L46)
67
+ [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L11)
package/docs/interfaces/OldExtensionSlotBaseProps.md CHANGED
@@ -24,7 +24,7 @@
24
24
 
25
25
  #### Defined in
26
26
 
27
- [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:53](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L53)
27
+ [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L18)
28
28
 
29
29
  ___
30
30
 
@@ -34,7 +34,7 @@ ___
34
34
 
35
35
  #### Defined in
36
36
 
37
- [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:51](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L51)
37
+ [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L16)
38
38
 
39
39
  ___
40
40
 
@@ -44,7 +44,7 @@ ___
44
44
 
45
45
  #### Defined in
46
46
 
47
- [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L55)
47
+ [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L20)
48
48
 
49
49
  ## Methods
50
50
 
@@ -64,4 +64,4 @@ ___
64
64
 
65
65
  #### Defined in
66
66
 
67
- [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:54](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L54)
67
+ [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L19)
package/mock.tsx CHANGED
@@ -249,12 +249,6 @@ export const useSession = jest.fn(() => ({
249
249
 
250
250
  export const useLayoutType = jest.fn(() => "desktop");
251
251
 
252
- export const useExtensionSlot = jest.fn(() => ({
253
- extensionSlotModuleName: "",
254
- attachedExtensionSlotName: "",
255
- extensionIdsToRender: [],
256
- }));
257
-
258
252
  export const useExtensionSlotMeta = jest.fn(() => ({}));
259
253
 
260
254
  export const UserHasAccess = jest.fn().mockImplementation((props: any) => {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openmrs/esm-framework",
3
- "version": "3.4.1-pre.156",
3
+ "version": "3.4.1-pre.159",
4
4
  "license": "MPL-2.0",
5
5
  "browser": "dist/openmrs-esm-framework.js",
6
6
  "main": "src/index.ts",
@@ -35,18 +35,18 @@
35
35
  "access": "public"
36
36
  },
37
37
  "dependencies": {
38
- "@openmrs/esm-api": "^3.4.1-pre.156",
39
- "@openmrs/esm-breadcrumbs": "^3.4.1-pre.156",
40
- "@openmrs/esm-config": "^3.4.1-pre.156",
41
- "@openmrs/esm-error-handling": "^3.4.1-pre.156",
42
- "@openmrs/esm-extensions": "^3.4.1-pre.156",
43
- "@openmrs/esm-globals": "^3.4.1-pre.156",
44
- "@openmrs/esm-offline": "^3.4.1-pre.156",
45
- "@openmrs/esm-react-utils": "^3.4.1-pre.156",
46
- "@openmrs/esm-state": "^3.4.1-pre.156",
47
- "@openmrs/esm-styleguide": "^3.4.1-pre.156",
48
- "@openmrs/esm-utils": "^3.4.1-pre.156",
38
+ "@openmrs/esm-api": "^3.4.1-pre.159",
39
+ "@openmrs/esm-breadcrumbs": "^3.4.1-pre.159",
40
+ "@openmrs/esm-config": "^3.4.1-pre.159",
41
+ "@openmrs/esm-error-handling": "^3.4.1-pre.159",
42
+ "@openmrs/esm-extensions": "^3.4.1-pre.159",
43
+ "@openmrs/esm-globals": "^3.4.1-pre.159",
44
+ "@openmrs/esm-offline": "^3.4.1-pre.159",
45
+ "@openmrs/esm-react-utils": "^3.4.1-pre.159",
46
+ "@openmrs/esm-state": "^3.4.1-pre.159",
47
+ "@openmrs/esm-styleguide": "^3.4.1-pre.159",
48
+ "@openmrs/esm-utils": "^3.4.1-pre.159",
49
49
  "dayjs": "^1.10.7"
50
50
  },
51
- "gitHead": "643ddd2b2faf12c13f29caa2f22b9b125040b7fc"
51
+ "gitHead": "5db63763cc56f850b2cb1a9d51d4d540cc16344d"
52
52
  }