@openmrs/esm-styleguide 8.0.1-pre.3581 → 8.0.1-pre.3592

package/.turbo/turbo-build.log

@@ -3,12 +3,12 @@
 [0]   Why you should do it regularly: https://github.com/browserslist/update-db#readme
 [0] WARNING in ⚠ asset size limit: The following asset(s) exceed the recommended size limit (244.141 KiB). This can impact web performance.
 [0]   │ Assets:
-[0]   │   openmrs-esm-styleguide.js (248.469 KiB)
-[0]   │   openmrs-esm-styleguide.css (3.262 MiB)
+[0]   │   openmrs-esm-styleguide.js (249.951 KiB)
+[0]   │   openmrs-esm-styleguide.css (3.266 MiB)
 [0] 
 [0] WARNING in ⚠ entrypoint size limit: The following entrypoint(s) combined asset size exceeds the recommended limit (244.141 KiB). This can impact web performance.
 [0]   │ Entrypoints:
-[0]   │   main (3.505 MiB)
+[0]   │   main (3.510 MiB)
 [0]   │       openmrs-esm-styleguide.css
 [0]   │       openmrs-esm-styleguide.js
 [0] 
@@ -16,6 +16,6 @@
 [0]   │ You can limit the size of your bundles by using import() to lazy load some parts of your application.
 [0]   │ For more info visit https://www.rspack.dev/guide/optimization/code-splitting
 [0] 
-[0] Rspack compiled with 3 warnings in 9.91 s
+[0] Rspack compiled with 3 warnings in 10.40 s
 [0] rspack --mode=production exited with code 0
 [1] tsc --project tsconfig.build.json exited with code 0

package/dist/empty-card/empty-card.component.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+export interface EmptyCardProps {
+    /** The name of the type of item that would be displayed here if not empty. This must be a pre-translated string. */
+    displayText: string;
+    /** The title to use for this empty component. This must be a pre-translated string. */
+    headerTitle: string;
+    /** A callback to invoke when the user tries to record a new item. */
+    launchForm?(): void;
+}
+/**
+ * Re-usable card for displaying an empty state
+ */
+export declare const EmptyCard: React.FC<EmptyCardProps>;

package/dist/empty-card/index.d.ts

@@ -0,0 +1 @@
+export { EmptyCard, type EmptyCardProps } from './empty-card.component';

package/dist/error-card/error-card.component.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+export interface ErrorCardProps {
+    /** This is the error that triggered rendering the card. It is expected to be the error returned from `openmrsFetch()` */
+    error: any;
+    /** The title for this card. This must be a pre-translated string. */
+    headerTitle: string;
+}
+/**
+ * Re-usable card for displaying a fetch error
+ */
+export declare const ErrorCard: React.FC<ErrorCardProps>;

package/dist/error-card/index.d.ts

@@ -0,0 +1 @@
+export { ErrorCard, type ErrorCardProps } from './error-card.component';

package/dist/error-state/error-state.component.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+export interface ErrorStateProps {
+    error: any;
+    headerTitle: string;
+}
+export declare const ErrorState: React.FC<ErrorStateProps>;

package/dist/error-state/index.d.ts

@@ -0,0 +1 @@
+export * from './error-state.component';

package/dist/internal.d.ts

@@ -1,9 +1,12 @@
 export * from './breakpoints';
+export * from './cards';
 export * from './config-schema';
 export * from './custom-overflow-menu';
 export * from './dashboard-extension';
 export * from './datepicker';
 export * from './diagnosis-tags';
+export * from './empty-card';
+export * from './error-card';
 export * from './error-state';
 export * from './icons/icons';
 export * from './left-nav';
@@ -13,6 +16,7 @@ export * from './notifications';
 export * from './notifications/actionable-notification.component';
 export * from './notifications/notification.component';
 export * from './page-header';
+export * from './pagination';
 export * from './patient-banner';
 export * from './patient-photo';
 export * from './pictograms/pictograms';

package/dist/left-nav/index.d.ts

@@ -0,0 +1,23 @@
+/** @module @category UI */
+import React from 'react';
+import { type SideNavProps } from '@carbon/react';
+/**
+ * Extended props for the LeftNavMenu component
+ */
+interface LeftNavMenuProps extends SideNavProps {
+    /**
+     * Flag indicating if this component is a child of the header component.
+     * When true, the component renders the left nav menu.
+     * When false, it renders an empty fragment.
+     */
+    isChildOfHeader?: boolean;
+}
+/**
+ * This component renders the left nav in desktop mode. It's also used to render the same
+ * nav when the hamburger menu is clicked on in tablet mode. See side-menu-panel.component.tsx
+ *
+ * Use of this component by anything other than <SideMenuPanel> (where isChildOfHeader == false)
+ * is deprecated; it simply renders nothing.
+ */
+export declare const LeftNavMenu: React.ForwardRefExoticComponent<LeftNavMenuProps & React.RefAttributes<HTMLElement>>;
+export {};

package/dist/modals/index.d.ts

@@ -0,0 +1,25 @@
+type ModalSize = 'xs' | 'sm' | 'md' | 'lg';
+export interface ModalProps {
+    size?: ModalSize;
+    [key: string]: unknown;
+}
+/**
+ * @internal
+ * Sets up the modals system. Should be called in the app shell during initialization.
+ */
+export declare function setupModals(modalContainer: HTMLElement | null): void;
+/**
+ * Shows a modal dialog.
+ *
+ * The modal must have been registered by name. This should be done in the `routes.json` file of the
+ * app that defines the modal. Note that both the `<ModalHeader>` and `<ModalBody>` should be at the
+ * top level of the modal component (wrapped in a React.Fragment), or else the content of the modal
+ * body might not vertical-scroll properly.
+ *
+ * @param modalName The name of the modal to show.
+ * @param props The optional props to provide to the modal.
+ * @param onClose The optional callback to call when the modal is closed.
+ * @returns The dispose function to force closing the modal dialog.
+ */
+export declare function showModal(modalName: string, props?: ModalProps, onClose?: () => void): () => void;
+export {};

package/dist/notifications/actionable-notification.component.d.ts

@@ -0,0 +1,20 @@
+import React from 'react';
+/** @module @category UI */
+export interface ActionableNotificationProps {
+    notification: ActionableNotificationMeta;
+}
+export interface ActionableNotificationDescriptor {
+    actionButtonLabel: string;
+    onActionButtonClick(): void;
+    onClose?(): void;
+    subtitle: string;
+    title?: string;
+    kind?: ActionableNotificationType | string;
+    critical?: boolean;
+    progressActionLabel?: string;
+}
+export interface ActionableNotificationMeta extends ActionableNotificationDescriptor {
+    id: number;
+}
+export type ActionableNotificationType = 'error' | 'info' | 'info-square' | 'success' | 'warning' | 'warning-alt';
+export declare const ActionableNotificationComponent: React.FC<ActionableNotificationProps>;

package/dist/notifications/active-actionable-notifications.component.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import type { Subject } from 'rxjs';
+import type { ActionableNotificationMeta } from './actionable-notification.component';
+interface ActionableActiveNotificationProps {
+    subject: Subject<ActionableNotificationMeta>;
+}
+declare const ActionableActiveNotifications: React.FC<ActionableActiveNotificationProps>;
+export default ActionableActiveNotifications;

package/dist/notifications/active-notifications.component.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import type { Subject } from 'rxjs';
+import type { InlineNotificationMeta } from './notification.component';
+interface ActiveNotificationProps {
+    subject: Subject<InlineNotificationMeta>;
+}
+declare const ActiveNotifications: React.FC<ActiveNotificationProps>;
+export default ActiveNotifications;

package/dist/notifications/index.d.ts

@@ -0,0 +1,19 @@
+import type { NotificationDescriptor } from './notification.component';
+import type { ActionableNotificationDescriptor } from './actionable-notification.component';
+/**
+ * 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.
+ * @param target The container target that hosts the inline notifications.
+ */
+export declare function renderInlineNotifications(target: HTMLElement | null): void;
+/**
+ * Displays an inline notification in the UI.
+ * @param notification The description of the notification to display.
+ */
+export declare function showNotification(notification: NotificationDescriptor): void;
+export declare function renderActionableNotifications(target: HTMLElement | null): void;
+/**
+ * Displays an actionable notification in the UI.
+ * @param notification The description of the notification to display.
+ */
+export declare function showActionableNotification(notification: ActionableNotificationDescriptor): void;

package/dist/notifications/notification.component.d.ts

@@ -0,0 +1,19 @@
+import React from 'react';
+/** @module @category UI */
+export interface NotificationProps {
+    notification: InlineNotificationMeta;
+}
+export interface NotificationDescriptor {
+    description: string;
+    action?: string;
+    kind?: InlineNotificationType;
+    critical?: boolean;
+    millis?: number;
+    title?: string;
+    onAction?: () => void;
+}
+export interface InlineNotificationMeta extends NotificationDescriptor {
+    id: number;
+}
+export type InlineNotificationType = 'error' | 'info' | 'info-square' | 'success' | 'warning' | 'warning-alt';
+export declare const Notification: React.FC<NotificationProps>;