@openmrs/esm-styleguide 3.1.15-pre.693 → 3.1.15-pre.709
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/README.md +0 -2
- package/package.json +3 -4
- package/docs/API.md +0 -198
- package/typedoc.json +0 -7
package/README.md
CHANGED
|
@@ -7,5 +7,3 @@ All our frontend UI development is based on [Carbon Design System](https://www.c
|
|
|
7
7
|
Please see the Developer Documentation page [Using Carbon and the Styleguide](https://openmrs.github.io/openmrs-esm-core/#/main/carbon).
|
|
8
8
|
|
|
9
9
|
See also the [full, detailed styleguide in Zeplin here](https://app.zeplin.io/styleguide/60d5ecb9efdcd81256117e7d/components) (let us know if you require an invitation)
|
|
10
|
-
|
|
11
|
-
[API Docs](docs/API.md)
|
package/package.json
CHANGED
|
@@ -1,13 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openmrs/esm-styleguide",
|
|
3
|
-
"version": "3.1.15-pre.
|
|
3
|
+
"version": "3.1.15-pre.709",
|
|
4
4
|
"license": "MPL-2.0",
|
|
5
5
|
"description": "The styleguide for OpenMRS SPA",
|
|
6
6
|
"browser": "dist/openmrs-esm-styleguide.js",
|
|
7
7
|
"main": "src/index.ts",
|
|
8
8
|
"source": true,
|
|
9
9
|
"scripts": {
|
|
10
|
-
"document": "../../../document.sh esm-styleguide",
|
|
11
10
|
"test": "jest --passWithNoTests",
|
|
12
11
|
"start:storybook": "start-storybook --port 7000",
|
|
13
12
|
"build:storybook": "build-storybook",
|
|
@@ -52,7 +51,7 @@
|
|
|
52
51
|
"rxjs": "6.x"
|
|
53
52
|
},
|
|
54
53
|
"devDependencies": {
|
|
55
|
-
"@openmrs/esm-extensions": "^3.1.15-pre.
|
|
54
|
+
"@openmrs/esm-extensions": "^3.1.15-pre.709",
|
|
56
55
|
"@pickra/copy-code-block": "^1.1.7",
|
|
57
56
|
"@storybook/addon-a11y": "^5.2.1",
|
|
58
57
|
"@storybook/addon-knobs": "^5.2.1",
|
|
@@ -65,5 +64,5 @@
|
|
|
65
64
|
"react-dom": "^16.13.1",
|
|
66
65
|
"rxjs": "^6.5.3"
|
|
67
66
|
},
|
|
68
|
-
"gitHead": "
|
|
67
|
+
"gitHead": "20e905827ceb11c90871b5e28a7bd56ab4fbab18"
|
|
69
68
|
}
|
package/docs/API.md
DELETED
|
@@ -1,198 +0,0 @@
|
|
|
1
|
-
[Back to README.md](../README.md)
|
|
2
|
-
|
|
3
|
-
# @openmrs/esm-styleguide
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Functions
|
|
8
|
-
|
|
9
|
-
- [integrateBreakpoints](API.md#integratebreakpoints)
|
|
10
|
-
- [renderInlineNotifications](API.md#renderinlinenotifications)
|
|
11
|
-
- [renderLoadingSpinner](API.md#renderloadingspinner)
|
|
12
|
-
- [renderModals](API.md#rendermodals)
|
|
13
|
-
- [renderToasts](API.md#rendertoasts)
|
|
14
|
-
- [showModal](API.md#showmodal)
|
|
15
|
-
- [showNotification](API.md#shownotification)
|
|
16
|
-
- [showToast](API.md#showtoast)
|
|
17
|
-
|
|
18
|
-
## Functions
|
|
19
|
-
|
|
20
|
-
### integrateBreakpoints
|
|
21
|
-
|
|
22
|
-
▸ **integrateBreakpoints**(): `void`
|
|
23
|
-
|
|
24
|
-
#### Returns
|
|
25
|
-
|
|
26
|
-
`void`
|
|
27
|
-
|
|
28
|
-
#### Defined in
|
|
29
|
-
|
|
30
|
-
[breakpoints/index.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/breakpoints/index.ts#L20)
|
|
31
|
-
|
|
32
|
-
___
|
|
33
|
-
|
|
34
|
-
### renderInlineNotifications
|
|
35
|
-
|
|
36
|
-
▸ **renderInlineNotifications**(`target`): `void`
|
|
37
|
-
|
|
38
|
-
Starts a rendering host for inline notifications. Should only be used by the app shell.
|
|
39
|
-
Under normal conditions there is no need to use this function.
|
|
40
|
-
|
|
41
|
-
#### Parameters
|
|
42
|
-
|
|
43
|
-
| Name | Type | Description |
|
|
44
|
-
| :------ | :------ | :------ |
|
|
45
|
-
| `target` | `HTMLElement` \| ``null`` | The container target that hosts the inline notifications. |
|
|
46
|
-
|
|
47
|
-
#### Returns
|
|
48
|
-
|
|
49
|
-
`void`
|
|
50
|
-
|
|
51
|
-
#### Defined in
|
|
52
|
-
|
|
53
|
-
[notifications/index.tsx:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/notifications/index.tsx#L19)
|
|
54
|
-
|
|
55
|
-
___
|
|
56
|
-
|
|
57
|
-
### renderLoadingSpinner
|
|
58
|
-
|
|
59
|
-
▸ **renderLoadingSpinner**(`target`): () => `any`
|
|
60
|
-
|
|
61
|
-
#### Parameters
|
|
62
|
-
|
|
63
|
-
| Name | Type |
|
|
64
|
-
| :------ | :------ |
|
|
65
|
-
| `target` | `HTMLElement` |
|
|
66
|
-
|
|
67
|
-
#### Returns
|
|
68
|
-
|
|
69
|
-
`fn`
|
|
70
|
-
|
|
71
|
-
▸ (): `any`
|
|
72
|
-
|
|
73
|
-
##### Returns
|
|
74
|
-
|
|
75
|
-
`any`
|
|
76
|
-
|
|
77
|
-
#### Defined in
|
|
78
|
-
|
|
79
|
-
[spinner/index.ts:1](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/spinner/index.ts#L1)
|
|
80
|
-
|
|
81
|
-
___
|
|
82
|
-
|
|
83
|
-
### renderModals
|
|
84
|
-
|
|
85
|
-
▸ **renderModals**(`modalContainer`): `void`
|
|
86
|
-
|
|
87
|
-
#### Parameters
|
|
88
|
-
|
|
89
|
-
| Name | Type |
|
|
90
|
-
| :------ | :------ |
|
|
91
|
-
| `modalContainer` | `HTMLElement` \| ``null`` |
|
|
92
|
-
|
|
93
|
-
#### Returns
|
|
94
|
-
|
|
95
|
-
`void`
|
|
96
|
-
|
|
97
|
-
#### Defined in
|
|
98
|
-
|
|
99
|
-
[modals/index.tsx:109](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/modals/index.tsx#L109)
|
|
100
|
-
|
|
101
|
-
___
|
|
102
|
-
|
|
103
|
-
### renderToasts
|
|
104
|
-
|
|
105
|
-
▸ **renderToasts**(`target`): `void`
|
|
106
|
-
|
|
107
|
-
Starts a rendering host for toast notifications. Should only be used by the app shell.
|
|
108
|
-
Under normal conditions there is no need to use this function.
|
|
109
|
-
|
|
110
|
-
#### Parameters
|
|
111
|
-
|
|
112
|
-
| Name | Type | Description |
|
|
113
|
-
| :------ | :------ | :------ |
|
|
114
|
-
| `target` | `HTMLElement` \| ``null`` | The container target that hosts the toast notifications. |
|
|
115
|
-
|
|
116
|
-
#### Returns
|
|
117
|
-
|
|
118
|
-
`void`
|
|
119
|
-
|
|
120
|
-
#### Defined in
|
|
121
|
-
|
|
122
|
-
[toasts/index.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/index.tsx#L16)
|
|
123
|
-
|
|
124
|
-
___
|
|
125
|
-
|
|
126
|
-
### showModal
|
|
127
|
-
|
|
128
|
-
▸ **showModal**(`extensionId`, `props?`, `onClose?`): () => `void`
|
|
129
|
-
|
|
130
|
-
Shows the provided extension component in a modal dialog.
|
|
131
|
-
|
|
132
|
-
#### Parameters
|
|
133
|
-
|
|
134
|
-
| Name | Type | Description |
|
|
135
|
-
| :------ | :------ | :------ |
|
|
136
|
-
| `extensionId` | `string` | The id of the extension to show. |
|
|
137
|
-
| `props` | `Record`<`string`, `any`\> | The optional props to provide to the extension. |
|
|
138
|
-
| `onClose` | () => `void` | The optional notification to receive when the modal is closed. |
|
|
139
|
-
|
|
140
|
-
#### Returns
|
|
141
|
-
|
|
142
|
-
`fn`
|
|
143
|
-
|
|
144
|
-
The dispose function to force closing the modal dialog.
|
|
145
|
-
|
|
146
|
-
▸ (): `void`
|
|
147
|
-
|
|
148
|
-
##### Returns
|
|
149
|
-
|
|
150
|
-
`void`
|
|
151
|
-
|
|
152
|
-
#### Defined in
|
|
153
|
-
|
|
154
|
-
[modals/index.tsx:163](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/modals/index.tsx#L163)
|
|
155
|
-
|
|
156
|
-
___
|
|
157
|
-
|
|
158
|
-
### showNotification
|
|
159
|
-
|
|
160
|
-
▸ **showNotification**(`notification`): `void`
|
|
161
|
-
|
|
162
|
-
Displays an inline notification in the UI.
|
|
163
|
-
|
|
164
|
-
#### Parameters
|
|
165
|
-
|
|
166
|
-
| Name | Type | Description |
|
|
167
|
-
| :------ | :------ | :------ |
|
|
168
|
-
| `notification` | `NotificationDescriptor` | The description of the notification to display. |
|
|
169
|
-
|
|
170
|
-
#### Returns
|
|
171
|
-
|
|
172
|
-
`void`
|
|
173
|
-
|
|
174
|
-
#### Defined in
|
|
175
|
-
|
|
176
|
-
[notifications/index.tsx:40](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/notifications/index.tsx#L40)
|
|
177
|
-
|
|
178
|
-
___
|
|
179
|
-
|
|
180
|
-
### showToast
|
|
181
|
-
|
|
182
|
-
▸ **showToast**(`toast`): `void`
|
|
183
|
-
|
|
184
|
-
Displays a toast notification in the UI.
|
|
185
|
-
|
|
186
|
-
#### Parameters
|
|
187
|
-
|
|
188
|
-
| Name | Type | Description |
|
|
189
|
-
| :------ | :------ | :------ |
|
|
190
|
-
| `toast` | `ToastDescriptor` | The description of the toast to display. |
|
|
191
|
-
|
|
192
|
-
#### Returns
|
|
193
|
-
|
|
194
|
-
`void`
|
|
195
|
-
|
|
196
|
-
#### Defined in
|
|
197
|
-
|
|
198
|
-
[toasts/index.tsx:34](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/index.tsx#L34)
|