@muraldevkit/ui-toolkit 1.21.10 → 1.22.0

package/dist/contexts/MrlDeviceProvider/MrlDeviceProvider.d.ts

@@ -0,0 +1,28 @@
+import React from 'react';
+/**
+ * browser: mobile and desktop browsers
+ * native: native app running on tablets and phones
+ * display: SmartHubs and other big displays
+ */
+export type MrlDeviceClient = 'browser' | 'native' | 'display';
+export interface MrlDeviceProviderProps {
+    /** The child elements to be wrapped by the MrlDeviceProvider. */
+    children: React.ReactNode;
+    /**  The type of client where the UI toolkit is running: 'browser', 'native', or 'display'. */
+    client: MrlDeviceClient;
+}
+/**
+ * Provides context for switching the views according to the client type (browser, mobile or display).
+ *
+ * `client` can be retrieved using the `useDeviceClient()` hook. Defaults to `browser` when running outside the provider.
+ *
+ * @param {MrlDeviceClient} props.client The client type where ui-toolkit is running
+ * @returns the devices provider component
+ */
+export declare function MrlDeviceProvider({ children, client }: MrlDeviceProviderProps): React.ReactElement;
+/**
+ * React hook for customizing the UI according to the client type.
+ *
+ * @returns {MrlDeviceClient} 'browser' | 'native' | 'display' (defaults to 'browser' called outside MrlDeviceProvider is present)
+ */
+export declare function useDeviceClient(): MrlDeviceClient;

package/dist/contexts/MrlDeviceProvider/index.d.ts

@@ -0,0 +1 @@
+export * from './MrlDeviceProvider';

package/dist/contexts/index.d.ts

@@ -0,0 +1 @@
+export * from './MrlDeviceProvider';

package/dist/index.d.ts

@@ -1,2 +1,3 @@
-export * from "./components";
-export * from "./utils";
+export * from './components';
+export * from './utils';
+export * from './contexts';