Skip to content

Latest commit

 

History

History
198 lines (112 loc) · 4.22 KB

File metadata and controls

198 lines (112 loc) · 4.22 KB

Back to README.md

@openmrs/esm-styleguide

Table of contents

Functions

Functions

integrateBreakpoints

integrateBreakpoints(): void

Returns

void

Defined in

breakpoints/index.ts:20


renderInlineNotifications

renderInlineNotifications(target): void

Starts a rendering host for inline notifications. Should only be used by the app shell. Under normal conditions there is no need to use this function.

Parameters

Name Type Description
target HTMLElement | null The container target that hosts the inline notifications.

Returns

void

Defined in

notifications/index.tsx:19


renderLoadingSpinner

renderLoadingSpinner(target): () => any

Parameters

Name Type
target HTMLElement

Returns

fn

▸ (): any

Returns

any

Defined in

spinner/index.ts:1


renderModals

renderModals(modalContainer): void

Parameters

Name Type
modalContainer HTMLElement | null

Returns

void

Defined in

modals/index.tsx:109


renderToasts

renderToasts(target): void

Starts a rendering host for toast notifications. Should only be used by the app shell. Under normal conditions there is no need to use this function.

Parameters

Name Type Description
target HTMLElement | null The container target that hosts the toast notifications.

Returns

void

Defined in

toasts/index.tsx:16


showModal

showModal(extensionId, props?, onClose?): () => void

Shows the provided extension component in a modal dialog.

Parameters

Name Type Description
extensionId string The id of the extension to show.
props Record<string, any> The optional props to provide to the extension.
onClose () => void The optional notification to receive when the modal is closed.

Returns

fn

The dispose function to force closing the modal dialog.

▸ (): void

Returns

void

Defined in

modals/index.tsx:163


showNotification

showNotification(notification): void

Displays an inline notification in the UI.

Parameters

Name Type Description
notification NotificationDescriptor The description of the notification to display.

Returns

void

Defined in

notifications/index.tsx:40


showToast

showToast(toast): void

Displays a toast notification in the UI.

Parameters

Name Type Description
toast ToastDescriptor The description of the toast to display.

Returns

void

Defined in

toasts/index.tsx:34